Skip to main content
POST
Create Reimbursement

Authorizations

Authorization
string
header
required

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

Headers

X-MultiTenantKey
string

Required when using a Platform API token. The tenant key identifying which business to operate on.

Body

application/json

Create reimbursement request payload. Identify the worker with exactly one of userId or personId.

title
string
required

A short title describing the reimbursement.

Example:

"Client dinner"

currency
string
required

The currency the entry amounts are denominated in.

Example:

"USD"

destinationCurrency
string
required

The currency the worker is reimbursed in.

Example:

"USD"

entries
object[]
required

The individual line items that make up the reimbursement.

userId
string<uuid>

The worker the reimbursement is for. Provide either userId or personId.

Example:

"a3b4c5d6-e7f8-9012-abcd-ef3456789012"

personId
string<uuid>

The worker the reimbursement is for, identified by their personId within the tenant. Provide either userId or personId.

Example:

"c5d6e7f8-9012-3456-cdef-789012345678"

Response

The created reimbursement's id

id
string<uuid>