Skip to main content
PUT
/
reimbursements
/
{reimbursement}
Update a reimbursement
curl --request PUT \
  --url https://sandbox.nmbr.co/services/payroll/reimbursements/{reimbursement} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "frequency": "per_payroll",
  "reimbursement_type": "non_taxable_reimbursement",
  "amount": "35",
  "effective_from": "2026-01-01"
}
'
{
  "id": "<id>",
  "object": "reimbursement",
  "data": {
    "work_assignment": {
      "id": "<id>",
      "object": "work_assignment",
      "links": {
        "self": "/work_assignments/<id>"
      }
    },
    "reimbursement_type": {
      "id": "<id>",
      "object": "reimbursement_type",
      "data": {
        "type": "non_taxable_reimbursement",
        "label": "Non-Taxable Reimbursement"
      },
      "links": {
        "self": "/reimbursement_types/non_taxable_reimbursement"
      }
    },
    "title": null,
    "title_translations": null,
    "title_translated": null,
    "frequency": "per_payroll",
    "date_basis": null,
    "pay_period_cadence": null,
    "amount": 35,
    "effective_from": "2026-01-01",
    "effective_to": null,
    "business_preset": null,
    "expense_accounting_code": null,
    "liability_accounting_code": null,
    "external_ref": null,
    "created_at": "2026-01-01T00:00:00.000000Z",
    "updated_at": "2026-01-01T00:00:00.000000Z"
  },
  "links": {
    "self": "/reimbursements/<id>"
  }
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
reimbursement
string
required

Body

application/json
​
business_preset_id
string
​
frequency
enum<string>

The frequency at which this reimbursement 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
​
reimbursement_type
enum<string>

The type of reimbursement, which determines how it is categorized and reported on Pay Stubs.

Available options:
health_spending_account,
non_taxable_reimbursement,
professional_membership,
taxable_reimbursement,
transit_pass,
wellness_spending_account
​
amount
number<decimal>

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

Required range: 0 <= x <= 99999
​
effective_from
string<date>

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

​
effective_to
string<date>

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

​
title
string | null
Maximum string length: 255
​
title_translations
object

Optional translations for the title property.

​
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

200 - application/json

OK

​
id
string
read-only

The unique identifier of the object in Nmbr.

​
object
string
read-only

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

​
data
Reimbursement · object