Vista previa factura de venta

post

https://api.alegra.com/api/v1/invoices/preview

Endpoint que permite generar la url para consultar el pdf de la vista previa de la creación de la factura de venta.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

paymentMethod

string

Para México, requerido, representa la forma de pago de la factura. Las opciones posibles son: cash Efectivo, debit-card Tarjeta de débito, credit-card Tarjeta de crédito, service-card Tarjeta de servicios, transfer Transferencia electrónica de fondos, check Cheque nominativo, electronic-wallet Monedero electrónico, electronic-money Dinero electrónico, grocery-voucher Vale de despensa, dation-payment Dación en pago, subrogation-payment Pago por subrogación, allocation-payment Pago por consignación, forgiveness Condonación, compensation Compensación, novation Novación, misunderstanding Confusión, debt-remission Remisión de deuda, prescription-or-expiration Prescripción o caducidad, creditor-satisfaction A satisfacción del acreedor. Si el paymentType es "PPD" solo admite el paymentMethod other Por Definir.

accountNumber

string

Para México, representa el número de cuenta o tarjeta de pago. Debe tener mínimo 4 caracteres.

paymentType

string

Para México, representa el método de la factura. Admite los valores PUE para Pago en Una sola Exhibición y PPD para Pago en Parcialidades o Diferido.

date

string

required

Fecha de la factura. Formato yyyy-MM-dd.

dueDate

string

required

Fecha de vencimiento de la factura. Formato yyyy-MM-dd.

anotation

string

Notas de la factura, visibles en el PDF o documento impreso. Longitud máxima permitida: 500.

termsConditions

string

Términos y condiciones de la factura. Longitud máxima permitida: 500.

client

object

required

Objecto que contiene el id del cliente asociado a la factura. Se puede enviar directamente el id del cliente en este atributo.

numberTemplate

object

Objeto que contiene la información de la numeración de la factura. Para numeraciones automáticas solo debe incluir el id de la numeración, para numeraciones manuales se debe enviar como mínimo el id de la numeración y el número de la factura. Si no se envía este atributo la aplicación intenta crear la factura con la numeración preferida que tiene configurada la empresa. Si no es posible retorna error. Para la creación de tickets de venta (México) es necesario enviar la numeración de tipo Ticket de venta. Para la creación de Documento equivalente P.O.S. (Colombia) es necesario enviar la numeración de tipo Documento equivalente POS.

items

array of objects

required

Array de objetos item (productos/servicios) asociados a la factura. Cada objeto debe incluir: id (number, obligatorio): identificador del producto o servicio que se vende; price (double, obligatorio): precio de venta; reference (string) : referencia del producto/servicio; description (string): descripción del producto/servicio; tax (objeto) : array de objetos tax que indican la información del impuesto; quantity (obligatorio): cantidad vendida del producto o servicio; discount (decimal): porcentaje de descuento aplicado al producto, éste no debe incluir el símbolo %, únicamente su tasa Para costa rica, el atributo discount pasa a ser un objeto compuesto por los atributos: nature (indica la naturaleza del descuento) y discount (indica la tasa del descuento). El precio del producto/servicio no debe incluir impuestos ni descuentos; importRequest (string) : Solo para Mexico se puede enviar el número de pedimento si el item lo tiene activo, este debe contener 21 caracteres y debe seguir el formato: 99 99 9999 9999999. Utilizando 2 espacios para separar cada conjunto de caracteres.

items*

currency

object

Objecto que incluye la información de la moneda y tasa de cambio asociada a la factura. Solo se debe incluir si la compañía tiene activa la funcionalidad de multimoneda y tiene configurada la moneda seleccionada. Debe incluir el código de la moneda (de tres letras según ISO) y la tasa de cambio.

Responses

200200 OK

400Bad request