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
Optional

employee_payroll_runString
Optional
The deduction's employee payroll run.

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_dataArray
Optional

The Deduction object

{
  "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_data": [
    {
      "path": "/payroll-deduction",
      "data": [
        "Varies by platform"
      ]
    }
  ]
}

GET

/deductions

Returns a list of Deduction objects.


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_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

{
  "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_data": [
        {
          "path": "/payroll-deduction",
          "data": [
            "Varies by platform"
          ]
        }
      ]
    }
  ]
}
Field support by platform

UKG Ready

UKG Ready

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


employee_payroll_runString

nameString

Rippling

Rippling

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


employee_deductionNumber

employee_payroll_runString

company_deductionNumber

nameString

UKG Pro

UKG Pro

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


employee_deductionNumber

employee_payroll_runString

Workday

Workday

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


employee_deductionNumber

employee_payroll_runString

nameString

Paychex

Paychex

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

employee_deductionNumber

employee_payroll_runString
POST

/deductions

BETA

Creates a Deduction object with the given values.


Query & Path Parameters


run_asyncBoolean
Optional
Whether or not third-party updates should be run asynchronously.

Body Parameters


employee_payroll_runString
Optional
The deduction's employee payroll run. Must pass in a valid Merge ID, which can be obtained from the id field in the Employee_payroll_run table.

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_dataArray
Optional

Response

{
  "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_data": [
    {
      "path": "/payroll-deduction",
      "data": [
        "Varies by platform"
      ]
    }
  ]
}
GET

/deductions/{id}

Returns a Deduction object with the given id.


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

{
  "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_data": [
    {
      "path": "/payroll-deduction",
      "data": [
        "Varies by platform"
      ]
    }
  ]
}
Field support by platform

UKG Ready

UKG Ready

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


employee_payroll_runString

nameString

Rippling

Rippling

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


employee_deductionNumber

employee_payroll_runString

company_deductionNumber

nameString

UKG Pro

UKG Pro

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


employee_deductionNumber

employee_payroll_runString

Workday

Workday

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


employee_deductionNumber

employee_payroll_runString

nameString

Paychex

Paychex

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

employee_deductionNumber

employee_payroll_runString