Rippling: PATCH Company Deduction — request body — body
PATCH Company Deduction: request body, field body. Complete fields and constraints for contract 2026-10-28.
API reference · Contract 2026-10-28
SDK schema: PATCH Company Deduction — request body — 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. One of: 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. One of: 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 |