Rippling: GET Annual Payroll Information
Rippling payrollApi.getAnnualEmployeePayrollInfo: arguments, response, policy and SDK examples.
← Payroll API operations · Get started
Operation rippling.payroll_api.get_annual_employee_payroll_info
Provider route: GET /platform/api/companies/annual_employee_payroll_info. 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"]["getAnnualEmployeePayrollInfo"]>[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.getAnnualEmployeePayrollInfo(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_annual_employee_payroll_info(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
query | object | Required within parent | Additional keys: not allowed |
query.year | string | Required within parent |
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 |
|---|---|---|---|
$ | Model | Root | Expand GET Annual Payroll Information — response body |
Referenced models: GET Annual Payroll Information — response body
Schemas
Section titled “Schemas”GET Annual Payroll Information — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Annual payroll information for a given company. |
| string | Optional | |
company_name | string | Optional | |
employees_info | array | Optional | |
employees_info[] | JSON | Each item | |
employees_info[] (anyOf 1) | object | Alternative | A summary of a Company's 401k information for a given employee. |
employees_info[] (anyOf 1).employee_details | JSON | Optional | |
employees_info[] (anyOf 1).employee_details (anyOf 1) | object | Alternative | The employee details object used within the annual 401k report |
employees_info[] (anyOf 1).employee_details (anyOf 1).birth_date | string | Optional | |
employees_info[] (anyOf 1).employee_details (anyOf 1).first_name | string | Optional | |
employees_info[] (anyOf 1).employee_details (anyOf 1).hire_date | string | Optional | |
employees_info[] (anyOf 1).employee_details (anyOf 1).id | string | Optional | |
employees_info[] (anyOf 1).employee_details (anyOf 1).last_Name | string | Optional | |
employees_info[] (anyOf 1).employee_details (anyOf 1).previous_termination_date | JSON | Optional | |
employees_info[] (anyOf 1).employee_details (anyOf 1).previous_termination_date (anyOf 1) | string | Alternative | |
employees_info[] (anyOf 1).employee_details (anyOf 1).previous_termination_date (anyOf 2) | null | Alternative | |
employees_info[] (anyOf 1).employee_details (anyOf 1).rehire_date | JSON | Optional | |
employees_info[] (anyOf 1).employee_details (anyOf 1).rehire_date (anyOf 1) | string | Alternative | |
employees_info[] (anyOf 1).employee_details (anyOf 1).rehire_date (anyOf 2) | null | Alternative | |
employees_info[] (anyOf 1).employee_details (anyOf 1).ssn | string | Optional | |
employees_info[] (anyOf 1).employee_details (anyOf 1).termination_date | string | Optional | |
employees_info[] (anyOf 1).employee_details (anyOf 2) | null | Alternative | |
employees_info[] (anyOf 1).year | string | Optional | |
employees_info[] (anyOf 1).ytd_comp_w_2_box3 | string | Optional | |
employees_info[] (anyOf 1).ytd_ee_pretax_deferral | string | Optional | |
employees_info[] (anyOf 1).ytd_er_match | string | Optional | |
employees_info[] (anyOf 1).ytd_gross_wages | string | Optional | |
employees_info[] (anyOf 1).ytd_loan_payments | string | Optional | |
employees_info[] (anyOf 2) | null | Alternative | |
end_date | string | Optional | |
start_date | string | Optional |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: rippling.payroll_api.get_annual_employee_payroll_info. Catalog operation: payroll-api.get-annual_employee_payroll_info. 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.