payroll runs list
GET {{baseUrl}}/payroll-runs
Returns a list of PayrollRun 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. | |
ended_after | string | If provided, will only return payroll runs ended after this datetime. | |
ended_before | string | If provided, will only return payroll runs ended before this datetime. | |
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. | |
remote_fields | string | Which fields should be returned in non-normalized form. | |
remote_id | string | The API provider's ID for the given object. | |
run_type | string | If provided, will only return PayrollRun's with this status. Options: ('REGULAR', 'OFF_CYCLE', 'CORRECTION', 'TERMINATION', 'SIGN_ON_BONUS') | |
started_after | string | If provided, will only return payroll runs started after this datetime. | |
started_before | string | If provided, will only return 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":"37336947-b3d4-4a4c-a310-ab6ab510e079","remote_id":"19202938","run_state":"APPROVED","run_type":"OFF_CYCLE","start_date":"2020-11-08T00:00:00Z","end_date":"2020-11-15T00:00:00Z","check_date":"2020-11-15T00:00:00Z","remote_data":[{"path":"deserunt Lorem","data":{"ipsum69":{},"adipisicingf":{}}},{"path":"dolore quis Excepteur","data":{"proident1d":{},"et_2":{}}}],"remote_was_deleted":false},{"id":"37336947-b3d4-4a4c-a310-ab6ab510e079","remote_id":"19202938","run_state":"PAID","run_type":"SIGN_ON_BONUS","start_date":"2020-11-08T00:00:00Z","end_date":"2020-11-15T00:00:00Z","check_date":"2020-11-15T00:00:00Z","remote_data":[{"path":"proi","data":{"minim1f":{},"tempor_4":{}}},{"path":"enim ad velit eu","data":{"esse_305":{},"consequatbe":{}}}],"remote_was_deleted":false}]}