Skip to main content
POST
/
reimbursements
Create a reimbursement
curl --request POST \
  --url https://sandbox.nmbr.co/services/payroll/reimbursements \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "work_assignment_id": "<id>",
  "reimbursement_type": "non_taxable_reimbursement",
  "amount": "35",
  "frequency": "per_payroll",
  "effective_from": "2026-01-01",
  "tag_assignment": {
    "unit": "percentage",
    "tag_allocations": [
      {
        "tags": [
          "<id>"
        ],
        "value": 100
      }
    ]
  }
}
'
import requests

url = "https://sandbox.nmbr.co/services/payroll/reimbursements"

payload = {
    "work_assignment_id": "<id>",
    "reimbursement_type": "non_taxable_reimbursement",
    "amount": "35",
    "frequency": "per_payroll",
    "effective_from": "2026-01-01",
    "tag_assignment": {
        "unit": "percentage",
        "tag_allocations": [
            {
                "tags": ["<id>"],
                "value": 100
            }
        ]
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    work_assignment_id: '<id>',
    reimbursement_type: 'non_taxable_reimbursement',
    amount: '35',
    frequency: 'per_payroll',
    effective_from: '2026-01-01',
    tag_assignment: {unit: 'percentage', tag_allocations: [{tags: ['<id>'], value: 100}]}
  })
};

fetch('https://sandbox.nmbr.co/services/payroll/reimbursements', 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/reimbursements",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'work_assignment_id' => '<id>',
    'reimbursement_type' => 'non_taxable_reimbursement',
    'amount' => '35',
    'frequency' => 'per_payroll',
    'effective_from' => '2026-01-01',
    'tag_assignment' => [
        'unit' => 'percentage',
        'tag_allocations' => [
                [
                                'tags' => [
                                                                '<id>'
                                ],
                                'value' => 100
                ]
        ]
    ]
  ]),
  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/reimbursements"

	payload := strings.NewReader("{\n  \"work_assignment_id\": \"<id>\",\n  \"reimbursement_type\": \"non_taxable_reimbursement\",\n  \"amount\": \"35\",\n  \"frequency\": \"per_payroll\",\n  \"effective_from\": \"2026-01-01\",\n  \"tag_assignment\": {\n    \"unit\": \"percentage\",\n    \"tag_allocations\": [\n      {\n        \"tags\": [\n          \"<id>\"\n        ],\n        \"value\": 100\n      }\n    ]\n  }\n}")

	req, _ := http.NewRequest("POST", 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.post("https://sandbox.nmbr.co/services/payroll/reimbursements")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"work_assignment_id\": \"<id>\",\n  \"reimbursement_type\": \"non_taxable_reimbursement\",\n  \"amount\": \"35\",\n  \"frequency\": \"per_payroll\",\n  \"effective_from\": \"2026-01-01\",\n  \"tag_assignment\": {\n    \"unit\": \"percentage\",\n    \"tag_allocations\": [\n      {\n        \"tags\": [\n          \"<id>\"\n        ],\n        \"value\": 100\n      }\n    ]\n  }\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://sandbox.nmbr.co/services/payroll/reimbursements")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"work_assignment_id\": \"<id>\",\n  \"reimbursement_type\": \"non_taxable_reimbursement\",\n  \"amount\": \"35\",\n  \"frequency\": \"per_payroll\",\n  \"effective_from\": \"2026-01-01\",\n  \"tag_assignment\": {\n    \"unit\": \"percentage\",\n    \"tag_allocations\": [\n      {\n        \"tags\": [\n          \"<id>\"\n        ],\n        \"value\": 100\n      }\n    ]\n  }\n}"

response = http.request(request)
puts response.read_body
{
  "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.

Body

application/json
work_assignment_id
string
required
amount
number<decimal>
required

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

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

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
effective_from
string<date>
required

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

business_preset_id
string
reimbursement_type
enum<string>

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

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

Available options:
health_spending_account,
non_taxable_reimbursement,
professional_membership,
taxable_reimbursement,
transit_pass,
wellness_spending_account
effective_to
string<date>

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

expense_accounting_code_id
string
liability_accounting_code_id
string
title
string | null
Maximum string length: 255
title_translations
object | null

Optional translations for the title property.

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 ("reimbursement").

data
Reimbursement · object