Skip to content

Rippling: GET Company Deductions

Rippling payrollApi.getCompanyDeductions: arguments, response, policy and SDK examples.

← Payroll API operations · Get started

Operation rippling.payroll_api.get_company_deductions

Provider route: GET /platform/api/company_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"]["getCompanyDeductions"]>[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.getCompanyDeductions(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_company_deductions(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed

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 Company Deduction Detail — response body

Referenced models: GET Company Deduction Detail — response body

GET Company Deduction Detail — response body
FieldTypePresenceDescription and constraints
$objectRootA company deduction object.
allowedEarningTypeForPercentCalcarrayOptionalThe earning types this company deduction type applies to.
allowedEarningTypeForPercentCalc[]stringEach item
companyContributionJSONOptional
companyContribution (anyOf 1)stringAlternativeThe amount the company pays on the employee's behalf.
companyContribution (anyOf 2)nullAlternative
deductionTypestringOptionalThe deduction type.
Known values: MEDICAL, DENTAL, VISION, HSA, FSA_MEDICAL, FSA_DEPENDENT_CARE, SIMPLE_IRA, _401K, ROTH_401K, OTHER_TAXABLE, OTHER_NON_TAXABLE, COMMUTER_TRANSIT, COMMUTER_PARKING, _401K_LOAN_PAYMENT, SHORT_DISABILITY, LONG_DISABILITY, LIFE, SEP_IRA, SARSEP, CUSTOM_TAXABLE, _403B, ROTH_403B, STUDENT_LOAN
employeeDeductionJSONOptional
employeeDeduction (anyOf 1)stringAlternativeThe amount the employee pays out of their pocket.
employeeDeduction (anyOf 2)nullAlternative
employerMatch401KobjectOptionalThis field earlier returned tiered match in case only one tiered match is set up for a company. This field is now deprecated.
Additional keys: not allowed
idstringOptionalThe company deduction unique identifier.
isEEPercentbooleanOptionalIf the amount given in a employee deduction is a % than true. Otherwise false, if the amount if an absolute dollar amount value.
isERPercentbooleanOptionalIf the amount given in a company contribution is a % than true. Otherwise false, if the amount if an absolute dollar amount value.
isMonthlyJSONOptional
isMonthly (anyOf 1)booleanAlternativeIndicates that the admin has set up deduction amounts per month. It is true only when the admin explicitly selects 'Monthy' while setting up the Company Deduction Type (CDT). If it is false, then the defaults set up are used per pay period.
isMonthly (anyOf 2)nullAlternative
matchingScheme401kstringOptionalThe defined matching scheme. Safe harbor is used if you want to use tiered matching.
Known values: NON_ELECTIVE, SAFE_HARBOR
namestringOptionalName of the company deduction.
tiered_401k_matchesarrayOptionalThis returns an array of tiered match object ids. We can use these ids with API https://api.rippling.com
/platform/api/tiered_match_401k/{id} to query tiered matches for a company.
tiered_401k_matches[]stringEach item

SDK function policy ID: rippling.payroll_api.get_company_deductions. Catalog operation: payroll-api.get-company_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.