Skip to main content
POST
/
allowances
Create an allowance
curl --request POST \
  --url https://sandbox.nmbr.co/services/payroll/allowances \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "work_assignment_id": "<id>",
  "allowance_type": "cell_phone_allowance",
  "amount": "75.25",
  "title": "Cell phone allowance",
  "title_translations": {
    "en": "Cell phone allowance",
    "fr": "Allocation de téléphone cellulaire"
  },
  "frequency": "per_month",
  "effective_from": "2026-01-01",
  "effective_to": "2026-12-31",
  "external_ref": "01KFNHG3MNRS84XF1ERW0M7HP0",
  "tag_assignment": {
    "unit": "percentage",
    "tag_allocations": [
      {
        "tags": [
          "<id>"
        ],
        "value": 100
      }
    ]
  },
  "date_basis": "by_period_start_date",
  "pay_period_cadence": [
    1
  ]
}
'
{
  "id": "<id>",
  "object": "allowance",
  "data": {
    "work_assignment": {
      "id": "<id>",
      "object": "work_assignment",
      "links": {
        "self": "/work_assignments/<id>"
      }
    },
    "allowance_type": {
      "id": "<id>",
      "object": "allowance_type",
      "data": {
        "type": "cell_phone_allowance",
        "label": "Cell phone allowance"
      },
      "links": {
        "self": "/allowance_types/cell_phone_allowance"
      }
    },
    "title": "Cell phone allowance",
    "title_translations": {
      "en": "Cell phone allowance",
      "fr": "Allocation de téléphone cellulaire"
    },
    "title_translated": "Cell phone allowance",
    "amount": 75.25,
    "frequency": "per_month",
    "date_basis": "by_period_start_date",
    "pay_period_cadence": [
      1
    ],
    "effective_from": "2026-01-01",
    "effective_to": "2026-12-31",
    "business_preset": null,
    "expense_accounting_code": null,
    "liability_accounting_code": null,
    "external_ref": "01KFNHG3MNRS84XF1ERW0M7HP0",
    "created_at": "2026-01-01T00:00:00.000000Z",
    "updated_at": "2026-01-01T00:00:00.000000Z"
  },
  "links": {
    "self": "/allowances/<id>"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
work_assignment_id
string
required

Must belong to a work assignment associated with an entity of type Employee.

​
amount
number<decimal>
required

The monetary amount applied each time this allowance is included on a Pay Stub.

Required range: 0 <= x <= 99999
​
frequency
enum<string>
required

The frequency at which this allowance is applied to Pay Stubs. When per_month, the amount is distributed evenly across all Payrolls in the calendar month.

Available options:
once,
per_month,
per_payroll
​
effective_from
string<date>
required

The date from which this allowance is applied to Pay Stubs.

​
business_preset_id
string
​
allowance_type
enum<string>

The type of allowance, which determines how it is taxed and reported on Pay Stubs.

Must be present when business_preset_id is either empty or not set.

Available options:
automobile_and_motor_vehicle,
cell_phone_allowance,
child_care_expenses,
child_eduction_non_taxable,
child_eduction_taxable,
clothing_non_taxable,
clothing_taxable,
education_and_professional_development,
housing_allowance_cash,
internet_allowance,
meals_taxable,
moving_allowance_non_taxable,
moving_allowance_taxable,
municipal_officers_expense,
non_taxable_allowance,
overtime_meals_non_taxable,
parking_allowance,
professional_membership,
professional_membership_dues_taxable,
social_event_allowance,
taxable_cash_allowance,
tools_allowance,
transit_pass,
travelling_allowance_non_taxable,
travelling_allowance_taxable,
utilities_allowance
​
title
string | null
Maximum string length: 255
​
title_translations
object

Optional translations for the title property.

​
effective_to
string<date>

The date after which this allowance is no longer applied. null if the allowance applies indefinitely.

​
expense_accounting_code_id
string
​
liability_accounting_code_id
string
​
external_ref
string
Maximum string length: 255
​
tag_assignment
object
​
date_basis
enum<string>

Which payroll date determines the calendar month for the allocation. Applies only to per_month recurrences.

Available options:
by_pay_date,
by_period_end_date,
by_period_start_date
​
pay_period_cadence
integer[]

Which pay periods within the month receive the allocation. An array of 1-based positions; -1 is the final period. Applies only to per_month recurrences.

Minimum array length: 1

Response

201 - application/json

Created

​
id
string
read-only

The unique identifier of the object in Nmbr.

​
object
string
read-only

The type of the object in Nmbr ("allowance").

​
data
Allowance · object