Skip to content

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

FieldTypePresenceDescription and constraints
$objectRoot
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_codestringOptionalISO country code where this payroll record applies.
currencystringOptionalISO currency code for monetary amounts in this record.
deductionsarrayOptionalList of deduction line items.
deductions[]ModelEach itemExpand List worker-payroll-records — response body — results item deductions item
earningsarrayOptionalList of earning line items.
earnings[]ModelEach itemExpand List worker-payroll-records — response body — results item earnings item
garnishmentsarrayOptionalList of garnishment line items.
garnishments[]ModelEach itemExpand List worker-payroll-records — response body — results item garnishments item
gross_paystringOptionalGross pay amount for the current period.
idstringOptionalUnique identifier for this payroll record (PRE version ID).
net_paystringOptionalNet pay amount for the current period.
run_idstringOptionalIdentifier of the payroll run this record belongs to.
summaryobjectOptionalAggregate totals for taxes, deductions, and garnishments.
summary.employee_deductionsstringOptionalTotal employee deductions.
summary.employee_taxesstringOptionalTotal employee-paid taxes.
summary.employer_contributionsstringOptionalTotal employer contributions (e.g. retirement matching).
summary.employer_taxesstringOptionalTotal employer-paid taxes.
summary.total_garnishmentsstringOptionalTotal garnishments withheld.
taxesarrayOptionalList of tax line items.
taxes[]ModelEach itemExpand List worker-payroll-records — response body — results item taxes item
worker_idstringOptionalIdentifier 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

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.