Expense Reports

GET /accounting/expense-reports

Group: Accounting › Expense Reports · Operation ID: expenseReports

Returns a list of expense reports. Each entry is the report header. Read one report with its expense items from GET accounting/expense-reports/:id or POST accounting/expense-reports/search.

Open in the interactive reference

Parameters

Name	In	Type	Required	Description
`Api-Version`	header	`"v1"`	yes	The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version `v1`.

Query surface

id — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
expenseNumber — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
status — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
paymentStatus — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
submittedDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
reimbursementCurrency — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
externalExpenseReportId — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
origin — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
lastModifiedDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
Orderable: id, expenseNumber, status, paymentStatus, submittedDate, reimbursementCurrency, reimbursableTotal, openAmount, lastModifiedDate
Selectable: id, expenseNumber, status, paymentStatus, submittedDate, reimbursementCurrency, reimbursableTotal, reimbursableTotalNetAmount, amountPaid, openAmount, pendingAmount, containsBillableItem, pendingPayment, externalExpenseReportId, origin, employeeName, entityName, lastModifiedDate

Response

200 Success

Under data, an array of expenseReportsRow:

Field	Type	Required	Description
`id`	string	no	The unique identifier for the expense report.
`expenseNumber`	string or null	no	The expense number.
`status`	string or null	no	The approval status of the report. Values include 'draft', 'pendingApproval', 'approved', 'rejected' and 'paid'.
`paymentStatus`	string or null	no	The payment status of the report.
`submittedDate`	string (date) or null	no	The date the employee submitted the report. Format YYYY-MM-DD.
`reimbursementCurrency`	string or null	no	The currency the report is reimbursed in. Format ISO 4217, for example 'USD'. Governs every header total below.
`reimbursableTotal`	string (decimal) or null	no	The total reimbursable amount across the report's items, in reimbursementCurrency.
`reimbursableTotalNetAmount`	string (decimal) or null	no	The total reimbursable amount excluding VAT, in reimbursementCurrency.
`amountPaid`	string (decimal) or null	no	The amount already reimbursed to the employee, in reimbursementCurrency.
`openAmount`	string (decimal) or null	no	The amount still owed to the employee, reimbursableTotal minus amountPaid, in reimbursementCurrency.
`pendingAmount`	string (decimal) or null	no	The amount committed to an in-flight payment run but not yet paid, in reimbursementCurrency.
`containsBillableItem`	boolean or null	no	Whether at least one item on the report is marked billable to a customer.
`pendingPayment`	boolean or null	no	Whether a payment for this report is in flight.
`externalExpenseReportId`	string or null	no	The identifier this report has in the upstream system that produced it. It is not unique.
`origin`	string or null	no	The source system this report came from, as free-form text.
`employeeName`	string or null	no	The name of the employee the report belongs to.
`entityName`	string or null	no	The name of the legal entity the report is posted under.
`lastModifiedDate`	string (date-time) or null	no	The date and time the expense report last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.

Statuses

400 — Invalid request or business failure
401 — Missing or invalid access token
403 — Not authorized
404 — Not found
429 — Too many requests
500 — Internal server error