Employee Payroll Runs

The EmployeePayrollRun object is used to represent a payroll run for a specific employee.

The EmployeePayrollRun object

Properties

idString

Required

remote_idString

Optional

The third-party API ID of the matching object.

employeeString

Optional

payroll_runString

Optional

gross_payNumber

Optional

The gross pay from the run.

net_payNumber

Optional

The net pay from the run.

start_dateString

Optional

The day and time the payroll run started.

end_dateString

Optional

The day and time the payroll run ended.

check_dateString

Optional

The day and time the payroll run was checked.

earningsEarning[]

Required

The Earning object

The Earning object is used to represent an earning for a given employee's payroll run. One run could include several earnings.


{
  "id": "babbced6-3a81-4775-8da2-490dc6385259",
  "employee_payroll_run": "35347df1-95e7-46e2-93cc-66f1191edca5",
  "amount": 1002.34,
  "type": "SALARY",
  "remote_was_deleted": true
}

Properties

idString

Required

employee_payroll_runString

Optional

amountNumber

Optional

The amount earned.

typeEnum

Optional

The type of earning. Possible values include: SALARY, REIMBURSEMENT, OVERTIME, BONUS, or - in cases where there is no clear mapping - the original value passed through.

remote_was_deletedBoolean

Required

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

deductionsDeduction[]

Required

The Deduction object

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


{
  "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
}

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.

taxesTax[]

Required

The Tax object

The Tax object is used to represent a tax for a given employee's payroll run. One run could include several taxes.


{
  "id": "e3a825fd-c38d-4095-a717-df98c4cb9ebc",
  "employee_payroll_run": "35347df1-95e7-46e2-93cc-66f1191edca5",
  "name": "California State Income Tax",
  "amount": 100.25,
  "employer_tax": "False",
  "remote_was_deleted": true
}

Properties

idString

Required

employee_payroll_runString

Optional

nameString

Optional

The tax's name.

amountNumber

Optional

The tax amount.

employer_taxBoolean

Optional

Whether or not the employer is responsible for paying the tax.

remote_was_deletedBoolean

Required

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

remote_was_deletedBoolean

Required

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

The EmployeePayrollRun object

JSON


{
  "id": "fb8c55b6-1cb8-4b4c-9fb6-17924231619d",
  "remote_id": "19202938",
  "employee": "d2f972d0-2526-434b-9409-4c3b468e08f0",
  "payroll_run": "35347df1-95e7-46e2-93cc-66f1191edca5",
  "gross_pay": 1342.67,
  "net_pay": 865.78,
  "start_date": "2020-11-08T00:00:00Z",
  "end_date": "2020-11-09T00:00:00Z",
  "check_date": "2020-11-10T00:00:00Z",
  "earnings": [
    {
      "employee_payroll_run": "35347df1-95e7-46e2-93cc-66f1191edca5",
      "amount": 1002.34,
      "type": "SALARY"
    },
    {
      "employee_payroll_run": "35347df1-95e7-46e2-93cc-66f1191edca5",
      "amount": 8342.34,
      "type": "OVERTIME"
    }
  ],
  "deductions": [
    {
      "employee_payroll_run": "35347df1-95e7-46e2-93cc-66f1191edca5",
      "name": "Social Security",
      "employee_deduction": 34.54,
      "company_deduction": 78.78
    }
  ],
  "taxes": [
    {
      "employee_payroll_run": "35347df1-95e7-46e2-93cc-66f1191edca5",
      "name": "California State Income Tax",
      "amount": 100.25,
      "employer_tax": "False"
    }
  ],
  "remote_was_deleted": true
}

GET

/employee-payroll-runs

Returns a list of EmployeePayrollRun 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_idString

Optional

If provided, will only return employee payroll runs for this employee.

ended_afterString

Optional

If provided, will only return employee payroll runs ended after this datetime.

ended_beforeString

Optional

If provided, will only return employee payroll runs ended before this datetime.

expandString

Optional

Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

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.

payroll_run_idString

Optional

If provided, will only return employee payroll runs for this employee.

remote_idString

Optional

The API provider's ID for the given object.

started_afterString

Optional

If provided, will only return employee payroll runs started after this datetime.

started_beforeString

Optional

If provided, will only return employee payroll runs started before this datetime.

Response

JSON


{
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
  "previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
  "results": [
    {
      "id": "fb8c55b6-1cb8-4b4c-9fb6-17924231619d",
      "remote_id": "19202938",
      "employee": "d2f972d0-2526-434b-9409-4c3b468e08f0",
      "payroll_run": "35347df1-95e7-46e2-93cc-66f1191edca5",
      "gross_pay": 1342.67,
      "net_pay": 865.78,
      "start_date": "2020-11-08T00:00:00Z",
      "end_date": "2020-11-09T00:00:00Z",
      "check_date": "2020-11-10T00:00:00Z",
      "earnings": [
        {
          "employee_payroll_run": "35347df1-95e7-46e2-93cc-66f1191edca5",
          "amount": 1002.34,
          "type": "SALARY"
        },
        {
          "employee_payroll_run": "35347df1-95e7-46e2-93cc-66f1191edca5",
          "amount": 8342.34,
          "type": "OVERTIME"
        }
      ],
      "deductions": [
        {
          "employee_payroll_run": "35347df1-95e7-46e2-93cc-66f1191edca5",
          "name": "Social Security",
          "employee_deduction": 34.54,
          "company_deduction": 78.78
        }
      ],
      "taxes": [
        {
          "employee_payroll_run": "35347df1-95e7-46e2-93cc-66f1191edca5",
          "name": "California State Income Tax",
          "amount": 100.25,
          "employer_tax": "False"
        }
      ],
      "remote_was_deleted": true
    }
  ]
}

UKG Pro

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

net_payNumber

payroll_runString

check_dateString

gross_payNumber

end_dateString

start_dateString

remote_idString

employeeString

SAP SuccessFactors

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

employeeString

payroll_runString

check_dateString

gross_payNumber

end_dateString

start_dateString

remote_idString

net_payNumber

Gusto

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

employeeString

payroll_runString

check_dateString

gross_payNumber

end_dateString

start_dateString

remote_idString

net_payNumber

Paychex

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

net_payNumber

payroll_runString

check_dateString

end_dateString

start_dateString

remote_idString

employeeString

Rippling

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

net_payNumber

payroll_runString

check_dateString

gross_payNumber

end_dateString

start_dateString

remote_idString

employeeString

TriNet

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

net_payNumber

payroll_runString

check_dateString

gross_payNumber

end_dateString

start_dateString

remote_idString

employeeString

Paylocity

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

employeeString

payroll_runString

check_dateString

gross_payNumber

end_dateString

start_dateString

net_payNumber

UKG Ready

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

payroll_runString

check_dateString

end_dateString

start_dateString

remote_idString

employeeString

Workday

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

employeeString

payroll_runString

check_dateString

gross_payNumber

end_dateString

start_dateString

net_payNumber

ADP Workforce Now

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

employeeString

payroll_runString

check_dateString

gross_payNumber

net_payNumber

Factorial

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

employeeString

payroll_runString

gross_payNumber

end_dateString

start_dateString

remote_idString

net_payNumber

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

GET

/employee-payroll-runs/{id}

Returns an EmployeePayrollRun 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

expandString

Optional

Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

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": "fb8c55b6-1cb8-4b4c-9fb6-17924231619d",
  "remote_id": "19202938",
  "employee": "d2f972d0-2526-434b-9409-4c3b468e08f0",
  "payroll_run": "35347df1-95e7-46e2-93cc-66f1191edca5",
  "gross_pay": 1342.67,
  "net_pay": 865.78,
  "start_date": "2020-11-08T00:00:00Z",
  "end_date": "2020-11-09T00:00:00Z",
  "check_date": "2020-11-10T00:00:00Z",
  "earnings": [
    {
      "employee_payroll_run": "35347df1-95e7-46e2-93cc-66f1191edca5",
      "amount": 1002.34,
      "type": "SALARY"
    },
    {
      "employee_payroll_run": "35347df1-95e7-46e2-93cc-66f1191edca5",
      "amount": 8342.34,
      "type": "OVERTIME"
    }
  ],
  "deductions": [
    {
      "employee_payroll_run": "35347df1-95e7-46e2-93cc-66f1191edca5",
      "name": "Social Security",
      "employee_deduction": 34.54,
      "company_deduction": 78.78
    }
  ],
  "taxes": [
    {
      "employee_payroll_run": "35347df1-95e7-46e2-93cc-66f1191edca5",
      "name": "California State Income Tax",
      "amount": 100.25,
      "employer_tax": "False"
    }
  ],
  "remote_was_deleted": true
}

UKG Pro

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

net_payNumber

payroll_runString

check_dateString

gross_payNumber

end_dateString

start_dateString

remote_idString

employeeString

SAP SuccessFactors

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

employeeString

payroll_runString

check_dateString

gross_payNumber

end_dateString

start_dateString

remote_idString

net_payNumber

Gusto

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

employeeString

payroll_runString

check_dateString

gross_payNumber

end_dateString

start_dateString

remote_idString

net_payNumber

Paychex

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

net_payNumber

payroll_runString

check_dateString

end_dateString

start_dateString

remote_idString

employeeString

Rippling

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

net_payNumber

payroll_runString

check_dateString

gross_payNumber

end_dateString

start_dateString

remote_idString

employeeString

TriNet

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

net_payNumber

payroll_runString

check_dateString

gross_payNumber

end_dateString

start_dateString

remote_idString

employeeString

Paylocity

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

employeeString

payroll_runString

check_dateString

gross_payNumber

end_dateString

start_dateString

net_payNumber

UKG Ready

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

payroll_runString

check_dateString

end_dateString

start_dateString

remote_idString

employeeString

Workday

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

employeeString

payroll_runString

check_dateString

gross_payNumber

end_dateString

start_dateString

net_payNumber

ADP Workforce Now

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

employeeString

payroll_runString

check_dateString

gross_payNumber

net_payNumber

Factorial

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

employeeString

payroll_runString

gross_payNumber

end_dateString

start_dateString

remote_idString

net_payNumber

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

Deductions

Next Up

Employees

Employee Payroll Runs

The EmployeePayrollRun object

Properties

The Earning object

Properties

The Deduction object

Properties

The Tax object

Properties

/employee-payroll-runs

Header Parameters

Query & Path Parameters

UKG Pro

SAP SuccessFactors

Gusto

Paychex

Rippling

TriNet

Paylocity

UKG Ready

Workday

ADP Workforce Now

Factorial

/employee-payroll-runs/{id}

Header Parameters

Query & Path Parameters

UKG Pro

SAP SuccessFactors

Gusto

Paychex

Rippling

TriNet

Paylocity

UKG Ready

Workday

ADP Workforce Now

Factorial

Previous

Next Up

Get Started

API Reference