Skip to main content
POST
Create a reimbursement

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