Skip to main content
GET
Explain one year of a member's allowance

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

The fiscal year to explain.

Required range: -9007199254740991 <= x <= 9007199254740991

Response

Successful response

legacy_unmigrated
boolean
required

True when this member has not been moved to the rules engine yet. Every other field is then null or empty: there is no rule-based breakdown to report.

no_allowance_for_year
boolean
required

True when the member has no allowance of this type in this year at all, for instance because no rule ever covered it. Every other field is then null or empty.

member_allowance_id
string | null
required

The id to pass to POST /allowances/{id}/revert-carryover-override.

fiscal_year_start_month
integer
required

0 = January, matching the workspace setting.

Required range: -9007199254740991 <= x <= 9007199254740991
active_rule
object | null
required

The rule that governed this year, if any.

allowance
number
required

The rule-granted entitlement after rounding.

raw_allowance
number
required

The same figure before rounding.

rounding_increment
number | null
required

What the entitlement was rounded up to, e.g. 0.5 days.

rounding_delta
number
required

How much the rounding added: allowance minus raw_allowance.

adjustments
number
required

The manual adjustments of this year.

brought_forward
number
required
overwrite_brought_forward
boolean
required
taken
number
required
remaining
number
required
will_expire
number
required
expired
number
required
expiration
number
required
carry_forward_deadline
string | null
required
next_credit_expiry
string | null
required

The next day on which part of the balance expires.

credit_expiration_past
number
required

Already expired out of the dated credits.

credit_expiration_future
number
required

Still to expire out of them, later this year.

monthly_accruals
object[]
required

Empty when the year accrued in one go rather than per month.

carry_forward_detail
object | null
required

Null for the member's first year, which carries nothing over.

deductions
object[]
required

What was booked out of this year, oldest first.

adjustment_details
object[]
required

The individual adjustments that make up adjustments.