List accounting dimensions

Authorizations

X-API-Key

string

header

required

User API key authentication. Create a key under Settings → API keys in the Slash dashboard (https://app.slash.com/global-settings/api-keys) and send the x-legal-entity header naming the legal entity to act on with every request. Keys scoped to a legal entity are rejected with 403 user_api_key_required.

Headers

x-legal-entity

string

required

The legal entity to act on. Required on every request; a user API key can act on any legal entity its user has access to.

Pattern: ^le_[a-zA-Z0-9]+$

Query Parameters

connectionId

string

The accounting connection to read. Optional when the legal entity has exactly one connection; required (connection_id_required) when it has several. List them at GET /v2/accounting/connections.

cursor

string

The opaque metadata.nextCursor value from the previous page. It carries that page's filters, page size and ordering, so pass it on its own; see Pagination.

limit

integer

Number of items per page, from 1 to 100. The page size is carried inside metadata.nextCursor, so later pages keep the same size unless limit is passed again to change it.

Required range: 1 <= x <= 100

Response

The connection's dimensions, account first.

items

AccountingDimension · object[]

required

Hide child attributes

items.key

string

required

Stable identifier used in every other accounting endpoint. Platform dimensions use fixed keys (account, vendor, customer, class, department, location, project, subsidiary); custom fields use customField: followed by the field's key; generic dimensions use the key defined on the connection.

Example:

"account"

items.connectionId

string

required

The connection this dimension belongs to.

Example:

"accounting_connection_2rj4l7hmrrrcv"

items.name

string

required

Display name shown in the dashboard.

Example:

"Account"

items.type

enum<string>

required

platform dimensions are the platform's own objects and their values carry that object's id prefix (accounting_account_, accounting_vendor_, ...). generic dimensions are stored on the connection itself and their values use the acc_dim_val_ prefix. custom_field dimensions are platform custom fields exposed through the same interface; their values are the field's options, each identified by the option value itself.

Available options:

platform,

generic,

custom_field

items.required

boolean

required

Every editable line item must carry a value for this dimension before the entry can sync.

items.mappable

boolean

required

Whether accounting rules can set this dimension automatically.

items.enabled

boolean

required

Whether the dimension is switched on for coding. Disabled dimensions are still listed so you can recognize keys that appear on older entries.

items.parentKey

string

Key of the dimension whose value narrows this one, when the platform nests dimensions (for example cost_code under project on Procore). Values can then be filtered by parentValueId. Hierarchies inside a single dimension, such as sub-accounts or sub-classes, are not nesting: those values report their parent in metadata.parentExternalId.

Example:

"project"

items.defaultValueId

string

The value new line items receive when none is provided.

Example:

"accounting_account_2rj4l7hmrrrcv"

items.customField

object

Present on custom_field dimensions. Custom fields are not coded with value ids: their raw values live in customFields on the entry (for entry level fields) or on each line item (for line_item level fields), keyed by fieldKey. select and multiselect fields list their allowed options as this dimension's values.

Hide child attributes

items.customField.fieldKey

string

required

The key to use in customFields.

Example:

"cf_cost_center"

items.customField.fieldType

enum<string>

required

The type of value the field accepts.

Available options:

boolean,

select,

string,

number,

multiselect

items.customField.level

enum<string>

required

Whether the value is set once per entry or per line item.

Available options:

entry,

line_item

metadata

PaginationMetadata · object

required

Hide child attributes

metadata.count

integer

required

Number of items in this page.

Required range: x >= 0

metadata.nextCursor

string

Opaque cursor for the next page. Omitted on the final page.

Accounts

Virtual accounts

Contacts

Transfers

Transactions

Documents

Bills

Accounting

List accounting dimensions

Authorizations

Headers

Query Parameters

Response