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. To receive all enum values in the original format, use the show_enum_origins query parameter. Learn more.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[]RemoteData
object is used to represent the full data pulled from the third-party API for an object.path
Stringdata
Anyhttps://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
Booleaninclude_shell_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)
Supported Response Fields
earnings
Earning[]employee_payroll_run
stringamount
numberemployee
UUIDend_date
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringstart_date
DateTime (ISO 8601)
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
UUIDremote_data
RemoteData[]path
stringdata
stringstart_date
DateTime (ISO 8601)
Supported Response Fields
employee
UUIDend_date
DateTime (ISO 8601)net_pay
Numberremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstart_date
DateTime (ISO 8601)
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
Numberpayroll_run
UUIDremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstart_date
DateTime (ISO 8601)
Supported Response Fields
earnings
Earning[]remote_id
stringemployee_payroll_run
stringamount
numbertype
stringemployee
UUIDremote_data
RemoteData[]path
stringdata
stringremote_id
String
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)
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
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)
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)
Supported Response Fields
check_date
DateTime (ISO 8601)employee
UUIDend_date
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringstart_date
DateTime (ISO 8601)
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)
Supported Response Fields
earnings
Earning[]remote_id
stringemployee_payroll_run
stringamount
numbertype
stringemployee
UUIDgross_pay
Numberremote_data
RemoteData[]path
stringdata
stringstart_date
DateTime (ISO 8601)
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)
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)
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)
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)
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
Supported Response Fields
earnings
Earning[]employee_payroll_run
stringamount
numberemployee
UUIDend_date
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringstart_date
DateTime (ISO 8601)
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
UUIDremote_data
RemoteData[]path
stringdata
stringstart_date
DateTime (ISO 8601)
Supported Response Fields
employee
UUIDend_date
DateTime (ISO 8601)net_pay
Numberremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstart_date
DateTime (ISO 8601)
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
Numberpayroll_run
UUIDremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstart_date
DateTime (ISO 8601)
Supported Response Fields
earnings
Earning[]remote_id
stringemployee_payroll_run
stringamount
numbertype
stringemployee
UUIDremote_data
RemoteData[]path
stringdata
stringremote_id
String
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)
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
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)
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)
Supported Response Fields
check_date
DateTime (ISO 8601)employee
UUIDend_date
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringstart_date
DateTime (ISO 8601)
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)
Supported Response Fields
earnings
Earning[]remote_id
stringemployee_payroll_run
stringamount
numbertype
stringemployee
UUIDgross_pay
Numberremote_data
RemoteData[]path
stringdata
stringstart_date
DateTime (ISO 8601)
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)
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)
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)
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)
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)
