Sintropix Dimensions API: Reporting Axes and Values

Dimensions are reporting axes you define for an Organization. Each Dimension holds Dimension Values that tag Ledger Entry Lines. Only lines on Result Accounts (income and expense types) can carry Dimension Values. This page covers full CRUD for both Dimensions and their Values.

Open in the app. This resource has a page in the Sintropix web app at https://app.sintropix.com/organizations/{organizationId}/settings/dimensions?dimension={dimensionId}, where each id in braces is the same UUID as in the API route or response. The page lives in the Organization's Configuración, under Dimensiones. Take organizationId from any Entity of the Organization. When you mention a record to a user, include that link. See Link to the App for the full URL grammar.

Dimensions belong to the Organization

A Dimension and its Values belong to the Organization, not to one Entity. Every Entity of the Organization can tag its lines with every Value, so one Dimension splits the results of all its Entities the same way.

A Dimension name is unique in the Organization. A Value code is unique in its Dimension.
A rename, a recode, or a move in the hierarchy applies to every Entity of the Organization, whichever Entity you make it from.
Each Entity keeps its own lines and tags. When you book or retag a line, dimensionValueIds must name Values of the Entity’s Organization.
You can’t delete a Value while a line of any Entity of the Organization carries it.
The Income Statement by Dimension stays per Entity: it lists the Organization’s Values and adds up that Entity’s lines.
An Entity whose lines carry a Value can’t move to another Organization.

The routes on this page live under the Organization, not under an Entity. Read the organizationId from the Entity. The routes need the books permission in the Organization: books read for GET, books write for the other methods. An API key confined to one Entity can call them for that Entity’s Organization. Any other Organization, or one where you hold no Membership, answers 404 with ORGANIZATION_NOT_FOUND_ERROR.

GET /api/organizations/:organizationId/dimensions

List all Dimensions of the Organization.

Path param: organizationId (UUID)
Success response: array of Dimension objects
Status: 200

Field	Type	Description
`id`	UUID	Dimension id
`organizationId`	UUID	Owning Organization
`name`	string	Dimension name
`createdAt`	ISO datetime	Creation timestamp
`updatedAt`	ISO datetime	Last update timestamp

curl https://api.sintropix.com/api/organizations/$ORGANIZATION_ID/dimensions \
  -H "x-api-key: $SINTROPIX_API_KEY"

POST /api/organizations/:organizationId/dimensions

Create a new Dimension.

Path param: organizationId (UUID)
Body:

Field	Type	Required	Description
`id`	UUID	Yes	Client-supplied idempotency id
`name`	string	Yes	Dimension name, non-empty and unique in the Organization

Success response: the created Dimension (same shape as the list response)
Status: 201

curl -X POST https://api.sintropix.com/api/organizations/$ORGANIZATION_ID/dimensions \
  -H "Content-Type: application/json" \
  -H "x-api-key: $SINTROPIX_API_KEY" \
  -H "x-audit-actor: my-agent" \
  -d '{
    "id": "22222222-2222-4222-8222-222222222222",
    "name": "Centro de costo"
  }'

PATCH /api/organizations/:organizationId/dimensions/:dimensionId

Rename a Dimension. The new name applies to every Entity of the Organization.

Path params: organizationId (UUID), dimensionId (UUID)
Body:

Field	Type	Required	Description
`name`	string	Yes	New dimension name

Success response: the updated Dimension (same shape as the list response)
Status: 200

curl -X PATCH https://api.sintropix.com/api/organizations/$ORGANIZATION_ID/dimensions/$DIMENSION_ID \
  -H "Content-Type: application/json" \
  -H "x-api-key: $SINTROPIX_API_KEY" \
  -H "x-audit-actor: my-agent" \
  -d '{"name": "Proyecto"}'

DELETE /api/organizations/:organizationId/dimensions/:dimensionId

Delete a Dimension. A Dimension that has values cannot be deleted.

Path params: organizationId (UUID), dimensionId (UUID)
Success response: the deleted Dimension (same shape as the list response)
Status: 200

curl -X DELETE https://api.sintropix.com/api/organizations/$ORGANIZATION_ID/dimensions/$DIMENSION_ID \
  -H "x-api-key: $SINTROPIX_API_KEY" \
  -H "x-audit-actor: my-agent"

GET /api/organizations/:organizationId/dimensions/:dimensionId/values

List all Dimension Values for a Dimension.

Path params: organizationId (UUID), dimensionId (UUID)
Success response: array of Dimension Value objects
Status: 200

Field	Type	Description
`id`	UUID	Value id
`organizationId`	UUID	Owning Organization
`dimensionId`	UUID	Parent Dimension
`code`	string	Value code
`name`	string	Value name
`parentId`	UUID or null	Parent value for hierarchy
`createdAt`	ISO datetime	Creation timestamp
`updatedAt`	ISO datetime	Last update timestamp

curl https://api.sintropix.com/api/organizations/$ORGANIZATION_ID/dimensions/$DIMENSION_ID/values \
  -H "x-api-key: $SINTROPIX_API_KEY"

POST /api/organizations/:organizationId/dimensions/:dimensionId/values

Create a new Dimension Value.

Path params: organizationId (UUID), dimensionId (UUID)
Body:

Field	Type	Required	Description
`id`	UUID	Yes	Client-supplied idempotency id
`code`	string	Yes	Value code, non-empty and unique in the Dimension
`name`	string	Yes	Value name, non-empty
`parentId`	UUID or null	No	Parent value id; null for top-level

Success response: the created Dimension Value (same shape as the values list response)
Status: 201

curl -X POST https://api.sintropix.com/api/organizations/$ORGANIZATION_ID/dimensions/$DIMENSION_ID/values \
  -H "Content-Type: application/json" \
  -H "x-api-key: $SINTROPIX_API_KEY" \
  -H "x-audit-actor: my-agent" \
  -d '{
    "id": "33333333-3333-4333-8333-333333333333",
    "code": "CC-100",
    "name": "Ventas",
    "parentId": null
  }'

PATCH /api/organizations/:organizationId/dimensions/:dimensionId/values/:dimensionValueId

Update a Dimension Value. You can rename, recode, or reparent it. The change applies to every Entity of the Organization.

Path params: organizationId (UUID), dimensionId (UUID), dimensionValueId (UUID)
Body:

Field	Type	Required	Description
`code`	string	No	New code
`name`	string	No	New name
`parentId`	UUID or null	No	New parent or null for top-level

At least one field must be provided.

Success response: the updated Dimension Value (same shape as the values list response)
Status: 200

curl -X PATCH https://api.sintropix.com/api/organizations/$ORGANIZATION_ID/dimensions/$DIMENSION_ID/values/$VALUE_ID \
  -H "Content-Type: application/json" \
  -H "x-api-key: $SINTROPIX_API_KEY" \
  -H "x-audit-actor: my-agent" \
  -d '{"name": "Ventas sur"}'

DELETE /api/organizations/:organizationId/dimensions/:dimensionId/values/:dimensionValueId

Delete a Dimension Value. A value that a Ledger Entry Line of any Entity of the Organization carries, or that has children, cannot be deleted.

Path params: organizationId (UUID), dimensionId (UUID), dimensionValueId (UUID)
Success response: the deleted Dimension Value (same shape as the values list response)
Status: 200

curl -X DELETE https://api.sintropix.com/api/organizations/$ORGANIZATION_ID/dimensions/$DIMENSION_ID/values/$VALUE_ID \
  -H "x-api-key: $SINTROPIX_API_KEY" \
  -H "x-audit-actor: my-agent"

Domain error codes

Code	Meaning
`ORGANIZATION_NOT_FOUND_ERROR`	Organization does not exist or is outside your reach
`DIMENSION_NOT_FOUND_ERROR`	Dimension does not exist in the Organization
`DIMENSION_ALREADY_EXISTS_ERROR`	Dimension id already used
`DIMENSION_NAME_ALREADY_EXISTS_ERROR`	Dimension name already in use in the Organization
`DIMENSION_HAS_VALUES_ERROR`	Cannot delete a Dimension that has values
`DIMENSION_VALUE_NOT_FOUND_ERROR`	Dimension Value does not exist
`DIMENSION_VALUE_ALREADY_EXISTS_ERROR`	Dimension Value id already used
`DIMENSION_VALUE_CODE_ALREADY_EXISTS_ERROR`	Code already in use for this Dimension
`DIMENSION_VALUE_PARENT_NOT_FOUND_ERROR`	Parent value not found
`DIMENSION_VALUE_PARENT_CYCLE_ERROR`	Value cannot become a descendant of itself
`DIMENSION_VALUE_IN_USE_ERROR`	Value is tagged on a Ledger Entry Line of an Entity of the Organization
`DIMENSION_VALUE_HAS_CHILDREN_ERROR`	Value has child values

Status codes

Status	Meaning
200	Success (GET, PATCH, DELETE)
201	Created (POST)
400	Validation error
401	Unauthenticated
403	Forbidden
404	Resource not found
409	Domain rule violation

Get Started

Ledger

Banking

Documents

Reports & Audit

Sources & Integrations

Platform

Sintropix Dimensions API: Reporting Axes and Values

Dimensions belong to the Organization

GET /api/organizations/:organizationId/dimensions

POST /api/organizations/:organizationId/dimensions

PATCH /api/organizations/:organizationId/dimensions/:dimensionId

DELETE /api/organizations/:organizationId/dimensions/:dimensionId

GET /api/organizations/:organizationId/dimensions/:dimensionId/values

POST /api/organizations/:organizationId/dimensions/:dimensionId/values

PATCH /api/organizations/:organizationId/dimensions/:dimensionId/values/:dimensionValueId

DELETE /api/organizations/:organizationId/dimensions/:dimensionId/values/:dimensionValueId

Domain error codes

Status codes

​Dimensions belong to the Organization

​GET /api/organizations/:organizationId/dimensions

​POST /api/organizations/:organizationId/dimensions

​PATCH /api/organizations/:organizationId/dimensions/:dimensionId

​DELETE /api/organizations/:organizationId/dimensions/:dimensionId

​GET /api/organizations/:organizationId/dimensions/:dimensionId/values

​POST /api/organizations/:organizationId/dimensions/:dimensionId/values

​PATCH /api/organizations/:organizationId/dimensions/:dimensionId/values/:dimensionValueId

​DELETE /api/organizations/:organizationId/dimensions/:dimensionId/values/:dimensionValueId

​Domain error codes

​Status codes

Dimensions belong to the Organization

GET /api/organizations/:organizationId/dimensions

POST /api/organizations/:organizationId/dimensions

PATCH /api/organizations/:organizationId/dimensions/:dimensionId

DELETE /api/organizations/:organizationId/dimensions/:dimensionId

GET /api/organizations/:organizationId/dimensions/:dimensionId/values

POST /api/organizations/:organizationId/dimensions/:dimensionId/values

PATCH /api/organizations/:organizationId/dimensions/:dimensionId/values/:dimensionValueId

DELETE /api/organizations/:organizationId/dimensions/:dimensionId/values/:dimensionValueId

Domain error codes

Status codes