EmployeePayrollRun
object is used to represent an employee's pay statement for a specific payroll run.id
Stringremote_id
Stringemployee
Stringpayroll_run
Stringgross_pay
Numbernet_pay
Numberstart_date
Stringend_date
Stringcheck_date
Stringearnings
Earning[]Earning
object is used to represent an array of different compensations that an employee receives within specific wage categories.{"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}
id
Stringremote_id
Stringemployee_payroll_run
Stringamount
Numbertype
EnumSALARY
, REIMBURSEMENT
, OVERTIME
, BONUS
, or -
in cases where there is no clear mapping - the original value passed through.remote_was_deleted
Booleanfield_mappings
Objectmodified_at
Stringremote_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": "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}
id
Stringremote_id
Stringemployee_payroll_run
Stringname
Stringemployee_deduction
Numbercompany_deduction
Numberremote_was_deleted
Booleanfield_mappings
Objectmodified_at
Stringremote_data
Arraytaxes
Tax[]Tax
object is used to represent an array of the tax deductions for a given employee's payroll run.{"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}
id
Stringremote_id
Stringemployee_payroll_run
Stringname
Stringamount
Numberemployer_tax
Booleanremote_was_deleted
Booleanfield_mappings
Objectmodified_at
Stringremote_data
Arrayremote_was_deleted
Booleanfield_mappings
Objectmodified_at
Stringremote_data
RemoteData[]{"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}
Returns a list of EmployeePayrollRun
objects.
Authorization
StringX-Account-Token
Stringcreated_after
Stringcreated_before
Stringcursor
Stringemployee_id
Stringended_after
Stringended_before
Stringexpand
Stringinclude_deleted_data
Booleaninclude_remote_data
Booleanmodified_after
Stringmodified_before
Stringpage_size
Integerpayroll_run_id
Stringremote_id
Stringstarted_after
Stringstarted_before
String{"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}]}

Merge supports Passthrough Requests to this platform's API
Supported Response Fields
deductions
Deduction[]employee_payroll_run
stringname
stringemployee_deduction
numberremote_data
arrayearnings
Earning[]employee_payroll_run
stringamount
numbertype
stringtaxes
Tax[]employee_payroll_run
stringname
stringamount
numberemployer_tax
booleancheck_date
Stringemployee
Stringgross_pay
Numbernet_pay
Numberpayroll_run
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
employee
Stringend_date
Stringgross_pay
Numbernet_pay
Numberpayroll_run
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringstart_date
String
Merge supports Passthrough Requests to this platform's API
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
Stringemployee
Stringend_date
Stringgross_pay
Numbernet_pay
Numberpayroll_run
Stringremote_id
Stringstart_date
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
deductions
Deduction[]employee_payroll_run
stringname
stringemployee_deduction
numberremote_data
arrayearnings
Earning[]employee_payroll_run
stringamount
numbertype
stringtaxes
Tax[]employee_payroll_run
stringname
stringamount
numberemployer_tax
booleancheck_date
Stringemployee
Stringend_date
Stringnet_pay
Numberpayroll_run
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringstart_date
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
deductions
Deduction[]remote_id
stringemployee_payroll_run
stringname
stringemployee_deduction
numbercompany_deduction
numberremote_data
arrayearnings
Earning[]remote_id
stringemployee_payroll_run
stringamount
numbertype
stringremote_data
arraytaxes
Tax[]remote_id
stringemployee_payroll_run
stringname
stringamount
numberemployer_tax
booleanremote_data
arraycheck_date
Stringemployee
Stringend_date
Stringgross_pay
Numbernet_pay
Numberpayroll_run
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringstart_date
String
Merge supports Passthrough Requests to this platform's API
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
Stringemployee
Stringend_date
Stringgross_pay
Numbernet_pay
Numberstart_date
String
Merge supports Passthrough Requests to this platform's API
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
numbercheck_date
Stringemployee
Stringend_date
Stringgross_pay
Numbernet_pay
Numberpayroll_run
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringstart_date
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
earnings
Earning[]employee_payroll_run
stringamount
numbertype
stringtaxes
Tax[]employee_payroll_run
stringamount
numbercheck_date
Stringemployee
Stringend_date
Stringgross_pay
Numbernet_pay
Numberpayroll_run
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringstart_date
String
Merge supports Passthrough Requests to this platform's API
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
Stringemployee
Stringend_date
Stringgross_pay
Numbernet_pay
Numberpayroll_run
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringstart_date
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
deductions
Deduction[]remote_id
stringemployee_payroll_run
stringname
stringemployee_deduction
numbercompany_deduction
numberremote_data
arrayearnings
Earning[]remote_id
stringemployee_payroll_run
stringamount
numbertype
stringremote_data
arraytaxes
Tax[]remote_id
stringemployee_payroll_run
stringname
stringamount
numberremote_data
arraycheck_date
Stringemployee
Stringend_date
Stringgross_pay
Numbernet_pay
Numberpayroll_run
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringstart_date
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
deductions
Deduction[]employee_payroll_run
stringname
stringremote_data
arrayearnings
Earning[]employee_payroll_run
stringamount
numbertype
stringcheck_date
Stringemployee
Stringend_date
Stringpayroll_run
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringstart_date
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
deductions
Deduction[]employee_payroll_run
stringname
stringemployee_deduction
numberremote_data
arrayearnings
Earning[]employee_payroll_run
stringamount
numbertype
stringcheck_date
Stringemployee
Stringend_date
Stringgross_pay
Numbernet_pay
Numberpayroll_run
Stringremote_data
RemoteData[]path
stringdata
objectstart_date
StringReturns an EmployeePayrollRun
object with the given id
.
Authorization
StringX-Account-Token
Stringexpand
Stringid
Stringinclude_remote_data
Boolean{"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}

Merge supports Passthrough Requests to this platform's API
Supported Response Fields
deductions
Deduction[]employee_payroll_run
stringname
stringemployee_deduction
numberremote_data
arrayearnings
Earning[]employee_payroll_run
stringamount
numbertype
stringtaxes
Tax[]employee_payroll_run
stringname
stringamount
numberemployer_tax
booleancheck_date
Stringemployee
Stringgross_pay
Numbernet_pay
Numberpayroll_run
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
employee
Stringend_date
Stringgross_pay
Numbernet_pay
Numberpayroll_run
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringstart_date
String
Merge supports Passthrough Requests to this platform's API
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
Stringemployee
Stringend_date
Stringgross_pay
Numbernet_pay
Numberpayroll_run
Stringremote_id
Stringstart_date
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
deductions
Deduction[]employee_payroll_run
stringname
stringemployee_deduction
numberremote_data
arrayearnings
Earning[]employee_payroll_run
stringamount
numbertype
stringtaxes
Tax[]employee_payroll_run
stringname
stringamount
numberemployer_tax
booleancheck_date
Stringemployee
Stringend_date
Stringnet_pay
Numberpayroll_run
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringstart_date
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
deductions
Deduction[]remote_id
stringemployee_payroll_run
stringname
stringemployee_deduction
numbercompany_deduction
numberremote_data
arrayearnings
Earning[]remote_id
stringemployee_payroll_run
stringamount
numbertype
stringremote_data
arraytaxes
Tax[]remote_id
stringemployee_payroll_run
stringname
stringamount
numberemployer_tax
booleanremote_data
arraycheck_date
Stringemployee
Stringend_date
Stringgross_pay
Numbernet_pay
Numberpayroll_run
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringstart_date
String
Merge supports Passthrough Requests to this platform's API
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
Stringemployee
Stringend_date
Stringgross_pay
Numbernet_pay
Numberstart_date
String
Merge supports Passthrough Requests to this platform's API
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
numbercheck_date
Stringemployee
Stringend_date
Stringgross_pay
Numbernet_pay
Numberpayroll_run
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringstart_date
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
earnings
Earning[]employee_payroll_run
stringamount
numbertype
stringtaxes
Tax[]employee_payroll_run
stringamount
numbercheck_date
Stringemployee
Stringend_date
Stringgross_pay
Numbernet_pay
Numberpayroll_run
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringstart_date
String
Merge supports Passthrough Requests to this platform's API
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
Stringemployee
Stringend_date
Stringgross_pay
Numbernet_pay
Numberpayroll_run
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringstart_date
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
deductions
Deduction[]remote_id
stringemployee_payroll_run
stringname
stringemployee_deduction
numbercompany_deduction
numberremote_data
arrayearnings
Earning[]remote_id
stringemployee_payroll_run
stringamount
numbertype
stringremote_data
arraytaxes
Tax[]remote_id
stringemployee_payroll_run
stringname
stringamount
numberremote_data
arraycheck_date
Stringemployee
Stringend_date
Stringgross_pay
Numbernet_pay
Numberpayroll_run
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringstart_date
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
deductions
Deduction[]employee_payroll_run
stringname
stringremote_data
arrayearnings
Earning[]employee_payroll_run
stringamount
numbertype
stringcheck_date
Stringemployee
Stringend_date
Stringpayroll_run
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringstart_date
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
deductions
Deduction[]employee_payroll_run
stringname
stringemployee_deduction
numberremote_data
arrayearnings
Earning[]employee_payroll_run
stringamount
numbertype
stringcheck_date
Stringemployee
Stringend_date
Stringgross_pay
Numbernet_pay
Numberpayroll_run
Stringremote_data
RemoteData[]path
stringdata
objectstart_date
String