{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/invoices/preview","auth":"required","settings":"","results":{"codes":[{"name":"","code":"{\n    \"pdfUrl\": \"https://alegra-temporary-files.s3.amazonaws.com/testing/invoices/pdf/0wqwq\n}","language":"json","status":200},{"name":"","code":"{ \n\t\"error\": \"La información para crear la vista previa no existe o es inválida\",\n  \"code\" : 400\n}","language":"json","status":400}]},"params":[{"name":"date","type":"yyyy-mm-dd","default":"","desc":"Fecha de la factura. Formato yyyy-MM-dd.","required":true,"in":"body","ref":"","_id":"5f89c1e2fffb0c002cac93d9"},{"name":"dueDate","type":"yyyy-mm-dd","default":"","desc":"Fecha de vencimiento de la factura. Formato yyyy-MM-dd.","required":true,"in":"body","ref":"","_id":"5f89c1e2fffb0c002cac93d8"},{"name":"anotation","type":"string","default":"","desc":"Notas de la factura, visibles en el PDF o documento impreso. Longitud máxima permitida: 500.","required":false,"in":"body","ref":"","_id":"5f89c1e2fffb0c002cac93d7"},{"name":"termsConditions","type":"string","default":"","desc":"Términos y condiciones de la factura. Longitud máxima permitida: 500.","required":false,"in":"body","ref":"","_id":"5f89c1e2fffb0c002cac93d6"},{"name":"client","type":"object","default":"","desc":"Objecto que contiene el id del cliente asociado a la factura. Se puede enviar directamente el id del cliente en este atributo.","required":true,"in":"body","ref":"","_id":"5f89c1e2fffb0c002cac93d5"},{"name":"numberTemplate","type":"object","default":"","desc":"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.","required":false,"in":"body","ref":"","_id":"5f89c1e2fffb0c002cac93d4"},{"name":"items","type":"array_object","default":"","desc":"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.","required":true,"in":"body","ref":"","_id":"5f89c1e2fffb0c002cac93d3"},{"name":"currency","type":"object","default":"","desc":"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.","required":false,"in":"body","ref":"","_id":"5f89c1e2fffb0c002cac93d2"},{"name":"paymentMethod (México)","type":"string","default":"","desc":"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.","required":false,"in":"body","ref":"","_id":"5f89c1e2fffb0c002cac93d1"},{"name":"paymentMethod (Costa Rica)","type":"string","default":"","desc":"Para Costa Rica, indica el método de pago de la factura.  Las opciones posibles son: `cash`  Efectivo,  `card` Tarjeta débito/crédito,  `check` Cheque,  `transfer` Transferencia - depósito bancario,  `collection-by-third` Recaudo por teceros,  `other` Otros métodos de pago. Si se desea emitir la factura, este atributo se vuelve obligatorio.","required":false,"in":"body","ref":"","_id":"5f89c1e2fffb0c002cac93d0"},{"name":"paymentMethod (Colombia)","type":"string","default":"","desc":"Para Colombia, indica el medio de pago de la factura de venta. Sí el atributo `paymentForm` es `CASH` y la compañía tiene activa la opción de facturación electrónica 2.1, este atributo se vuelve obligatorio. Consulta el catálogo de parámetros correspondiente a cada país haciendo clic [aquí](https://developer.alegra.com/docs/colombia).","required":false,"in":"body","ref":"","_id":"5f89c1e2fffb0c002cac93cf"},{"name":"paymentForm (Colombia)","type":"string","default":"","desc":"Para Colombia, indica la forma de pago de la factura de venta. Admite los valores: `CASH` para efectivo y `CREDIT` para crédito. Si la compañía tiene activa la opción de facturación electrónica 2.1, este atributo se vuelve obligatorio.","required":false,"in":"body","ref":"","_id":"5f89c1e2fffb0c002cac93ce"},{"name":"paymentForm (Chile)","type":"object","default":"","desc":"Para Chile, el objeto paymentForm indica la forma de pago de la factura, este objeto puede contener atributos:  * `id (string)` código de la forma de pago y * `value(string)` nombre de la forma de pago. Si se desea emitir la factura, este atributo se vuelve obligatorio.","required":false,"in":"body","ref":"","_id":"5f89c1e2fffb0c002cac93cd"},{"name":"type","type":"string","default":"","desc":"Para Colombia, Costa Rica y Chile, indica el tipo de la factura de venta. Si no se envía, se asignará por defecto el código: `NATIONAL`. Consulta el catálogo de parámetros correspondiente a cada país haciendo [aquí](https://developer.alegra.com/docs/colombia#tipos-de-factura).","required":false,"in":"body","ref":"","_id":"5f89c1e2fffb0c002cac93cc"},{"name":"accountNumber (México)","type":"string","default":"","desc":"Para México, representa el número de cuenta o tarjeta de pago. Debe tener mínimo 4 caracteres.","required":false,"in":"body","ref":"","_id":"5f89c1e2fffb0c002cac93cb"},{"name":"paymentType (México)","type":"string","default":"","desc":"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.","required":false,"in":"body","ref":"","_id":"5f89c1e2fffb0c002cac93ca"}],"examples":{"codes":[{"code":"{\n    \"date\": \"2020-08-05\",\n    \"dueDate\": \"2020-08-05\",\n    \"client\": {\n        \"id\": 1\n    },\n    \"items\": [\n        {\n            \"id\": 1,\n            \"description\": \"DESDE FECHA 01/06/2020 HASTA FECHA 30/06/2020\",\n            \"price\": 111370,\n            \"quantity\": 1\n        },\n        {\n            \"id\": 2, \n            \"price\": 1000,\n            \"quantity\": 1\n        }\n    ],\n    \"paymentMethod\": \"cash\",\n    \"paymentForm\": \"CASH\",\n    \"numberTemplate\": {\n        \"id\": 1\n    },\n    \"type\": \"NATIONAL\",\n    \"anotation\": \"estas son las notas\",\n    \"termsConditions\": \"estos son los terminos y condiciones\"\n}","language":"json","name":"Factura Sencilla"}]},"method":"post"},"next":{"description":"","pages":[]},"title":"Vista previa factura de venta","type":"endpoint","slug":"vista-previa-factura-de-venta","excerpt":"Genera la url para consultar el pdf de la vista previa de la creación de la factura de venta.","body":"","updates":[],"order":10,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5f89c1e2fffb0c002cac93c9","createdAt":"2020-10-16T15:53:06.153Z","user":"56abd213d4432d1900eed227","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Facturas de venta","slug":"facturas-de-venta","order":3,"from_sync":false,"reference":true,"_id":"56b4b32deed075230097d689","__v":0,"project":"56abd2434e4b730d009eb10a","createdAt":"2016-02-05T14:35:25.879Z","version":"56abd2434e4b730d009eb10d"},"version":{"version":"1","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["56abd2444e4b730d009eb10e","56abd4c8f25f160d00e17f81","56abd72ff25f160d00e17f84","56b3b8ea9f97020d0012d936","56b3b91ac25dea2b00b0cac9","56b4b2faeed075230097d688","56b4b32deed075230097d689","56b4b37327d9c00d005d6bc4","56b4b3bf3d5f130d00dad120","56b4b3d9eed075230097d68a","56b4b3eb7bccae0d00e9a12e","56b4b4085997532100bc6b61","56fbce6e2885e80e006c855f","5739ed9aad40e23200f674b6","573dd672b3f88f0e00dcae1c","58ad0922e570c62500512a82","58ad092b55018f1900218fda","58e412a5aa544d1b0005f7da","59e62c2a3ccab100263e800a","59e63126b4f8b0002edbe92c","5b5bbc98eaf71700031c2fda","5bedb529a56934002ee522b9","5c3e39454d3006001420f73e","5c4f5c0e1555130014796daa","5c6ac741acb04f003f927fa7","5c7e9c7c412d4c003f750162","5d055915910ab30020e5bc06","5d76e2018e0ce7006c82dbe1","5d9ca92eac34370012872d08","5d9f8149103b9f006c1421e0","5e3098aba5919200612d0c33","5e8ca028538a310018ccd2df","5e9f0d4c720ad8006c6c7dc1","5ea9c2f382fcd2003df9f412","5ec7defc6aa2be001e7504f5","5ed8f716a8308c0412b5473a","5ed9274fe5a9b8041fd1df43","5ed92afa0d09d60253220b3f","5efcff9cd7e1be00118e8272","5f172282d7522c03be08713f","5f3c4814ac3e6209c38b7615","5f4fbe7281626c006887f104","5f5242887d2f8701ff580d22"],"_id":"56abd2434e4b730d009eb10d","project":"56abd2434e4b730d009eb10a","releaseDate":"2016-01-29T20:57:39.712Z","__v":43,"createdAt":"2016-01-29T20:57:39.712Z"},"project":"56abd2434e4b730d009eb10a","__v":0,"parentDoc":null}

postVista previa factura de venta

Genera la url para consultar el pdf de la vista previa de la creación de la factura de venta.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

date:
required
yyyy-mm-dd
Fecha de la factura. Formato yyyy-MM-dd.
dueDate:
required
yyyy-mm-dd
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:
required
object
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.
items:
required
array of objects
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.
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.
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.
paymentMethod:
string
Para Costa Rica, indica el método de pago de la factura. Las opciones posibles son: `cash` Efectivo, `card` Tarjeta débito/crédito, `check` Cheque, `transfer` Transferencia - depósito bancario, `collection-by-third` Recaudo por teceros, `other` Otros métodos de pago. Si se desea emitir la factura, este atributo se vuelve obligatorio.
paymentMethod:
string
Para Colombia, indica el medio de pago de la factura de venta. Sí el atributo `paymentForm` es `CASH` y la compañía tiene activa la opción de facturación electrónica 2.1, este atributo se vuelve obligatorio. Consulta el catálogo de parámetros correspondiente a cada país haciendo clic [aquí](https://developer.alegra.com/docs/colombia).
paymentForm:
string
Para Colombia, indica la forma de pago de la factura de venta. Admite los valores: `CASH` para efectivo y `CREDIT` para crédito. Si la compañía tiene activa la opción de facturación electrónica 2.1, este atributo se vuelve obligatorio.
paymentForm:
object
Para Chile, el objeto paymentForm indica la forma de pago de la factura, este objeto puede contener atributos: * `id (string)` código de la forma de pago y * `value(string)` nombre de la forma de pago. Si se desea emitir la factura, este atributo se vuelve obligatorio.
type:
string
Para Colombia, Costa Rica y Chile, indica el tipo de la factura de venta. Si no se envía, se asignará por defecto el código: `NATIONAL`. Consulta el catálogo de parámetros correspondiente a cada país haciendo [aquí](https://developer.alegra.com/docs/colombia#tipos-de-factura).
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.

Examples


Result Format


User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}