v1

latestOpenAPI 3.1.02026-07-261420929.5 KB

Consultar um carnê customizado

Consulte um carnê customizado através do seu ID.

get/custom_payment_booklets/{id}

Path parameters

idstring required

ID do Carnê Customizado que deseja consultar

Response

200

idstring
descriptionstring
custom_payment_booklet_invoicesinteger
secure_urlstring

Example response

{
  "id": "7A0155B45001498DB0A2D71974A19881",
  "custom_payment_booklet_invoices": 3,
  "secure_url": "https://faturas.iugu.test/custom_payment_booklet/7a0155b4-5001-498d-b0a2-d71974a19881-c974",
  "invoices": [
    {
      "id": "D88D0092251044C7A0FD899306345862",
      "due_date": "2023-04-12",
      "currency": "BRL",
      "email": "teste@teste.com",
      "items_total_cents": 1000,
      "status": "pending",
      "total_cents": 1000,
      "payable_with": [
        "credit_card"
      ],
      "updated_at": "2023-02-17T18:00:04.000-03:00",
      "payer_name": "Teste da Silva",
      "payer_email": "payer.email@teste.com",
      "payer_cpf_cnpj": "23194443003",
      "payer_phone": "12345678",
      "payer_phone_prefix": "11",
      "payer_address_zip_code": "29190560",
      "payer_address_street": "Rua A",
      "payer_address_district": "Polivalente",
      "payer_address_state": "SP",
      "payer_address_number": "100",
      "payer_address_complement": "ap 32",
      "payer_address_country": "Brasil",
      "late_payment_fine": 2,
      "account_id": "068A36CA56CE4E3DA1F749A247D2DDBD",
      "bank_account_branch": "0001",
      "bank_account_number": "5799207-0",
      "account_name": "03316142000150 - GRUPO 3 (doc. requested)",
      "secure_id": "d88d0092-2510-44c7-a0fd-899306345862-7e82",
      "secure_url": "https://faturas.iugu.test/d88d0092-2510-44c7-a0fd-899306345862-7e82",
      "total": "10.00 BRL",
      "taxes_paid": "0.00 BRL",
      "total_paid": "0.00 BRL",
      "total_overpaid": "0.00 BRL",
      "total_refunded": "0.00 BRL",
      "commission": "0.00 BRL",
      "fines_on_occurrence_day": "0.00 BRL",
      "total_on_occurrence_day": "0.00 BRL",
      "paid": "0.00 BRL",
      "created_at": "17 Feb 03:33 PM",
      "created_at_iso": "2023-02-17T15:33:42-03:00",
      "transaction_number": 69972,
      "bank_slip": {
        "digitable_line": "23793.38128 60000.006993 72000.050806 1 93180000001000",
        "barcode_data": "23791931800000010003381260000006997200005080",
        "barcode": "https://api.iugu.test/v1/public/invoice/d88d0092-2510-44c7-a0fd-899306345862-7e82/barcode",
        "bank_slip_bank": 237,
        "bank_slip_status": "processing"
      },
      "items": [
        {
          "id": "5000FE3CE6CB4728ACF4B0F2BEC604EC",
          "description": "Item teste",
          "price_cents": 1000,
          "quantity": 1,
          "created_at": "2023-02-17T15:33:42.000-03:00",
          "updated_at": "2023-02-17T15:33:42.000-03:00",
          "price": "10.00 BRL"
        }
      ],
      "variables": [
        {
          "variable": "next_dunning_date",
          "value": "2023-04-12"
        }
      ],
      "logs": [
        {
          "id": "68B0BDD5B87A4EE8BDB159B362BBEECB",
          "description": "Reminder email sent!",
          "notes": "Successfully sent reminder to: teste@teste.com",
          "created_at": "17 Feb 03:33 PM"
        }
      ]
    }
  ]
}