Pular para o conteúdo principal
POST
Criar uma regra de conciliação

Autorizações

Authorization
string
header
obrigatório

Autenticação por Bearer token (formato: "Bearer {token}")

Cabeçalhos

X-Request-Id
string

A unique identifier for tracing the request across services.

X-Idempotency-Key
string

Chave de idempotência opcional para novas tentativas seguras. Também aceita Idempotency-Key como nome alternativo do cabeçalho. Se a mesma chave for enviada novamente e a requisição original já tiver sido processada, a resposta em cache é retornada com X-Idempotency-Replayed: true.

Consulte Novas tentativas e idempotência para mais detalhes.

Parâmetros de caminho

contextId
string
obrigatório

The unique identifier of the reconciliation context.

Corpo

application/json

Payload de criação da regra de conciliação

priority
integer
obrigatório
Intervalo obrigatório: 1 <= x <= 1000
Exemplo:

1

type
enum<string>
obrigatório

Tipo de algoritmo da regra de conciliação

Opções disponíveis:
EXACT,
TOLERANCE,
DATE_LAG
Exemplo:

"EXACT"

config
object

Resposta

Regra de conciliação criada com sucesso.

A resposta inclui o cabeçalho X-Idempotency-Replayed.

Se o valor for false, a requisição acabou de ser processada. Se o valor for true, a resposta é uma reprodução de uma requisição processada anteriormente.

Consulte Retentativas e idempotência para mais detalhes.

Regra de conciliação dentro de um contexto de conciliação

config
object

Configuração da regra

contextId
string

ID do contexto ao qual esta regra pertence

Exemplo:

"019c96a0-10a0-72d2-9fb0-2b7de8093182"

createdAt
string

Timestamp de criação no formato RFC3339

Exemplo:

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

id
string

Identificador único da regra

Exemplo:

"019c96a0-1071-7a0d-9916-a831221de252"

priority
integer

Prioridade de execução (menor = maior prioridade)

Intervalo obrigatório: 1 <= x <= 1000
Exemplo:

1

type
enum<string>

Tipo de regra de conciliação

Opções disponíveis:
EXACT,
TOLERANCE,
DATE_LAG
Exemplo:

"EXACT"

updatedAt
string

Timestamp da última atualização no formato RFC3339

Exemplo:

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