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
Query dimensions

Description

Configuration of analytic categories, known as dimensions and tags in the API context, and displayed as Categories and Tags in the product interface.
The Dimensions resource allows you to retrieve all available dimensions and their associated tags.

Warning: Analytic tag settings are currently read-only.
At this stage, creating or modifying these settings is not supported via the API and must be done directly from the Settings interface in Sage Active.

img

An analytic dimension represents a customizable axis used to categorize accounting entry lines for analytical purposes.

  • Typical examples include dimensions such as Warehouse, Department, or Project.

  • Each dimension is configured with a list of tags, which define the allowed values for that dimension.
    For example, the Warehouse dimension may include tags such as Lyon, Toulouse, and Rouen, each representing a specific location used in allocation.

  • When creating accounting entries, you can allocate each line across one or more analytic dimensions by assigning a specific tag from the list defined for each dimension.
    See API resources overview / Accounting Entries
  • You can also configure accounts in the chart of accounts to assign default dimension tags, which will be automatically applied to entry lines using those accounts. See API resources overview / Accounting Accounts
img
GraphQL Query
query {
  dimensions {
    id
    code
    name
    description
    isActive
    creationDate
    modificationDate
    dimensionTags {
      id
      tagCode
      name
      isActive
    }
  }
}

Example Response

{
  "data": {
    "dimensions": [
      {
        "id": "f501e055-1b21-4adf-89e6-9d2e00dfe001",
        "code": "WAREHOUSE",
        "name": "Warehouse",
        "description": "Main warehouses in use",
        "isActive": true,
        "creationDate": "2025-06-01T10:23:00Z",
        "modificationDate": "2025-06-05T08:12:30Z",
        "dimensionTags": [
          {
            "id": "99ae4c65-4cc7-4767-9424-084ad13f2498",
            "tagCode": "TOULOUSE",
            "name": "Toulouse",
            "isActive": true
          },
          {
            "id": "73b0fbc1-1d10-4a4d-89b7-44e91c6a7fa1",
            "tagCode": "LYON",
            "name": "Lyon",
            "isActive": true
          }
        ]
      }
    ]
  }
}
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?

dimensions

Fields Type Description Length
id UUID Id  
creationDate DateTime Creation Date  
modificationDate DateTime Modification Date  
       
code String Code of the dimension (unique) 20
name String Display name 50
description String Optional description 255
isActive Boolean Whether the dimension is active  
dimensionTags Array Associated analytic tags  

dimensions/dimensionTags dimensionTags

This section describes the analytic tags associated with a dimension.

Fields Type Description Length
id UUID Id  
creationDate DateTime Creation Date  
modificationDate DateTime Modification Date  
       
dimensionId UUID Id of the dimension (e.g. Warehouse)  
       
tagCode String Code of the tag (unique) 20
name String Display name 50
isActive Boolean Whether the tag is active  
isDefault Boolean Whether this is the default tag  
Info
  • tagCode: Unique identifier (code) of the tag within the dimension.
  • name: Display name of the tag shown in UI and documents.
  • isActive: Indicates if the tag is available for use in allocations.
  • isDefault: Marks this tag as the default value for its dimension, when applicable.