List deductions added to a person
Person-specific deductions only. Company-wide ones are in pay.deductions on the person.
Error codes: invalid_api_key, parameter_invalid, resource_not_found, scope_missing, rate_limited.
Authorizations
Server API key, scoped. pk_test_ keys hit the sandbox tenant.
Headers
Optional client correlation id, up to 128 characters. It is not echoed: the response's X-Request-Id is always
our own req_… id. We log your value with the request as client_request_id, so support can find a request by
either id. A longer value is refused with 400 parameter_invalid.
128Path Parameters
Payroll person id (ppl_…).
^ppl_[0-9A-HJKMNP-TV-Z]{26}$Query Parameters
Comma-separated statuses. Default active.
active, completed, removed Response
The person's deductions.
Cursor page. Domain files compose this with allOf and set data.items.
"list"Items, newest first.
True when another page exists.
Cursor for the next page in the same direction: pass it as after if this page was read with after (or no cursor), as before if it was read with before. Null when has_more is false.
Only when include=total_count was sent.