Skip to main content
Dimensions are the fields an entry is coded with: the GL account, the vendor, a class or a department. Each one has a list of values that come from the accounting platform. Look them up here before you code an entry or write a rule.

​
List dimensions

List accounting dimensions returns every dimension on the connection:
  • key identifies the dimension everywhere else in the API.
  • required dimensions must have a value before an entry can sync. account is always required.
  • enabled is whether the dimension is switched on for coding.

​
Find a value

List dimension values returns one dimension’s values sorted by name, a page at a time. Retrieve a dimension value reads one by id:
Use the value’s id when you code an entry. externalId is the record’s id on the accounting platform, which is useful for matching values to your own data. Values that are switched off for coding are left out unless you pass includeDisabled=true.

​
How coding shows up on an entry

Each entry has at least two line items:
  • Fixed lines are the bank or card account the money moved through. Slash sets these from the connection’s settings.
  • Editable lines are the side you code, such as the expense account, vendor and class.
Each line’s dimensions shows the value coded for each dimension. A dimension that’s missing hasn’t been coded yet.
An entry stays in_review until every required dimension has a value.

​
Special cases

Some platforms record a dimension once for the whole entry rather than per line. These are listed in the entry’s entryLevelDimensions, and every line shows the same value. Dimensions the platform doesn’t accept for that kind of entry, such as a vendor on a bank transfer, are listed in unsupportedDimensions.
On some platforms one dimension is scoped by another: on Procore, a cost code belongs to a project. The narrower dimension has a parentKey, and you can list only the values under one parent with parentValueId.
Platforms such as NetSuite, Sage Intacct and Xero let companies add their own fields. These appear as dimensions with type: custom_field and a key starting with customField:. Their values are stored in customFields on the entry or line item instead of dimensions. For select fields, the values endpoint lists the options; an option’s id is the value to put in customFields. Custom fields take no default value, and their options can’t be switched on or off from the API.