Update accounting intelligence settings

Changed on

Turn the accounting intelligence agent on or off, or choose which dimensions it codes. Changes apply to entries coded from now on.

patch/v2/accounting/intelligence

Request

  • Base URL
    https://api.slash.com
  • URL
    https://api.slash.com/v2/accounting/intelligence
  • Auth
    API key in header X-API-Key

Request body

connectionIdstring

The connection to update. Optional when the legal entity has exactly one connection; required when it has several.

mode'disabled' | 'all_fields' | 'selected_fields'

disabled stops auto-coding, all_fields codes every supported dimension, selected_fields codes only enabledDimensionKeys.

enabledDimensionKeysstring[]

The dimensions to auto-code when the resulting mode is selected_fields, where at least one key is required; each key must be in supportedDimensionKeys. With any other mode, send an empty list or exactly what GET reports for that mode (every supported key for all_fields, none for disabled), so the settings object can be sent back as read. The selection is kept only while the mode is selected_fields, so switching back to it needs the keys again.

Example request

{
  "connectionId": "accounting_connection_2rj4l7hmrrrcv",
  "enabledDimensionKeys": [
    "account",
    "class"
  ]
}

Response

The settings as stored.

connectionIdstring required
mode'disabled' | 'all_fields' | 'selected_fields' required

disabled never auto-codes. all_fields auto-codes every dimension in supportedDimensionKeys. selected_fields auto-codes only the dimensions chosen in enabledDimensionKeys.

enabledDimensionKeysstring[] required

The dimensions the agent codes under the current mode: empty when disabled, every supported key when all_fields, the chosen keys when selected_fields.

supportedDimensionKeysstring[] required

The dimensions the agent can code on this platform.

Example response

{
  "connectionId": "accounting_connection_2rj4l7hmrrrcv",
  "enabledDimensionKeys": [
    "account",
    "class"
  ],
  "supportedDimensionKeys": [
    "account",
    "class",
    "vendor",
    "customer",
    "department",
    "location",
    "project"
  ]
}

Changes