SLslashfi

Enable or disable a dimension value

Changed on

Turn a value on or off for coding, for example to hide a retired account. Entries already coded with it keep it.

patch/v2/accounting/dimensions/{dimensionKey}/values/{valueId}

Request

  • Base URL
    https://api.slash.com
  • URL
    https://api.slash.com/v2/accounting/dimensions/{dimensionKey}/values/{valueId}
  • Auth
    API key in header X-API-Key

Request body

enabledboolean required

Whether the value can be coded onto new entries.

Response

The value, with its new availability.

idstring 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.

dimensionKeystring required

The dimension this value belongs to.

connectionIdstring required
namestring required

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

externalIdstring 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.

platformStatusstring

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.

parentIdstring

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

enabledboolean 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.

metadataobject

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

Example response

{
  "id": "accounting_account_2rj4l7hmrrrcv",
  "dimensionKey": "account",
  "connectionId": "accounting_connection_2rj4l7hmrrrcv",
  "name": "6100 Software Subscriptions",
  "externalId": "80",
  "platformStatus": "active",
  "parentId": "acc_dim_val_2rj4l7hmrrrcv"
}

Changes