Pular para o conteúdo principal
POST
/
v1
/
imports
/
contexts
/
{contextId}
/
sources
/
{sourceId}
/
preview
Pré-visualizar um arquivo de transações
curl --request POST \
  --url https://matcher.sandbox.lerian.net/v1/imports/contexts/{contextId}/sources/{sourceId}/preview \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form file='@example-file' \
  --form format=csv \
  --form max_rows=5
{
  "columns": [
    "date",
    "amount",
    "reference",
    "description"
  ],
  "sampleRows": [
    [
      "<string>"
    ]
  ],
  "rowCount": 5,
  "format": "csv"
}

Autorizações

​
Authorization
string
header
obrigatório

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

Cabeçalhos

​
X-Request-Id
string

Um identificador único para rastrear a requisição entre serviços.

Parâmetros de caminho

​
contextId
string
obrigatório

O identificador único do contexto de conciliação.

​
sourceId
string
obrigatório

O identificador único da fonte de conciliação.

Corpo

multipart/form-data
​
file
file
obrigatório

Arquivo de transações para pré-visualização (CSV, JSON ou XML)

​
format
enum<string>

Formato do arquivo (detectado automaticamente pelo nome do arquivo se omitido)

Opções disponíveis:
csv,
json,
xml
​
max_rows
integer
padrão:5

Número máximo de linhas de amostra a retornar

Intervalo obrigatório: 1 <= x <= 20

Resposta

Pré-visualização do arquivo com colunas detectadas e linhas de amostra

Pré-visualização de um arquivo de transações mostrando colunas detectadas e dados de amostra

​
columns
string[]

Nomes das colunas detectadas

Exemplo:
[
  "date",
  "amount",
  "reference",
  "description"
]
​
sampleRows
string[][]

Linhas de dados de amostra

​
rowCount
integer

Número de linhas de amostra retornadas

Exemplo:

5

​
format
string

Formato de arquivo detectado

Exemplo:

"csv"