deductions list
GET {{baseUrl}}/deductions
Returns a list of Deduction 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_payroll_run_id | string | If provided, will only return deductions for this employee payroll run. | |
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_id | string | The API provider's ID for the given object. |
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":"5fd439fc-1b64-4755-b275-64918936c365","employee_payroll_run":"35347df1-95e7-46e2-93cc-66f1191edca5","name":"Social Security","employee_deduction":34.54,"company_deduction":78.78,"remote_data":[{"path":"nostrud nisi","data":{"elit0":{},"aliqua_92":{},"eiusmod_a6b":{}}},{"path":"dolore ea officia sed dolor","data":{"cillum_1":{},"aute_de":{}}}],"remote_was_deleted":true},{"id":"5fd439fc-1b64-4755-b275-64918936c365","employee_payroll_run":"35347df1-95e7-46e2-93cc-66f1191edca5","name":"Social Security","employee_deduction":34.54,"company_deduction":78.78,"remote_data":[{"path":"amet eu deserunt elit","data":{"quis_04":{},"aliquip_d3":{},"ut_5":{}}},{"path":"aute elit proident cupidata","data":{"et4c7":{},"in_04":{}}}],"remote_was_deleted":false}]}