Skip to main content
POST
Create an allowance adjustment

Authorizations

X-API-KEY
string
header
required

Path Parameters

member_id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Body

application/json
allowance_type_id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
amount
number
required

Adjustment amount (positive to add, negative to subtract). For day-based allowance types the value is in days; for hour-based allowance types the value is in MINUTES (e.g. 480 = 8 hours).

Required range: -100000 <= x <= 100000
date
string
required

Effective date of the adjustment in YYYY-MM-DD format

Pattern: ^\d{4}-\d{2}-\d{2}$
expiry_date
string | null

Optional expiry date in YYYY-MM-DD format after which the adjustment is revoked. Only allowed for positive adjustments.

Pattern: ^\d{4}-\d{2}-\d{2}$
comment
string
default:""

Optional comment for audit trail (max 500 characters)

Maximum string length: 500

Response

Successful response

id
number
required