Sign in

v5

latestOpenAPI 3.0.02026-08-044441026.8 MB
Reimbursements

Create a reimbursement

post/reimbursements

Request body

work_assignment_idstring required
business_preset_idstring
reimbursement_type'health_spending_account' | 'non_taxable_reimbursement' | 'professional_membership' | 'taxable_reimbursement' | 'transit_pass' | 'wellness_spending_account'

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.

amountnumber required

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

frequency'once' | 'per_month' | 'per_payroll' 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.

effective_fromstring date required

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

effective_tostring date

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

expense_accounting_code_idstring
liability_accounting_code_idstring
titlestring nullable
external_refstring
date_basis'by_pay_date' | 'by_period_end_date' | 'by_period_start_date'

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

pay_period_cadenceinteger[]

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.

Response

Created

idstring

The unique identifier of the object in Nmbr.

objectstring

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