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

Autorisierungen

X-API-KEY
string
header
erforderlich

Pfadparameter

member_id
string<uuid>
erforderlich
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$

Abfrageparameter

allowance_type_id
string<uuid>
erforderlich
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
year
integer
erforderlich

The fiscal year to explain.

Erforderlicher Bereich: -9007199254740991 <= x <= 9007199254740991
locale
enum<string>
Verfügbare Optionen:
en,
de,
fr,
hu,
it,
pl,
pt,
ru,
es,
tr,
uk

Antwort

Successful response

legacy_unmigrated
boolean
erforderlich

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
erforderlich

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
erforderlich

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

fiscal_year_start_month
integer
erforderlich

0 = January, matching the workspace setting.

Erforderlicher Bereich: -9007199254740991 <= x <= 9007199254740991
active_rule
object | null
erforderlich

The rule that governed this year, if any.

allowance
number
erforderlich

The rule-granted entitlement after rounding.

raw_allowance
number
erforderlich

The same figure before rounding.

rounding_increment
number | null
erforderlich

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

rounding_mode
enum<string> | null
erforderlich

How the entitlement is rounded: up to rounding_increment, or a fraction of half a day or more up to a full day.

Verfügbare Optionen:
increment,
half_day_threshold
rounding_delta
number
erforderlich

How much the rounding added: allowance minus raw_allowance.

adjustments
number
erforderlich

The manual adjustments of this year.

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

The next day on which part of the balance expires.

credit_expiration_past
number
erforderlich

Already expired out of the dated credits.

credit_expiration_future
number
erforderlich

Still to expire out of them, later this year.

monthly_accruals
object[]
erforderlich

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

carry_forward_detail
object | null
erforderlich

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

deductions
object[]
erforderlich

What was booked out of this year, oldest first.

adjustment_details
object[]
erforderlich

The individual adjustments that make up adjustments.