v1

latestOpenAPI 3.1.02026-07-263644911022.4 KB

Ingestion

Preview a transaction file

Use this endpoint to preview a transaction file before importing it. Returns sample rows and detected columns to help verify the file structure and field mapping.

post/v1/imports/contexts/{contextId}/sources/{sourceId}/preview

Path parameters

contextIdstring required

The unique identifier of the reconciliation context.

sourceIdstring required

The unique identifier of the reconciliation source.

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.

Response

File preview with detected columns and sample rows.

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.

columnsstring[]

Detected column names

rowCountinteger

Number of sample rows returned

formatstring

Detected file format

Example response

{
  "columns": [
    "date",
    "amount",
    "reference",
    "description"
  ],
  "rowCount": 5,
  "format": "csv"
}