Skip to main content
POST
Add an adjustment to a closed retainer pack

Authorizations

Authorization
string
header
required

Authenticate with a Bearer token: API key, OAuth token, or session token.

Path Parameters

id
string<uuid>
required

Retainer pack ID

Body

application/json
amount
number
required

Money returned on the pack, above 0 and at most the net retained amount. Stored positive and shown as a negative line.

comment
string | null

Note on the adjustment, at most 500 characters.

Maximum string length: 500
adjusted_on
string<date> | null

Date of the adjustment (YYYY-MM-DD). Defaults to today.

Response

Adjustment added

success
enum<boolean>
required
Available options:
true
data
object
required