Skip to content
Last updated

Categories / Chart of Accounts API

The Categories API lets you manage your chart of accounts — the categories and subcategories used to classify spend. This document describes the category and subcategory objects and the available endpoints.

Category Object

PropertyTypeDescription
_idstringUnique identifier for the category
groupidstringIdentifier of the group the category belongs to
namestringName of the category
descriptionstringDescription of the category
statusstringCurrent status (e.g., "ACTIVE", "ARCHIVED")
subcategoriesarray of objectsSubcategories under this category
createdAtstring (ISO 8601 date-time)When the category was created
updatedAtstring (ISO 8601 date-time)When the category was last updated
__vnumberVersion number (internal use)

Subcategory Object

PropertyTypeDescription
_idstringUnique identifier for the subcategory
group_idstringIdentifier of the group
categorystringParent category identifier
codestringAccounting code for the subcategory
namestringName of the subcategory
descriptionstringDescription of the subcategory
statusstringCurrent status (e.g., "ACTIVE", "ARCHIVED")
teamsarray of stringsTeams the subcategory applies to
mapping_idstringExternal mapping identifier
createdAtstring (ISO 8601 date-time)When the subcategory was created
updatedAtstring (ISO 8601 date-time)When the subcategory was last updated
__vnumberVersion number (internal use)

API Endpoints

The following endpoints are available for managing your chart of accounts. See the full reference: Categories / Chart of Accounts API.

List Categories

Retrieves all categories (with their subcategories) for the business.

GET /v1/categories

Create a Category

POST /v1/categories
{
  "name": "Transport",
  "description": "Travel and transport spend",
  "status": "ACTIVE"
}

Update a Category

PATCH /v1/categories/{categoryId}

Archive a Category

DELETE /v1/categories/{categoryId}

Create a Subcategory

POST /v1/categories/{categoryId}/subcategories

Update a Subcategory

PATCH /v1/categories/{categoryId}/subcategories/{subcategoryId}

Archive a Subcategory

DELETE /v1/categories/{categoryId}/subcategories/{subcategoryId}

All requests require your API key in the x-api-key header — see Authentication.