v1

latestOpenAPI 3.1.02026-07-242735131.1 MB

Expenses

List expense categories

Lists the effective hierarchy of expense categories. At least one of employment_id, expense_id, or country_code must be provided.

get/v1/expenses/categories

Query parameters

employment_idstring

The employment ID for which to list categories. Required if neither expense_id nor country_code is provided.

expense_idstring

The expense ID for which to list categories (includes the expense's category, even if it is not selectable by default). If provided without employment_id, will use the expense's employment context.

include_parentsboolean

Include un-selectable intermediate categories in the response

country_codestring

Filter categories by country (ISO 3166-1 alpha-3 code, e.g. "GBR"). Only used when neither employment_id nor expense_id is provided.

Response

Success

Example response

{
  "data": [
    {
      "code": "travel",
      "description": "Travel-related expenses",
      "instructions": null,
      "is_selectable": false,
      "parent": null,
      "prompt": null,
      "scope": "global",
      "slug": "travel-abc123",
      "status": "active",
      "title": "Travel"
    },
    {
      "code": "travel.flights",
      "description": "Flight expenses for business travel",
      "instructions": "Please include flight confirmation number",
      "is_selectable": true,
      "parent": {
        "code": "travel",
        "slug": "travel-abc123",
        "title": "Travel"
      },
      "prompt": "What was the purpose of this flight?",
      "scope": "global",
      "slug": "travel-flights-abc123",
      "status": "active",
      "title": "Flights"
    }
  ]
}