Employee Payroll Runs

The EmployeePayrollRun object is used to represent an employee's pay statement for a specific payroll run.

The EmployeePayrollRun object

Properties


idString
Required

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 total earnings throughout a given period for an employee before any deductions are made.

net_payNumber
Optional
The take-home pay throughout a given period for an employee after deductions are made.

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 array of different compensations that an employee receives within specific wage categories.
JSON
{
"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 by third party webhooks.

deductionsDeduction[]
Required

The Deduction object

The Deduction object is used to represent an array of the wages withheld from total earnings for the purpose of paying taxes.
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_mappings": {
"organization_defined_targets": {
"custom_key": "custom_value"
},
"linked_account_defined_targets": {
"custom_key": "custom_value"
}
}
}

Properties


idString
Required

employee_payroll_runString
Optional

nameString
Optional
The deduction's name.

employee_deductionNumber
Optional
The amount of money that is withheld from an employee's gross pay by the employee.

company_deductionNumber
Optional
The amount of money that is withheld on behalf of an employee by the company.

remote_was_deletedBoolean
Required
Indicates whether or not this object has been deleted by third party webhooks.

field_mappingsObject
Optional

taxesTax[]
Required

The Tax object

The Tax object is used to represent an array of the tax deductions for a given employee's payroll run.
JSON
{
"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 by third party webhooks.

remote_dataRemoteData[]
Optional

remote_was_deletedBoolean
Required
Indicates whether or not this object has been deleted by third party webhooks.

field_mappingsObject
Optional

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_data": [
{
"path": "/employee-payroll",
"data": [
"Varies by platform"
]
}
],
"remote_was_deleted": true,
"field_mappings": {
"organization_defined_targets": {
"custom_key": "custom_value"
},
"linked_account_defined_targets": {
"custom_key": "custom_value"
}
}
}

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 marked as deleted by third party webhooks.

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_data": [
{
"path": "/employee-payroll",
"data": [
"Varies by platform"
]
}
],
"remote_was_deleted": true,
"field_mappings": {
"organization_defined_targets": {
"custom_key": "custom_value"
},
"linked_account_defined_targets": {
"custom_key": "custom_value"
}
}
}
]
}
Field support by platform

ADP Workforce Now

ADP Workforce Now

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


deductionsDeduction[]
employee_payroll_runstring
namestring
employee_deductionnumber

earningsEarning[]
employee_payroll_runstring
amountnumber
typestring

taxesTax[]
employee_payroll_runstring
namestring
amountnumber
employer_taxboolean

check_dateString

employeeString

gross_payNumber

net_payNumber

payroll_runString

Deel

Deel

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


employeeString

end_dateString

gross_payNumber

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

start_dateString

Factorial

Factorial

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


employeeString

end_dateString

gross_payNumber

net_payNumber

payroll_runString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

start_dateString

Gusto

Gusto

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


deductionsDeduction[]
employee_payroll_runstring
namestring
employee_deductionnumber

earningsEarning[]
employee_payroll_runstring
amountnumber
typestring

taxesTax[]
employee_payroll_runstring
namestring
amountnumber
employer_taxboolean

check_dateString

employeeString

end_dateString

gross_payNumber

net_payNumber

payroll_runString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

start_dateString

Paychex

Paychex

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


deductionsDeduction[]
employee_payroll_runstring
namestring
employee_deductionnumber

earningsEarning[]
employee_payroll_runstring
amountnumber
typestring

taxesTax[]
employee_payroll_runstring
namestring
amountnumber
employer_taxboolean

check_dateString

employeeString

end_dateString

net_payNumber

payroll_runString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

start_dateString

Paylocity

Paylocity

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


deductionsDeduction[]
employee_payroll_runstring
namestring
employee_deductionnumber

earningsEarning[]
employee_payroll_runstring
amountnumber
typestring

taxesTax[]
employee_payroll_runstring
namestring
amountnumber

check_dateString

employeeString

end_dateString

gross_payNumber

net_payNumber

payroll_runString

remote_dataRemoteData[]
pathstring
dataobject

start_dateString

Proliant

Proliant

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


deductionsDeduction[]
employee_payroll_runstring
namestring
employee_deductionnumber

earningsEarning[]
employee_payroll_runstring
amountnumber
typestring

taxesTax[]
employee_payroll_runstring
namestring
amountnumber
employer_taxboolean

check_dateString

employeeString

end_dateString

gross_payNumber

net_payNumber

start_dateString

Rippling

Rippling

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


deductionsDeduction[]
employee_payroll_runstring
namestring
employee_deductionnumber
company_deductionnumber

earningsEarning[]
employee_payroll_runstring
amountnumber
typestring

taxesTax[]
employee_payroll_runstring
namestring
amountnumber

check_dateString

employeeString

end_dateString

gross_payNumber

net_payNumber

payroll_runString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

start_dateString

SAP SuccessFactors

SAP SuccessFactors

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


earningsEarning[]
employee_payroll_runstring
amountnumber
typestring

taxesTax[]
employee_payroll_runstring
amountnumber

check_dateString

employeeString

end_dateString

gross_payNumber

net_payNumber

payroll_runString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

start_dateString

TriNet

TriNet

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


deductionsDeduction[]
employee_payroll_runstring
namestring
company_deductionnumber

earningsEarning[]
employee_payroll_runstring
amountnumber
typestring

taxesTax[]
employee_payroll_runstring
namestring
amountnumber
employer_taxboolean

check_dateString

employeeString

end_dateString

gross_payNumber

net_payNumber

payroll_runString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

start_dateString

UKG Pro

UKG Pro

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


deductionsDeduction[]
employee_payroll_runstring
employee_deductionnumber

earningsEarning[]
employee_payroll_runstring
amountnumber

taxesTax[]
employee_payroll_runstring
amountnumber

check_dateString

employeeString

end_dateString

gross_payNumber

net_payNumber

payroll_runString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

start_dateString

UKG Ready

UKG Ready

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


deductionsDeduction[]
employee_payroll_runstring
namestring

earningsEarning[]
employee_payroll_runstring
amountnumber
typestring

check_dateString

employeeString

end_dateString

payroll_runString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

start_dateString

Workday

Workday

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


deductionsDeduction[]
employee_payroll_runstring
namestring
employee_deductionnumber

earningsEarning[]
employee_payroll_runstring
amountnumber
typestring

check_dateString

employeeString

end_dateString

gross_payNumber

net_payNumber

payroll_runString

remote_dataRemoteData[]
pathstring
dataobject

start_dateString
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_data": [
{
"path": "/employee-payroll",
"data": [
"Varies by platform"
]
}
],
"remote_was_deleted": true,
"field_mappings": {
"organization_defined_targets": {
"custom_key": "custom_value"
},
"linked_account_defined_targets": {
"custom_key": "custom_value"
}
}
}
Field support by platform

ADP Workforce Now

ADP Workforce Now

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


deductionsDeduction[]
employee_payroll_runstring
namestring
employee_deductionnumber

earningsEarning[]
employee_payroll_runstring
amountnumber
typestring

taxesTax[]
employee_payroll_runstring
namestring
amountnumber
employer_taxboolean

check_dateString

employeeString

gross_payNumber

net_payNumber

payroll_runString

Deel

Deel

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


employeeString

end_dateString

gross_payNumber

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

start_dateString

Factorial

Factorial

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


employeeString

end_dateString

gross_payNumber

net_payNumber

payroll_runString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

start_dateString

Gusto

Gusto

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


deductionsDeduction[]
employee_payroll_runstring
namestring
employee_deductionnumber

earningsEarning[]
employee_payroll_runstring
amountnumber
typestring

taxesTax[]
employee_payroll_runstring
namestring
amountnumber
employer_taxboolean

check_dateString

employeeString

end_dateString

gross_payNumber

net_payNumber

payroll_runString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

start_dateString

Paychex

Paychex

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


deductionsDeduction[]
employee_payroll_runstring
namestring
employee_deductionnumber

earningsEarning[]
employee_payroll_runstring
amountnumber
typestring

taxesTax[]
employee_payroll_runstring
namestring
amountnumber
employer_taxboolean

check_dateString

employeeString

end_dateString

net_payNumber

payroll_runString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

start_dateString

Paylocity

Paylocity

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


deductionsDeduction[]
employee_payroll_runstring
namestring
employee_deductionnumber

earningsEarning[]
employee_payroll_runstring
amountnumber
typestring

taxesTax[]
employee_payroll_runstring
namestring
amountnumber

check_dateString

employeeString

end_dateString

gross_payNumber

net_payNumber

payroll_runString

remote_dataRemoteData[]
pathstring
dataobject

start_dateString

Proliant

Proliant

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


deductionsDeduction[]
employee_payroll_runstring
namestring
employee_deductionnumber

earningsEarning[]
employee_payroll_runstring
amountnumber
typestring

taxesTax[]
employee_payroll_runstring
namestring
amountnumber
employer_taxboolean

check_dateString

employeeString

end_dateString

gross_payNumber

net_payNumber

start_dateString

Rippling

Rippling

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


deductionsDeduction[]
employee_payroll_runstring
namestring
employee_deductionnumber
company_deductionnumber

earningsEarning[]
employee_payroll_runstring
amountnumber
typestring

taxesTax[]
employee_payroll_runstring
namestring
amountnumber

check_dateString

employeeString

end_dateString

gross_payNumber

net_payNumber

payroll_runString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

start_dateString

SAP SuccessFactors

SAP SuccessFactors

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


earningsEarning[]
employee_payroll_runstring
amountnumber
typestring

taxesTax[]
employee_payroll_runstring
amountnumber

check_dateString

employeeString

end_dateString

gross_payNumber

net_payNumber

payroll_runString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

start_dateString

TriNet

TriNet

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


deductionsDeduction[]
employee_payroll_runstring
namestring
company_deductionnumber

earningsEarning[]
employee_payroll_runstring
amountnumber
typestring

taxesTax[]
employee_payroll_runstring
namestring
amountnumber
employer_taxboolean

check_dateString

employeeString

end_dateString

gross_payNumber

net_payNumber

payroll_runString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

start_dateString

UKG Pro

UKG Pro

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


deductionsDeduction[]
employee_payroll_runstring
employee_deductionnumber

earningsEarning[]
employee_payroll_runstring
amountnumber

taxesTax[]
employee_payroll_runstring
amountnumber

check_dateString

employeeString

end_dateString

gross_payNumber

net_payNumber

payroll_runString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

start_dateString

UKG Ready

UKG Ready

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


deductionsDeduction[]
employee_payroll_runstring
namestring

earningsEarning[]
employee_payroll_runstring
amountnumber
typestring

check_dateString

employeeString

end_dateString

payroll_runString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

start_dateString

Workday

Workday

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


deductionsDeduction[]
employee_payroll_runstring
namestring
employee_deductionnumber

earningsEarning[]
employee_payroll_runstring
amountnumber
typestring

check_dateString

employeeString

end_dateString

gross_payNumber

net_payNumber

payroll_runString

remote_dataRemoteData[]
pathstring
dataobject

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