Employee Payroll Runs
The EmployeePayrollRun object is used to represent an employee's pay statement for a specific payroll run.The EmployeePayrollRun object
Properties
idStringRequired
remote_idStringOptional
The third-party API ID of the matching object.
employeeStringOptional
The employee whose payroll is being run.
payroll_runStringOptional
The payroll being run.
gross_payNumberOptional
The total earnings throughout a given period for an employee before any deductions are made.
net_payNumberOptional
The take-home pay throughout a given period for an employee after deductions are made.
start_dateStringOptional
The day and time the payroll run started.
end_dateStringOptional
The day and time the payroll run ended.
check_dateStringOptional
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","remote_id": "52802","employee_payroll_run": "35347df1-95e7-46e2-93cc-66f1191edca5","amount": 1002.34,"type": "SALARY","remote_was_deleted": true,Show advanced fields}
Properties
idStringRequired
remote_idStringOptional
The third-party API ID of the matching object.
employee_payroll_runStringOptional
amountNumberOptional
The amount earned.
typeEnumOptional
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_deletedBooleanRequired
Indicates whether or not this object has been deleted by third party webhooks.
field_mappingsObjectOptional
modified_atStringRequired
This is the datetime that this object was last updated by Merge
remote_dataArrayOptional
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","remote_id": "93478612","employee_payroll_run": "35347df1-95e7-46e2-93cc-66f1191edca5","name": "Social Security","employee_deduction": 34.54,"company_deduction": 78.78,"remote_was_deleted": true,Show advanced fields}
Properties
idStringRequired
remote_idStringOptional
The third-party API ID of the matching object.
employee_payroll_runStringOptional
nameStringOptional
The deduction's name.
employee_deductionNumberOptional
The amount of money that is withheld from an employee's gross pay by the employee.
company_deductionNumberOptional
The amount of money that is withheld on behalf of an employee by the company.
remote_was_deletedBooleanRequired
Indicates whether or not this object has been deleted by third party webhooks.
field_mappingsObjectOptional
modified_atStringRequired
This is the datetime that this object was last updated by Merge
remote_dataArrayOptional
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","remote_id": "26806834","employee_payroll_run": "35347df1-95e7-46e2-93cc-66f1191edca5","name": "California State Income Tax","amount": 100.25,"employer_tax": "False","remote_was_deleted": true,Show advanced fields}
Properties
idStringRequired
remote_idStringOptional
The third-party API ID of the matching object.
employee_payroll_runStringOptional
nameStringOptional
The tax's name.
amountNumberOptional
The tax amount.
employer_taxBooleanOptional
Whether or not the employer is responsible for paying the tax.
remote_was_deletedBooleanRequired
Indicates whether or not this object has been deleted by third party webhooks.
field_mappingsObjectOptional
modified_atStringRequired
This is the datetime that this object was last updated by Merge
remote_dataArrayOptional
remote_was_deletedBooleanRequired
Indicates whether or not this object has been deleted by third party webhooks.
field_mappingsObjectOptional
modified_atStringRequired
This is the datetime that this object was last updated by Merge
remote_dataRemoteData[]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_was_deleted": true,Show advanced fields}
GET
/employee-payroll-runs
BetaReturns a list of EmployeePayrollRun objects.
Header Parameters
AuthorizationStringRequired
Token-based authentication with required prefix "Bearer"
X-Account-TokenStringRequired
Token identifying the end user.
Query & Path Parameters
created_afterStringOptional
If provided, will only return objects created after this datetime.
created_beforeStringOptional
If provided, will only return objects created before this datetime.
cursorStringOptional
The pagination cursor value.
employee_idStringOptional
If provided, will only return employee payroll runs for this employee.
ended_afterStringOptional
If provided, will only return employee payroll runs ended after this datetime.
ended_beforeStringOptional
If provided, will only return employee payroll runs ended before this datetime.
expandStringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
include_deleted_dataBooleanOptional
Whether to include data that was marked as deleted by third party webhooks.
include_remote_dataBooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
modified_afterStringOptional
If provided, only objects synced by Merge after this date time will be returned.
modified_beforeStringOptional
If provided, only objects synced by Merge before this date time will be returned.
page_sizeIntegerOptional
Number of results to return per page.
payroll_run_idStringOptional
If provided, will only return employee payroll runs for this employee.
remote_idStringOptional
The API provider's ID for the given object.
started_afterStringOptional
If provided, will only return employee payroll runs started after this datetime.
started_beforeStringOptional
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,Show advanced fields}]}
Field support by platform
ADP Workforce Now
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
deductionsDeduction[]employee_payroll_runstringnamestringemployee_deductionnumberremote_dataarrayearningsEarning[]employee_payroll_runstringamountnumbertypestringtaxesTax[]employee_payroll_runstringnamestringamountnumberemployer_taxbooleancheck_dateStringemployeeStringgross_payNumbernet_payNumberpayroll_runString
Factorial
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
employeeStringend_dateStringgross_payNumbernet_payNumberpayroll_runStringremote_dataRemoteData[]pathstringdataobjectremote_idStringstart_dateString
Gusto
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
deductionsDeduction[]employee_payroll_runstringnamestringemployee_deductionnumberearningsEarning[]employee_payroll_runstringamountnumbertypestringtaxesTax[]employee_payroll_runstringamountnumbercheck_dateStringemployeeStringend_dateStringgross_payNumbernet_payNumberpayroll_runStringremote_idStringstart_dateString
Paychex
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
deductionsDeduction[]employee_payroll_runstringnamestringemployee_deductionnumberremote_dataarrayearningsEarning[]employee_payroll_runstringamountnumbertypestringtaxesTax[]employee_payroll_runstringnamestringamountnumberemployer_taxbooleancheck_dateStringemployeeStringend_dateStringnet_payNumberpayroll_runStringremote_dataRemoteData[]pathstringdataobjectremote_idStringstart_dateString
Paylocity
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
deductionsDeduction[]remote_idstringemployee_payroll_runstringnamestringemployee_deductionnumbercompany_deductionnumberremote_dataarrayearningsEarning[]remote_idstringemployee_payroll_runstringamountnumbertypestringremote_dataarraytaxesTax[]remote_idstringemployee_payroll_runstringnamestringamountnumberemployer_taxbooleanremote_dataarraycheck_dateStringemployeeStringend_dateStringgross_payNumbernet_payNumberpayroll_runStringremote_dataRemoteData[]pathstringdataobjectremote_idStringstart_dateString
Proliant
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
deductionsDeduction[]employee_payroll_runstringnamestringemployee_deductionnumberearningsEarning[]employee_payroll_runstringamountnumbertypestringtaxesTax[]employee_payroll_runstringnamestringamountnumberemployer_taxbooleancheck_dateStringemployeeStringend_dateStringgross_payNumbernet_payNumberstart_dateString
Rippling
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
deductionsDeduction[]employee_payroll_runstringnamestringemployee_deductionnumbercompany_deductionnumberearningsEarning[]employee_payroll_runstringamountnumbertypestringtaxesTax[]employee_payroll_runstringnamestringamountnumbercheck_dateStringemployeeStringend_dateStringgross_payNumbernet_payNumberpayroll_runStringremote_dataRemoteData[]pathstringdataobjectremote_idStringstart_dateString
SAP SuccessFactors
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
earningsEarning[]employee_payroll_runstringamountnumbertypestringtaxesTax[]employee_payroll_runstringamountnumbercheck_dateStringemployeeStringend_dateStringgross_payNumbernet_payNumberpayroll_runStringremote_dataRemoteData[]pathstringdataobjectremote_idStringstart_dateString
TriNet
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
deductionsDeduction[]employee_payroll_runstringnamestringcompany_deductionnumberearningsEarning[]employee_payroll_runstringamountnumbertypestringtaxesTax[]employee_payroll_runstringnamestringamountnumberemployer_taxbooleancheck_dateStringemployeeStringend_dateStringgross_payNumbernet_payNumberpayroll_runStringremote_dataRemoteData[]pathstringdataobjectremote_idStringstart_dateString
UKG Pro
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
deductionsDeduction[]remote_idstringemployee_payroll_runstringnamestringemployee_deductionnumbercompany_deductionnumberremote_dataarrayearningsEarning[]remote_idstringemployee_payroll_runstringamountnumbertypestringremote_dataarraytaxesTax[]remote_idstringemployee_payroll_runstringnamestringamountnumberremote_dataarraycheck_dateStringemployeeStringend_dateStringgross_payNumbernet_payNumberpayroll_runStringremote_dataRemoteData[]pathstringdataobjectremote_idStringstart_dateString
UKG Ready
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
deductionsDeduction[]employee_payroll_runstringnamestringremote_dataarrayearningsEarning[]employee_payroll_runstringamountnumbertypestringcheck_dateStringemployeeStringend_dateStringpayroll_runStringremote_dataRemoteData[]pathstringdataobjectremote_idStringstart_dateString
Workday
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
deductionsDeduction[]employee_payroll_runstringnamestringemployee_deductionnumberremote_dataarrayearningsEarning[]employee_payroll_runstringamountnumbertypestringcheck_dateStringemployeeStringend_dateStringgross_payNumbernet_payNumberpayroll_runStringremote_dataRemoteData[]pathstringdataobjectstart_dateStringHint: Use the /linked-accounts endpoint to pull platform support information.
GET
/employee-payroll-runs/{id}
BetaReturns an EmployeePayrollRun object with the given id.
Header Parameters
AuthorizationStringRequired
Token-based authentication with required prefix "Bearer"
X-Account-TokenStringRequired
Token identifying the end user.
Query & Path Parameters
expandStringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
idStringRequired
include_remote_dataBooleanOptional
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,Show advanced fields}
Field support by platform
ADP Workforce Now
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
deductionsDeduction[]employee_payroll_runstringnamestringemployee_deductionnumberremote_dataarrayearningsEarning[]employee_payroll_runstringamountnumbertypestringtaxesTax[]employee_payroll_runstringnamestringamountnumberemployer_taxbooleancheck_dateStringemployeeStringgross_payNumbernet_payNumberpayroll_runStringFactorial
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
employeeStringend_dateStringgross_payNumbernet_payNumberpayroll_runStringremote_dataRemoteData[]pathstringdataobjectremote_idStringstart_dateStringGusto
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
deductionsDeduction[]employee_payroll_runstringnamestringemployee_deductionnumberearningsEarning[]employee_payroll_runstringamountnumbertypestringtaxesTax[]employee_payroll_runstringamountnumbercheck_dateStringemployeeStringend_dateStringgross_payNumbernet_payNumberpayroll_runStringremote_idStringstart_dateStringPaychex
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
deductionsDeduction[]employee_payroll_runstringnamestringemployee_deductionnumberremote_dataarrayearningsEarning[]employee_payroll_runstringamountnumbertypestringtaxesTax[]employee_payroll_runstringnamestringamountnumberemployer_taxbooleancheck_dateStringemployeeStringend_dateStringnet_payNumberpayroll_runStringremote_dataRemoteData[]pathstringdataobjectremote_idStringstart_dateStringPaylocity
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
deductionsDeduction[]remote_idstringemployee_payroll_runstringnamestringemployee_deductionnumbercompany_deductionnumberremote_dataarrayearningsEarning[]remote_idstringemployee_payroll_runstringamountnumbertypestringremote_dataarraytaxesTax[]remote_idstringemployee_payroll_runstringnamestringamountnumberemployer_taxbooleanremote_dataarraycheck_dateStringemployeeStringend_dateStringgross_payNumbernet_payNumberpayroll_runStringremote_dataRemoteData[]pathstringdataobjectremote_idStringstart_dateStringProliant
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
deductionsDeduction[]employee_payroll_runstringnamestringemployee_deductionnumberearningsEarning[]employee_payroll_runstringamountnumbertypestringtaxesTax[]employee_payroll_runstringnamestringamountnumberemployer_taxbooleancheck_dateStringemployeeStringend_dateStringgross_payNumbernet_payNumberstart_dateStringRippling
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
deductionsDeduction[]employee_payroll_runstringnamestringemployee_deductionnumbercompany_deductionnumberearningsEarning[]employee_payroll_runstringamountnumbertypestringtaxesTax[]employee_payroll_runstringnamestringamountnumbercheck_dateStringemployeeStringend_dateStringgross_payNumbernet_payNumberpayroll_runStringremote_dataRemoteData[]pathstringdataobjectremote_idStringstart_dateStringSAP SuccessFactors
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
earningsEarning[]employee_payroll_runstringamountnumbertypestringtaxesTax[]employee_payroll_runstringamountnumbercheck_dateStringemployeeStringend_dateStringgross_payNumbernet_payNumberpayroll_runStringremote_dataRemoteData[]pathstringdataobjectremote_idStringstart_dateStringTriNet
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
deductionsDeduction[]employee_payroll_runstringnamestringcompany_deductionnumberearningsEarning[]employee_payroll_runstringamountnumbertypestringtaxesTax[]employee_payroll_runstringnamestringamountnumberemployer_taxbooleancheck_dateStringemployeeStringend_dateStringgross_payNumbernet_payNumberpayroll_runStringremote_dataRemoteData[]pathstringdataobjectremote_idStringstart_dateStringUKG Pro
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
deductionsDeduction[]remote_idstringemployee_payroll_runstringnamestringemployee_deductionnumbercompany_deductionnumberremote_dataarrayearningsEarning[]remote_idstringemployee_payroll_runstringamountnumbertypestringremote_dataarraytaxesTax[]remote_idstringemployee_payroll_runstringnamestringamountnumberremote_dataarraycheck_dateStringemployeeStringend_dateStringgross_payNumbernet_payNumberpayroll_runStringremote_dataRemoteData[]pathstringdataobjectremote_idStringstart_dateStringUKG Ready
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
deductionsDeduction[]employee_payroll_runstringnamestringremote_dataarrayearningsEarning[]employee_payroll_runstringamountnumbertypestringcheck_dateStringemployeeStringend_dateStringpayroll_runStringremote_dataRemoteData[]pathstringdataobjectremote_idStringstart_dateStringWorkday
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
deductionsDeduction[]employee_payroll_runstringnamestringemployee_deductionnumberremote_dataarrayearningsEarning[]employee_payroll_runstringamountnumbertypestringcheck_dateStringemployeeStringend_dateStringgross_payNumbernet_payNumberpayroll_runStringremote_dataRemoteData[]pathstringdataobjectstart_dateStringHint: Use the /linked-accounts endpoint to pull platform support information.