Skip to content

Rippling: GET Company Payroll Runs — response body — item

GET Company Payroll Runs: response body, field item. Complete fields and constraints for contract 2026-10-28.

API reference · Contract 2026-10-28

SDK schema: GET Company Payroll Runs — response body — item

FieldTypePresenceDescription and constraints
$objectRootThe payroll run object.
approvalDeadlinestringOptional
approvedAtJSONOptional
approvedAt (anyOf 1)stringAlternative
approvedAt (anyOf 2)nullAlternative
checkDatestringOptional
einstringOptionalEmployer identification number, also known as the Federal Employer Identification Number or the Federal Tax Identification Number.
idstringOptionalThe unique identifier for the payroll run.
namestringOptional
payPeriodJSONOptional
payPeriod (anyOf 1)objectAlternative
payPeriod (anyOf 1).endDatestringOptional
payPeriod (anyOf 1).payScheduleJSONOptional
payPeriod (anyOf 1).paySchedule (anyOf 1)stringAlternative
payPeriod (anyOf 1).paySchedule (anyOf 2)nullAlternative
payPeriod (anyOf 1).startDatestringOptional
payPeriod (anyOf 2)nullAlternative
runStatestringOptionalDRAFT means the admin hasn’t approved the run yet.
APPROVED means the admin has approved the run, but the check date has not arrived yet.
PAID means the check date has arrived and the run was paid.
FAILED means the check date arrived, but the run was not paid.
CLOSED means the payroll run was canceled before being paid.
Known values: DRAFT, APPROVED, PAID, FAILED, CLOSED
runTypestringOptionalKnown values: INIT, REGULAR, OFF_CYCLE, CORRECTION, TERMINATION, RECONCILIATION, NEW_HIRE, POP, TRANSITION, CORRECTION_DISPLAY, EXCESS_HOURS, SIGN_ON_BONUS, S_CORP, FRINGE_BENEFITS, CONTRACTOR_LATE_PAYMENTS

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.