employee payroll runs list
GET {{baseUrl}}/employee-payroll-runs
Returns a list of EmployeePayrollRun objects.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
created_after | string | If provided, will only return objects created after this datetime. | |
created_before | string | If provided, will only return objects created before this datetime. | |
cursor | string | The pagination cursor value. | |
employee_id | string | If provided, will only return employee payroll runs for this employee. | |
ended_after | string | If provided, will only return employee payroll runs ended after this datetime. | |
ended_before | string | If provided, will only return employee payroll runs ended before this datetime. | |
expand | string | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | |
include_deleted_data | boolean | Whether to include data that was marked as deleted by third party webhooks. | |
include_remote_data | boolean | Whether to include the original data Merge fetched from the third-party to produce these models. | |
modified_after | string | If provided, will only return objects modified after this datetime. | |
modified_before | string | If provided, will only return objects modified before this datetime. | |
page_size | number | Number of results to return per page. | |
payroll_run_id | string | If provided, will only return employee payroll runs for this employee. | |
remote_id | string | The API provider's ID for the given object. | |
started_after | string | If provided, will only return employee payroll runs started after this datetime. | |
started_before | string | If provided, will only return employee payroll runs started before this datetime. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
X-Account-Token | string | (Required) Token identifying the end user. | |
Accept | string |
RESPONSES
status: OK
{"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":[{"id":"e3a825fd-c38d-4095-a717-df98c4cb9ebc","employee_payroll_run":"35347df1-95e7-46e2-93cc-66f1191edca5","name":"California State Income Tax","amount":100.25,"employer_tax":true,"remote_was_deleted":false},{"id":"e3a825fd-c38d-4095-a717-df98c4cb9ebc","employee_payroll_run":"35347df1-95e7-46e2-93cc-66f1191edca5","name":"California State Income Tax","amount":100.25,"employer_tax":true,"remote_was_deleted":true}],"remote_data":[{"path":"exercitation commodo","data":{"Excepteurc":{},"occaecat1f":{},"in_9f":{},"tempord53":{}}},{"path":"reprehenderit pariatur ut","data":{"elit52":{}}}],"remote_was_deleted":true},{"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":[{"id":"e3a825fd-c38d-4095-a717-df98c4cb9ebc","employee_payroll_run":"35347df1-95e7-46e2-93cc-66f1191edca5","name":"California State Income Tax","amount":100.25,"employer_tax":false,"remote_was_deleted":false},{"id":"e3a825fd-c38d-4095-a717-df98c4cb9ebc","employee_payroll_run":"35347df1-95e7-46e2-93cc-66f1191edca5","name":"California State Income Tax","amount":100.25,"employer_tax":false,"remote_was_deleted":false}],"remote_data":[{"path":"consectetur fugiat sit","data":{"commodo_235":{},"Excepteur_83":{},"ad48":{}}},{"path":"Excepteur pariatur","data":{"cillum_4":{},"deserunt0":{}}}],"remote_was_deleted":false}]}