FAfactorialhr
Timeoff > AllowanceIncidence

Creates an Allowance incidence

Changed on

Creates an allowance incidence, also known as an Allowance Adjustment in the Employee Time off Page. They are hours or days added or subtracted from the time off allowance

post/api/2026-10-01/resources/timeoff/allowance_incidences

Request

  • Base URL
    https://api.factorialhr.com
  • URL
    https://api.factorialhr.com/api/2026-10-01/resources/timeoff/allowance_incidences
  • 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

Request body

employee_idstring required

Employee Id

timeoff_allowance_idstring required

Allowance Id

days_in_centsinteger required

How many units multiplied by 100 do you want to add/substract. Can be positive or negative

descriptionstring

A free text field to add a description to the incidence

effective_onstring required

When does the incidence take effect. This is related to the allowance cycle.

target_balance'available' | 'accrued' required

Which counter does the incidence affect. Can be "accrued" or "available"

_skip_notificationsboolean

When set to true, it prevents notifications being sent to employee when this incidence is created

Example request

{
  "employee_id": "6",
  "timeoff_allowance_id": "1",
  "days_in_cents": 100,
  "description": "Working on a bank holiday a different day",
  "effective_on": "2024-01-05",
  "target_balance": "accrued"
}

Response

CREATED

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