Dimensions

Dimensions are a classification system used to organize, sort, and report on company information in meaningful ways. You can think of each dimension as a category with a set of values that you can apply to transactions and entries. Every transaction can be tagged with multiple dimension values to identify and report on it. For example, you can tag transactions with pre-defined locations, and then generate reports to show sales by each location.

List dimensions

get/services/company-config/dimensions/list

Lists all standard and user-defined dimensions in a company along with integration information about each one.

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "dimensionName": "DEPARTMENT",
      • "dimensionLabel": "Department",
      • "termName": "Department",
      • "isUserDefinedDimension": false,
      • "isEnabledInGL": true,
      • "dimensionEndpoint": "/objects/company-config/department"
      },
    • {
      • "dimensionName": "LOCATION",
      • "dimensionLabel": "Location",
      • "termName": "Loc",
      • "isUserDefinedDimension": false,
      • "isEnabledInGL": true,
      • "dimensionEndpoint": "/objects/company-config/location"
      },
    • {
      • "dimensionName": "PROJECT",
      • "dimensionLabel": "Project",
      • "termName": "Project",
      • "isUserDefinedDimension": false,
      • "isEnabledInGL": true,
      • "dimensionEndpoint": "/objects/projects/project"
      },
    • {
      • "dimensionName": "CUSTOMER",
      • "dimensionLabel": "Customer",
      • "termName": "Customer",
      • "isUserDefinedDimension": false,
      • "isEnabledInGL": true,
      • "dimensionEndpoint": "/objects/accounts-receivable/customer"
      },
    • {
      • "dimensionName": "VENDOR",
      • "dimensionLabel": "Vendor",
      • "termName": "Vendor",
      • "isUserDefinedDimension": false,
      • "isEnabledInGL": true,
      • "dimensionEndpoint": "/objects/accounts-payable/vendor"
      },
    • {
      • "dimensionName": "EMPLOYEE",
      • "dimensionLabel": "Employee",
      • "termName": "Employee",
      • "isUserDefinedDimension": false,
      • "isEnabledInGL": true,
      • "dimensionEndpoint": "/objects/company-config/employee"
      },
    • {
      • "dimensionName": "ITEM",
      • "dimensionLabel": "Item",
      • "termName": "Item",
      • "isUserDefinedDimension": false,
      • "isEnabledInGL": true,
      • "dimensionEndpoint": "/objects/inventory-control/item"
      },
    • {
      • "dimensionName": "CLASS",
      • "dimensionLabel": "Class",
      • "termName": "Class",
      • "isUserDefinedDimension": false,
      • "isEnabledInGL": true,
      • "dimensionEndpoint": "/objects/company-config/class"
      },
    • {
      • "dimensionName": "CONTRACT",
      • "dimensionLabel": "Contract",
      • "termName": "Contract",
      • "isUserDefinedDimension": false,
      • "isEnabledInGL": false,
      • "dimensionEndpoint": "/objects/contracts/contract"
      },
    • {
      • "dimensionName": "TASK",
      • "dimensionLabel": "Task",
      • "termName": "Task",
      • "isUserDefinedDimension": false,
      • "isEnabledInGL": false,
      • "dimensionEndpoint": "/objects/projects/task"
      },
    • {
      • "dimensionName": "WAREHOUSE",
      • "dimensionLabel": "Warehouse",
      • "termName": "Warehouse",
      • "isUserDefinedDimension": false,
      • "isEnabledInGL": false,
      • "dimensionEndpoint": "/objects/inventory-control/warehouse"
      },
    • {
      • "dimensionName": "COSTTYPE",
      • "dimensionLabel": "Cost type",
      • "termName": "Cost type",
      • "isUserDefinedDimension": false,
      • "isEnabledInGL": false,
      • "dimensionEndpoint": "/objects/construction/cost-type"
      },
    • {
      • "dimensionName": "AFFILIATEENTITY",
      • "dimensionLabel": "Affiliate entity",
      • "termName": "Affiliate entity",
      • "isUserDefinedDimension": false,
      • "isEnabledInGL": false,
      • "dimensionEndpoint": "/objects/company-config/affiliate-entity"
      },
    • {
      • "dimensionName": "FIXEDASSET",
      • "dimensionLabel": "Asset",
      • "termName": "Asset",
      • "isUserDefinedDimension": false,
      • "isEnabledInGL": false,
      • "dimensionEndpoint": "/objects/fixed-assets/asset"
      },
    • {
      • "dimensionName": "CHANNEL",
      • "dimensionLabel": "Channel",
      • "termName": "Channel",
      • "isUserDefinedDimension": true,
      • "isEnabledInGL": true,
      • "dimensionEndpoint": "/objects/platform-apps/nsp::channel"
      },
    • {
      • "dimensionName": "DACIA",
      • "dimensionLabel": "dacia",
      • "termName": "dacia",
      • "isUserDefinedDimension": true,
      • "isEnabledInGL": true,
      • "dimensionEndpoint": "/objects/platform-apps/nsp::dacia"
      }
    ],
  • "ia::meta": {
    • "totalCount": "15",
    • "totalSuccess": "15",
    • "totalError": "0"
    }
}