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

idUUID
Required

remote_idString
Optional
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.

employeeUUID
Optional
The employee whose payroll is being run.

payroll_runUUID
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_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

idUUID
Required

remote_idString
Optional
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_runUUID
Optional

amountNumber
Optional
The amount earned.

typeEnum
Optional
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.

remote_was_deletedBoolean
Required
Indicates whether or not this object has been deleted in the third party platform.

field_mappingsObject
Optional

remote_dataArray
Optional

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

idUUID
Required

remote_idString
Optional
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_runUUID
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 in the third party platform.

field_mappingsObject
Optional

remote_dataArray
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.
Properties

idUUID
Required

remote_idString
Optional
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_runUUID
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 in the third party platform.

field_mappingsObject
Optional

remote_dataArray
Optional

remote_was_deletedBoolean
Required
Indicates whether or not this object has been deleted in the third party platform.

field_mappingsObject
Optional

remote_dataRemoteData[]
Optional


GET
/employee-payroll-runs
Beta

https://api.merge.dev/api/hris/v1/employee-payroll-runs

US
EU

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.

cursorString
Optional
The pagination cursor value.

employee_idString
Optional
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.

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_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_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_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 fields
Use the /linked-accounts endpoint to pull platform support information
ADP Workforce Now
ADP Workforce Now
Employment Hero
Employment Hero
Gusto
Oracle Cloud Human Capital Management (HCM)
Oracle Cloud Human Capital Management (HCM)
OysterHR
OysterHR
Paychex
Paychex
Proliant
Proliant
SAP SuccessFactors
SAP SuccessFactors
TriNet
TriNet
UKG Pro
UKG Pro
UKG Ready
UKG Ready
Workday
Workday
GET
/employee-payroll-runs/{id}
Beta

https://api.merge.dev/api/hris/v1/employee-payroll-runs/{id}

US
EU

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.

idUUID
Required

include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.
Field support by integration
See all supported fields
Use the /linked-accounts endpoint to pull platform support information
ADP Workforce Now
ADP Workforce Now
Employment Hero
Employment Hero
Gusto
Oracle Cloud Human Capital Management (HCM)
Oracle Cloud Human Capital Management (HCM)
OysterHR
OysterHR
Paychex
Paychex
Proliant
Proliant
SAP SuccessFactors
SAP SuccessFactors
TriNet
TriNet
UKG Pro
UKG Pro
UKG Ready
UKG Ready
Workday
Workday