Skip to content

Create allowance type

POST/payroll/allowances

Creates a new reusable allowance type with a name, calculation method (fixed or percentage of basic), and taxability flag.

Request

Request body

Content type application/json (required).

FieldTypeRequiredDescription
namestringYes

Max length: 180

calculation_methodstringYes

One of: "fixed", "percentage"

default_valuenumber (float)Yes
is_taxablebooleanNo

Default: true

descriptionstringNo

Example

{
  "name": "Transport Allowance",
  "calculation_method": "fixed",
  "default_value": 200.0,
  "is_taxable": false,
  "description": "Fixed monthly transport allowance for all permanent staff."
}

Responses

201 Allowance type created

422 Validation failed

Example request

curl -X POST "https://{tenant}.faciotech.net/api/v1/payroll/allowances" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"name": "Transport Allowance", "calculation_method": "fixed", "default_value": 200.0, "is_taxable": false, "description": "Fixed monthly transport allowance for all permanent staff."}'
Loading