| Property | Value | Description | ReadOnly |
|---|---|---|---|
| verb | enum |
The verb for the scheduled change.
PATCH POST |
|
| options | string | The options used when the scheduled change was requested. | |
| description | string | The description of the scheduled change. | x |
| requested_date | string | The date which the scheduled change was requested. | x |
| effective_date | string | The date which the scheduled change will take place, pending user approval. | |
| body | object | The body of the scheduled change. | |
| requested_version | string | The version of the employee deduction object against which the scheduled change was requested. Only required when verb is PATCH. | x |
Body
| Property | Value | Description | ReadOnly |
|---|---|---|---|
| id | integer | The id of the employee deduction. | x |
| employee_id | integer | The id of the employee. | x |
| employee_number | integer | The number of the employee. This is an editable identifier. | x |
| deduction_type | enum |
The type of the employee deduction.
1 - Section 125 Health 2 - 401k 3 - 403b 4 - 457 6 - Roth 401k 7 - Roth 403b 8 - FSA 9 - HSA 10 - Simple IRA 12 - FSA Dependent Care 21 - Standard Deduction 22 - Tip Deduction 23 - Union Dues 24 - Imputed 25 - Union Dues Hours 102 - Section 132 Commuter |
x |
| deduction_id | integer | The id of the company deduction. | x |
| percent | decimal | The percent of gross of the employee contribution. Takes precedent over amount. | |
| annual_limit | decimal | The annual limit of the employee deduction. | x |
| amount | decimal | The amount of the employee contribution. | |
| override_amount | decimal | The override amount of the employee deduction. | |
| active | boolean | Indicates if the employee deduction is active for the pay run. | |
| ach_active | boolean | Indicates if ach is active. | |
| routing | string | The routing number to which the deduction applies. | |
| account | string | The account number to which the deduction applies. | |
| savings | boolean | Indicates if the account is a savings account. | |
| memo | string | The memo for the employee deduction. | |
| include_benefit_amount_in_ach | boolean | Indicates if the benefit amount is to be included in ach. | |
| override_company_benefit_amount | decimal | The override amount of the employer contribution. | |
| lifetime_limit | decimal | The lifetime limit of the employee deduction. | |
| version | string | The version of the employee. See Versioning section. | x |