API Reference

List expense reports for organization

get
https://stage-api.findity.com/api/v1/admin/organizations//reports

Lists expense reports for the specified organization.

Path Params
string
required

The organization id

Query Params
statuses
array of strings

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

statuses
include
array of strings

Parameter used to include additional data in the response. Available options:

  • expenseRecords: Include all expense records in the report
  • approvalChain: Include approval chain information (reminderSentToApprover, hasRejectedExpenseRecords, hasIncorrectApprovalChains, currentApproverInfo, approvalAllowed)
  • sendChain: Include send chain information (sendChain, hasIncorrectApprovalChains)
  • employeeId: Include the employee ID of the report owner
  • 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
include
integer
1 to 1000
Defaults to 10

Max records to return

integer
≥ 0
Defaults to 0

Offset to be used in list

string

Parameter used in the search

string
Defaults to lastUpdated:desc

Sort parameter for expense reports. Accepts one or more sorting criteria in the format property:direction, where property is one of name, dateCreated, sent, reportNumber, ownerName, totalAmount, organizationName, organizationNumber, approved, lastUpdated, paid, status, employeeId, dueDate; and direction is either asc or desc. Multiple criteria can be provided as a comma-separated list. Default is lastUpdated:desc. Company card listings (companyCardOnly=true) always append owner last name ascending as a secondary sort, so the order within tied values is stable across pages.

string
enum

Filter ON_HOLD reports by substatus

Allowed:
date

Used for filtering

date

Used for filtering

boolean
Defaults to false

When true, only company card expense reports are returned. The response meta will also include aggregated totalAmount and totalExpenses for the whole filtered set.

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

Filters the listing to reports whose next recipient is this one, meaning the step with the lowest sortOrder among the steps still in TRANSFER_TO_RECIPIENT. Used by the Ready to send tab, which is split per recipient. Only applied to organization listings.

integer
≥ 0

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.

Response

Updated 5 months ago

Did this page help you?
Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 5 months ago

Did this page help you?