Rippling: List worker-payroll-records
Rippling restApi.listWorkerPayrollRecords: arguments, response, policy and SDK examples.
← Rest API operations · Get started
Operation rippling.rest_api.list_worker_payroll_records
Provider route: GET /payroll-runs/{run_id}/worker-payroll-records/. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/rippling with npm, or alter-sdk-rippling with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { RipplingIntegration } from "@alter-ai/rippling";
async function execute(input: Parameters<RipplingIntegration["restApi"]["listWorkerPayrollRecords"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new RipplingIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.restApi.listWorkerPayrollRecords(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_rippling import RipplingIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = RipplingIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.rest_api.list_worker_payroll_records(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.run_id | string | Required within parent | |
query | object | Optional | Additional keys: not allowed |
query.filter | string | Optional | |
query.limit | integer | Optional | Default: 50 Maximum: 100 Minimum: 1 |
query.cursor | string | Optional |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
next_link | string | Optional | A link to the next page of responses. Format: uri |
results | array | Optional | |
results[] | Model | Each item | Expand List worker-payroll-records — response body — results item |
Referenced models: List worker-payroll-records — response body — results item
Schemas
Section titled “Schemas”List worker-payroll-records — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | V2 DTO representing earnings, deductions, taxes, and garnishments for a single worker in a payroll run. Used by: - GET /payroll-runs/{run_id}/worker-payroll-records/ (list) - GET /payroll-runs/{run_id}/worker-payroll-records/{id} (retrieve) |
country_code | string | Optional | ISO country code where this payroll record applies. |
currency | string | Optional | ISO currency code for monetary amounts in this record. |
deductions | array | Optional | List of deduction line items. |
deductions[] | Model | Each item | Expand List worker-payroll-records — response body — results item deductions item |
earnings | array | Optional | List of earning line items. |
earnings[] | Model | Each item | Expand List worker-payroll-records — response body — results item earnings item |
garnishments | array | Optional | List of garnishment line items. |
garnishments[] | Model | Each item | Expand List worker-payroll-records — response body — results item garnishments item |
gross_pay | string | Optional | Gross pay amount for the current period. |
id | string | Optional | Unique identifier for this payroll record (PRE version ID). |
net_pay | string | Optional | Net pay amount for the current period. |
run_id | string | Optional | Identifier of the payroll run this record belongs to. |
summary | object | Optional | Aggregate totals for taxes, deductions, and garnishments. |
summary.employee_deductions | string | Optional | Total employee deductions. |
summary.employee_taxes | string | Optional | Total employee-paid taxes. |
summary.employer_contributions | string | Optional | Total employer contributions (e.g. retirement matching). |
summary.employer_taxes | string | Optional | Total employer-paid taxes. |
summary.total_garnishments | string | Optional | Total garnishments withheld. |
taxes | array | Optional | List of tax line items. |
taxes[] | Model | Each item | Expand List worker-payroll-records — response body — results item taxes item |
worker_id | string | Optional | Identifier of the worker (role ID). |
Referenced models: List worker-payroll-records — response body — results item deductions item, List worker-payroll-records — response body — results item earnings item, List worker-payroll-records — response body — results item garnishments item, List worker-payroll-records — response body — results item taxes item
List worker-payroll-records — response body — results item deductions item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A single deduction line item on a worker's payroll record. |
deduction_code | string | Optional | Code identifying the deduction type. |
display_name | string | Optional | Human-readable name of the deduction. |
employee_amount | string | Optional | Employee contribution amount for the current period. |
employer_amount | string | Optional | Employer contribution amount for the current period. |
List worker-payroll-records — response body — results item earnings item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A single earning line item on a worker's payroll record. |
amount | string | Optional | Earning amount for the current period. |
display_name | string | Optional | Human-readable name of the earning. |
earning_category | string | Optional | Category of the earning (e.g. SALARY, HOURLY). |
earning_code | string | Optional | Code identifying the earning type (e.g. regular_salary). |
hours | string | Optional | Hours worked for this earning in the current period. |
rate | string | Optional | Hourly rate applied to this earning. |
time_labels | array | Optional | Time tracking labels associated with this earning. |
time_labels[] | string | Each item |
List worker-payroll-records — response body — results item garnishments item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A single garnishment line item on a worker's payroll record. |
amount | string | Optional | Garnishment amount for the current period. |
garnishment_code | string | Optional | Code identifying the garnishment. |
List worker-payroll-records — response body — results item taxes item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A single tax line item on a worker's payroll record. |
amount | string | Optional | Tax amount for the current period. |
display_name | string | Optional | Human-readable name of the tax. |
paid_by | string | Optional | Who pays this tax: EMPLOYER or EMPLOYEE. |
tax_code | string | Optional | Unique code identifying the tax. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: rippling.rest_api.list_worker_payroll_records. Catalog operation: list-worker-payroll-records. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.
Required provider scopes: ["worker-payroll-records.read"]
Provider entitlements: ["Global_Payroll"]
Pinned headers: {"Rippling-Api-Version": "2024-08-01"}