NMnmbr
Reimbursements

Update a reimbursement

Changed on
put/reimbursements/{reimbursement}

Request

  • Base URL
    https://sandbox.nmbr.co/services/payroll
  • Auth
    HTTP bearer

Path parameters

reimbursementstring required

Request body

business_preset_idstring
frequency'once' | 'per_month' | 'per_payroll'

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.

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.

amountnumber

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

Up to 2 decimal places.

effective_fromstring date

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.

titlestring nullable
expense_accounting_code_idstring
liability_accounting_code_idstring
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

OK

idstring

The unique identifier of the object in Nmbr.

objectstring

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

Changes

  • e0954625b417Revision changes
    • warning

      added the new grossable enum value to the ///// response property for the response status

    • warning

      added the new included_in_gross_pay enum value to the //////// response property for the response status

  • 9429c5a0b5ceRevision changes
    • warning

      added the new money_moving enum value to the ///// response property for the response status

    • warning

      added the new moves_money enum value to the //////// response property for the response status