Skip to main content
GET
Read a member's allowance history

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

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)$
year
integer
Required range: -9007199254740991 <= x <= 9007199254740991

Response

Successful response

id
number
required
createdAt
string
required
year
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
event_type
enum<string>
required
Available options:
BROUGHT_FORWARD_OVERRIDE_SET,
BROUGHT_FORWARD_OVERRIDE_REVERTED,
ALLOWANCE_MANUALLY_EDITED,
ALLOWANCE_LEGACY_EDITED,
ADJUSTMENT_DELETED
old_allowance
number | null
required
new_allowance
number | null
required
old_brought_forward
number | null
required
new_brought_forward
number | null
required
old_compensatory_time_off
number | null
required
new_compensatory_time_off
number | null
required
old_overwrite_brought_forward
boolean | null
required
new_overwrite_brought_forward
boolean | null
required
delta_allowance
number | null
required

Set instead of the old/new pair on entries migrated from the pre-rules history, which only recorded a difference.

delta_brought_forward
number | null
required
delta_compensatory_time_off
number | null
required
comment
string | null
required
actor
object | null
required

Who made the change; null once that member has been deleted.