Expense

Object

id

legacyId

Legacy ID as returned by API V1. Avoid relying on this field as it may be removed in the future.

description

Title/main description for this expense

longDescription

Longer description for this expense

reference

User-provided reference number or any other identifier that references the invoice

amount

Total amount of the expense (sum of the item's amounts).

amountV2

Total amount of the expense

taxes

Taxes applied to this expense

accountCurrencyFxRate

The exchange rate between the expense currency and the account currency

accountingCategory

The accounting category attached to this expense

valuesByRole

If available, this field will contain a breakdown of the expense values depending on who edited it

createdAt

The time of creation

currency

Currency that should be used for the payout

type

Whether this expense is a receipt or an invoice

status

The state of the expense (pending, approved, paid, rejected...etc)

approvedBy

The accounts who approved this expense

paidBy

The account who paid this expense

onHold

Whether this expense is on hold

comments

Returns the list of comments for this expense, or null if user is not allowed to see them

account

The account where the expense was submitted

payee

The account being paid by this expense

payeeLocation

The address of the payee

createdByAccount

The account who created this expense

host

The account from where the expense was paid

payoutMethod

The payout method to use for this expense

paymentMethod

virtualCard

The virtual card used to pay for this charge

attachedFiles

(Optional) files attached to the expense

invoiceFile

(Optional - applicable to invoice expense only) The invoice file for this expense

items

privateMessage

Additional information about the payment as HTML. Only visible to user and admins.

invoiceInfo

Information to display on the invoice. Only visible to user and admins.

feesPayer

The fees payer for this expense

permissions

The permissions given to current logged in user for this expense

activities

The list of activities (ie. approved, edited, etc) for this expense ordered by date ascending

tags

requiredLegalDocuments

Returns the list of legal documents required from the payee before the expense can be payed. Must be logged in.

legalDocuments

Returns the list of legal documents attached to this expense. Must be logged in as a host admin.

draft

Drafted field values that were still not persisted

requestedByAccount

The account that requested this expense to be submitted

quote

validateTransferRequirements

recurringExpense

securityChecks

[Admin only] Security checks for this expense. Only available to expenses under trusted hosts.

draftKey

[Host Admin only] Key to access the draft of this expense

customData

Custom data for this expense

merchantId

The merchant ID for this expense

transferReference

The reference text used in the payment transfer

lockedFields

Fields that cannot be edited on this expense

transactionImportRow

[Host admins only] If the expense associated with a transactions import row, this field will reference it