{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/pluggy/json-schema/pluggy-create-boleto-schema.json",
  "title": "CreateBoleto",
  "description": "Request with information to create a 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/CreateBoleto",
  "type": "object",
  "properties": {
    "boletoConnectionId": {
      "type": "string",
      "format": "uuid",
      "description": "Primary identifier of the boleto connection"
    },
    "boleto": {
      "type": "object",
      "properties": {
        "seuNumero": {
          "type": "string",
          "maxLength": 10,
          "description": "Your identifier for this boleto"
        },
        "amount": {
          "type": "number",
          "minimum": 2.5,
          "description": "Boleto amount"
        },
        "dueDate": {
          "type": "string",
          "format": "date-time",
          "description": "Due date for the boleto. Must be today or in the future."
        },
        "payer": {
          "type": "object",
          "properties": {
            "taxNumber": {
              "type": "string",
              "description": "Payer tax number (CPF/CNPJ)"
            },
            "name": {
              "type": "string",
              "description": "Payer name"
            },
            "addressStreet": {
              "type": "string",
              "description": "Payer street address"
            },
            "addressCity": {
              "type": "string",
              "description": "Payer city"
            },
            "addressState": {
              "type": "string",
              "description": "Payer state"
            },
            "addressZipCode": {
              "type": "string",
              "description": "Payer ZIP code"
            }
          },
          "required": [
            "taxNumber",
            "name",
            "addressState",
            "addressZipCode"
          ]
        },
        "fine": {
          "type": "object",
          "description": "Fine information for late payment",
          "properties": {
            "value": {
              "type": "number",
              "minimum": 0,
              "description": "Fine value"
            },
            "type": {
              "type": "string",
              "enum": [
                "PERCENTAGE",
                "FIXED"
              ],
              "description": "Type of fine calculation"
            }
          },
          "required": [
            "value",
            "type"
          ]
        },
        "interest": {
          "type": "object",
          "description": "Interest information for late payment",
          "properties": {
            "value": {
              "type": "number",
              "minimum": 0,
              "description": "Interest value"
            },
            "type": {
              "type": "string",
              "enum": [
                "PERCENTAGE"
              ],
              "description": "Type of interest calculation"
            }
          },
          "required": [
            "value",
            "type"
          ]
        }
      },
      "required": [
        "seuNumero",
        "amount",
        "dueDate",
        "payer"
      ]
    }
  },
  "required": [
    "boletoConnectionId",
    "boleto"
  ]
}