Skip to main content
POST
Create an export job

Authorizations

​
Authorization
string
header
required

Bearer token authentication (format: "Bearer {token}")

Headers

​
X-Request-Id
string

A unique identifier for tracing the request across services.

​
X-Idempotency
string

Optional idempotency key for safe retries. Matcher reads the key only from this header, and only when you send one. A request that carries a key only in X-Idempotency-Key or Idempotency-Key is refused with 400 (MTCH-0015), and nothing is processed. If the same key is sent again and the original request was already processed, the stored response is returned with X-Idempotency-Replayed: true. A malformed key returns 400, a key whose first request is still in progress returns 409, and an idempotency storage failure returns 500. These refusals are problem documents.

Path Parameters

​
contextId
string<uuid>
required

The unique identifier of the reconciliation context. Context ID

Body

application/json

Export job parameters

​
format
enum<string>
required

Export file format (uppercase only).

Available options:
CSV,
JSON,
XML
Example:

"CSV"

​
reportType
enum<string>
required

Report type to export (uppercase only).

Available options:
MATCHED,
UNMATCHED,
SUMMARY,
VARIANCE,
EXCEPTIONS,
MATCHES,
UNMATCHED_TRANSACTIONS
Example:

"MATCHED"

​
dateFrom
string<date>

Start date (YYYY-MM-DD). Optional: defaults to 30 days before dateTo.

Example:

"2025-01-01"

​
dateTo
string<date>

End date (YYYY-MM-DD). Optional: defaults to tomorrow (UTC).

Example:

"2025-01-31"

​
sourceId
string<uuid>

Optional source ID filter (UUID)

Example:

"550e8400-e29b-41d4-a716-446655440000"

Response

Indicates that the request was accepted for processing.

​
jobId
string<uuid>
required

Identifier of the newly created export job (UUID).

Example:

"550e8400-e29b-41d4-a716-446655440000"

​
status
enum<string>
required

Initial status of the job; always QUEUED on creation.

Available options:
QUEUED
Example:

"QUEUED"

​
statusUrl
string
required

Relative URL to poll for this job's status.

Example:

"/v1/export-jobs/550e8400-e29b-41d4-a716-446655440001"