v1

latestOpenAPI 3.1.02026-07-263644911022.4 KB

Export Jobs

Create an export job

Use this endpoint to create an asynchronous export job for large report exports. Supported formats include CSV, JSON, and XML.

post/v1/contexts/{contextId}/export-jobs

Path parameters

contextIdstring required

The unique identifier of the reconciliation context.

Headers

X-Request-Idstring

A unique identifier for tracing the request across services.

X-Idempotency-Keystring

Optional idempotency key for safe retries. Also accepts Idempotency-Key as an alternative header name. If the same key is sent again and the original request was already processed, the cached response is returned with X-Idempotency-Replayed: true.

See Retries and idempotency for details.

Request body

dateFromstring required

dateTostring required

format'CSV' | 'JSON' | 'XML' required

reportType'MATCHED' | 'UNMATCHED' | 'SUMMARY' | 'VARIANCE' required

sourceIdstring

Response

Indicates that the request was accepted for processing.

The response includes the X-Idempotency-Replayed header.

If the value is false, the request was just processed. If the value is true, the response is a replay of a previously processed request.

See Retries and idempotency for more details.

jobIdstring

statusstring

statusUrlstring