HomeGuíasAPI ReferenceChangelog
Log In
API Reference
  1. Recursos principales
  2. Invoices

Crear Invoice

post
https://api.trytoku.com/invoices

Crea una Invoice o actualiza la existente si coincide el identificador.

Es la forma de cargar una Invoice a un Customer. Toda Invoice queda asociada a una Subscription: puedes indicarla por su identificador público si ya existe, o enviar un product_id y dejar que Toku resuelva la Subscription a partir de él. Es idempotente por su identificador de negocio (product_id más due_date o invoice_external_id): si la Invoice ya existe se actualiza y la respuesta es 200; si es nueva se crea y la respuesta es 201. El monto va en la moneda de la Invoice, con los decimales que esa moneda admita.

Límite de tasa: 20 solicitudes por segundo. Al superarlo, la API responde 429. Ver Límites de tasa.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Campos del cuerpo para crear o actualizar una Invoice.

number
≥ 0

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.

string
enum

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.

Allowed:
string
required

Identificador público del Customer (cus_...) dueño de la Invoice.

boolean
Defaults to false

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.

string
required
length ≤ 256
^\S+$

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

InvoiceExpirationAction | string

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.

string

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.

integer

Identificador del recibo asociado a la Invoice.

string
length ≤ 256

Identificador único de la deuda externo a Toku. Permite distinguir dos Invoices del mismo producto que vencen el mismo día.

boolean

Marca la Invoice como pagada al crearla o editarla.

boolean
Defaults to false

Indica si la Invoice está anulada.

string
^((https://)|(http://))[a-zA-Z0-9.\-_~+#,%&=*;:@!/()?`_{}[\]|~]+$

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.

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.

metadata
object

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.

string
length ≤ 256
^(?! ).*(?<! )$

Identificador del producto de la organización asociado a la Invoice.

string
enum

Tipo de recibo a emitir para la Invoice: bill (boleta), invoice (factura) o no_receipt (sin recibo).

Allowed:
string
length ≤ 32

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.

string

Identificador público de la Subscription (sub_...) a la que pertenece la Invoice.

Headers
string

Llave de API de una Account, para operar sobre esa Account en lugar de la principal.

date

Versión del API para esta petición, como cualquier fecha YYYY-MM-DD. Fija el contrato de la respuesta; si se omite, se deriva de la fecha de creación de la organización.

Responses

Updated 5 days ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 5 days ago

Did this page help you?