Skip to main content
GET
Get expenses

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

lastUpdatedDate
string

Date filter - returns all records modified after the specified date

cursor
string

Cursor from the previous paginated response

limit
integer<int32>

Page size, i.e. number of items to return per page

Query Parameters

year
integer<int32>

Year filter (YYYY) - returns all records for the specified year. Null will return all expenses.

type
enum<string>[]

Type filter - returns all expenses for the specified types. Null or empty list will default to PENDING, BUSINESS, & NOT_BUSINESS.

Available options:
BUSINESS,
NOT_BUSINESS,
PENDING,
PAYROLL
status
enum<string>[]

Status filter - returns all expenses for the specified statuses. Null or empty list will default to ACTIVE.

Available options:
ACTIVE,
INACTIVE
includeRecurringParents
boolean

Whether recurring parent expenses should be included in the response. Defaults to true, i.e. all expenses, including recurring parent expenses, will be returned.

Response

200 - application/json

successful operation

data
object[]

The list of entities

lastUpdatedDate
string<date-time>

Date filter - to be used in your subsequent request

cursor
string

Cursor to be used in your subsequent paginated request. Only populated if there are more pages available.

deletedIds
integer<int32>[]

Ids of entities that no longer match the request's filter criteria since the request's lastUpdatedDate