Crear Invoice

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

Body Params

customer

string

required

ID del Customer entregado en su creación.

product_id

string

Identificador interno del producto que genera el Invoice. Puede ser un número de contrato o de propuesta. Si envías algo en el campo subscription, el valor de product_id será ignorado.

due_date

date

required

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

subscription

string

required

ID de la Subscription a la cual asociar la nueva invoice. Si por algún motivo no tienes acceso a la subscription, puedes no enviar este campo y usar el campo product_id en su lugar.

amount

float

required

Monto adeudado en moneda local

is_paid

boolean

Indica si el Invoice se encuentra pagado o no.

is_void

boolean

Defaults to false

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

link_payment

string

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.

metadata

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í.

receipt_type

string

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.

id_receipt

string

ID del recibo. Solo aplica para módulo de facturación Chile.

disable_automatic_payment

boolean

Defaults to false

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_code

string

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

invoice_external_id

string

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"

Headers

x-account-key

string

Llave única que identifica la Cuenta de cobro

Responses

Language

Credentials

Header


xxxxxxxxxx
10
1
curl --request POST \
2
     --url https://api.trytoku.com/invoices \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "is_void": false,
8
  "disable_automatic_payment": false
9
}
10
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

201201

404404

409409

422422