{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/pluggy/json-schema/pluggy-issued-boleto-schema.json",
  "title": "IssuedBoleto",
  "description": "Response with information related to an issued boleto",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/pluggy-boleto-management-api-openapi.yml#/components/schemas/IssuedBoleto",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Primary identifier"
    },
    "amount": {
      "type": "number",
      "description": "Boleto amount",
      "minimum": 2.5
    },
    "status": {
      "type": "string",
      "description": "Current status of the boleto.\n- `OPEN`: the boleto has been issued and is awaiting payment.\n- `PAID`: the boleto has been paid (see `paidAt`, `amountPaid`, `paymentOrigin`).\n- `OVERDUE`: the due date has passed and the boleto has not been paid.\n- `CANCELLED`: the boleto was canceled by the issuer.\n- `PROTESTED`: the boleto was sent to a protesto/credit-bureau process.",
      "enum": [
        "OPEN",
        "PAID",
        "OVERDUE",
        "CANCELLED",
        "PROTESTED"
      ]
    },
    "seuNumero": {
      "type": "string",
      "maxLength": 10,
      "description": "Your identifier for this boleto"
    },
    "dueDate": {
      "type": "string",
      "format": "date-time",
      "description": "Due date of the boleto"
    },
    "payer": {
      "type": "object",
      "properties": {
        "taxNumber": {
          "type": "string",
          "description": "Payer tax number (CPF/CNPJ)"
        },
        "personType": {
          "type": "string",
          "description": "Type of person (individual or business)"
        },
        "name": {
          "type": "string",
          "description": "Payer name"
        },
        "addressStreet": {
          "type": "string",
          "description": "Payer street address"
        },
        "addressNumber": {
          "type": "string",
          "description": "Payer address number"
        },
        "addressComplement": {
          "type": "string",
          "description": "Additional address information"
        },
        "addressNeighborhood": {
          "type": "string",
          "description": "Payer neighborhood"
        },
        "addressCity": {
          "type": "string",
          "description": "Payer city"
        },
        "addressState": {
          "type": "string",
          "description": "Payer state"
        },
        "addressZipCode": {
          "type": "string",
          "description": "Payer ZIP code"
        },
        "email": {
          "type": "string",
          "description": "Payer email"
        },
        "ddd": {
          "type": "string",
          "description": "Payer area code"
        },
        "phoneNumber": {
          "type": "string",
          "description": "Payer phone number"
        }
      },
      "required": [
        "taxNumber",
        "name",
        "addressState",
        "addressZipCode"
      ]
    },
    "pixQr": {
      "type": "string",
      "description": "PIX QR code for payment"
    },
    "digitableLine": {
      "type": "string",
      "description": "Boleto digitable line"
    },
    "nossoNumero": {
      "type": "string",
      "description": "Bank's internal identifier for the boleto"
    },
    "barcode": {
      "type": "string",
      "description": "Boleto barcode"
    },
    "boletoConnectionId": {
      "type": "string",
      "format": "uuid",
      "description": "ID of the boleto connection used to create this boleto"
    },
    "createdAt": {
      "type": "string",
      "format": "date-time",
      "description": "Date when the boleto was created"
    },
    "amountPaid": {
      "type": [
        "number",
        "null"
      ],
      "description": "Amount that was paid for this boleto"
    },
    "paymentOrigin": {
      "type": [
        "string",
        "null"
      ],
      "enum": [
        "PIX",
        "BOLETO",
        null
      ],
      "description": "Origin of the payment when the boleto is paid"
    },
    "fine": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "value": {
          "type": "number",
          "minimum": 0,
          "description": "Fine value"
        },
        "type": {
          "type": "string",
          "enum": [
            "PERCENTAGE",
            "FIXED"
          ],
          "description": "Type of fine calculation"
        }
      },
      "description": "Fine information for late payment"
    },
    "interest": {
      "type": "object",
      "properties": {
        "value": {
          "type": "number",
          "minimum": 0,
          "description": "Interest value"
        },
        "type": {
          "type": "string",
          "enum": [
            "PERCENTAGE"
          ],
          "description": "Type of interest calculation"
        }
      },
      "description": "Interest information for late payment"
    },
    "paidAt": {
      "type": "string",
      "format": "date-time",
      "description": "Date when the boleto was paid"
    }
  },
  "required": [
    "id",
    "amount",
    "status",
    "createdAt",
    "seuNumero",
    "dueDate",
    "payer",
    "digitableLine",
    "barcode",
    "boletoConnectionId"
  ]
}