Deductions

The Deduction object is used to represent a deduction for a given employee's payroll run. One run could include several deductions.

The Deduction object

Properties


idString
Required

employee_payroll_runString
Optional

nameString
Optional
The deduction's name.

employee_deductionNumber
Optional
The amount the employee is deducting.

company_deductionNumber
Optional
The amount the company is deducting.

remote_was_deletedBoolean
Required
Indicates whether or not this object has been deleted on the third-party.

The Deduction object
JSON
{
"id": "5fd439fc-1b64-4755-b275-64918936c365",
"employee_payroll_run": "35347df1-95e7-46e2-93cc-66f1191edca5",
"name": "Social Security",
"employee_deduction": 34.54,
"company_deduction": 78.78,
"remote_was_deleted": true
}

GET

/deductions

Returns a list of Deduction objects.


Header Parameters


AuthorizationString
Required
Token-based authentication with required prefix "Bearer"

X-Account-TokenString
Required
Token identifying the end user.

Query & Path Parameters


created_afterString
Optional
If provided, will only return objects created after this datetime.

created_beforeString
Optional
If provided, will only return objects created before this datetime.

cursorString
Optional
The pagination cursor value.

employee_payroll_run_idString
Optional
If provided, will only return deductions for this employee payroll run.

include_deleted_dataBoolean
Optional
Whether to include data that was deleted in the third-party service.

include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.

modified_afterString
Optional
If provided, will only return objects modified after this datetime.

modified_beforeString
Optional
If provided, will only return objects modified before this datetime.

page_sizeInteger
Optional
Number of results to return per page.

remote_idString
Optional
The API provider's ID for the given object.

Response
JSON
{
"next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
"previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
"results": [
{
"id": "5fd439fc-1b64-4755-b275-64918936c365",
"employee_payroll_run": "35347df1-95e7-46e2-93cc-66f1191edca5",
"name": "Social Security",
"employee_deduction": 34.54,
"company_deduction": 78.78,
"remote_was_deleted": true
}
]
}
Field support by platform

UKG Pro

UKG Pro

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


employee_payroll_runString

employee_deductionNumber

Gusto

Gusto

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


employee_payroll_runString

nameString

employee_deductionNumber

Paychex

Paychex

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


employee_deductionNumber

employee_payroll_runString

nameString

Rippling

Rippling

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


employee_payroll_runString

nameString

employee_deductionNumber

company_deductionNumber

TriNet

TriNet

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


employee_payroll_runString

nameString

company_deductionNumber

Paylocity

Paylocity

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


employee_payroll_runString

nameString

employee_deductionNumber

UKG Ready

UKG Ready

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


employee_payroll_runString

nameString

Workday

Workday

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


employee_payroll_runString

nameString

employee_deductionNumber

ADP Workforce Now

ADP Workforce Now

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


employee_payroll_runString

nameString

employee_deductionNumber
Hint: Use the /linked-accounts endpoint to pull platform support information.
GET

/deductions/{id}

Returns a Deduction object with the given id.


Header Parameters


AuthorizationString
Required
Token-based authentication with required prefix "Bearer"

X-Account-TokenString
Required
Token identifying the end user.

Query & Path Parameters


idString
Required

include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.
Response
JSON
{
"id": "5fd439fc-1b64-4755-b275-64918936c365",
"employee_payroll_run": "35347df1-95e7-46e2-93cc-66f1191edca5",
"name": "Social Security",
"employee_deduction": 34.54,
"company_deduction": 78.78,
"remote_was_deleted": true
}
Field support by platform

UKG Pro

UKG Pro

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


employee_payroll_runString

employee_deductionNumber

Gusto

Gusto

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


employee_payroll_runString

nameString

employee_deductionNumber

Paychex

Paychex

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


employee_deductionNumber

employee_payroll_runString

nameString

Rippling

Rippling

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


employee_payroll_runString

nameString

employee_deductionNumber

company_deductionNumber

TriNet

TriNet

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


employee_payroll_runString

nameString

company_deductionNumber

Paylocity

Paylocity

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


employee_payroll_runString

nameString

employee_deductionNumber

UKG Ready

UKG Ready

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


employee_payroll_runString

nameString

Workday

Workday

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


employee_payroll_runString

nameString

employee_deductionNumber

ADP Workforce Now

ADP Workforce Now

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


employee_payroll_runString

nameString

employee_deductionNumber
Hint: Use the /linked-accounts endpoint to pull platform support information.