The payroll item warnings field is populated when previewing or approving a payroll. If there are deductions that cannot be fully applied to a payroll, there will be a corresponding element in the warnings array.
The Warning Object
| Attribute | Description |
|---|---|
| code string | Action taken on the deduction. One of skipped and partially_applied. |
| reason string | Explanation of why the deduction was not applied. One of negative_net_pay and exceeds_max_percent. |
| deduction_type string | Type of deduction the warning is for. One of post_tax_deduction, tax, and benefit. |
| deduction string | ID of the deduction the warning is for. |
| actual_deduction_amount string | Actual amount of the deduction withheld. |
| expected_deduction_amount string | The full amount expected to be withheld for this deduction. |
Check provides the following values for code and reason:
| Warning code | |
|---|---|
| skipped | The deduction was not applied to the payroll item and is not included in any calculations. |
| partially_applied | A partial amount of the deduction was able to be withheld from the payroll item. |
| Warning reason | |
|---|---|
| negative_net_pay | Applying the deduction to the payroll item would have resulted in an employee net pay (excluding reimbursements) below $0. |
| exceeds_max_percent | Applying the child support deductions would have resulted in the amount being a larger percent of disposable earnings than the max_percent field. |