Gets a collection of expenses

GET/jsonapi/expenses

Access

Bearer authentication. Confirm your scopes, data access and required adviser context.

Request parameters

filter query

filterarray

·Array itemstring

sort query

sortarray

·Array itemstring

page query

pageobjectPagination ↗

·sizeinteger

format: int32

·numberinteger

format: int32

include query

includearray

·Array itemstring

Example request

Use your supplied API base URL and replace path placeholders such as {id}. These examples run in your backend or terminal, where your credentials are kept.

curl --globoff --request GET "${API_BASE_URL}/jsonapi/expenses" \
  --header "Authorization: Bearer $ACCESS_TOKEN" \
  --header "UserId: $ADVISER_CONTACT_ID" \
  --header 'Accept: application/vnd.api+json'

Responses

200 response

application/vnd.api+json

Example response body

Generated from the OpenAPI Specification with illustrative values. Shows primary data and attributes where defined; optional links, relationships and included resources are omitted. Actual values and returned fields depend on your request and access.

{
  "data": [
    {
      "type": "expenses",
      "id": "1001",
      "attributes": {
        "updated": "2026-01-15T09:00:00Z",
        "created": "2026-01-15T09:00:00Z",
        "description": "string",
        "value": 1,
        "expenseTypeId": 1,
        "frequency": "string",
        "expenseCategory": "string",
        "expenseType": "string",
        "expenseCategoryId": 1
      }
    }
  ]
}

200 responseobjectExpensesDocument ↗

metaobjectread only

jsonApiobjectread only

linksall ofread only

dataarrayrequired

includedarray · nullableread only

For guidance beyond this operation's schema, see troubleshooting and JSON:API explained.