Dimensions are the tagging axes on the books: Class, Location, and any custom axis a company defines. Each has a list of values, and revenue, expense, and cost-of-goods postings can carry one value per dimension so reports can be filtered by them. Requires the settings scope. The list returns every dimension in one response; there is no pagination.
Endpoints
GET/api/v1/dimensions
List dimensions
Returns all dimensions with their values for the current organization.
Path & Query Parameters
| Parameter | Type | Description |
|---|
| include_inactive | string | Pass 'true' to include deactivated dimensions and values |
POST/api/v1/dimensions
Create a dimension
Creates a new tracking dimension.
Body Parameters
| Parameter | Type | Description |
|---|
| namerequired | string | Dimension name (must be unique within the organization) |
| required | boolean | Whether this dimension is required on postings (default: false) |
| description | string | Human-readable description |
GET/api/v1/dimensions/:id
Show a dimension
Returns a single dimension with its values.
Path & Query Parameters
| Parameter | Type | Description |
|---|
| idrequired | string | Dimension UUID |
| include_inactive | string | Pass 'true' to include deactivated values |
PATCH/api/v1/dimensions/:id
Update a dimension
Updates a dimension's name, description, required flag, or position.
Path & Query Parameters
| Parameter | Type | Description |
|---|
| idrequired | string | Dimension UUID |
Body Parameters
| Parameter | Type | Description |
|---|
| name | string | New name |
| description | string | New description |
| required | boolean | Whether this dimension is required |
| position | number | Sort position |
PATCH/api/v1/dimensions/:id/deactivate
Deactivate a dimension
Soft-deactivates a dimension. It will no longer appear in active lists.
Path & Query Parameters
| Parameter | Type | Description |
|---|
| idrequired | string | Dimension UUID |
PATCH/api/v1/dimensions/:id/activate
Activate a dimension
Re-activates a previously deactivated dimension.
Path & Query Parameters
| Parameter | Type | Description |
|---|
| idrequired | string | Dimension UUID |
POST/api/v1/dimensions/:dimension_id/values
Create a dimension value
Adds a new value to a dimension.
Path & Query Parameters
| Parameter | Type | Description |
|---|
| dimension_idrequired | string | Parent dimension UUID |
Body Parameters
| Parameter | Type | Description |
|---|
| namerequired | string | Value name (must be unique within the dimension) |
| code | string | Short code (e.g., 'ENG') |
PATCH/api/v1/dimensions/:dimension_id/values/:id
Update a dimension value
Updates a dimension value's name, code, or position.
Path & Query Parameters
| Parameter | Type | Description |
|---|
| dimension_idrequired | string | Parent dimension UUID |
| idrequired | string | Value UUID |
Body Parameters
| Parameter | Type | Description |
|---|
| name | string | New name |
| code | string | New code |
| position | number | Sort position |
PATCH/api/v1/dimensions/:dimension_id/values/:id/deactivate
Deactivate a value
Soft-deactivates a dimension value.
Path & Query Parameters
| Parameter | Type | Description |
|---|
| dimension_idrequired | string | Parent dimension UUID |
| idrequired | string | Value UUID |
PATCH/api/v1/dimensions/:dimension_id/values/:id/activate
Activate a value
Re-activates a previously deactivated dimension value.
Path & Query Parameters
| Parameter | Type | Description |
|---|
| dimension_idrequired | string | Parent dimension UUID |
| idrequired | string | Value UUID |