v1

latestOpenAPI 3.0.12026-07-245303882.5 MB

Fatura

Listar faturas da conta.

get/statements/accounts/{accountId}/statements

Path parameters

accountIdinteger required

Id da Conta

Query parameters

invoiceExternalIdinteger

Id da Fatura Externo

perPageinteger

Quantidade de itens por página (mín: 1, máx: 24)

status'FECHADA' | 'ABERTA' | 'FUTURA'

Status da fatura

datestring date

Data da fatura (formato: Y-m-d)

direction'asc' | 'desc'

Direção da ordenação

orderBy'status' | 'date'

Campo para ordenação

Headers

Program-Idinteger

Programa Id Externo

Response

versionstring

statusnumber

Example response

{
  "version": "1.0.0",
  "status": 200,
  "body": {
    "data": [
      {
        "invoiceId": 255,
        "accountId": 116,
        "programId": 7,
        "cycle": 2,
        "invoiceCycle": 2,
        "cycleStartDate": "2025-03-22",
        "cycleClosingDate": "2025-04-21",
        "dueDate": "2025-05-11",
        "dueDateBusinessDay": "2025-05-12",
        "totalCreditAmount": "0.00",
        "totalDebitAmount": "0.00",
        "balanceAmount": 696.55,
        "minimumPaymentAmount": "0.00",
        "invoiceExternalId": 2490388734,
        "invoiceStatus": "ABERTA",
        "createdAt": "2025-04-11 21:35:09",
        "updatedAt": "2025-01-01 00:00:00"
      }
    ],
    "currentPage": 1,
    "totalPages": 2,
    "itemsPerPage": 6
  }
}