Skip to content

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.

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 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.payroll_api.get_employee_deductions(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectOptionalAdditional keys: not allowed
query.companyDeductionTypestringOptional
query.rolestringOptional

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

FieldTypePresenceDescription and constraints
$arrayRoot
$[]ModelEach itemExpand GET Employee Deductions — response body — item

Referenced models: GET Employee Deductions — response body — item

GET Employee Deductions — response body — item
FieldTypePresenceDescription and constraints
$objectRootAn 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.
companyContributionstringOptionalSets the companyContribution at the employee level. This will overwrite the values set by the company deduction type, associated with the employee deduction type.
companyDeductionTypestringOptionalUnique identifier of the Company Deduction Type that is associated with this Employee Deduction Type.
employeeDeductionstringOptionalStes the employeeDeduction at the employee level. This will override the values set by the company deduction type associated with this employee deduction type.
idstringOptionalUnique identifier of the employee deduction type.
isEEPercentbooleanOptionalIf the employee deduction is a percentage. If false, then it will be a flat dollar amount.
isERPecentstringOptionalTrue 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.
isMonthlyJSONOptional
isMonthly (anyOf 1)booleanAlternativeCorresponds to whether the deduction type is set to be monthly for the company deduction type associated with this role.
isMonthly (anyOf 2)nullAlternative
namestringOptionalName of the employee deduction type.
rolestringOptionalRole identifier of the employee deduction type that the company deduction type belong to.

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.

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.