Skip to main content
GET
List a member's allowances

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)$

Query Parameters

year
integer
Required range: -9007199254740991 <= x <= 9007199254740991

Response

Successful response

id
string
required
member_id
string
required
allowance_type_id
string
required
year
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
start
string
required

First day of the fiscal year (inclusive).

end
string
required

Last day of the fiscal year (inclusive).

allowance
number
required

The entitlement of this year: rule_allowance plus adjustments. Same meaning as the allowance field on GET /members/{id}.

rule_allowance
number
required

The part of the entitlement the allowance rule granted. For a year still on the pre-rules data it holds the stored entitlement, and adjustments is 0.

adjustments
number
required

The part that came from manual adjustments, overtime compensation excluded.

brought_forward
number
required

Carried over from the previous year into this one.

overwrite_brought_forward
boolean
required

True when an admin set the carry-over by hand instead of letting it be computed.

compensatory_time_off
number
required

Overtime compensation credited to this year.

taken
number
required

Booked and approved out of this year.

remaining
number
required

What is left to book.

carry_over
number
required

What this year hands to the next one.

will_expire
number
required

Of remaining, how much expires later this year.

expired
number
required

How much has already expired this year.

carry_forward_deadline
string
required

The day carried-over balance expires.

expiring_adjustments
object | null
required

Positive adjustments of this year that expire in the future, if any. Always null when the year filter is used.

allowance_type
object
required
createdAt
string
required
updatedAt
string
required