DimensionTag

Quick Links

Accounts Accounting Entries Products Customers Sales quotes Sales invoices Suppliers Purchase invoices

COMING SOON This feature is currently in development and will be available in the next version. It’s already documented to keep you informed about its upcoming availability

This feature is currently under development and, although not available in the current version, its preliminary documentation is provided to give you a preview of the enhancements that will be included in an upcoming update.

HTTP	Operation	Type	Object
POST	List	Query	`dimensionTags`

Description

A dimension tag represents a specific value within an analytic dimension.
For example, in a Warehouse dimension, you might use tags such as Toulouse, Lyon, or Rouen.

Each tag is linked to a single dimension, and can be marked as active or as the default value.

How to list dimensionTags?

GraphQL Query

query {
  dimensionTags {
    id
    dimensionId
    tagCode
    name
    isActive
    isDefault
    creationDate
    modificationDate
  }
}

Example Response

{
  "data": {
    "dimensionTags": [
      {
        "id": "10d1b100-1f2a-4a2c-8b91-93ef3e11c001",
        "dimensionId": "f501e055-1b21-4adf-89e6-9d2e00dfe001", // Warehouse
        "tagCode": "TOULOUSE",
        "name": "Toulouse",
        "isActive": true,
        "isDefault": true,
        "creationDate": "2025-06-01T11:10:00Z",
        "modificationDate": "2025-06-05T08:15:00Z"
      },
      {
        "id": "10d1b101-1f2a-4a2c-8b91-93ef3e11c002",
        "dimensionId": "f501e055-1b21-4adf-89e6-9d2e00dfe001", // Warehouse
        "tagCode": "LYON",
        "name": "Lyon",
        "isActive": true,
        "isDefault": false,
        "creationDate": "2025-06-01T11:11:00Z",
        "modificationDate": "2025-06-05T08:16:00Z"
      },
      {
        "id": "10d1b102-1f2a-4a2c-8b91-93ef3e11c003",
        "dimensionId": "a512e422-9e31-4f88-bb7c-7d7e00fdf002", // Department
        "tagCode": "SALES",
        "name": "Sales",
        "isActive": true,
        "isDefault": true,
        "creationDate": "2025-06-01T11:12:00Z",
        "modificationDate": "2025-06-05T08:17:00Z"
      }
    ]
  }
}

Key	Value
`Authorization`	Bearer Current access Token How to find?
`X-TenantId`	Current tenant id How to find?
`X-OrganizationId`	Current organization Id How to find?
`x-api-key`	Primary or secondary subscription key of your app How to find?

dimensionTags

Fields	Type	Description	Length
idSSystem field that cannot be assigned	UUID	Id
creationDateSSystem field that cannot be assigned	DateTime	Creation Date
modificationDateSSystem field that cannot be assigned	DateTime	Modification Date

dimensionId	UUID	Id of the related dimension
tagCode *The value of the field or object is mandatory	String	Code of the tag (unique)	20
name *The value of the field or object is mandatory	String	Display name	50
isActive *The value of the field or object is mandatory	Boolean	Whether the tag is active
isDefault *The value of the field or object is mandatory	Boolean	Whether this is the default tag

Warning

Analytic tag settings are currently read-only.
You cannot assign or modify these values through the API at this stage.
Dataloaders are not currently available for analytic dimensions and dimensionTags.
This means that if you need to retrieve additional details (e.g., dimension name for a given dimensionId), you must manually correlate the values using the identifiers (id fields) returned by the API.