List expense reports for organization

get

https://stage-api.findity.com/api/v1/admin/organizations/{organizationId}/reports

Lists expense reports for the specified organization.

Path Params

organizationId

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)

include

Allowed:

max

integer

1 to 1000

Defaults to 10

Max records to return

offset

integer

≥ 0

Defaults to 0

Offset to be used in list

string

Parameter used in the search

sort

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.

filterStatus

string

enum

Filter ON_HOLD reports by substatus

Allowed:

fromDate

date

Used for filtering

toDate

date

Used for filtering

companyCardOnly

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.

Response

Language

Credentials

Bearer

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK