Skip to main content
GET
/
scheduled-documents
/
{id}
/
preview
Preview de documento programado guardado
curl --request GET \
  --url https://api.tupana.ai/v1/scheduled-documents/{id}/preview \
  --header 'Authorization: <api-key>'
{
  "pdf_base64": "JVBERi0xLjQKMSAwIG9iago8PC9UeXBlIC9DYXRhbG9n..."
}

Qué hace

  • Genera un preview en PDF del próximo documento que se emitirá
  • Muestra cómo se verá el documento en su próxima emisión automática
  • Proporciona el PDF en formato base64 para facilitar su visualización
  • No emite realmente el documento, solo genera una vista previa
  • Útil para verificar la configuración antes de la ejecución automática

Ejemplos de uso

  • Visualizar cómo se verá un documento antes de su próxima emisión
  • Verificar que la configuración del documento programado es correcta
  • Revisar montos, productos y detalles antes de la ejecución automática
  • Compartir un preview con el cliente antes de activar la programación
  • Validar que todos los datos están correctos antes de la emisión

Notas

  • El PDF generado es un borrador que muestra cómo se verá el documento en su próxima emisión
  • El documento no se emite realmente, solo se genera una vista previa
  • El PDF está codificado en base64 para facilitar su uso en aplicaciones web

Endpoints relacionados

Authorizations

Authorization
string
header
required

API Key para autenticación. Debe proporcionarse en el header Authorization con el formato: 'Api-Key YOUR-API-KEY' (incluye el prefijo 'Api-Key ' seguido de tu API key)

Path Parameters

id
integer
required

ID del documento programado

Example:

789

Query Parameters

master_entity_id
integer
required

ID de la entidad maestra

Example:

123

Response

Preview generado exitosamente

pdf_base64
string

PDF del documento en formato base64

Example:

"JVBERi0xLjQKMSAwIG9iago8PC9UeXBlIC9DYXRhbG9n..."