FAfactorialhr
Timeoff > AllowanceIncidence

Reads a single Allowance incidence

Changed on

Reads a single Allowance incidence

get/api/2026-10-01/resources/timeoff/allowance_incidences/{id}

Request

  • Base URL
    https://api.factorialhr.com
  • URL
    https://api.factorialhr.com/api/2026-10-01/resources/timeoff/allowance_incidences/{id}
  • Auth
    • OAuth 2
      Authorization code: https://id.factorialhr.com/oauth/authorize
      Token URL: https://id.factorialhr.com/api/oauth/token scopes: time_off
    • or API key in header x-api-key

Path parameters

idstring required

Response

OK

idstring required

Unique identifier of the allowance incidence

employee_idstring required

Employee id of the affected employee

descriptionstring

Optional comment regarding the incidence

days_in_centsinteger required

How many units * 100 does the incidence add/substract. Can be positive or negative. Example is one unit

timeoff_allowance_idstring required

To what allowance does the incidence affect. It will dictate if its days or hours

effective_onstring required

When does the incidence take effect; this is for time off cycles calculations.

target_balancestring

Whether the incidence affects the Accrued or the Available counter.

created_atinteger required

Unix timestamp when the DB record was created

updated_atinteger required

Unix timestamp when the DB record was last updated

Example response

{
  "id": "1",
  "employee_id": "1",
  "description": "Added because working on a holiday",
  "days_in_cents": 100,
  "timeoff_allowance_id": "2",
  "effective_on": "2024-01-02",
  "target_balance": "accrued",
  "created_at": 1723623354,
  "updated_at": 1723623354
}

Changes