Listar documentos programados
curl --request GET \
--url https://api.tupana.ai/v1/scheduled-documents \
--header 'Authorization: <api-key>'import requests
url = "https://api.tupana.ai/v1/scheduled-documents"
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', 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",
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"
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")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.tupana.ai/v1/scheduled-documents")
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{
"count": 25,
"next": "https://api.tupana.ai/v1/scheduled-documents?master_entity_id=123&page=2",
"previous": null,
"results": [
{
"id": 789,
"sender": {
"id": 123,
"name": "Empresa Ejemplo SpA",
"rut": "76543210-1"
},
"receiver": {
"id": 456,
"name": "Cliente ABC Ltda",
"rut": "12345678-9"
},
"dte_type": {
"id": 1,
"code": "33",
"description": "Factura Electrónica"
},
"frequency": "monthly",
"frequency_display": "Mensual",
"day_of_month": 15,
"day_of_week": null,
"next_execution": "2024-02-15T10:00:00Z",
"status": "active",
"status_display": "Activo",
"amount": 100000,
"currency": "CLP",
"currency_day": 10,
"completed_occurrences": 5,
"max_occurrences": null,
"start_date": "2024-02-01",
"emission_day_adjustment": "none",
"end_type": "never",
"end_date": "2024-12-31",
"details": [
{
"id": 1,
"item_name": "Servicio mensual de consultoría",
"item_description": "Consultoría especializada en tecnología",
"quantity": 1,
"unit_price": 100000,
"unit_of_measurement": "UN",
"item_code": "PROD-001",
"item_type_code": "1"
}
],
"references": [
{
"id": 1,
"dte_type_code": "33",
"reference_folio": "123",
"reference_date": "2024-01-15",
"reference_reason": "ANULA DOCUMENTO DE LA REFERENCIA"
}
],
"created_at": "2024-01-15T10:00:00Z",
"updated_at": "2024-01-20T15:30:00Z"
}
]
}{
"error": "VALIDATION_ERROR",
"message": "<string>"
}{
"error": "VALIDATION_ERROR",
"message": "<string>"
}{
"error": "VALIDATION_ERROR",
"message": "<string>"
}Documentos Programados
Listar documentos programados
Obtiene una lista paginada de documentos programados de una entidad específica. Los documentos programados son plantillas que se ejecutan automáticamente según una frecuencia definida.
GET
/
scheduled-documents
Listar documentos programados
curl --request GET \
--url https://api.tupana.ai/v1/scheduled-documents \
--header 'Authorization: <api-key>'import requests
url = "https://api.tupana.ai/v1/scheduled-documents"
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', 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",
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"
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")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.tupana.ai/v1/scheduled-documents")
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{
"count": 25,
"next": "https://api.tupana.ai/v1/scheduled-documents?master_entity_id=123&page=2",
"previous": null,
"results": [
{
"id": 789,
"sender": {
"id": 123,
"name": "Empresa Ejemplo SpA",
"rut": "76543210-1"
},
"receiver": {
"id": 456,
"name": "Cliente ABC Ltda",
"rut": "12345678-9"
},
"dte_type": {
"id": 1,
"code": "33",
"description": "Factura Electrónica"
},
"frequency": "monthly",
"frequency_display": "Mensual",
"day_of_month": 15,
"day_of_week": null,
"next_execution": "2024-02-15T10:00:00Z",
"status": "active",
"status_display": "Activo",
"amount": 100000,
"currency": "CLP",
"currency_day": 10,
"completed_occurrences": 5,
"max_occurrences": null,
"start_date": "2024-02-01",
"emission_day_adjustment": "none",
"end_type": "never",
"end_date": "2024-12-31",
"details": [
{
"id": 1,
"item_name": "Servicio mensual de consultoría",
"item_description": "Consultoría especializada en tecnología",
"quantity": 1,
"unit_price": 100000,
"unit_of_measurement": "UN",
"item_code": "PROD-001",
"item_type_code": "1"
}
],
"references": [
{
"id": 1,
"dte_type_code": "33",
"reference_folio": "123",
"reference_date": "2024-01-15",
"reference_reason": "ANULA DOCUMENTO DE LA REFERENCIA"
}
],
"created_at": "2024-01-15T10:00:00Z",
"updated_at": "2024-01-20T15:30:00Z"
}
]
}{
"error": "VALIDATION_ERROR",
"message": "<string>"
}{
"error": "VALIDATION_ERROR",
"message": "<string>"
}{
"error": "VALIDATION_ERROR",
"message": "<string>"
}Qué hace
- Obtiene una lista paginada de documentos programados de una entidad específica
- Filtra documentos por estado (active, inactive, completed)
- Filtra por frecuencia de ejecución (daily, weekly, monthly, quarterly)
- Filtra por tipo de DTE
- Proporciona información completa de cada documento programado incluyendo próxima ejecución
Ejemplos de uso
- Listar todos los documentos programados activos de una entidad
- Consultar documentos programados por frecuencia (mensual, semanal, etc.)
- Verificar cuándo se ejecutará cada documento programado
- Revisar el estado de los documentos programados (activos, pausados, completados)
- Filtrar documentos programados por tipo de DTE
Endpoints relacionados
- Crear Documento Programado - Crear un nuevo documento programado
- Obtener Documento Programado - Ver detalles de un documento específico
- Actualizar Documento Programado - Modificar un documento programado existente
- Preview de Documento Programado - Ver preview del próximo documento a emitir
- Eliminar Documento Programado - Eliminar un 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)
Query Parameters
ID de la entidad maestra
Example:
123
Filtrar por estado del documento programado
Available options:
active, inactive, completed Example:
"active"
Filtrar por frecuencia de ejecución
Available options:
daily, weekly, monthly, quarterly Example:
"monthly"
Filtrar por tipo de DTE
Example:
"33"
Número de página para paginación
Example:
1
Número de elementos por página
Required range:
x <= 100Example:
20
Response
Lista de documentos programados obtenida exitosamente
