Rippling: List worker-payroll-records — response body — results item
List worker-payroll-records: response body, field results / item. Complete fields and constraints for contract 2026-10-28.
API reference · Contract 2026-10-28
SDK schema: 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