Skip to main content
GET
List a member's allowances

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

year
integer
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

id
string
erforderlich
member_id
string
erforderlich
allowance_type_id
string
erforderlich
year
integer
erforderlich
Erforderlicher Bereich: -9007199254740991 <= x <= 9007199254740991
start
string
erforderlich

First day of the fiscal year (inclusive).

end
string
erforderlich

Last day of the fiscal year (inclusive).

allowance
number
erforderlich

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

rule_allowance
number
erforderlich

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.

adjustments
number
erforderlich

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

brought_forward
number
erforderlich

Carried over from the previous year into this one.

overwrite_brought_forward
boolean
erforderlich

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

compensatory_time_off
number
erforderlich

Overtime compensation credited to this year.

taken
number
erforderlich

Booked and approved out of this year.

remaining
number
erforderlich

What is left to book.

carry_over
number
erforderlich

Compatibility alias for allowance carried over from the previous year into this one.

will_expire
number
erforderlich

Of remaining, how much expires later this year.

expired
number
erforderlich

How much has already expired this year.

carry_forward_deadline
string
erforderlich

The day carried-over balance expires.

expiring_adjustments
object | null
erforderlich

Positive adjustments of this year that expire in the future, if any. Always null when the year filter is used.

allowance_type
object
erforderlich
createdAt
string
erforderlich
updatedAt
string
erforderlich