Skip to main content
GET
List expense reports

Authorizations

Authorization
string
header
required

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

Path Parameters

partnerId
string
required

The id of the partner for which we retrieve expense reports UUID without dashes (32-character hex string)

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

Query Parameters

statuses
enum<string>[]

Comma separated list of statuses to include, to exclude a status use ! before the status

Available options:
APPROVAL,
APPROVED,
BULK_TRANSFER,
DELETED,
ERROR,
NEW,
NORMAL,
ON_HOLD,
PAID,
READY_TO_SEND,
REJECTED,
REVIEW,
SEND,
SENT,
TRANSFER,
TRANSFER_TO_RECIPIENT
include
enum<string>[]

Comma-separated list of strings used to include additional data in the response. Accepted values:

  • expenseRecords: Include all expense records in the report
  • approvalChain: Include approval chain information (hasRejectedExpenseRecords, hasIncorrectApprovalChains, currentApproverInfo, approvalAllowed)
  • sendChain: Include send chain information (sendChain, hasIncorrectApprovalChains)
  • employeeId: Include the employee ID of the report owner
  • validationErrors: Include the validation errors of the report and of its expenses
  • tag: Include tag information (simulatedCardReport, integrationTest, dimensions)
  • externalReports: Include reports an integration module is still working on, under meta.externalReports
  • meta.violations: Include the report's policy violations
  • meta.messages: Include the direct messages attached to the report
  • meta.autoApproval: Include the AI review guidance verdict for the report
  • meta.ids: Include the ids of every report matching the filter, ignoring pagination, under meta.ids
Available options:
expenseRecords,
approvalChain,
sendChain,
employeeId,
validationErrors,
tag,
externalReports,
meta.violations,
meta.messages,
meta.autoApproval,
meta.ids
max
integer<int>
default:10

max records to return

Required range: 1 <= x <= 1000
offset
integer<int>
default:0

the offset to be used in list

Required range: x >= 0
q
string

Parameter used in the search

reportGroup
integer

Zero based index of the report group to return, used by the Ready to send tab to split a large listing into slices. Reports are assigned to a group by their creation time, so the groups are stable and disjoint. Only applied when the owner is configured with more than one group (an organization's reportGroupSettings.numberOfRTSGroups, or a partner's numberOfReportGroups); otherwise the parameter is ignored and the full listing is returned.

Required range: x >= 0

Response

200 - application/json

OK

meta
object
data
object[]