Pular para o conteúdo principal
GET
Get a reconciliation source

Autorizações

Authorization
string
header
obrigatório

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

Cabeçalhos

X-Request-Id
string

A unique identifier for tracing the request across services.

Parâmetros de caminho

contextId
string<uuid>
obrigatório

The unique identifier of the reconciliation context. Context ID

sourceId
string<uuid>
obrigatório

The unique identifier of the reconciliation source. Source ID

Resposta

Successfully retrieved source

config
object
obrigatório

Source-specific configuration object. Cross-key rules the schema cannot express: a duplicate_key component this source's field map does not fill is refused, because a key over an always-empty field makes every row a duplicate of every other; a source bound to an aggregator connection (reserved key connection_config_name) cannot carry a duplicate_key of its own, and a config holding both is refused in either direction; and editing duplicate_key governs later imports only — rows already imported keep the key they were deduplicated under, so a duplicate straddling the change is knowingly not detected.

contextId
string
obrigatório

Identifier of the context this source belongs to.

Exemplo:

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

createdAt
string
obrigatório

Creation timestamp in RFC 3339 format.

Exemplo:

"2025-01-15T10:30:00Z"

id
string
obrigatório

Unique identifier of the source.

Exemplo:

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

name
string
obrigatório

Human-readable name of the source.

Exemplo:

"Primary Bank Account"

side
enum<string>
obrigatório

Matching side this source feeds. LEFT and RIGHT are the two sides reconciled against each other.

Opções disponíveis:
LEFT,
RIGHT
Exemplo:

"LEFT"

type
enum<string>
obrigatório

Origin of the source data. LEDGER is the internal ledger; BANK is a bank statement feed; GATEWAY is a payment gateway; CUSTOM is a bespoke feed; FETCHER is a discovery-engine pull.

Opções disponíveis:
LEDGER,
BANK,
GATEWAY,
CUSTOM,
FETCHER
Exemplo:

"BANK"

updatedAt
string
obrigatório

Last update timestamp in RFC 3339 format.

Exemplo:

"2025-01-15T10:30:00Z"

archivedAt
string

RFC 3339 timestamp when the source was archived; absent when the source is live.

Exemplo:

"2025-01-15T10:30:00Z"