Skip to main content

List Cost Categories

GET 

/api/cost-categories

List all cost categories, ordered by name.

Not yet available to API tokens

This endpoint currently requires session authentication; Personal Access Token scope support is in progress.

Each category includes its default_nominal_code_id and, when set, an embedded default_nominal_code object ({id, code, name}). The default nominal code is the account a landed-cost bill line assigned to this category posts its debit to by default (an explicit nominal code on the line still wins; if the category has no default, posting falls back to the nominal code mapping settings).

Query parameters:

  • selectable (boolean) — exclude system categories
  • is_active (boolean) — filter by active/archived
  • with_usage_counts (boolean) — include usage counts

Authentication: Requires Bearer token.

Request

Responses

OK

Response Headers
    Content-Type