Preview de documento programado guardado
curl --request GET \
--url https://api.tupana.ai/v1/scheduled-documents/{id}/preview \
--header 'Authorization: <api-key>'import requests
url = "https://api.tupana.ai/v1/scheduled-documents/{id}/preview"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.tupana.ai/v1/scheduled-documents/{id}/preview', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.tupana.ai/v1/scheduled-documents/{id}/preview",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.tupana.ai/v1/scheduled-documents/{id}/preview"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.tupana.ai/v1/scheduled-documents/{id}/preview")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.tupana.ai/v1/scheduled-documents/{id}/preview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"pdf_base64": "JVBERi0xLjQKMSAwIG9iago8PC9UeXBlIC9DYXRhbG9n..."
}{
"error": "VALIDATION_ERROR",
"message": "<string>"
}{
"error": "VALIDATION_ERROR",
"message": "<string>"
}{
"error": "VALIDATION_ERROR",
"message": "<string>"
}{
"error": "VALIDATION_ERROR",
"message": "<string>"
}Documentos Programados
Preview de documento programado
Genera un preview en PDF del próximo documento que se emitirá para un documento programado ya guardado.
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>'import requests
url = "https://api.tupana.ai/v1/scheduled-documents/{id}/preview"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.tupana.ai/v1/scheduled-documents/{id}/preview', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.tupana.ai/v1/scheduled-documents/{id}/preview",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.tupana.ai/v1/scheduled-documents/{id}/preview"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.tupana.ai/v1/scheduled-documents/{id}/preview")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.tupana.ai/v1/scheduled-documents/{id}/preview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"pdf_base64": "JVBERi0xLjQKMSAwIG9iago8PC9UeXBlIC9DYXRhbG9n..."
}{
"error": "VALIDATION_ERROR",
"message": "<string>"
}{
"error": "VALIDATION_ERROR",
"message": "<string>"
}{
"error": "VALIDATION_ERROR",
"message": "<string>"
}{
"error": "VALIDATION_ERROR",
"message": "<string>"
}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
- Obtener Documento Programado - Ver detalles del documento programado
- Actualizar Documento Programado - Modificar el documento antes de la emisión
- Listar Documentos Programados - Ver todos los documentos programados
- Crear Documento Programado - Crear un nuevo documento programado
- Listar Documentos - Consultar documentos ya emitidos
Authorizations
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 del documento programado
Example:
789
Query Parameters
ID de la entidad maestra
Example:
123
Response
Preview generado exitosamente
PDF del documento en formato base64
Example:
"JVBERi0xLjQKMSAwIG9iago8PC9UeXBlIC9DYXRhbG9n..."
