Sign in
latestOpenAPI 3.1.02026-08-22695252.1 KB

ef777d51e6f2

Allowance Management

List a member's allowances

Every fiscal year of every allowance type the member can use, oldest first. Allowance types that are switched off for this member are left out. This is the read side of the deprecated PUT /members/{id}/allowance/{allowance_type_id}/{year}.

get/members/{member_id}/allowances

Path parameters

member_idstring uuid required

Query parameters

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

Response

Successful response

idstring required
member_idstring required
allowance_type_idstring required
yearinteger required
startstring required

First day of the fiscal year (inclusive).

endstring required

Last day of the fiscal year (inclusive).

allowancenumber required

The entitlement of this year: rule_allowance plus adjustments. Same meaning as the allowance field on GET /members/{id}.

rule_allowancenumber required

The part of the entitlement the allowance rule granted. For a year still on the pre-rules data it holds the stored entitlement, and adjustments is 0.

adjustmentsnumber required

The part that came from manual adjustments, overtime compensation excluded.

brought_forwardnumber required

Carried over from the previous year into this one.

overwrite_brought_forwardboolean required

True when an admin set the carry-over by hand instead of letting it be computed.

compensatory_time_offnumber required

Overtime compensation credited to this year.

takennumber required

Booked and approved out of this year.

remainingnumber required

What is left to book.

carry_overnumber required

What this year hands to the next one.

will_expirenumber required

Of remaining, how much expires later this year.

expirednumber required

How much has already expired this year.

carry_forward_deadlinestring required

The day carried-over balance expires.

createdAtstring required
updatedAtstring required