Employee Payroll Runs

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

The EmployeePayrollRun object

Properties


idString
Optional

remote_idString
Optional
The third-party API ID of the matching object.

employeeString
Optional
The employee whose payroll is being run.

payroll_runString
Optional
The payroll being run.

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[]
Optional

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

Properties


idString
Optional

employee_payroll_runString
Optional
The earning's employee payroll run.

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

deductionsDeduction[]
Optional

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

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

taxesTax[]
Optional

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

Properties


idString
Optional

employee_payroll_runString
Optional
The tax's employee payroll run.

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

remote_dataRemoteData[]
Optional

The EmployeePayrollRun object

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

GET

/employee-payroll-runs

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

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

TriNet

TriNet

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


check_dateString

end_dateString

remote_dataRemoteData[]

employeeString

gross_payNumber

net_payNumber

start_dateString

remote_idString

UKG Ready

UKG Ready

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


check_dateString

end_dateString

remote_dataRemoteData[]

employeeString

payroll_runString

start_dateString

remote_idString

Rippling

Rippling

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


check_dateString

end_dateString

remote_dataRemoteData[]

employeeString

gross_payNumber

payroll_runString

net_payNumber

start_dateString

remote_idString

UKG Pro

UKG Pro

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


check_dateString

end_dateString

remote_dataRemoteData[]

employeeString

gross_payNumber

payroll_runString

net_payNumber

start_dateString

remote_idString

Workday

Workday

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


check_dateString

end_dateString

employeeString

gross_payNumber

payroll_runString

net_payNumber

start_dateString

SAP SuccessFactors

SAP SuccessFactors

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


check_dateString

end_dateString

remote_dataRemoteData[]

employeeString

gross_payNumber

payroll_runString

net_payNumber

start_dateString

remote_idString

Paylocity

Paylocity

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


check_dateString

end_dateString

remote_dataRemoteData[]

employeeString

gross_payNumber

payroll_runString

net_payNumber

start_dateString

Paychex

Paychex

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


end_dateString

check_dateString

remote_dataRemoteData[]

employeeString

payroll_runString

net_payNumber

start_dateString

remote_idString
GET

/employee-payroll-runs/{id}

Returns an EmployeePayrollRun object with the given id.


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

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

TriNet

TriNet

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


check_dateString

end_dateString

remote_dataRemoteData[]

employeeString

gross_payNumber

net_payNumber

start_dateString

remote_idString

UKG Ready

UKG Ready

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


check_dateString

end_dateString

remote_dataRemoteData[]

employeeString

payroll_runString

start_dateString

remote_idString

Rippling

Rippling

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


check_dateString

end_dateString

remote_dataRemoteData[]

employeeString

gross_payNumber

payroll_runString

net_payNumber

start_dateString

remote_idString

UKG Pro

UKG Pro

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


check_dateString

end_dateString

remote_dataRemoteData[]

employeeString

gross_payNumber

payroll_runString

net_payNumber

start_dateString

remote_idString

Workday

Workday

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


check_dateString

end_dateString

employeeString

gross_payNumber

payroll_runString

net_payNumber

start_dateString

SAP SuccessFactors

SAP SuccessFactors

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


check_dateString

end_dateString

remote_dataRemoteData[]

employeeString

gross_payNumber

payroll_runString

net_payNumber

start_dateString

remote_idString

Paylocity

Paylocity

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


check_dateString

end_dateString

remote_dataRemoteData[]

employeeString

gross_payNumber

payroll_runString

net_payNumber

start_dateString

Paychex

Paychex

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


end_dateString

check_dateString

remote_dataRemoteData[]

employeeString

payroll_runString

net_payNumber

start_dateString

remote_idString