List accounting mappings

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

sourceType

enum<string>

Return only mappings keyed on this kind of source.

Available options:

account,

virtual_account,

card,

card_group,

merchant,

merchant_category,

contact,

accounts_payable

sourceId

string

Return only mappings keyed on this source id.

dimensionKey

string

Return only mappings that code this dimension.

Response

A page of mappings, oldest first.

items

AccountingMapping · object[]

required

Hide child attributes

items.id

string

required

Mapping id with the accounting_mapping_ prefix.

Example:

"accounting_mapping_2rj4l7hmrrrcv"

items.connectionId

string

required

The connection the mapping belongs to.

Example:

"accounting_connection_2rj4l7hmrrrcv"

items.source

AccountingMappingSource · object

required

What a mapping keys on.

Hide child attributes

items.source.type

enum<string>

required

Which resource id names. account is an Account (sa_group_) and sets the cash-side account of its transactions; virtual_account (subaccount_), card (c_), card_group (card_group_), merchant (merchant_v2_, from a card transaction's details.merchant.id), merchant_category (merchant_category_, from a card transaction's details.merchant.categoryId) and contact (le_c_, the recipient of a transfer) code the expense side of matching transactions; accounts_payable takes no id and sets the accounts payable account bills are posted to. When several rules reach the same dimension of one transaction the more specific source wins, from weakest to strongest: virtual_account, card_group, card, merchant_category, merchant, contact.

Available options:

account,

virtual_account,

card,

card_group,

merchant,

merchant_category,

contact,

accounts_payable

items.source.id

string

The id of that resource. Required for every type except accounts_payable.

Required string length: 1 - 255

Example:

"c_2rj4l7hmrrrcv"

items.dimensionKey

string

required

The dimension this mapping codes, a key from GET /v2/accounting/dimensions.

Example:

"account"

items.createdAt

string<date-time>

required

items.valueId

string

The dimension value applied, from GET /v2/accounting/dimensions/{dimensionKey}/values. Absent on custom-field mappings, which carry customFieldValue instead.

Example:

"accounting_account_2rj4l7hmrrrcv"

items.customFieldValue

The custom field value applied, present only when dimensionKey is a custom_field dimension. Its shape follows the field's fieldType: an option value for select, a list of option values for multiselect, otherwise a boolean, string or number.

items.createdBy

enum<string>

user for mappings written by people or the API, ai for mappings the accounting intelligence agent proposed and applied.

Available options:

user,

ai

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 mappings

Authorizations

Headers

Query Parameters

Response