Fatura

Obter os detalhes do pagamento da fatura.

get/statements/{invoiceId}/paymentDetail

Request

  • The document declares no server URL.
  • Auth
    none declared

Path parameters

invoiceIdinteger required

Id da Fatura

Headers

Program-Idinteger

Programa Id Externo

Response

Ok

versionstring
statusinteger

Example response

{
  "version": "1.0.0",
  "status": 200,
  "body": {
    "invoiceId": 1,
    "accountId": 1,
    "programId": 1,
    "cycle": 4,
    "invoiceCycle": 3,
    "cycleStartDate": "2025-04-26",
    "cycleClosingDate": "2025-05-26",
    "dueDate": "2025-06-10",
    "dueDateBusinessDay": "2025-06-10",
    "totalCreditAmount": "17.08",
    "totalDebitAmount": "23.52",
    "balanceAmount": "23.52",
    "minimumPaymentAmount": "0.00",
    "invoiceExternalId": 1408641988,
    "invoiceStatus": "FECHADA",
    "createdAt": "2025-07-31 19:42:58",
    "updatedAt": "2025-07-31 19:50:00",
    "billing": {
      "billId": 89,
      "requestId": "025fe274-6764-454b-8f41-a3454e3fa7c0",
      "externalId": "688bc7455f74e8dcfc597779",
      "accountId": 236,
      "nominalValue": "23.52",
      "bankNumber": "3000000000155829",
      "billNumber": "3025073106194552343",
      "billReferenceNumber": "1753990984815000731",
      "barCode": "50992116900000023520000000003000000000166829",
      "digitableLine": "50990000010000300000700001828292215590000002352",
      "dueDate": "2025-08-10",
      "issueDate": "2025-07-31",
      "origin": "WORKER",
      "documentKind": "DUPLICATA_MERCANTIL",
      "paymentType": "PARCIAL",
      "status": "REGISTRADO",
      "beneficiary": {
        "documentType": "CNPJ",
        "document": "40749371000155",
        "name": "Cliente X"
      },
      "beneficiaryFinal": {
        "documentType": "CNPJ",
        "document": "40749371000155",
        "name": "Cliente X"
      },
      "payer": {
        "documentType": "CPF",
        "name": "Joao Silva",
        "document": "75896767803",
        "address": "Rua Dezenove, 573",
        "city": "Betim",
        "state": "MG",
        "zipCode": "32634747"
      }
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.