Skip to main content
POST
Remove a deduction from a person

Authorizations

Authorization
string
header
required

Server API key, scoped. pk_test_ keys hit the sandbox tenant.

Headers

X-Request-Id
string

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.

Maximum string length: 128

Path Parameters

person_id
string
required

Payroll person id (ppl_…).

Pattern: ^ppl_[0-9A-HJKMNP-TV-Z]{26}$
person_deduction_id
string
required

Person deduction id (pdd_…).

Pattern: ^pdd_[0-9A-HJKMNP-TV-Z]{26}$

Response

The removed deduction.

A deduction added to one person (pdd_…).

id
string
required

pdd_…

object
string
required

Always person_deduction.

Allowed value: "person_deduction"
created_at
string<date-time>
required

RFC 3339, UTC.

Example:

"2026-10-27T08:41:00Z"

person_id
string
required

ppl_…

deduction_type
object
required

The type.

status
enum<string>
required

completed when a loan is repaid or a one-off has been taken; removed by you or on offboarding.

Available options:
active,
completed,
removed
updated_at
string<date-time>

RFC 3339, UTC.

Example:

"2026-10-27T08:41:00Z"

amount
object

Per run, for fixed, loan and one-off.

loan
object

For loans.