Rippling: GET Company Deduction Detail
Rippling v1ArchiveApi.getCompanyDeductionsDeductionId: arguments, response, policy and SDK examples.
← V1 archive API operations · Get started
Operation rippling.v1_archive_api.get_company_deductions_deductionid
Provider route: GET /platform/api/company_deductions/{deductionId}. 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["v1ArchiveApi"]["getCompanyDeductionsDeductionId"]>[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.v1ArchiveApi.getCompanyDeductionsDeductionId(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.v1_archive_api.get_company_deductions_deduction_id(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.deductionId | integer | 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 Company Deduction Detail — response body |
Referenced models: GET Company Deduction Detail — response body
Schemas
Section titled “Schemas”GET Company Deduction Detail — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A company deduction object. |
allowedEarningTypeForPercentCalc | array | Optional | The earning types this company deduction type applies to. |
allowedEarningTypeForPercentCalc[] | string | Each item | |
companyContribution | JSON | Optional | |
companyContribution (anyOf 1) | string | Alternative | The amount the company pays on the employee's behalf. |
companyContribution (anyOf 2) | null | Alternative | |
deductionType | string | Optional | The 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 |
employeeDeduction | JSON | Optional | |
employeeDeduction (anyOf 1) | string | Alternative | The amount the employee pays out of their pocket. |
employeeDeduction (anyOf 2) | null | Alternative | |
employerMatch401K | object | Optional | This 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 |
id | string | Optional | The company deduction unique identifier. |
isEEPercent | boolean | Optional | If the amount given in a employee deduction is a % than true. Otherwise false, if the amount if an absolute dollar amount value. |
isERPercent | boolean | Optional | If the amount given in a company contribution is a % than true. Otherwise false, if the amount if an absolute dollar amount value. |
isMonthly | JSON | Optional | |
isMonthly (anyOf 1) | boolean | Alternative | Indicates 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) | null | Alternative | |
matchingScheme401k | string | Optional | The defined matching scheme. Safe harbor is used if you want to use tiered matching. Known values: NON_ELECTIVE, SAFE_HARBOR |
name | string | Optional | Name of the company deduction. |
tiered_401k_matches | array | Optional | This 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[] | string | Each item |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: rippling.v1_archive_api.get_company_deductions_deductionid. Catalog operation: v1-archive-api.get-company_deductions-deductionId. 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.