Sobre API de Extrato Consolidado
O que é Extrato Consolidado?
Do ponto de vista financeiro, extrato consolidado consiste na apresentação de um conjunto de informações organizadas de maneira clara, facilitando o entendimento a respeito das transações de um determinado serviço. Possui a função de apresentar todas as movimentações realizadas em uma conta corrente/ poupança ou de débitos e créditos fiscais, como INSS e FGTS.
Por que consultar o extrato na Celcoin?
A consulta é necessária para conferir os extratos de operações realizadas pelas APIs da Celcoin com o seu fluxo de caixa, garantindo transparência e permitindo identificar possíveis divergências.
Pré requisitos para implementação:
- Possuir uma chave API da Celcoin, para mais informações acessar esse link.
- Ter familiaridade com APIs Rest usando o protocolo OAuth 2.0.
Esta funcionalidade tem o objetivo de facilitar a conciliação entre o cliente e a Celcoin, possibilitando uma manipulação mais eficiente dos dados e uma estabilidade de retorno constante e mais seguro.
Caso de uso:
Como fintech, quero consultar, via API, os lançamentos transacionais contábeis gerados anteriormente para poder realizar minha conciliação com a Celcoin.
Consultar Extrato Consolidado
A API para Consultar Extrato Consolidado permite buscar em D+1 o extrato consolidado por produto. Nesta consulta é possível passar os seguintes parâmetros de busca:
- startDate- Data contábil inicial de pesquisa, seguindo formato AAAA-MM-DD.
- endDate– Data contábil final de pesquisa, seguindo formato AAAA-MM-DD.
- page - Identificador da página da listagem retornada.
- quantity - Identificador da quantidade por página retornada.
️ Atenção!
É necessário informar pelo menos startDate e endDate para realizar a consulta.
Pesquisa limitada em 15 dias de intervalo entre startDate e endDate.
Modelo de request:
curl --location --request GET 'https://sandbox.openfinance.celcoin.dev/tools-conciliation/v1/ConsolidatedStatement?startDate=2022-01-02&endDate=2022-01-03' \
--header 'accept: application/json' \
--header 'Authorization: Bearer {access_token}'
Modelo de response:
{
"statement": [
{
"date": "2022-01-03T00:00:00",
"accountDate": "2022-01-03T00:00:00",
"nsa": 5729,
"entryName": "Pgto Contas Concessionarias/Tributos",
"entryAmount": 47887,
"value": -4212076.5,
"indCreditDebit": "D",
"balance": -1802424.5
},
{
"date": "2022-01-03T00:00:00",
"accountDate": "2022-01-03T00:00:00",
"nsa": 5729,
"entryName": "Pgto Contas Boletos",
"entryAmount": 204577,
"value": -24533722,
"indCreditDebit": "D",
"balance": -26336146
},
{
"date": "2022-01-03T00:00:00",
"accountDate": "2022-01-03T00:00:00",
"nsa": 5729,
"entryName": "Recarga",
"entryAmount": 103422,
"value": -1746272.9,
"indCreditDebit": "D",
"balance": -28082420
},
{
"date": "2022-01-03T00:00:00",
"accountDate": "2022-01-03T00:00:00",
"entryName": "Depósito",
"entryAmount": 20,
"value": 12520000,
"indCreditDebit": "C",
"balance": -22277410
},
{
"date": "2022-01-03T00:00:00",
"accountDate": "2022-01-03T00:00:00",
"entryName": "Estorno de Contas",
"entryAmount": 113,
"value": 4824.52,
"indCreditDebit": "C",
"balance": -22272586
},
{
"date": "2022-01-03T00:00:00",
"accountDate": "2022-01-03T00:00:00",
"entryName": "Estorno de Conta - Desfazimento",
"entryAmount": 1,
"value": 55,
"indCreditDebit": "C",
"balance": -22272530
},
{
"date": "2022-01-03T00:00:00",
"accountDate": "2022-01-03T00:00:00",
"entryName": "Devolução Transferencias",
"entryAmount": 69,
"value": 19452.8,
"indCreditDebit": "C",
"balance": -22253078
},
{
"date": "2022-01-03T00:00:00",
"accountDate": "2022-01-03T00:00:00",
"entryName": "Transferencias",
"entryAmount": 775,
"value": -292824.75,
"indCreditDebit": "D",
"balance": -28375244
},
{
"date": "2022-01-03T00:00:00",
"accountDate": "2022-01-03T00:00:00",
"entryName": "Pagamento Eletronico",
"entryAmount": 345,
"value": 268750,
"indCreditDebit": "C",
"balance": -21984328
},
{
"date": "2022-01-03T00:00:00",
"accountDate": "2022-01-03T00:00:00",
"entryName": "Recebimento Eletronico",
"entryAmount": 7,
"value": -920,
"indCreditDebit": "D",
"balance": -28376164
}
],
"balance": {
"balanceStartDate": 2409652.2,
"balanceEndDate": -210270.39
},
"pagination": {
"page": 1,
"totalCount": 16,
"totalPages": 2,
"hasPrevious": false,
"hasNext": true
}
}
Descrição dos campos
A seguir, a lista com a descrição dos campos retornados nas requisições:
| Campo | Tipo | Descrição |
|---|---|---|
| Date | DateTime | Data do lançamento |
| AccountDate | DateTime | Data liquidação dos lançamentos |
| EntryName | String | Histórico de lançamento |
| EntryAmount | Int32 | Quantidade de lançamentos para o histórico |
| Value | Float | Valor totalizador do lançamento |
| IndCreditDebit | String | Indicativo de Crédito ou Débito |
| Balance | Float | Saldo após lançamento |
| BalanceStartDate | Float | Valor de saldo inicial da pesquisa |
| BalanceEndDate | Float | Valor de saldo final da pesquisa |
| NSA | Int16 | Identificador ND |
️ Atenção!
Para testar essa API é necessário realizar uma ou mais transações (Pix, Boleto, Recarga, Débito automático, etc.).
É importante ressaltar que as consultas neste endpoint só serão apresentadas no dia posterior (D+1) ao processamento da transação, pois buscamos que nosso ambiente de Sandbox tenha o mesmo comportamento que o de Produção.
Updated 4 months ago