v1

latestOpenAPI 3.0.12026-07-245303882.5 MB

Consultar extrato consolidado

Essa API possibilita que seja realizada a consulta de extrato consolidado. Para mais informações de como realizar a implementação dessa API, criamos este artigo.

Para saber mais sobre os erros que essa API retorna ao realizar a consulta, clique aqui

get/tools-conciliation/v1/ConsolidatedStatement

Query parameters

startDatestring date required

Data contábil inicial de pesquisa

endDatestring date required

Data contábil final de pesquisa

pageinteger

Número de página. Por padrão, se não informado, retorna a página 1.

quantityinteger

Quantidade de registros por página. Por padrão a API retorna 1.000 registros

Response

200

Example response

{
  "statement": [
    {
      "date": "2022-01-03T00:00:00",
      "accountDate": "2022-01-03T00:00:00",
      "entryName": "Pgto Contas Concessionarias/Tributos",
      "entryAmount": 47887,
      "value": -4212076.5,
      "indCreditDebit": "D",
      "balance": -1802424.5
    }
  ],
  "balance": {
    "balanceStartDate": 2409652.2,
    "balanceEndDate": -210270.39
  },
  "pagination": {
    "page": 1,
    "totalCount": 16,
    "totalPages": 2,
    "hasNext": true
  }
}