Pular para o conteúdo principal
POST
Criar uma tarefa de exportaçã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

Parâmetros da tarefa de exportação

dateFrom
string
obrigatório
dateTo
string
obrigatório
format
enum<string>
obrigatório
Opções disponíveis:
CSV,
JSON,
XML
reportType
enum<string>
obrigatório
Opções disponíveis:
MATCHED,
UNMATCHED,
SUMMARY,
VARIANCE
sourceId
string

Resposta

Indica que a requisição foi aceita para processamento.

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 repetição de uma requisição processada anteriormente.

Consulte Retries and idempotency para mais detalhes.

jobId
string
status
string
statusUrl
string