Rippling: GET Company Payroll Runs For Date Range
Rippling payrollApi.getCompanyPayrollRunsForDateRange: arguments, response, policy and SDK examples.
← Payroll API operations · Get started
Operation rippling.payroll_api.get_company_payroll_runs_for_date_range
Provider route: GET /platform/api/payroll_runs/all. 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["payrollApi"]["getCompanyPayrollRunsForDateRange"]>[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.payrollApi.getCompanyPayrollRunsForDateRange(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.payroll_api.get_company_payroll_runs_for_date_range(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
query | object | Optional | Additional keys: not allowed |
query.from | string | Optional | |
query.to | string | Optional | |
query.requested_fields | 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 |
|---|---|---|---|
$ | array | Root | |
$[] | Model | Each item | Expand GET Company Payroll Runs — response body — item |
Referenced models: GET Company Payroll Runs — response body — item
Schemas
Section titled “Schemas”GET Company Payroll Runs — response body — item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The payroll run object. |
approvalDeadline | string | Optional | |
approvedAt | JSON | Optional | |
approvedAt (anyOf 1) | string | Alternative | |
approvedAt (anyOf 2) | null | Alternative | |
checkDate | string | Optional | |
ein | string | Optional | Employer identification number, also known as the Federal Employer Identification Number or the Federal Tax Identification Number. |
id | string | Optional | The unique identifier for the payroll run. |
name | string | Optional | |
payPeriod | JSON | Optional | |
payPeriod (anyOf 1) | object | Alternative | |
payPeriod (anyOf 1).endDate | string | Optional | |
payPeriod (anyOf 1).paySchedule | JSON | Optional | |
payPeriod (anyOf 1).paySchedule (anyOf 1) | string | Alternative | |
payPeriod (anyOf 1).paySchedule (anyOf 2) | null | Alternative | |
payPeriod (anyOf 1).startDate | string | Optional | |
payPeriod (anyOf 2) | null | Alternative | |
runState | string | Optional | DRAFT 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 |
runType | string | Optional | Known 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 |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: rippling.payroll_api.get_company_payroll_runs_for_date_range. Catalog operation: payroll-api.get-company-payroll-runs-for-date-range. 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.