latestOpenAPI 3.1.02026-08-22695252.1 KB

ef777d51e6f2

Allowance Management

Explain one year of a member's allowance

How the figures of one fiscal year came about: which rule was active, what accrued month by month, what was carried over, what expired and what was booked. This is the calculation the app shows in the ledger.

get/members/{member_id}/allowance-breakdown

Path parameters

member_idstring uuid required

Query parameters

allowance_type_idstring uuid required

yearinteger required

The fiscal year to explain.

locale'en' | 'de' | 'fr' | 'hu' | 'it' | 'pl' | 'pt' | 'ru' | 'es' | 'tr' | 'uk'

Response

Successful response

legacy_unmigratedboolean 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_yearboolean 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_idstring nullable required

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

fiscal_year_start_monthinteger required

0 = January, matching the workspace setting.

allowancenumber required

The rule-granted entitlement after rounding.

raw_allowancenumber required

The same figure before rounding.

rounding_incrementnumber nullable required

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

rounding_deltanumber required

How much the rounding added: allowance minus raw_allowance.

adjustmentsnumber required

The manual adjustments of this year.

brought_forwardnumber required

overwrite_brought_forwardboolean required

takennumber required

remainingnumber required

will_expirenumber required

expirednumber required

expirationnumber required

carry_forward_deadlinestring nullable required

next_credit_expirystring nullable required

The next day on which part of the balance expires.

credit_expiration_pastnumber required

Already expired out of the dated credits.

credit_expiration_futurenumber required

Still to expire out of them, later this year.