Employee Payroll Runs
The
EmployeePayrollRun object is used to represent an employee's pay statement for a specific payroll run.Properties
idUUIDRequired
remote_idStringOptional
The third-party API ID of the matching object.
created_atDateTime (ISO 8601)Required
The datetime that this object was created by Merge.
modified_atDateTime (ISO 8601)Required
The datetime that this object was modified by Merge.
employeeUUIDOptional
The employee whose payroll is being run.
payroll_runUUIDOptional
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_dateDateTime (ISO 8601)Optional
The day and time the payroll run started.
end_dateDateTime (ISO 8601)Optional
The day and time the payroll run ended.
check_dateDateTime (ISO 8601)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.Properties
idUUIDRequired
remote_idStringOptional
The third-party API ID of the matching object.
created_atDateTime (ISO 8601)Required
The datetime that this object was created by Merge.
modified_atDateTime (ISO 8601)Required
The datetime that this object was modified by Merge.
employee_payroll_runUUIDOptional
amountNumberOptional
The amount earned.
typeEnumOptional
The type of earning. Possible values include:
SALARY, REIMBURSEMENT, OVERTIME, BONUS. In cases where there is no clear mapping, the original value passed through will be returned. To receive all enum values in the original format, use the show_enum_origins query parameter. Learn more.remote_was_deletedBooleanRequired
Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.
field_mappingsObjectOptional
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.Properties
idUUIDRequired
remote_idStringOptional
The third-party API ID of the matching object.
created_atDateTime (ISO 8601)Required
The datetime that this object was created by Merge.
modified_atDateTime (ISO 8601)Required
The datetime that this object was modified by Merge.
employee_payroll_runUUIDOptional
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 in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.
field_mappingsObjectOptional
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.Properties
idUUIDRequired
remote_idStringOptional
The third-party API ID of the matching object.
created_atDateTime (ISO 8601)Required
The datetime that this object was created by Merge.
modified_atDateTime (ISO 8601)Required
The datetime that this object was modified by Merge.
employee_payroll_runUUIDOptional
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 in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.
field_mappingsObjectOptional
remote_dataArrayOptional
remote_was_deletedBooleanRequired
Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.
field_mappingsObjectOptional
remote_dataRemoteData[]Optional
GET
/employee-payroll-runs
Betahttps://api.merge.dev/api/hris/v1/employee-payroll-runs
US
EU
APAC
Returns a list of EmployeePayrollRun objects.
Query & Path Parameters
created_afterDateTime (ISO 8601)Optional
If provided, will only return objects created after this datetime.
created_beforeDateTime (ISO 8601)Optional
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_afterDateTime (ISO 8601)Optional
If provided, will only return employee payroll runs ended after this datetime.
ended_beforeDateTime (ISO 8601)Optional
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
Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.
include_remote_dataBooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
include_shell_dataBooleanOptional
Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
modified_afterDateTime (ISO 8601)Optional
If provided, only objects synced by Merge after this date time will be returned.
modified_beforeDateTime (ISO 8601)Optional
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_afterDateTime (ISO 8601)Optional
If provided, will only return employee payroll runs started after this datetime.
started_beforeDateTime (ISO 8601)Optional
If provided, will only return employee payroll runs started before this datetime.
Field support by integration
See all supported fieldsUse the /linked-accounts endpoint to pull platform support information
ADP RUN
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
earningsEarning[]employee_payroll_runstringamountnumberemployeeUUIDend_dateDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringstart_dateDateTime (ISO 8601)
ADP Workforce Now
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
deductionsDeduction[]employee_payroll_runstringnamestringemployee_deductionnumberearningsEarning[]employee_payroll_runstringamountnumbertypestringtaxesTax[]employee_payroll_runstringnamestringamountnumberemployer_taxbooleancheck_dateDateTime (ISO 8601)employeeUUIDend_dateDateTime (ISO 8601)gross_payNumbernet_payNumberpayroll_runUUIDstart_dateDateTime (ISO 8601)
Employment Hero
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
employeeUUIDend_dateDateTime (ISO 8601)net_payNumberremote_dataRemoteData[]pathstringdatastringremote_idStringstart_dateDateTime (ISO 8601)
Gusto
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
deductionsDeduction[]employee_payroll_runstringnamestringemployee_deductionnumberearningsEarning[]employee_payroll_runstringamountnumbertypestringtaxesTax[]employee_payroll_runstringnamestringamountnumberemployer_taxbooleancheck_dateDateTime (ISO 8601)employeeUUIDend_dateDateTime (ISO 8601)gross_payNumbernet_payNumberpayroll_runUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringstart_dateDateTime (ISO 8601)
Hibob
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
earningsEarning[]remote_idstringemployee_payroll_runstringamountnumbertypestringemployeeUUIDremote_dataRemoteData[]pathstringdatastringremote_idString
Oracle Cloud Human Capital Management (HCM)
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
deductionsDeduction[]employee_payroll_runstringnamestringemployee_deductionnumbercompany_deductionnumberearningsEarning[]employee_payroll_runstringamountnumbertypestringtaxesTax[]employee_payroll_runstringnamestringamountnumberemployer_taxbooleancheck_dateDateTime (ISO 8601)employeeUUIDend_dateDateTime (ISO 8601)gross_payNumbernet_payNumberremote_dataRemoteData[]pathstringdatastringremote_idStringstart_dateDateTime (ISO 8601)
OysterHR
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
earningsEarning[]employee_payroll_runstringamountnumbertypestringtaxesTax[]employee_payroll_runstringnamestringamountnumberemployeeUUIDnet_payNumberpayroll_runUUIDremote_dataRemoteData[]pathstringdatastring
Paychex
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
deductionsDeduction[]employee_payroll_runstringnamestringemployee_deductionnumberearningsEarning[]employee_payroll_runstringamountnumbertypestringtaxesTax[]employee_payroll_runstringnamestringamountnumberemployer_taxbooleancheck_dateDateTime (ISO 8601)employeeUUIDend_dateDateTime (ISO 8601)net_payNumberpayroll_runUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringstart_dateDateTime (ISO 8601)
Paylocity
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
deductionsDeduction[]remote_idstringemployee_payroll_runstringnamestringemployee_deductionnumbercompany_deductionnumberearningsEarning[]remote_idstringemployee_payroll_runstringamountnumbertypestringtaxesTax[]remote_idstringemployee_payroll_runstringnamestringamountnumberemployer_taxbooleancheck_dateDateTime (ISO 8601)employeeUUIDend_dateDateTime (ISO 8601)gross_payNumbernet_payNumberpayroll_runUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringstart_dateDateTime (ISO 8601)
Planday
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
check_dateDateTime (ISO 8601)employeeUUIDend_dateDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringstart_dateDateTime (ISO 8601)
Proliant
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
deductionsDeduction[]employee_payroll_runstringnamestringemployee_deductionnumberearningsEarning[]employee_payroll_runstringamountnumbertypestringtaxesTax[]employee_payroll_runstringnamestringamountnumberemployer_taxbooleancheck_dateDateTime (ISO 8601)employeeUUIDend_dateDateTime (ISO 8601)gross_payNumbernet_payNumberstart_dateDateTime (ISO 8601)
Sage People
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
earningsEarning[]remote_idstringemployee_payroll_runstringamountnumbertypestringemployeeUUIDgross_payNumberremote_dataRemoteData[]pathstringdatastringstart_dateDateTime (ISO 8601)
SAP SuccessFactors
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
earningsEarning[]employee_payroll_runstringamountnumbertypestringtaxesTax[]employee_payroll_runstringamountnumbercheck_dateDateTime (ISO 8601)employeeUUIDend_dateDateTime (ISO 8601)gross_payNumbernet_payNumberpayroll_runUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringstart_dateDateTime (ISO 8601)
TriNet
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
deductionsDeduction[]employee_payroll_runstringnamestringcompany_deductionnumberearningsEarning[]employee_payroll_runstringamountnumbertypestringtaxesTax[]employee_payroll_runstringnamestringamountnumberemployer_taxbooleancheck_dateDateTime (ISO 8601)employeeUUIDend_dateDateTime (ISO 8601)gross_payNumbernet_payNumberpayroll_runUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringstart_dateDateTime (ISO 8601)
UKG Pro
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
deductionsDeduction[]remote_idstringemployee_payroll_runstringnamestringemployee_deductionnumbercompany_deductionnumberearningsEarning[]remote_idstringemployee_payroll_runstringamountnumbertypestringtaxesTax[]remote_idstringemployee_payroll_runstringnamestringamountnumbercheck_dateDateTime (ISO 8601)employeeUUIDend_dateDateTime (ISO 8601)gross_payNumbernet_payNumberpayroll_runUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringstart_dateDateTime (ISO 8601)
UKG Ready
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
deductionsDeduction[]employee_payroll_runstringnamestringearningsEarning[]employee_payroll_runstringamountnumbertypestringcheck_dateDateTime (ISO 8601)employeeUUIDend_dateDateTime (ISO 8601)payroll_runUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringstart_dateDateTime (ISO 8601)
Workday
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
deductionsDeduction[]employee_payroll_runstringnamestringemployee_deductionnumberearningsEarning[]employee_payroll_runstringamountnumbertypestringcheck_dateDateTime (ISO 8601)employeeUUIDend_dateDateTime (ISO 8601)gross_payNumbernet_payNumberpayroll_runUUIDremote_dataRemoteData[]pathstringdatastringstart_dateDateTime (ISO 8601)GET
/employee-payroll-runs/{id}
Betahttps://api.merge.dev/api/hris/v1/employee-payroll-runs/{id}
US
EU
APAC
Returns an EmployeePayrollRun object with the given id.
Query & Path Parameters
expandStringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
idUUIDRequired
include_remote_dataBooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
Field support by integration
See all supported fieldsUse the /linked-accounts endpoint to pull platform support information
ADP RUN
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
earningsEarning[]employee_payroll_runstringamountnumberemployeeUUIDend_dateDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringstart_dateDateTime (ISO 8601)ADP Workforce Now
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
deductionsDeduction[]employee_payroll_runstringnamestringemployee_deductionnumberearningsEarning[]employee_payroll_runstringamountnumbertypestringtaxesTax[]employee_payroll_runstringnamestringamountnumberemployer_taxbooleancheck_dateDateTime (ISO 8601)employeeUUIDend_dateDateTime (ISO 8601)gross_payNumbernet_payNumberpayroll_runUUIDstart_dateDateTime (ISO 8601)Employment Hero
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
employeeUUIDend_dateDateTime (ISO 8601)net_payNumberremote_dataRemoteData[]pathstringdatastringremote_idStringstart_dateDateTime (ISO 8601)Gusto
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
deductionsDeduction[]employee_payroll_runstringnamestringemployee_deductionnumberearningsEarning[]employee_payroll_runstringamountnumbertypestringtaxesTax[]employee_payroll_runstringnamestringamountnumberemployer_taxbooleancheck_dateDateTime (ISO 8601)employeeUUIDend_dateDateTime (ISO 8601)gross_payNumbernet_payNumberpayroll_runUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringstart_dateDateTime (ISO 8601)Hibob
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
earningsEarning[]remote_idstringemployee_payroll_runstringamountnumbertypestringemployeeUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringOracle Cloud Human Capital Management (HCM)
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
deductionsDeduction[]employee_payroll_runstringnamestringemployee_deductionnumbercompany_deductionnumberearningsEarning[]employee_payroll_runstringamountnumbertypestringtaxesTax[]employee_payroll_runstringnamestringamountnumberemployer_taxbooleancheck_dateDateTime (ISO 8601)employeeUUIDend_dateDateTime (ISO 8601)gross_payNumbernet_payNumberremote_dataRemoteData[]pathstringdatastringremote_idStringstart_dateDateTime (ISO 8601)OysterHR
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
earningsEarning[]employee_payroll_runstringamountnumbertypestringtaxesTax[]employee_payroll_runstringnamestringamountnumberemployeeUUIDnet_payNumberpayroll_runUUIDremote_dataRemoteData[]pathstringdatastringPaychex
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
deductionsDeduction[]employee_payroll_runstringnamestringemployee_deductionnumberearningsEarning[]employee_payroll_runstringamountnumbertypestringtaxesTax[]employee_payroll_runstringnamestringamountnumberemployer_taxbooleancheck_dateDateTime (ISO 8601)employeeUUIDend_dateDateTime (ISO 8601)net_payNumberpayroll_runUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringstart_dateDateTime (ISO 8601)Paylocity
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
deductionsDeduction[]remote_idstringemployee_payroll_runstringnamestringemployee_deductionnumbercompany_deductionnumberearningsEarning[]remote_idstringemployee_payroll_runstringamountnumbertypestringtaxesTax[]remote_idstringemployee_payroll_runstringnamestringamountnumberemployer_taxbooleancheck_dateDateTime (ISO 8601)employeeUUIDend_dateDateTime (ISO 8601)gross_payNumbernet_payNumberpayroll_runUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringstart_dateDateTime (ISO 8601)Planday
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
check_dateDateTime (ISO 8601)employeeUUIDend_dateDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringstart_dateDateTime (ISO 8601)Proliant
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
deductionsDeduction[]employee_payroll_runstringnamestringemployee_deductionnumberearningsEarning[]employee_payroll_runstringamountnumbertypestringtaxesTax[]employee_payroll_runstringnamestringamountnumberemployer_taxbooleancheck_dateDateTime (ISO 8601)employeeUUIDend_dateDateTime (ISO 8601)gross_payNumbernet_payNumberstart_dateDateTime (ISO 8601)Sage People
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
earningsEarning[]remote_idstringemployee_payroll_runstringamountnumbertypestringemployeeUUIDgross_payNumberremote_dataRemoteData[]pathstringdatastringstart_dateDateTime (ISO 8601)SAP SuccessFactors
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
earningsEarning[]employee_payroll_runstringamountnumbertypestringtaxesTax[]employee_payroll_runstringamountnumbercheck_dateDateTime (ISO 8601)employeeUUIDend_dateDateTime (ISO 8601)gross_payNumbernet_payNumberpayroll_runUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringstart_dateDateTime (ISO 8601)TriNet
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
deductionsDeduction[]employee_payroll_runstringnamestringcompany_deductionnumberearningsEarning[]employee_payroll_runstringamountnumbertypestringtaxesTax[]employee_payroll_runstringnamestringamountnumberemployer_taxbooleancheck_dateDateTime (ISO 8601)employeeUUIDend_dateDateTime (ISO 8601)gross_payNumbernet_payNumberpayroll_runUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringstart_dateDateTime (ISO 8601)UKG Pro
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
deductionsDeduction[]remote_idstringemployee_payroll_runstringnamestringemployee_deductionnumbercompany_deductionnumberearningsEarning[]remote_idstringemployee_payroll_runstringamountnumbertypestringtaxesTax[]remote_idstringemployee_payroll_runstringnamestringamountnumbercheck_dateDateTime (ISO 8601)employeeUUIDend_dateDateTime (ISO 8601)gross_payNumbernet_payNumberpayroll_runUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringstart_dateDateTime (ISO 8601)UKG Ready
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
deductionsDeduction[]employee_payroll_runstringnamestringearningsEarning[]employee_payroll_runstringamountnumbertypestringcheck_dateDateTime (ISO 8601)employeeUUIDend_dateDateTime (ISO 8601)payroll_runUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringstart_dateDateTime (ISO 8601)Workday
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
deductionsDeduction[]employee_payroll_runstringnamestringemployee_deductionnumberearningsEarning[]employee_payroll_runstringamountnumbertypestringcheck_dateDateTime (ISO 8601)employeeUUIDend_dateDateTime (ISO 8601)gross_payNumbernet_payNumberpayroll_runUUIDremote_dataRemoteData[]pathstringdatastringstart_dateDateTime (ISO 8601)