v1

latestOpenAPI 3.1.02026-08-0458234268.6 KB

catalog

Export a catalog variance batch (local only)

Marks the batch as exported without sending data to any external system. Sets exported_at to the current timestamp and api_status to success. Returns the exported batch with its costbatch_payload. Returns 400 if the batch is already exported.

post/catalog/variance-batches/{id}/export

Path parameters

idstring required

The catalog variance batch ID (ctb_xxx)

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.

Idempotency-Keystring

Client-generated unique key (UUID/ULID recommended). JSON requests: the first 2xx response is cached for 24h and replayed on a same-key retry with a matching body; a different body returns 422. Non-JSON requests (e.g. file uploads): the key is single-use — any same-key retry returns 422 regardless of body. See Idempotency for full details.

Response

Batch successfully marked as exported

idstring required

Unique batch identifier (prefixed with ctb_)

ottimate_company_idinteger required

Company ID this batch belongs to

batch_numberinteger required

Sequential batch number within the company

export_status'exported' required

Always 'exported' — non-exported batches are never returned by this API

exported_atstring date-time required

Timestamp when the batch was exported

exported_at_utcstring date-time nullable

UTC equivalent of exported_at. ISO 8601 with Z suffix, e.g. "2025-05-20T15:17:35.652584Z".