The post-tax deduction object

Represents deductions that are withheld from an employee’s after-tax wages.

Use this object to configure a child support garnishment or miscellaneous deduction type that is not an employee benefit.

{
    "id": "ptd_g4AGCxtz8VakIL4PmZ0r",
    "source": null,
    "type": "miscellaneous",
    "employee": "emp_bvNhcPxrbvRqgyCrlUcj",
    "description": "Union dues",
    "effective_start": "2020-01-01",
    "effective_end": null,
    "miscellaneous": {
        "amount": "10.00",
        "percent": null,
        "total_amount": "50.00"
    },
    "managed": false,
    "metadata": {}
}
AttributeDescription
id
string
Unique identifier for the post-tax deduction.
source
string
Read-only field that indicates the source that created the object. Will be null unless you expect a third-party to be managing objects in your system.
type
string
The type of post-tax deduction. May be miscellaneous or child_support.
employee
string
The ID of the employee associated with the post-tax deduction.
description
string
A description of the deduction. Maximum length of 255 characters.
effective_start
date
The start date for the deduction. Payrolls with a payday before this date will not include the deduction.
effective_end
date
The end date for the deduction. Payrolls with a payday after this date will not include the deduction.
miscellaneous
object
The configuration object for a miscellaneous post-tax deduction.
child_support
object
The configuration object for a child support garnishment.
managed
boolean
If true, Check will handle the money movement for this post-tax deduction. If false, the company is responsible for the money movement for this post-tax deduction. More info can be found here.
metadata
object
Additional loosely structured information to associate with the post-tax deduction.