latestOpenAPI 3.1.02026-08-22695252.1 KB

ef777d51e6f2

Allowance Management

List rule assignments for a member

Returns all rule assignments for a member. Optionally filter by allowance type.

get/members/{member_id}/rule-assignments

Path parameters

member_idstring uuid required

Query parameters

allowance_type_idstring uuid

Response

Successful response

idnumber required
rule_start_datestring required

First day the assignment itself applies (inclusive). This is the assignment's own validity, which is independent of the member: it does not account for a member who joined after it began. Matches what POST and PATCH accept, so values can be round-tripped — use coverage_start_date to see when the member actually starts accruing.

coverage_start_datestring required

First day this MEMBER actually accrues under the assignment (inclusive): rule_start_date, moved forward to the member's employment_start_date when they joined after the assignment began and before it ended. For an assignment that ended on or before the member's employment start, the member never accrued under it at all and this field simply equals rule_start_date (that state is detectable as rule_end_date <= employment_start_date). Read-only and derived — POST and PATCH do not accept it, and writing it back into rule_start_date would freeze a hire date that is still editable.

rule_end_datestring nullable required

Last day the rule applies (inclusive), or null for open-ended. Matches what POST and PATCH accept, so values can be round-tripped.

allowance_type_idstring required
rule_idstring required