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

Create an export job

cURL

curl --request POST \
  --url https://matcher.sandbox.lerian.net/v1/contexts/{contextId}/export-jobs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "format": "CSV",
  "reportType": "MATCHED",
  "dateFrom": "2025-01-01",
  "dateTo": "2025-01-31",
  "sourceId": "550e8400-e29b-41d4-a716-446655440000"
}
'

202

Example

{
  "jobId": "550e8400-e29b-41d4-a716-446655440000",
  "status": "QUEUED",
  "statusUrl": "/v1/export-jobs/550e8400-e29b-41d4-a716-446655440001"
}

Autorizaciones

Authorization · string · header · requerido

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

Encabezados

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 (MTCH-0018), a key whose earlier attempt already ran but whose answer cannot be replayed returns 409 (MTCH-0022), and an idempotency storage failure returns 500. POST, PUT, PATCH and DELETE requests accept the header. These refusals are problem documents.

Parámetros de ruta

contextId · string<uuid> · requerido

The unique identifier of the reconciliation context. Context ID

Cuerpo

application/json

Export job parameters

format · enum<string> · requerido

Export file format (uppercase only).

Opciones disponibles: CSV, JSON, XML

Ejemplo:

"CSV"

reportType · enum<string> · requerido

Report type to export (uppercase only).

Opciones disponibles: MATCHED, UNMATCHED, SUMMARY, VARIANCE, EXCEPTIONS, MATCHES, UNMATCHED_TRANSACTIONS

Ejemplo:

"MATCHED"

dateFrom · string<date>

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

Ejemplo:

"2025-01-01"

dateTo · string<date>

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

Ejemplo:

"2025-01-31"

sourceId · string<uuid>

Optional source ID filter (UUID)

Ejemplo:

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

Respuesta

202

application/json

Indicates that the request was accepted for processing.

jobId · string<uuid> · requerido

Identifier of the newly created export job (UUID).

Ejemplo:

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

status · enum<string> · requerido

Initial status of the job; always QUEUED on creation.

Opciones disponibles: QUEUED

Ejemplo:

"QUEUED"

statusUrl · string · requerido

Relative URL to poll for this job's status.

Ejemplo:

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