ABabsentify
Allowance Management

List a member's allowances

Changed on

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}.

Allowance figures are computed at the time of the call. An allowance type without a rule assignment, and a workspace that still uses flat allowances, report the stored figures, and only years with a stored row are listed. An allowance's updatedAt is when its stored row was last written, not when the figures were computed.

get/members/{member_id}/allowances

Request

  • Base URL
    https://api.absentify.com/api/v1
  • URL
    https://api.absentify.com/api/v1/members/{member_id}/allowances
  • Auth
    API key in header X-API-KEY

Path parameters

member_idstring uuid required

Query parameters

yearinteger
allowance_type_idstring uuid
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

Compensatory time off of this year, including approved overtime credits. Days for day-based allowance types, MINUTES for hour-based ones. On an allowance type with overtime logging, or with credited overtime in that year, it cannot be changed through PUT /members/{id}/allowance/{allowance_type_id}/{year}: log overtime with POST /overtime-entries instead.

takennumber required

Booked and approved out of this year.

remainingnumber required

What is left to book.

carry_overnumber required

Compatibility alias for allowance carried over from the previous year into this 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

Changes

  • 844a3fad80f7Revision changes
    • info

      added the new optional query request parameter allowance_type_id

  • 00323426aebdRevision changes
    • warning

      changed the pattern of the path request parameter member_id from ^([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)$ to ^([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})$