EmployeePayrollRun
object is used to represent an employee's pay statement for a specific payroll run.id
UUIDremote_id
Stringcreated_at
DateTime (ISO 8601)modified_at
DateTime (ISO 8601)employee
UUIDpayroll_run
UUIDgross_pay
Numbernet_pay
Numberstart_date
DateTime (ISO 8601)end_date
DateTime (ISO 8601)check_date
DateTime (ISO 8601)earnings
Earning[]Earning
object is used to represent an array of different compensations that an employee receives within specific wage categories.id
UUIDremote_id
Stringcreated_at
DateTime (ISO 8601)modified_at
DateTime (ISO 8601)employee_payroll_run
UUIDamount
Numbertype
EnumSALARY
, REIMBURSEMENT
, OVERTIME
, BONUS
. In cases where there is no clear mapping, the original value passed through will be returned.remote_was_deleted
Booleanfield_mappings
Objectremote_data
Arraydeductions
Deduction[]Deduction
object is used to represent an array of the wages withheld from total earnings for the purpose of paying taxes.id
UUIDremote_id
Stringcreated_at
DateTime (ISO 8601)modified_at
DateTime (ISO 8601)employee_payroll_run
UUIDname
Stringemployee_deduction
Numbercompany_deduction
Numberremote_was_deleted
Booleanfield_mappings
Objectremote_data
Arraytaxes
Tax[]Tax
object is used to represent an array of the tax deductions for a given employee's payroll run.id
UUIDremote_id
Stringcreated_at
DateTime (ISO 8601)modified_at
DateTime (ISO 8601)employee_payroll_run
UUIDname
Stringamount
Numberemployer_tax
Booleanremote_was_deleted
Booleanfield_mappings
Objectremote_data
Arrayremote_was_deleted
Booleanfield_mappings
Objectremote_data
RemoteData[]https://api.merge.dev/api/hris/v1/employee-payroll-runs
Returns a list of EmployeePayrollRun
objects.
created_after
DateTime (ISO 8601)created_before
DateTime (ISO 8601)cursor
Stringemployee_id
Stringended_after
DateTime (ISO 8601)ended_before
DateTime (ISO 8601)expand
Stringinclude_deleted_data
Booleaninclude_remote_data
Booleanmodified_after
DateTime (ISO 8601)modified_before
DateTime (ISO 8601)page_size
Integerpayroll_run_id
Stringremote_id
Stringstarted_after
DateTime (ISO 8601)started_before
DateTime (ISO 8601)![ADP Workforce Now](https://merge-api-production.s3.amazonaws.com/media/ADP_Square_Logo_GXCPXY1.jpg)
Supported Response Fields
deductions
Deduction[]employee_payroll_run
stringname
stringemployee_deduction
numberearnings
Earning[]employee_payroll_run
stringamount
numbertype
stringtaxes
Tax[]employee_payroll_run
stringname
stringamount
numberemployer_tax
booleancheck_date
DateTime (ISO 8601)employee
UUIDend_date
DateTime (ISO 8601)gross_pay
Numbernet_pay
Numberpayroll_run
UUIDstart_date
DateTime (ISO 8601)![Employment Hero](https://merge-api-production.s3.amazonaws.com/media/Employment-Hero-square.png)
Supported Response Fields
employee
UUIDend_date
DateTime (ISO 8601)net_pay
Numberremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstart_date
DateTime (ISO 8601)![](/static/b5d5c1854759bd0665de50ccff3750f5/35742/gusto_square_image.png)
Supported Response Fields
deductions
Deduction[]employee_payroll_run
stringname
stringemployee_deduction
numberearnings
Earning[]employee_payroll_run
stringamount
numbertype
stringtaxes
Tax[]employee_payroll_run
stringamount
numbercheck_date
DateTime (ISO 8601)employee
UUIDend_date
DateTime (ISO 8601)gross_pay
Numbernet_pay
Numberpayroll_run
UUIDremote_id
Stringstart_date
DateTime (ISO 8601)![Oracle Cloud Human Capital Management (HCM)](https://merge-api-production.s3.amazonaws.com/media/Oracle_square.png)
Supported Response Fields
deductions
Deduction[]employee_payroll_run
stringname
stringemployee_deduction
numbercompany_deduction
numberearnings
Earning[]employee_payroll_run
stringamount
numbertype
stringtaxes
Tax[]employee_payroll_run
stringname
stringamount
numberemployer_tax
booleancheck_date
DateTime (ISO 8601)employee
UUIDend_date
DateTime (ISO 8601)gross_pay
Numbernet_pay
Numberremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstart_date
DateTime (ISO 8601)![OysterHR](https://merge-api-production.s3.amazonaws.com/media/Oyster_square.png)
Supported Response Fields
earnings
Earning[]employee_payroll_run
stringamount
numbertype
stringtaxes
Tax[]employee_payroll_run
stringname
stringamount
numberemployee
UUIDnet_pay
Numberpayroll_run
UUIDremote_data
RemoteData[]path
stringdata
string![Paychex](https://merge-api-production.s3.amazonaws.com/media/Paychex_Square_Logo.png)
Supported Response Fields
deductions
Deduction[]employee_payroll_run
stringname
stringemployee_deduction
numberearnings
Earning[]employee_payroll_run
stringamount
numbertype
stringtaxes
Tax[]employee_payroll_run
stringname
stringamount
numberemployer_tax
booleancheck_date
DateTime (ISO 8601)employee
UUIDend_date
DateTime (ISO 8601)net_pay
Numberpayroll_run
UUIDremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstart_date
DateTime (ISO 8601)![Paylocity](https://merge-api-production.s3.amazonaws.com/media/Paylocity_Square_Logo_LGm1Fdn.png)
Supported Response Fields
deductions
Deduction[]remote_id
stringemployee_payroll_run
stringname
stringemployee_deduction
numbercompany_deduction
numberearnings
Earning[]remote_id
stringemployee_payroll_run
stringamount
numbertype
stringtaxes
Tax[]remote_id
stringemployee_payroll_run
stringname
stringamount
numberemployer_tax
booleancheck_date
DateTime (ISO 8601)employee
UUIDend_date
DateTime (ISO 8601)gross_pay
Numbernet_pay
Numberpayroll_run
UUIDremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstart_date
DateTime (ISO 8601)![Planday](https://merge-api-production.s3.amazonaws.com/media/PlatformPlanday.png)
Supported Response Fields
check_date
DateTime (ISO 8601)employee
UUIDend_date
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringstart_date
DateTime (ISO 8601)![Proliant](https://merge-api-production.s3.amazonaws.com/media/Proliant_Square_Logo.jpg)
Supported Response Fields
deductions
Deduction[]employee_payroll_run
stringname
stringemployee_deduction
numberearnings
Earning[]employee_payroll_run
stringamount
numbertype
stringtaxes
Tax[]employee_payroll_run
stringname
stringamount
numberemployer_tax
booleancheck_date
DateTime (ISO 8601)employee
UUIDend_date
DateTime (ISO 8601)gross_pay
Numbernet_pay
Numberstart_date
DateTime (ISO 8601)![SAP SuccessFactors](https://merge-api-production.s3.amazonaws.com/media/SuccessFactors_Square_Logo_BcXogF0.jpg)
Supported Response Fields
earnings
Earning[]employee_payroll_run
stringamount
numbertype
stringtaxes
Tax[]employee_payroll_run
stringamount
numbercheck_date
DateTime (ISO 8601)employee
UUIDend_date
DateTime (ISO 8601)gross_pay
Numbernet_pay
Numberpayroll_run
UUIDremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstart_date
DateTime (ISO 8601)![TriNet](https://merge-api-production.s3.amazonaws.com/media/Trinet.png)
Supported Response Fields
deductions
Deduction[]employee_payroll_run
stringname
stringcompany_deduction
numberearnings
Earning[]employee_payroll_run
stringamount
numbertype
stringtaxes
Tax[]employee_payroll_run
stringname
stringamount
numberemployer_tax
booleancheck_date
DateTime (ISO 8601)employee
UUIDend_date
DateTime (ISO 8601)gross_pay
Numbernet_pay
Numberpayroll_run
UUIDremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstart_date
DateTime (ISO 8601)![UKG Pro](https://merge-api-production.s3.amazonaws.com/media/UKG_Square_Logo_fl9LQnt.png)
Supported Response Fields
deductions
Deduction[]remote_id
stringemployee_payroll_run
stringname
stringemployee_deduction
numbercompany_deduction
numberearnings
Earning[]remote_id
stringemployee_payroll_run
stringamount
numbertype
stringtaxes
Tax[]remote_id
stringemployee_payroll_run
stringname
stringamount
numbercheck_date
DateTime (ISO 8601)employee
UUIDend_date
DateTime (ISO 8601)gross_pay
Numbernet_pay
Numberpayroll_run
UUIDremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstart_date
DateTime (ISO 8601)![UKG Ready](https://merge-api-production.s3.amazonaws.com/media/UKG_Square_Logo_fl9LQnt_jYRGZr5.png)
Supported Response Fields
deductions
Deduction[]employee_payroll_run
stringname
stringearnings
Earning[]employee_payroll_run
stringamount
numbertype
stringcheck_date
DateTime (ISO 8601)employee
UUIDend_date
DateTime (ISO 8601)payroll_run
UUIDremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstart_date
DateTime (ISO 8601)![Workday](https://merge-api-production.s3.amazonaws.com/media/Workday_Square_Logo.jpg)
Supported Response Fields
deductions
Deduction[]employee_payroll_run
stringname
stringemployee_deduction
numberearnings
Earning[]employee_payroll_run
stringamount
numbertype
stringcheck_date
DateTime (ISO 8601)employee
UUIDend_date
DateTime (ISO 8601)gross_pay
Numbernet_pay
Numberpayroll_run
UUIDremote_data
RemoteData[]path
stringdata
stringstart_date
DateTime (ISO 8601)https://api.merge.dev/api/hris/v1/employee-payroll-runs/{id}
Returns an EmployeePayrollRun
object with the given id
.
expand
Stringid
UUIDinclude_remote_data
Boolean![ADP Workforce Now](https://merge-api-production.s3.amazonaws.com/media/ADP_Square_Logo_GXCPXY1.jpg)
Supported Response Fields
deductions
Deduction[]employee_payroll_run
stringname
stringemployee_deduction
numberearnings
Earning[]employee_payroll_run
stringamount
numbertype
stringtaxes
Tax[]employee_payroll_run
stringname
stringamount
numberemployer_tax
booleancheck_date
DateTime (ISO 8601)employee
UUIDend_date
DateTime (ISO 8601)gross_pay
Numbernet_pay
Numberpayroll_run
UUIDstart_date
DateTime (ISO 8601)![Employment Hero](https://merge-api-production.s3.amazonaws.com/media/Employment-Hero-square.png)
Supported Response Fields
employee
UUIDend_date
DateTime (ISO 8601)net_pay
Numberremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstart_date
DateTime (ISO 8601)![](/static/b5d5c1854759bd0665de50ccff3750f5/35742/gusto_square_image.png)
Supported Response Fields
deductions
Deduction[]employee_payroll_run
stringname
stringemployee_deduction
numberearnings
Earning[]employee_payroll_run
stringamount
numbertype
stringtaxes
Tax[]employee_payroll_run
stringamount
numbercheck_date
DateTime (ISO 8601)employee
UUIDend_date
DateTime (ISO 8601)gross_pay
Numbernet_pay
Numberpayroll_run
UUIDremote_id
Stringstart_date
DateTime (ISO 8601)![Oracle Cloud Human Capital Management (HCM)](https://merge-api-production.s3.amazonaws.com/media/Oracle_square.png)
Supported Response Fields
deductions
Deduction[]employee_payroll_run
stringname
stringemployee_deduction
numbercompany_deduction
numberearnings
Earning[]employee_payroll_run
stringamount
numbertype
stringtaxes
Tax[]employee_payroll_run
stringname
stringamount
numberemployer_tax
booleancheck_date
DateTime (ISO 8601)employee
UUIDend_date
DateTime (ISO 8601)gross_pay
Numbernet_pay
Numberremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstart_date
DateTime (ISO 8601)![OysterHR](https://merge-api-production.s3.amazonaws.com/media/Oyster_square.png)
Supported Response Fields
earnings
Earning[]employee_payroll_run
stringamount
numbertype
stringtaxes
Tax[]employee_payroll_run
stringname
stringamount
numberemployee
UUIDnet_pay
Numberpayroll_run
UUIDremote_data
RemoteData[]path
stringdata
string![Paychex](https://merge-api-production.s3.amazonaws.com/media/Paychex_Square_Logo.png)
Supported Response Fields
deductions
Deduction[]employee_payroll_run
stringname
stringemployee_deduction
numberearnings
Earning[]employee_payroll_run
stringamount
numbertype
stringtaxes
Tax[]employee_payroll_run
stringname
stringamount
numberemployer_tax
booleancheck_date
DateTime (ISO 8601)employee
UUIDend_date
DateTime (ISO 8601)net_pay
Numberpayroll_run
UUIDremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstart_date
DateTime (ISO 8601)![Paylocity](https://merge-api-production.s3.amazonaws.com/media/Paylocity_Square_Logo_LGm1Fdn.png)
Supported Response Fields
deductions
Deduction[]remote_id
stringemployee_payroll_run
stringname
stringemployee_deduction
numbercompany_deduction
numberearnings
Earning[]remote_id
stringemployee_payroll_run
stringamount
numbertype
stringtaxes
Tax[]remote_id
stringemployee_payroll_run
stringname
stringamount
numberemployer_tax
booleancheck_date
DateTime (ISO 8601)employee
UUIDend_date
DateTime (ISO 8601)gross_pay
Numbernet_pay
Numberpayroll_run
UUIDremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstart_date
DateTime (ISO 8601)![Planday](https://merge-api-production.s3.amazonaws.com/media/PlatformPlanday.png)
Supported Response Fields
check_date
DateTime (ISO 8601)employee
UUIDend_date
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringstart_date
DateTime (ISO 8601)![Proliant](https://merge-api-production.s3.amazonaws.com/media/Proliant_Square_Logo.jpg)
Supported Response Fields
deductions
Deduction[]employee_payroll_run
stringname
stringemployee_deduction
numberearnings
Earning[]employee_payroll_run
stringamount
numbertype
stringtaxes
Tax[]employee_payroll_run
stringname
stringamount
numberemployer_tax
booleancheck_date
DateTime (ISO 8601)employee
UUIDend_date
DateTime (ISO 8601)gross_pay
Numbernet_pay
Numberstart_date
DateTime (ISO 8601)![SAP SuccessFactors](https://merge-api-production.s3.amazonaws.com/media/SuccessFactors_Square_Logo_BcXogF0.jpg)
Supported Response Fields
earnings
Earning[]employee_payroll_run
stringamount
numbertype
stringtaxes
Tax[]employee_payroll_run
stringamount
numbercheck_date
DateTime (ISO 8601)employee
UUIDend_date
DateTime (ISO 8601)gross_pay
Numbernet_pay
Numberpayroll_run
UUIDremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstart_date
DateTime (ISO 8601)![TriNet](https://merge-api-production.s3.amazonaws.com/media/Trinet.png)
Supported Response Fields
deductions
Deduction[]employee_payroll_run
stringname
stringcompany_deduction
numberearnings
Earning[]employee_payroll_run
stringamount
numbertype
stringtaxes
Tax[]employee_payroll_run
stringname
stringamount
numberemployer_tax
booleancheck_date
DateTime (ISO 8601)employee
UUIDend_date
DateTime (ISO 8601)gross_pay
Numbernet_pay
Numberpayroll_run
UUIDremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstart_date
DateTime (ISO 8601)![UKG Pro](https://merge-api-production.s3.amazonaws.com/media/UKG_Square_Logo_fl9LQnt.png)
Supported Response Fields
deductions
Deduction[]remote_id
stringemployee_payroll_run
stringname
stringemployee_deduction
numbercompany_deduction
numberearnings
Earning[]remote_id
stringemployee_payroll_run
stringamount
numbertype
stringtaxes
Tax[]remote_id
stringemployee_payroll_run
stringname
stringamount
numbercheck_date
DateTime (ISO 8601)employee
UUIDend_date
DateTime (ISO 8601)gross_pay
Numbernet_pay
Numberpayroll_run
UUIDremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstart_date
DateTime (ISO 8601)![UKG Ready](https://merge-api-production.s3.amazonaws.com/media/UKG_Square_Logo_fl9LQnt_jYRGZr5.png)
Supported Response Fields
deductions
Deduction[]employee_payroll_run
stringname
stringearnings
Earning[]employee_payroll_run
stringamount
numbertype
stringcheck_date
DateTime (ISO 8601)employee
UUIDend_date
DateTime (ISO 8601)payroll_run
UUIDremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstart_date
DateTime (ISO 8601)![Workday](https://merge-api-production.s3.amazonaws.com/media/Workday_Square_Logo.jpg)
Supported Response Fields
deductions
Deduction[]employee_payroll_run
stringname
stringemployee_deduction
numberearnings
Earning[]employee_payroll_run
stringamount
numbertype
stringcheck_date
DateTime (ISO 8601)employee
UUIDend_date
DateTime (ISO 8601)gross_pay
Numbernet_pay
Numberpayroll_run
UUIDremote_data
RemoteData[]path
stringdata
stringstart_date
DateTime (ISO 8601)