Skip to content

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.

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 os
from alter_sdk import App
from 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()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.run_idstringRequired within parent
queryobjectOptionalAdditional keys: not allowed
query.filterstringOptional
query.limitintegerOptionalDefault: 50
Maximum: 100
Minimum: 1
query.cursorstringOptional

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$objectRoot
next_linkstringOptionalA link to the next page of responses.
Format: uri
resultsarrayOptional
results[]ModelEach itemExpand List worker-payroll-records — response body — results item

Referenced models: List worker-payroll-records — response body — results item

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

List worker-payroll-records — response body — results item deductions item
FieldTypePresenceDescription and constraints
$objectRootA single deduction line item on a worker's payroll record.
deduction_codestringOptionalCode identifying the deduction type.
display_namestringOptionalHuman-readable name of the deduction.
employee_amountstringOptionalEmployee contribution amount for the current period.
employer_amountstringOptionalEmployer contribution amount for the current period.
List worker-payroll-records — response body — results item earnings item
FieldTypePresenceDescription and constraints
$objectRootA single earning line item on a worker's payroll record.
amountstringOptionalEarning amount for the current period.
display_namestringOptionalHuman-readable name of the earning.
earning_categorystringOptionalCategory of the earning (e.g. SALARY, HOURLY).
earning_codestringOptionalCode identifying the earning type (e.g. regular_salary).
hoursstringOptionalHours worked for this earning in the current period.
ratestringOptionalHourly rate applied to this earning.
time_labelsarrayOptionalTime tracking labels associated with this earning.
time_labels[]stringEach item
List worker-payroll-records — response body — results item garnishments item
FieldTypePresenceDescription and constraints
$objectRootA single garnishment line item on a worker's payroll record.
amountstringOptionalGarnishment amount for the current period.
garnishment_codestringOptionalCode identifying the garnishment.
List worker-payroll-records — response body — results item taxes item
FieldTypePresenceDescription and constraints
$objectRootA single tax line item on a worker's payroll record.
amountstringOptionalTax amount for the current period.
display_namestringOptionalHuman-readable name of the tax.
paid_bystringOptionalWho pays this tax: EMPLOYER or EMPLOYEE.
tax_codestringOptionalUnique code identifying the tax.

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"}

Official provider source

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.