Skip to content

List allowance types

GET/payroll/allowances

Returns all configured allowance types (e.g. transport, housing, meal allowances) available for assignment to employees.

Request

This endpoint takes no parameters and no request body.

Responses

200 List of allowance types

Content type application/json, array of object · AllowanceTypeV1.

FieldTypeRequiredDescription
idintegerNo
namestringNo
calculation_methodstringNo

Whether the allowance is a fixed amount or a percentage of the employee's basic salary.

One of: "fixed", "percentage"

default_valuenumber (float)No

Default amount or percentage used when the allowance is assigned without override.

is_taxablebooleanNo

Whether this allowance is subject to PAYE income tax.

descriptionstring, nullableNo

Example request

curl -X GET "https://{tenant}.faciotech.net/api/v1/payroll/allowances" \
  -H "Accept: application/json"
Loading