{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/toku/json-schema/toku-create-or-update-invoice-payload-schema.json",
  "title": "CreateOrUpdateInvoicePayload",
  "description": "Campos del cuerpo para crear o actualizar una Invoice.",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/toku-invoices-api-openapi.yml#/components/schemas/CreateOrUpdateInvoicePayload",
  "properties": {
    "amount": {
      "description": "Monto de la Invoice, expresado en la moneda indicada en `currency_code`. La cantidad de decimales admitida la define la moneda: CLP no acepta decimales, MXN y BRL aceptan 2, y CLF acepta 4. Debe ser menor que 1.000.000.000.000.000 (10^15).",
      "exclusiveMaximum": 1000000000000000,
      "minimum": 0,
      "title": "Amount",
      "type": "number"
    },
    "currency_code": {
      "allOf": [
        {
          "$ref": "#/$defs/CurrencyIso"
        }
      ],
      "description": "Moneda de la Invoice. Si se omite, se usa la moneda de la Account de cobro, o la que ya tenía la Invoice cuando se está actualizando una existente."
    },
    "customer": {
      "description": "Identificador público del Customer (`cus_...`) dueño de la Invoice.",
      "title": "Customer",
      "type": "string"
    },
    "disable_automatic_payment": {
      "default": false,
      "description": "Excluye la Invoice del cobro automático. Permite cargarla sin que se mande a cobrar aunque el Customer tenga un método de pago automático activo.",
      "title": "Disable Automatic Payment",
      "type": "boolean"
    },
    "due_date": {
      "description": "Fecha de vencimiento de la Invoice, en formato `YYYY-MM-DD`.",
      "maxLength": 256,
      "pattern": "^\\S+$",
      "title": "Due Date",
      "type": "string"
    },
    "expiration_action": {
      "anyOf": [
        {
          "$ref": "#/$defs/InvoiceExpirationAction"
        },
        {
          "type": "string"
        }
      ],
      "description": "Acción que se ejecuta sobre la Invoice cuando expira. Se envía un string vacío para dejarla sin acción de expiración.",
      "title": "Expiration Action"
    },
    "expiration_date": {
      "description": "Fecha y hora de expiración de la Invoice; a partir de ese momento no se realizan más intentos de cobro. Se acepta `YYYY-MM-DD HH:MM:SS` (hora local de la organización) o una fecha ISO 8601 con zona horaria explícita.",
      "title": "Expiration Date",
      "type": "string"
    },
    "id_receipt": {
      "description": "Identificador del recibo asociado a la Invoice.",
      "title": "Id Receipt",
      "type": "integer"
    },
    "invoice_external_id": {
      "description": "Identificador único de la deuda externo a Toku. Permite distinguir dos Invoices del mismo producto que vencen el mismo día.",
      "maxLength": 256,
      "title": "Invoice External Id",
      "type": "string"
    },
    "is_paid": {
      "description": "Marca la Invoice como pagada: registra un pago externo por el monto total de la Invoice. Al editar una Invoice ya pagada, enviarlo en `false` elimina el pago registrado y la deja no pagada; no se puede desmarcar si el pago lo cobró Toku.",
      "title": "Is Paid",
      "type": "boolean"
    },
    "is_void": {
      "default": false,
      "description": "Indica si la Invoice está anulada.",
      "title": "Is Void",
      "type": "boolean"
    },
    "link_payment": {
      "description": "URL donde se debe pagar la Invoice. Se deja vacía para usar el portal de pagos de Toku; se completa solo si se desea utilizar un procesador de pagos externo.",
      "pattern": "^((https://)|(http://))[a-zA-Z0-9.\\-_~+#,%&=*;:@!/()?`_{}\\[\\]|~]+$",
      "title": "Link Payment",
      "type": "string"
    },
    "max_collection_attempts": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "string"
        }
      ],
      "description": "Cantidad máxima de intentos de cobro antes de que la Invoice expire. Se envía un string vacío para quitar el límite.",
      "title": "Max Collection Attempts"
    },
    "metadata": {
      "additionalProperties": {
        "type": "string"
      },
      "default": {},
      "description": "Valores adicionales definidos por la organización. Se tratan como texto y no pueden superar los 256 caracteres cada uno. Deben declararse en la webapp de Toku antes de poder usarse.",
      "title": "Metadata",
      "type": "object"
    },
    "product_id": {
      "description": "Identificador del producto de la organización asociado a la Invoice.",
      "maxLength": 256,
      "pattern": "^(?:[^ \\n](?:[^\\n]*[^ \\n])?)?$",
      "title": "Product Id",
      "type": "string"
    },
    "receipt_type": {
      "allOf": [
        {
          "$ref": "#/$defs/ReceiptType"
        }
      ],
      "description": "Tipo de recibo a emitir para la Invoice: `bill` (boleta), `invoice` (factura) o `no_receipt` (sin recibo)."
    },
    "source": {
      "description": "Origen desde el que se creó la Invoice. Se informa cuando la carga proviene de una integración o de un proceso interno; en una creación por API se deja vacío.",
      "maxLength": 32,
      "title": "Source",
      "type": "string"
    },
    "subscription": {
      "description": "Identificador público de la Subscription (`sub_...`) a la que pertenece la Invoice.",
      "title": "Subscription",
      "type": "string"
    }
  },
  "required": [
    "due_date",
    "customer"
  ],
  "type": "object",
  "$defs": {
    "CurrencyIso": {
      "description": "Moneda, en código [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html). Cubre las monedas de los países donde Toku opera —`CLP` (peso chileno), `MXN` (peso mexicano) y `BRL` (real)— más `USD` y `CLF`, la Unidad de Fomento chilena. La moneda determina cuántos decimales admiten los montos: `CLP` no admite decimales, `MXN`, `BRL` y `USD` admiten dos, y `CLF` cuatro.",
      "enum": [
        "CLP",
        "CLF",
        "MXN",
        "BRL",
        "USD"
      ],
      "title": "CurrencyIso",
      "type": "string"
    },
    "InvoiceExpirationAction": {
      "description": "Acción que se ejecuta sobre una Invoice cuando expira: marcarla como expirada (`EXPIRE`), anularla (`VOID`) o eliminarla (`DELETE`). `EXPIRE` es legado: se mantiene por compatibilidad, pero deja la Invoice en el estado `EXPIRED`, que está deprecado. Para nuevas integraciones usa `VOID` o `DELETE`.",
      "enum": [
        "EXPIRE",
        "VOID",
        "DELETE"
      ],
      "title": "InvoiceExpirationAction",
      "type": "string"
    },
    "ReceiptType": {
      "description": "Documento tributario que se emite al cobrar: `bill` es una boleta, `invoice` una factura y `no_receipt` deja el cobro sin documento asociado.",
      "enum": [
        "bill",
        "invoice",
        "no_receipt"
      ],
      "title": "ReceiptType",
      "type": "string"
    }
  }
}