HomeDocumentaciónAPI EndpointsNovedades
Log In

[API FE DOM] Formato PDF POS disponible

¡Tenemos grandes noticias! Con la última actualización de nuestra API, los usuarios pueden ahora generar documentos en el nuevo formato de PDF llamado POS. Esta mejora ofrece una serie de beneficios para los usuarios, incluyendo...

  • Soporta el nuevo formato de PDF POS.
  • Se ha añadido una nueva propiedad a los endpoints de creación/actualización de compañías para permitir a los usuarios cargar su logotipo en formato base 64 (por el momento solo aplica para el PDF tipo POS). Con esta nueva propiedad, los usuarios pueden personalizar aún más sus documentos generados a través de nuestra API.
  • Se ha actualizado la documentación de la API para incluir información detallada sobre cómo utilizar el formato POS en las solicitudes de generación de documentos.

¡Veamos como puedes usar estas nuevas funcionalidades!

Añade un logo al PDF POS

Para añadir el logo de tu compañía, si ya tienes una creada, puedes actualizarla directamente. Si aún no tienes una compañía existente, puedes crearla al mismo tiempo que añades el logo en la solicitud. En cualquier caso, solo necesitas concentrarte en la propiedad llamada logo.

{
  "name": "Cool name",
  "tradeName": "Cool trade name",
  "identification": "123456789",
  "address": "address",
  "province": "province",
  "municipality": "municipality",  
  "type": "main",  
  "certificate": {  
    "name": "name",  
    "extension": "p12",  
    "content": "AA==",  
    "password": "pass"
  },  
  "webhooks": {},
  "logo": "Texto en base 64 de la imagen"
}

Actualización

{
  "logo": "Texto en base 64 de la imagen"
}

Una vez el logo esté cargado en la compañía, de forma automática aparecerá en tus PDFs tipo POS

Utilizar el PDF POS en los documentos electrónicos

Vamos a tomar de ejemplo las facturas de consumo, pero aplica para cualquier otro documento.

{  
  "idDoc": {...},  
  "sender": {...},  
  "buyer": {...},  
  "totals": {...},  
  "itemDetails": [{...}],
  "config": {  
    "pdf": {  
      "type": "pos",
      "note": "¡Alguna nota que aparecerá en la parte de abajo del PDF!"  
    }
  }
}

Consulta

Tienes que pasar un parametro de consulta (query param) a la URL llamado pdfType. Por ejemplo:

https://sandbox.alanube.co/dom/v1/invoices/{id}?pdfType=pos
https://sandbox.alanube.co/dom/v1/invoices/{id}/idCompany/{idCompany}?pdfType=pos

{
  "id": "id",
  "mail": "[email protected]",
  "pdfType": "pos"
}

Si por primera vez creaste un documento sin especificar el valor pos, no te preocupes. ¡Con solo especificar que quieres el PDF pos nosotros lo manejaremos por ti!
Y ahí lo tienes, esas son las nuevas funcionalidad añadidas al API.

Ejemplo de PDF tipo `pos`

Ejemplo de PDF tipo pos.