Preview coding defaults for a location + vendor | Ottimate Developer Documentation

curl -G https://api.ottimate.com/v1/coding-defaults \
     -H "X-Api-Key: your-api-key-here" \
     -H "X-API-Version: 1.0.0" \
     -H "Authorization: Bearer <token>" \
     -d ottimate_location_id=12345 \
     -d erp_vendor_id=SYSCO-001 \
     -d applies_to=header

{
  "ottimate_location_id": 12345,
  "erp_vendor_id": "SYSCO-001",
  "accounting_mode": "enhanced_dimensions",
  "header_dimensions": {
    "DEPARTMENT": {
      "erp_dimension_id": "DEPT-FOH",
      "code": "100",
      "name": "Front of House",
      "source": "mapping_rule",
      "rule_id": "invmr_98765"
    }
  },
  "vendor_coding": {
    "erp_vendor_id": "SYSCO-001",
    "source": "configured",
    "ottimate_vendor_id": 67890,
    "accounting_class": {
      "erp_dimension_id": "CLASS-VENDOR-DEFAULT",
      "code": "CLASS-VENDOR-DEFAULT",
      "name": "Vendor Default Class",
      "source": "configured"
    },
    "default_department": {
      "erp_dimension_id": "DEPT-KITCHEN",
      "code": "200",
      "name": "Kitchen",
      "source": "configured"
    }
  },
  "default_gl": null,
  "warnings": []
}

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.

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.

Authentication

AuthorizationBearer

OAuth2 authentication flows. Auth server URLs will vary by environment

Query parameters

ottimate_location_idintegerRequired

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

erp_vendor_idstringRequired

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

applies_toenumOptionalDefaults to header

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

Allowed values:

Response

Successful response with coding defaults

ottimate_location_idinteger

The location ID this response was resolved for

erp_vendor_idstring

The ERP vendor ID this response was resolved for

accounting_modeenum

Whether this location uses Enhanced Dimensions or legacy GL accounting

header_dimensionsobject

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

vendor_codingobject

Vendor-level coding defaults for this location + vendor, regardless of accounting mode.

default_globject or nullOptional

Default GL account. Populated for legacy_gl accounts, and also for enhanced_dimensions accounts that auto-map to a global default GL (source: ‘default’) — that path is not gated by accounting_mode.

warningslist of stringsOptional

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.

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error

Authentication

Headers

Query parameters

Response

Errors