Sign in
codingDefaults

Preview coding defaults for a location + vendor

Returns the GL and dimension coding defaults for the given ottimate_location_id and erp_vendor_id, without creating an invoice. Use this to pre-fill an invoice-capture UI before calling POST /invoices — pass the returned erp_dimension_id values through to that endpoint's dimensions field to persist them. This preview only covers header-level defaults; individual line items may still be affected by catalog/item-level mapping rules not shown here.

get/coding-defaults

Query parameters

ottimate_location_idinteger required

Restaurant/location ID, same value used on invoice create.

erp_vendor_idstring required

ERP accounting vendor ID (the accounting_id on the vendor record). Matched case-insensitively.

applies_to'header'

Which mapping rule scope to evaluate. Only header is supported in v1; line_item is reserved for a future version.

Headers

Authorizationstring required

OAuth2 authentication flows. Auth server URLs will vary by environment

X-Api-Keystring required

API key for authentication

X-API-Versionstring

API version to use (optional, defaults to latest). Supported values: 1.0.0, 1.1.0.

Response

Successful response with coding defaults

ottimate_location_idinteger required

The location ID this response was resolved for

erp_vendor_idstring required

The ERP vendor ID this response was resolved for

accounting_mode'enhanced_dimensions' | 'legacy_gl' required

Whether this location uses Enhanced Dimensions or legacy GL accounting

header_dimensionsCodingDefaultsGetResponsesContentApplicationJsonSchemaHeaderDimensions required

Header-level dimension defaults, keyed by dimension type (e.g. 'DEPARTMENT', 'CLASS'). Empty when accounting_mode is legacy_gl or no default applies.

warningsstring[]

Response-specific caveats, e.g. a matched value that couldn't be resolved to a usable ID. Empty when nothing unusual applies to this particular location/vendor pair.

Changes