Skip to main content
PATCH
Enable or disable a dimension value

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

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]+$

Path Parameters

dimensionKey
string
required

A key from GET /v2/accounting/dimensions.

valueId
string
required

A value id on that dimension.

Body

application/json
enabled
boolean
required

Whether the value can be coded onto new entries.

Response

The value, with its new availability.

One selectable value of a dimension: a general-ledger account, a vendor record, a class, and so on. Use id when coding a line item.

id
string
required

Value id. The prefix depends on the dimension's type: accounting_account_, accounting_vendor_, and so on for platform dimensions; acc_dim_val_ for generic dimensions. A custom_field option's id is the option value itself, the string customFields takes.

Example:

"accounting_account_2rj4l7hmrrrcv"

dimensionKey
string
required

The dimension this value belongs to.

Example:

"account"

connectionId
string
required
Example:

"accounting_connection_2rj4l7hmrrrcv"

name
string
required

Display name, as shown in the dashboard and the platform.

Example:

"6100 Software Subscriptions"

externalId
string
required

The accounting platform's own id for this value, or the id in the imported file on CSV connections. For the few values a platform reports no id for, a stable id assigned when the value was synced.

Example:

"80"

enabled
boolean
required

Whether a user has switched this value on for coding. Disabled values are not offered in the dashboard but stay valid on existing entries.

platformStatus
string

The value's status on the accounting platform, when it reports one (for example active or archived). Whether Slash offers the value for coding is enabled.

Example:

"active"

parentId
string

The value on the dimension named by the dimension's parentKey that this value belongs under. Only set on nested dimensions.

Example:

"acc_dim_val_2rj4l7hmrrrcv"

metadata
object

Platform-specific details such as the account number, account type, or currency. Keys vary by platform and dimension; treat them as informational.