Update an allowance

curl --request PUT \
  --url https://sandbox.nmbr.co/services/payroll/allowances/{allowance} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "frequency": "per_month",
  "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"
  },
  "effective_from": "2026-01-01",
  "effective_to": "2026-12-31",
  "external_ref": "01KFNHG3MNRS84XF1ERW0M7HP0",
  "date_basis": "by_period_start_date",
  "pay_period_cadence": [
    1
  ]
}
'

import requests

url = "https://sandbox.nmbr.co/services/payroll/allowances/{allowance}"

payload = {
    "frequency": "per_month",
    "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"
    },
    "effective_from": "2026-01-01",
    "effective_to": "2026-12-31",
    "external_ref": "01KFNHG3MNRS84XF1ERW0M7HP0",
    "date_basis": "by_period_start_date",
    "pay_period_cadence": [1]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    frequency: 'per_month',
    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'},
    effective_from: '2026-01-01',
    effective_to: '2026-12-31',
    external_ref: '01KFNHG3MNRS84XF1ERW0M7HP0',
    date_basis: 'by_period_start_date',
    pay_period_cadence: [1]
  })
};

fetch('https://sandbox.nmbr.co/services/payroll/allowances/{allowance}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandbox.nmbr.co/services/payroll/allowances/{allowance}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'frequency' => 'per_month',
    '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'
    ],
    'effective_from' => '2026-01-01',
    'effective_to' => '2026-12-31',
    'external_ref' => '01KFNHG3MNRS84XF1ERW0M7HP0',
    'date_basis' => 'by_period_start_date',
    'pay_period_cadence' => [
        1
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox.nmbr.co/services/payroll/allowances/{allowance}"

	payload := strings.NewReader("{\n  \"frequency\": \"per_month\",\n  \"allowance_type\": \"cell_phone_allowance\",\n  \"amount\": \"75.25\",\n  \"title\": \"Cell phone allowance\",\n  \"title_translations\": {\n    \"en\": \"Cell phone allowance\",\n    \"fr\": \"Allocation de téléphone cellulaire\"\n  },\n  \"effective_from\": \"2026-01-01\",\n  \"effective_to\": \"2026-12-31\",\n  \"external_ref\": \"01KFNHG3MNRS84XF1ERW0M7HP0\",\n  \"date_basis\": \"by_period_start_date\",\n  \"pay_period_cadence\": [\n    1\n  ]\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://sandbox.nmbr.co/services/payroll/allowances/{allowance}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"frequency\": \"per_month\",\n  \"allowance_type\": \"cell_phone_allowance\",\n  \"amount\": \"75.25\",\n  \"title\": \"Cell phone allowance\",\n  \"title_translations\": {\n    \"en\": \"Cell phone allowance\",\n    \"fr\": \"Allocation de téléphone cellulaire\"\n  },\n  \"effective_from\": \"2026-01-01\",\n  \"effective_to\": \"2026-12-31\",\n  \"external_ref\": \"01KFNHG3MNRS84XF1ERW0M7HP0\",\n  \"date_basis\": \"by_period_start_date\",\n  \"pay_period_cadence\": [\n    1\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox.nmbr.co/services/payroll/allowances/{allowance}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"frequency\": \"per_month\",\n  \"allowance_type\": \"cell_phone_allowance\",\n  \"amount\": \"75.25\",\n  \"title\": \"Cell phone allowance\",\n  \"title_translations\": {\n    \"en\": \"Cell phone allowance\",\n    \"fr\": \"Allocation de téléphone cellulaire\"\n  },\n  \"effective_from\": \"2026-01-01\",\n  \"effective_to\": \"2026-12-31\",\n  \"external_ref\": \"01KFNHG3MNRS84XF1ERW0M7HP0\",\n  \"date_basis\": \"by_period_start_date\",\n  \"pay_period_cadence\": [\n    1\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "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>"
  }
}

PUT

allowances

{allowance}

Update an allowance

curl --request PUT \
  --url https://sandbox.nmbr.co/services/payroll/allowances/{allowance} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "frequency": "per_month",
  "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"
  },
  "effective_from": "2026-01-01",
  "effective_to": "2026-12-31",
  "external_ref": "01KFNHG3MNRS84XF1ERW0M7HP0",
  "date_basis": "by_period_start_date",
  "pay_period_cadence": [
    1
  ]
}
'

import requests

url = "https://sandbox.nmbr.co/services/payroll/allowances/{allowance}"

payload = {
    "frequency": "per_month",
    "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"
    },
    "effective_from": "2026-01-01",
    "effective_to": "2026-12-31",
    "external_ref": "01KFNHG3MNRS84XF1ERW0M7HP0",
    "date_basis": "by_period_start_date",
    "pay_period_cadence": [1]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    frequency: 'per_month',
    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'},
    effective_from: '2026-01-01',
    effective_to: '2026-12-31',
    external_ref: '01KFNHG3MNRS84XF1ERW0M7HP0',
    date_basis: 'by_period_start_date',
    pay_period_cadence: [1]
  })
};

fetch('https://sandbox.nmbr.co/services/payroll/allowances/{allowance}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandbox.nmbr.co/services/payroll/allowances/{allowance}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'frequency' => 'per_month',
    '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'
    ],
    'effective_from' => '2026-01-01',
    'effective_to' => '2026-12-31',
    'external_ref' => '01KFNHG3MNRS84XF1ERW0M7HP0',
    'date_basis' => 'by_period_start_date',
    'pay_period_cadence' => [
        1
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox.nmbr.co/services/payroll/allowances/{allowance}"

	payload := strings.NewReader("{\n  \"frequency\": \"per_month\",\n  \"allowance_type\": \"cell_phone_allowance\",\n  \"amount\": \"75.25\",\n  \"title\": \"Cell phone allowance\",\n  \"title_translations\": {\n    \"en\": \"Cell phone allowance\",\n    \"fr\": \"Allocation de téléphone cellulaire\"\n  },\n  \"effective_from\": \"2026-01-01\",\n  \"effective_to\": \"2026-12-31\",\n  \"external_ref\": \"01KFNHG3MNRS84XF1ERW0M7HP0\",\n  \"date_basis\": \"by_period_start_date\",\n  \"pay_period_cadence\": [\n    1\n  ]\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://sandbox.nmbr.co/services/payroll/allowances/{allowance}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"frequency\": \"per_month\",\n  \"allowance_type\": \"cell_phone_allowance\",\n  \"amount\": \"75.25\",\n  \"title\": \"Cell phone allowance\",\n  \"title_translations\": {\n    \"en\": \"Cell phone allowance\",\n    \"fr\": \"Allocation de téléphone cellulaire\"\n  },\n  \"effective_from\": \"2026-01-01\",\n  \"effective_to\": \"2026-12-31\",\n  \"external_ref\": \"01KFNHG3MNRS84XF1ERW0M7HP0\",\n  \"date_basis\": \"by_period_start_date\",\n  \"pay_period_cadence\": [\n    1\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox.nmbr.co/services/payroll/allowances/{allowance}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"frequency\": \"per_month\",\n  \"allowance_type\": \"cell_phone_allowance\",\n  \"amount\": \"75.25\",\n  \"title\": \"Cell phone allowance\",\n  \"title_translations\": {\n    \"en\": \"Cell phone allowance\",\n    \"fr\": \"Allocation de téléphone cellulaire\"\n  },\n  \"effective_from\": \"2026-01-01\",\n  \"effective_to\": \"2026-12-31\",\n  \"external_ref\": \"01KFNHG3MNRS84XF1ERW0M7HP0\",\n  \"date_basis\": \"by_period_start_date\",\n  \"pay_period_cadence\": [\n    1\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "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.

Path Parameters

allowance

string

required

Body

application/json

business_preset_id

string

frequency

enum<string>

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

allowance_type

enum<string>

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

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,

vehicle_allowance_non_taxable

amount

number<decimal>

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

Required range: 0 <= x <= 99999

title

string | null

Maximum string length: 255

title_translations

object | null

Optional translations for the title property.

Hide child attributes

title_translations.en

string

Maximum string length: 255

title_translations.fr

string

Maximum string length: 255

effective_from

string<date>

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

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

Hide child attributes

tag_assignment.unit

enum<string>

Available options:

percentage

tag_assignment.is_component_locked

boolean

tag_assignment.tag_allocations

object[]

Hide child attributes

tag_assignment.tag_allocations.tags

string[]

tag_assignment.tag_allocations.value

number<decimal>

Required range: x >= 0

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

200 - application/json

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

Hide child attributes

data.work_assignment

object

Hide child attributes

data.work_assignment.id

string

read-only

The unique identifier of the object in Nmbr.

data.work_assignment.object

string

read-only

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

data.allowance_type

object

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

Hide child attributes

data.allowance_type.id

string

read-only

The unique identifier of the object in Nmbr.

data.allowance_type.object

string

read-only

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

data.allowance_type.data

Allowance Type · object

Hide child attributes

data.allowance_type.data.type

string | null

The string identifier for this allowance type.

data.allowance_type.data.label

string | null

The human-readable display name for this allowance type.

data.allowance_type.data.features

object[]

Hide child attributes

data.allowance_type.data.features.type

enum<string>

The payroll calculation this entry describes.

Available options:

eht,

income_tax,

insurable,

pensionable,

vacationable,

wcb

data.allowance_type.data.features.label

string

Human-readable name for the payroll calculation.

data.allowance_type.data.features.definitions

object[]

How this type affects the calculation, broken down by jurisdiction. Jurisdictions where it does not apply are omitted.

Hide child attributes

data.allowance_type.data.features.definitions.jurisdiction

string

The jurisdiction this applies to (e.g. ca_federal, ca_on, ca_qc).

data.allowance_type.data.features.definitions.effects

enum<string>[]

How this type affects the payroll calculation in this jurisdiction.

Available options:

accrues_vacation_pay,

reduces_base,

tax_credit,

withholding

data.allowance_type.data.features.definitions.help_text

string | null

Plain-language explanation of how this type affects the calculation in this jurisdiction.

data.allowance_type.data.features.definitions.program_label

string | null

The program that applies in this jurisdiction, for calculations that use different programs by jurisdiction (e.g. CPP federally, QPP in Quebec; EI federally, QPIP in Quebec).

data.allowance_type.data.form_mappings

object[]

Hide child attributes

data.allowance_type.data.form_mappings.form

string

The form code (e.g. t4).

data.allowance_type.data.form_mappings.form_label

string

Human-readable form name.

data.allowance_type.data.form_mappings.mapping

object[][]

The boxes on the form this type contributes to.

Hide child attributes

data.allowance_type.data.form_mappings.mapping.name

string

The box or line identifier on the form.

data.allowance_type.data.form_mappings.mapping.help_text

string | null

Plain-language explanation of the box, when available.

data.title

string | null

data.title_translations

object | null

Optional translations for the title property.

Hide child attributes

data.title_translations.en

string

Maximum string length: 255

data.title_translations.fr

string

Maximum string length: 255

data.title_translated

string

read-only

The translation of the title property for the request locale. Computed using the values in title and title_translations and the value of the request's Accept-Language header.

data.amount

number<decimal>

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

data.frequency

enum<string>

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

data.date_basis

enum<string> | null

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

data.pay_period_cadence

object | null

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.

data.effective_from

string<date>

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

data.effective_to

string<date> | null

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

data.business_preset

any

data.expense_accounting_code

any

data.liability_accounting_code

any

data.external_ref

string | null

A reference to the object in an external system, e.g. the primary key of the object in your application's database. Nmbr doesn't use, validate, parse, or require this value to be unique - it simply stores it for your reference.

Maximum string length: 255

data.created_at

string<dateTime>

read-only

The date and time the object was created in Nmbr.

data.updated_at

string<dateTime>

read-only

The date and time the object was last updated in Nmbr.

Retrieve an allowance Delete an allowance

⌘I