Una nota de venta representa un cobro (o intención de cobro) correspondiente a un producto o servicio por un periodo de tiempo, por ejemplo un ciclo de facturación de una suscripción.
Cada nuevo ciclo de facturación generado por una suscripción genera automáticamente una nueva nota de venta, sin embargo puedes crear cuantas notas de ventas quieras.
Una nota de venta, a diferencia de un pago, puede asociarse a un método de pago inscrito y cobrarse automáticamente en este método de pago, es decir no es necesario que el cliente intervenga. Estos pagos se llaman off session.
Usualmente cada nota de venta se asocia a una factura en sistema de facturación.
El objeto Invoice
InvoiceAtributos
id string
Identificador único del objeto.
object string
Indica el tipo de objeto. Valor siempre será invoice.
amount integer
Un número entero positivo que representa cuánto cobrar en la unidad monetaria más pequeña (por ejemplo, 100 centavos para cobrar USD $ 1,00 o 100 para cobrar CLP $ 100).
Se determina según los productos/ítems asociados.
cancel_url string
Una URL a la cual el cliente será redirigido si la autorización del pago falla.
cancel_url_method enum
El método HTTP a utilizar al redirigir al cliente en caso de un pago fallido.
| Posibles valores |
|---|
post default |
get |
collection_method enum
Indica el método de cobro, que puede ser automático sobre un método de pago inscrito o manualmente con el envío de un recordatorio de pago.
| Posibles valores |
|---|
automatic |
send_invoice |
currency string
Código de moneda ISO de tres letras. Corresponde a la moneda de presentación.
customer object expandible
Objeto customer relacionado.
customer_id string
ID customer relacionado.
default_payment_method object expandible
Objeto payment_method relacionado.
default_payment_method_id string
ID payment_method relacionado. Es el método de pago en donde se intentarán cobrar los ciclos de facturación futuros.
description string
Un texto arbitrario asociado al objeto.
discount amount
Monto total de los descuentos aplicados.
finalized_at datetime
Fecha de finalización.
last_payment_attempt_at datetime
Fecha de ultimo intento de pago.
lines array of objects
Listado de productos o servicios que componen la nota de venta.
marked_uncollectible_at datetime
Fecha cuando la nota de venta se marcó como incobrable.
metadata object
Conjunto de pares llave-valor que puedes asociar a un objeto.
Esto puede resultar útil para almacenar información adicional sobre el objeto en un formato estructurado.
number integer
Número de la nota de venta.
paid boolean
Indica si la nota de venta fue pagada o no.
paid_at datetime
Fecha de pago.
paid_out_of_band boolean
Indica si fue pagada por un canal distinto a VentiPay.
payment_attempts integer
Cantidad de intentos de pago.
period_starts_at datetime
Fecha de inicio del periodo de cobro.
period_ends_at datetime
Fecha de término del periodo de cobro.
proration object
Objeto que indica si el monto a cobrar fue prorrateado y su factor de prorrateo.
status enum
El estado de la nota de venta.
| Posibles valores |
|---|
draftEstado inicial de la nota de venta. Puede ser modificada mientras esté en este estado |
openEstá lista para intentar ser pagada. El monto no puede ser modificado en este estado. |
paidLa nota de venta está pagada exitosamente. |
uncollectibleLa nota de venta se considera como incobrable. |
voidLa nota de venta se encuentra anulada. |
success_url string
Una URL a la cual el cliente será redirigido si la autorización del pago es exitosa.
success_url_method enum
El método HTTP a utilizar al redirigir al cliente en caso de un pago exitoso.
| Posibles valores |
|---|
post default |
get |
subscription object expandible
Objeto subscription relacionado.
subscription_id string
ID subscription relacionado.
subtotal integer
Monto antes de aplicar impuestos.
tax integer
Monto total de los impuestos aplicados.
voided_at datetime
Fecha de anulación.
created_at datetime
Fecha de creación del objeto en formato ISO 8601. Basado en UTC.
updated_at datetime
Fecha de actualización del objeto en formato ISO 8601. Basado en UTC.