Rippling: GET Employee Deductions
Rippling payrollApi.getEmployeeDeductions: arguments, response, policy and SDK examples.
← Payroll API operations · Get started
Operation rippling.payroll_api.get_employee_deductions
Provider route: GET /platform/api/employee_deductions. 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"]["getEmployeeDeductions"]>[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.getEmployeeDeductions(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_employee_deductions(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.companyDeductionType | string | Optional | |
query.role | 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 Employee Deductions — response body — item |
Referenced models: GET Employee Deductions — response body — item
Schemas
Section titled “Schemas”GET Employee Deductions — response body — item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | An Employee Deduction object instance is created for every employee with a deduction. This will be inherited automatically by the company deduction type, but can be specified at the employee level as well, by directly modifying an employee's employee deduction object. |
companyContribution | string | Optional | Sets the companyContribution at the employee level. This will overwrite the values set by the company deduction type, associated with the employee deduction type. |
companyDeductionType | string | Optional | Unique identifier of the Company Deduction Type that is associated with this Employee Deduction Type. |
employeeDeduction | string | Optional | Stes the employeeDeduction at the employee level. This will override the values set by the company deduction type associated with this employee deduction type. |
id | string | Optional | Unique identifier of the employee deduction type. |
isEEPercent | boolean | Optional | If the employee deduction is a percentage. If false, then it will be a flat dollar amount. |
isERPecent | string | Optional | True if the value for an employee is a percentage of the employee's pay, or false if it is set to a flat dollar amount. |
isMonthly | JSON | Optional | |
isMonthly (anyOf 1) | boolean | Alternative | Corresponds to whether the deduction type is set to be monthly for the company deduction type associated with this role. |
isMonthly (anyOf 2) | null | Alternative | |
name | string | Optional | Name of the employee deduction type. |
role | string | Optional | Role identifier of the employee deduction type that the company deduction type belong to. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: rippling.payroll_api.get_employee_deductions. Catalog operation: payroll-api.get-employee_deductions. 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.