{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/toku/json-schema/toku-create-adjustment-document-payload-schema.json",
  "title": "CreateAdjustmentDocumentPayload",
  "description": "Subclass of BaseModel that allows public aliases for fields. _aliases defines aliases in the way \"external\": \"internal\"",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/toku-adjustment-documents-api-openapi.yml#/components/schemas/CreateAdjustmentDocumentPayload",
  "properties": {
    "amount": {
      "description": "Monto positivo en la moneda de la Account. La precisión decimal debe coincidir con `currency.decimals` de la Account asociada (por ejemplo, 0 para CLP, 2 para USD, 4 para UF). La moneda no se acepta aquí — se deriva de `id_account`.",
      "exclusiveMinimum": 0,
      "title": "Amount",
      "type": "number"
    },
    "external_id": {
      "description": "Identificador único de este documento de ajuste definido por la organización. Junto con la organización autenticada forma la clave de idempotencia: enviar el mismo par dos veces devuelve el documento original.",
      "maxLength": 256,
      "minLength": 1,
      "title": "External Id",
      "type": "string"
    },
    "id_account": {
      "description": "Identificador de la Account contra la que se aplica el documento. Determina la moneda y debe pertenecer a la organización autenticada.",
      "pattern": "^acc_[a-zA-Z0-9_\\-]{32}$",
      "title": "Id Account",
      "type": "string"
    },
    "id_customer": {
      "description": "Identificador del Customer dueño del documento.",
      "pattern": "^cus_[a-zA-Z0-9_\\-]{32}$",
      "title": "Id Customer",
      "type": "string"
    },
    "id_origin_invoice": {
      "description": "Identificador opcional de la Invoice a la que se liga el documento. Si se envía, el documento solo se puede aplicar al pagar esa Invoice, que debe ser del mismo Customer y la misma Account y no estar pagada ni anulada. Si se omite, el documento se puede aplicar al pagar cualquier Invoice del mismo Customer y Account. No se puede cambiar después: para ligarlo a otra Invoice, anula el documento y registra uno nuevo con otro `external_id`.",
      "pattern": "^in_[a-zA-Z0-9_\\-]{32}$",
      "title": "Id Origin Invoice",
      "type": "string"
    },
    "issued_at": {
      "description": "Fecha y hora opcional (UTC) que representa cuándo se emitió el documento, a diferencia de cuándo se registró en Toku. Omítelo para dejarlo sin definir.",
      "format": "date-time",
      "title": "Issued At",
      "type": "string"
    },
    "metadata": {
      "additionalProperties": {
        "type": "string"
      },
      "description": "Metadata de pares clave/valor de formato libre que se muestra al Customer en el detalle del cobro. Los valores que sean URLs se muestran como enlaces. Por defecto está vacía.",
      "title": "Metadata",
      "type": "object"
    },
    "type": {
      "allOf": [
        {
          "$ref": "#/$defs/AdjustmentDocumentService_AdjustmentDocumentType"
        }
      ],
      "description": "Categoría del documento. `credit_note` = un crédito emitido al Customer; `supplier_invoice` = una factura de proveedor a descontar al momento del cobro. Se pueden agregar nuevas categorías sin necesidad de un nuevo endpoint."
    }
  },
  "required": [
    "external_id",
    "type",
    "amount",
    "id_customer",
    "id_account"
  ],
  "type": "object",
  "$defs": {
    "AdjustmentDocumentService_AdjustmentDocumentType": {
      "description": "An enumeration.",
      "enum": [
        "credit_note",
        "supplier_invoice"
      ],
      "title": "AdjustmentDocumentService_AdjustmentDocumentType"
    }
  }
}