Skip to main content
A Delfinance gera automaticamente um relatório de extrato da conta todos os dias. No fim de cada mês, gera também um arquivo consolidado com todas as transações do mês. Use o extrato periódico para conciliação contábil, arquivamento e períodos com muitas transações. Para consultas pontuais ou filtros por tipo, use o extrato. Você pode baixar um relatório de duas formas:
  • Pelo período, direto, com um único request. É o caminho mais simples.
  • Pela listagem: liste os relatórios, consulte o relatório e baixe o arquivo pelo link.

​
Baixar pelo período

Informe a data do relatório diário (yyyyMMdd) ou o mês do consolidado (yyyyMM). A API responde com um redirect 302 para o link do arquivo CSV.
Para que o download funcione:
  • siga o redirect. No cURL, use --location. A maioria dos clientes HTTP segue redirects por padrão;
  • não envie seus headers de autenticação para o link do arquivo. Se o seu cliente repassa headers no redirect, desative isso ou baixe o arquivo em um segundo request;
  • trate a resposta como binário (stream, arraybuffer, bytes), não como JSON.
O redirect leva só para o primeiro arquivo do relatório. Um relatório grande, como o consolidado do mês, pode ter mais de um arquivo. Para pegar todos, consulte o relatório pelo período e baixe cada item de files, como explicado a seguir.

​
Consultar o relatório pelo período

Para ver os arquivos de um relatório sem baixá-los, use o mesmo pattern sem o /stream. A resposta é o JSON do relatório, com todos os links em files:
cURL
A resposta tem o mesmo formato da consulta pelo id, mostrada no passo 2 a seguir.

​
Baixar pela listagem

​
1. Listar os relatórios

Um relatório com status.name igual a FINISHED está pronto para download. O progress vai de 0 a 100 enquanto o relatório é gerado. A listagem é paginada com os query params page (padrão 1) e limit (padrão 10). A paginação vem no header Pagination:
Header
Para percorrer todos os relatórios, incremente page até chegar a pageCount.

​
2. Consultar o relatório

Consulte o relatório pelo id para obter os arquivos:
Se o array files vier vazio, o relatório ainda está sendo gerado ou não tem arquivos. Consulte de novo mais tarde.

​
3. Baixar o arquivo

Baixe o CSV pela URL em files[].link:
O link expira depois de um tempo. Baixe o arquivo logo após consultar o relatório. Se o link expirar, consulte o relatório de novo para gerar um link novo.
Um relatório grande pode ser dividido em mais de um arquivo. Baixe todos os itens de files.

​
Período dos relatórios

O period usa UTC. Um relatório diário vai de 00:00 a 23:59:59 no horário de Brasília, por isso aparece como 03:00Z até 03:00Z do dia seguinte.

​
Referência da API

Baixar relatório por período

GET /baas/api/v1/customer-reports/bankstatement/{pattern}/stream

Consultar relatório por período

GET /baas/api/v1/customer-reports/bankstatement/{pattern}

Listar relatórios

GET /baas/api/v1/customer-reports

Consultar relatório

GET /baas/api/v1/customer-reports/{id}