Skip to main content
PUT
Update expense report (fields format of expense report)

Authorizations

Authorization
string
header
required

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

Path Parameters

expenseReportId
string
required

Id of the expense report. UUID without dashes (32-character hex string)

Pattern: ^[0-9a-fA-F]{32}$

Query Parameters

format
string
required

Info about the structure passed in the body of request Parameter should be set to 'fields' value

forceSave
boolean

When true, saves the report even if non-blocking validation warnings exist; validation errors still abort. Defaults to false.

Body

application/json

Fields format of expense report

meta
object

Field-builder metadata for the expense report. Contains the summary, the caller's capability flags, and a preview URL.

fields
object[]

Field-builder array describing the expense report's editable values. Each entry pairs a property name with a value and any errors.

Response

OK

comment
string
dateCreated
string
read-only
emailRecipients
string
expenseRecords
object[]
id
string
version
integer<int64>

Optimistic-lock counter, incremented on every update. Echo this value back in the request body of a PUT to detect if the report was changed by someone else since it was read; a mismatch returns 409.

lastUpdated
string
meta
object
name
string
organizationId
string

UUID without dashes (32-character hex string)

Pattern: ^[0-9a-fA-F]{32}$
personId
string

UUID without dashes (32-character hex string)

Pattern: ^[0-9a-fA-F]{32}$
previewUrl
string
read-only
reportNumber
string
sent
string
read-only
status
enum<string>
read-only
Available options:
APPROVAL,
APPROVED,
READY_TO_SEND,
BULK_TRANSFER,
ERROR,
NEW,
NORMAL,
PAID,
REJECTED,
SEND,
SENT,
TRANSFER,
TRANSFER_TO_RECIPIENT
processStatus
enum<string>
read-only
Available options:
DRAFT,
PROCESSING,
PROCESSED,
REJECTED
reimbursement
number
read-only
reimbursementCurrency
string
read-only
approvalChainId
string
read-only
type
enum<string>
read-only
Available options:
AUTOMATIC,
MANUAL,
COMPANY_CARD
customFields
object[]