Skip to main content
GET
Listar documentos programados

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

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)

Query Parameters

master_entity_id
integer
required

ID de la entidad maestra

Example:

123

status
enum<string>

Filtrar por estado del documento programado

Available options:
active,
inactive,
completed
Example:

"active"

frequency
enum<string>

Filtrar por frecuencia de ejecución

Available options:
daily,
weekly,
monthly,
quarterly
Example:

"monthly"

dte_type
string

Filtrar por tipo de DTE

Example:

"33"

page
integer
default:1

Número de página para paginación

Example:

1

page_size
integer
default:20

Número de elementos por página

Required range: x <= 100
Example:

20

Response

Lista de documentos programados obtenida exitosamente

count
integer

Total de documentos programados

Example:

25

next
string | null

URL de la siguiente página

Example:

"https://api.tupana.ai/v1/scheduled-documents?master_entity_id=123&page=2"

previous
string | null

URL de la página anterior

Example:

null

results
object[]