latestOpenAPI 3.1.02026-08-22695252.1 KB

ef777d51e6f2

Allowance Management

Switch a member to manual allowance management

Takes the member off automatic accrual for this allowance type from valid_from on. Nothing accrues afterwards, and the balance is whatever you set through adjustments. Pass the member's active assignment as current_assignment_id and it is ended on valid_from in the same transaction; without it, an assignment overlapping valid_from makes the call fail.

post/members/{member_id}/manual-rule

Path parameters

member_idstring uuid required

Request body

allowance_type_idstring uuid required

valid_fromstring required

First day the member is managed manually (inclusive), in YYYY-MM-DD format.

valid_untilstring nullable

Last day of manual management (inclusive), in YYYY-MM-DD format, or null for open-ended.

current_assignment_idinteger nullable

The assignment that is active today, from GET /members/{member_id}/rule-assignments. Send null when the member has none.

reasonstring required

Why the member is managed manually — stored in the rule audit log.

Response

Successful response

successboolean required