List reimbursement categories

Authorization

Send one of these on every request. See Authentication for how to get credentials.

• API key

  Basic authentication header of the form Basic <api_key>, where <api_key> is your api key.

• Bearer token

Query parameters

• entityIds array

  Restrict to categories available for these company entities

• sort string

  Sort string in the format field:direction. To provide multiple sort fields, separate them with commas.

  Available directions: asc, desc.

  Available fields: createdAt, label.

• filter string

  Filter string in the format field:operator:value. To provide multiple filters, separate them with commas.

  Available operators: eq, ne, in, not_in, gt, gte, lt, lte.

  • For in and not_in operators, provide multiple values separated by the pipe character (|).

  Available fields: label, status, id, createdAt.

• searchTerm string

  Matches against the category label

• limit integer · int32

  Maximum number of items to return. Default is 50, maximum is 200.

• offset integer · int64deprecated

  Number of items to skip before starting to collect the result set. Deprecated, use 'cursor' instead.

• cursor string

  The cursor position to start returning results from. To opt-in into cursor-based pagination, provide 0 for the initial request. For subsequent requests, use nextCursor and prevCursor from the previous response to navigate. Cursor values are opaque and should not be constructed manually.

Response

• records array of object

  List of records for the current page

  • id string · uuid

    Unique identifier for the reimbursement category

  • companyId string · uuid

    ID of the company

  • companyEntityIds array of string · uuid

    Company entities this category is available for

  • label string

    Display name of the category

  • accountId string · uuid

    GL account a reimbursement line with this category books to

  • taxCodeId string · uuid

    Tax code applied to a reimbursement line with this category

  • context string

    Free-text guidance describing when the category applies

  • status string

    Status of the reimbursement category

    ⚠️ This enum is not exhaustive; new values may be added in the future.

    One of ACTIVE

  • createdAt string · date-time

    Timestamp when the reimbursement category was created

  • updatedAt string · date-time

    Timestamp when the reimbursement category was last updated

• hasMore boolean

  Boolean flag indicating if there are more records available

• total integer · int64deprecated

  Total number of records (only for offset pagination). This field is not guaranteed to be returned and only available for offset pagination, please do not rely on it and migrate to cursor pagination.

• nextCursor string

  Cursor for fetching the next page (only for cursor pagination)

• prevCursor string

  Cursor for fetching the previous page (only for cursor pagination)