About Consolidated Statement API
What is a Consolidated Statement?
From a financial point of view, a consolidated statement consists of the presentation of a set of information organized in a clear manner, facilitating understanding of the transactions of a given service. Its function is to present all transactions made in a current/savings account or tax debits and credits, such as INSS and FGTS.
Why check your statement at Celcoin?
The consultation is necessary to check the statements of operations carried out by Celcoin APIs with your cash flow, ensuring transparency and allowing the identification of possible discrepancies.
Quem pode utilizar esta API?
Clientes que possuem contrato de produtos Avulsos ou de Banking as a Service.
Prerequisites for implementation:
- Have a Celcoin API key, for more information access this link .
- Have familiarity with Rest APIs using the OAuth 2.0 protocol.
This functionality aims to facilitate reconciliation between the client and Celcoin, enabling more efficient data handling and constant and safer return stability.
Use case:
As a fintech, I want to consult, via API, the previously generated accounting transactional entries so that I can carry out my reconciliation with Celcoin.
Consult Consolidated Statement
The API for Consulting Consolidated Statement allows you to search for the consolidated statement by product on D+1. In this query, you can pass the following search parameters:
- startDate- Initial accounting date of research, following the YYYY-MM-DD format.
- endDate – Final accounting date of the search, following the YYYY-MM-DD format.
- page - Identifier of the page of the returned listing.
- quantity - Identifier of the quantity per page returned.
️ Attention!
You must provide at least startDate and endDate to perform the query.
Search limited to 15 days interval between startDate and endDate .
Request model:
cURL
curl --location --request GET 'https://sandbox.openfinance.celcoin.dev/tools-conciliation/v2/painel/ConsolidatedStatement?startDate=2025-03-01&endDate=2025-03-10&page=1' \ --header 'accept: application/json' \ --header 'Authorization: Bearer {access_token}'
Response model:
JSON
[ { "data": "05/03/2025", "nomeHistorico": "Saldo", "qtdOperacoes": 0, "debito": 0, "credito": 0, "saldoDia": 0, "saldo": -57201737.1700, "historicoId": 0, "nsa": 0 }, { "data": "05/03/2025", "dataContabil": "05/03/2025", "nomeHistorico": "Pgto Contas Concessionarias/Tributos", "qtdOperacoes": 5969, "debito": -526627.6000, "credito": 0, "saldoDia": 0, "saldo": -57728364.7700, "historicoId": 8, "nsa": 22428 }, { "data": "05/03/2025", "dataContabil": "05/03/2025", "nomeHistorico": "Pgto Contas Boletos", "qtdOperacoes": 16922, "debito": -4860071.2400, "credito": 0, "saldoDia": 0, "saldo": -62588436.0100, "historicoId": 9, "nsa": 22428 }, { "data": "10/03/2025", "dataContabil": "10/03/2025", "nomeHistorico": "Saldo", "qtdOperacoes": 0, "debito": 0, "credito": 0, "saldoDia": 0, "saldo": -57339557.2400, "historicoId": 0, "nsa": 0 } ]
Field description
Below is a list with a description of the fields returned in the requests:
| Field | Type | Description |
|---|---|---|
| Date | String | Release date |
| dataContabil | String | Settlement date of releases |
| nameHistory | String | Release history |
| qtyOperations | Int32 | Number of releases for history |
| debit | Decimal | Total value of the launch |
| credit | Decimal | Credit or Debit Indicator |
| balanceDay | Decimal | Balance after release |
| balance | Decimal | Initial research balance value |
| historicalId | Int32 | Final survey balance value |
| nsa | Int32 | ND Identifier |
️ Attention!
To test this API, you need to perform one or more transactions (Pix, Boleto, Recharge, Automatic Debit, etc.).
It is important to note that queries on this endpoint will only be presented on the day after (D+1) the transaction is processed, as we aim for our Sandbox environment to have the same behavior as the Production environment.