v1

latestOpenAPI 3.1.02026-07-24820248.4 KB

Editar Invoice

put/invoices/{id}

Path parameters

idstring required

ID de la Invoice entregado en su creación.

Headers

x-account-keystring

Llave única que identifica la Cuenta de cobro

Request body

product_idstring

Identificador interno del producto que genera el Invoice. Puede ser un número de contrato o de propuesta. Debe ser único por Cuenta de cobro.

due_datestring date

Fecha de vencimiento del Invoice, en formato YYYY-MM-DD.

amountnumber float

Monto adeudado en CLP.

is_paidboolean

Indica si el Invoice se encuentra pagado o no.

is_voidboolean

Indica si el Invoice se encuentra anulado o no. Los Invoices anulados se tratan como si hubiesen sido borrados.

link_paymentstring

URL en el que se debe pagar el Invoice. Dejar en blanco en caso de usar el portal de pagos de Toku. Incluir solo en el case de que poseas tu propio procesador de pagos.

receipt_typestring

Tipo de recibo de la invoice, puede ser 'bill' o 'invoice', dependiendo de si hace referencia a factura o a boleta. Solo aplica para módulo de facturación Chile.

disable_automatic_paymentboolean

Permite cargar invoice y evitar que se manden a cobrar automáticamente en caso de que el customer tenga un método de pago automático activo.

currency_codestring

Permite escoger la moneda a la que corresponde el monto de la Invoice. Acepta valores CLP o CLF

invoice_external_idstring

Identificador único de la deuda, permite diferenciar dos deudas con due_date el mismo día. En caso de no enviar se concatenara "product_id-due_date"

metadatastring json

Valores adicionales específicos de cada deuda. Son tratados como valores de texto y que no pueden tener más de 256 caracteres cada uno. Debes agregarlos en la webapp de Toku antes de poder utilizarlos aquí.

expiration_datestring date-time

Fecha y hora exacta de expiración de la invoice. Ejemplo: 2025-03-10 00:00:00

max_collection_attemptsinteger

Número máximo de intentos de cobro antes de ejecutar la acción de expiración.

expiration_action'VOID' | 'DELETE'

Acción a ejecutar cuando la invoice expira. Valores posibles: VOID, DELETE.

Response

200

customerstring

product_idstring

subscriptionstring

is_paidboolean

due_datestring

is_voidboolean

amountinteger

link_paymentstring

{"stackTrail":"paths:/invoices/{id}:put:responses:200:content:application/json:schema:properties:receipt_type","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/invoices/{id}:put:responses:200:content:application/json:schema:properties:id_receipt","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/invoices/{id}:put:responses:200:content:application/json:schema:properties:source","oasType":"schema","type":"unknown"}

disable_automatic_paymentboolean

currency_codestring

invoice_external_idstring

statusstring

idstring

Example response

{
  "customer": "cus_IANswlLiEc63IbyxVQtnSjYswibj8kII",
  "product_id": "92792",
  "subscription": "sub_dqoskUMFGszKHWXpQ9nJyt-3mhxaKy6z",
  "due_date": "2021-03-04",
  "amount": 1000,
  "link_payment": "https://portal.pagos.com/tu-empresa",
  "metadata": {
    "car_brand": "Toyota",
    "car_model": "Yaris"
  },
  "currency_code": "CLP",
  "invoice_external_id": "ejemplo-invoice-external-id",
  "status": "UNPAID",
  "id": "in_K3a1P1_p_t5UHJHJXmpkQYmqXCHvXrNi"
}