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.
Authorizations
Path Parameters
^([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
^([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)$The fiscal year to explain.
-9007199254740991 <= x <= 9007199254740991Response
Successful response
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.
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.
The id to pass to POST /allowances/{id}/revert-carryover-override.
0 = January, matching the workspace setting.
-9007199254740991 <= x <= 9007199254740991The rule that governed this year, if any.
The rule-granted entitlement after rounding.
The same figure before rounding.
What the entitlement was rounded up to, e.g. 0.5 days.
How much the rounding added: allowance minus raw_allowance.
The manual adjustments of this year.
The next day on which part of the balance expires.
Already expired out of the dated credits.
Still to expire out of them, later this year.
Empty when the year accrued in one go rather than per month.
Null for the member's first year, which carries nothing over.
What was booked out of this year, oldest first.
The individual adjustments that make up adjustments.