Sign in

v1

latestOpenAPI 3.1.02026-07-26549156879.0 KB
Timeoff > AllowanceIncidence

Updates an Allowance incidence

Updates an allowance incidence

put/api/2026-07-01/resources/timeoff/allowance_incidences/{id}

Path parameters

idstring required

Request body

idstring required
days_in_centsinteger

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

timeoff_allowance_idstring

Allowance Id

descriptionstring

A free text field to add a description to the incidence

effective_onstring

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

target_balance'available' | 'accrued'

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

Example request

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

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
}