Get the managerial key mapping table

GET/api/v1/businesses/{business_id}/managerial-key-mappings

One row per ledger in the chart of accounts (all account types) with a keys object holding the mapped category under every active key type, null where unmapped.

Operation ID: get_managerial_key_mapping_table_api_v1_businesses__business_id__managerial_key_mappings_get·View as markdown·OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Parameters

Path

business_idstringrequired

Query

key_typestring: Return only this key type's column.
only_mappedbooleandefault: False: Drop ledgers that have no value under any returned key.

Responses

200Successful Response

Schema: SuccessEnvelope_ManagerialKeyMappingTableResponse_

successboolean
messagestring
codestring
dataManagerialKeyMappingTableResponse

400Bad Request - Invalid input

401Unauthorized - Authentication required

403Forbidden - Insufficient permissions

422Validation Error

Schema: HTTPValidationError

detailarray · ValidationErrorValidationError

5 fields

locarray · string | integerrequired
msgstringrequired
typestringrequired
inputobject
ctxobject

Code samples

GET/api/v1/businesses/{business_id}/managerial-key-mappings

bash

curl -X GET 'https://api.ondayzero.com/api/v1/businesses/{business_id}/managerial-key-mappings' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID'