Listar documentos programados

Este endpoint permite obtener 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 (diaria, semanal, mensual o trimestral).

Características principales

Paginación: Resultados paginados con control de tamaño de página
Filtros: Por estado, frecuencia, tipo de DTE y más
Gestión completa: Crear, listar, actualizar y eliminar documentos programados
Automatización: Los documentos se emiten automáticamente según la programación

Parámetros principales

Parámetro	Tipo	Requerido	Descripción
`master_entity_id`	integer	Sí	ID de la entidad emisora cuyos documentos programados quieres consultar.
`status`	string	No	Filtrar por estado del documento programado: `active`, `inactive` o `completed`.
`frequency`	string	No	Filtrar por frecuencia de ejecución: `daily`, `weekly`, `monthly` o `quarterly`.
`dte_type`	string	No	Filtrar por tipo de DTE (ej: `33` para Factura Electrónica).
`page`	integer	No	Página actual, parte de la paginación estándar.
`page_size`	integer	No	Tamaño de página (máx. 100).

Respuesta exitosa

La respuesta 200 OK incluye un objeto paginado con:

count, next, previous para la navegación
results: arreglo de documentos programados con información de emisor, receptor, montos, estado, frecuencia, próxima ejecución y detalles

Estados de documentos programados

Los documentos programados pueden tener los siguientes estados:

Estado	Descripción
`active`	El documento está activo y se ejecutará según su programación
`inactive`	El documento está pausado y no se ejecutará
`completed`	El documento ha completado todas sus ejecuciones programadas

Frecuencias disponibles

Frecuencia	Descripción
`daily`	Se ejecuta diariamente
`weekly`	Se ejecuta semanalmente
`monthly`	Se ejecuta mensualmente
`quarterly`	Se ejecuta trimestralmente

Paginación

El endpoint soporta paginación mediante los parámetros page y page_size: La respuesta incluye:

count: Total de documentos programados
next: URL para la siguiente página (si existe)
previous: URL para la página anterior (si existe)
results: Array de documentos programados en la página actual

Campos de respuesta

Cada documento programado en el array results incluye:

id: ID único del documento programado
sender: Información de la entidad emisora (id, name, rut)
receiver: Información de la entidad receptora (id, name, rut) - puede ser null
dte_type: Tipo de documento tributario (id, code, description)
frequency: Frecuencia de ejecución (daily, weekly, monthly, quarterly)
frequency_display: Frecuencia en formato legible
day_of_month: Día del mes para ejecución (1-31, para frecuencias mensual/trimestral)
day_of_week: Día de la semana para ejecución (0=Lunes, 6=Domingo, para frecuencia semanal)
next_execution: Fecha y hora de la próxima ejecución
status: Estado actual del documento (active, inactive, completed)
status_display: Estado en formato legible
amount: Monto total del documento (number)
currency: Moneda del documento (string: CLP, UF, USD, EUR)
details: Array de detalles/productos del documento (ver formato abajo)
completed_occurrences: Número de veces que se ha ejecutado (integer)
max_occurrences: Número máximo de ejecuciones (integer, null = infinito)
created_at: Fecha de creación (datetime ISO 8601)
updated_at: Fecha de última actualización (datetime ISO 8601)

Formato del campo `details`

El campo details es un array de objetos que representa los productos o servicios incluidos en el documento programado. Cada elemento del array contiene:

Campo	Tipo	Requerido	Descripción
`id`	integer	No	ID único del detalle (solo en respuesta)
`product_name`	string	Sí	Nombre del producto o servicio
`description`	string	No	Descripción detallada del producto o servicio
`quantity`	number	Sí	Cantidad del producto (mínimo 0.01)
`unit_price`	number	Sí	Precio unitario del producto (mínimo 0)
`total`	number	No	Total de la línea (calculado automáticamente: quantity × unit_price, solo en respuesta)
`unit_of_measurement`	string	No	Unidad de medida (por defecto: `UN`)

Ejemplo de formato:

{
  "details": [
    {
      "id": 1,
      "product_name": "Servicio mensual de consultoría",
      "description": "Consultoría especializada en tecnología",
      "quantity": 1,
      "unit_price": 100000,
      "total": 100000,
      "unit_of_measurement": "UN"
    }
  ]
}

Nota: Al crear un documento programado, solo se requieren los campos product_name, quantity y unit_price. El campo total se calcula automáticamente y el id se asigna al crear el registro. Todos los endpoints requieren el parámetro master_entity_id como query parameter y autenticación mediante API Key.

Authorizations

Authorization

string

header

required

API Key para autenticación. Debe proporcionarse en el formato: 'Api-Key YOUR-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

string | null

URL de la siguiente página

Example:

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

string | null

URL de la página anterior

Example:

null

results

object[]

Show child attributes

results.id

integer

ID único del documento programado

Example:

789

results.sender

object

Información de la entidad emisora

Show child attributes

results.sender.id

integer

Example:

123

results.sender.name

string

Example:

"Empresa Ejemplo SpA"

results.sender.rut

string

Example:

"76543210-1"

results.receiver

object

Información de la entidad receptora

Show child attributes

results.receiver.id

integer

Example:

456

results.receiver.name

string

Example:

"Cliente ABC Ltda"

results.receiver.rut

string

Example:

"12345678-9"

results.dte_type

object

Tipo de documento tributario

Show child attributes

results.dte_type.id

integer

Example:

1

results.dte_type.code

string

Example:

"33"

results.dte_type.description

string

Example:

"Factura Electrónica"

results.frequency

enum<string>

Frecuencia de ejecución

Available options:

daily,

weekly,

monthly,

quarterly

Example:

"monthly"

results.frequency_display

string

Frecuencia en formato legible

Example:

"Mensual"

results.day_of_month

integer | null

Día del mes para ejecución (1-31)

Example:

15

results.day_of_week

integer | null

Día de la semana para ejecución (0=Lunes, 6=Domingo)

Example:

null

results.next_execution

string<date-time>

Fecha y hora de la próxima ejecución

Example:

"2024-02-15T10:00:00Z"

results.status

enum<string>

Estado del documento programado

Available options:

active,

inactive,

completed

Example:

"active"

results.status_display

string

Estado en formato legible

Example:

"Activo"

results.amount

number

Monto del documento

Example:

100000

results.currency

enum<string>

Moneda del documento

Available options:

CLP,

UF,

USD,

EUR

Example:

"CLP"

results.completed_occurrences

integer

Número de veces que se ha ejecutado

Example:

5

results.max_occurrences

integer | null

Número máximo de ejecuciones

Example:

null

results.details

object[]

Detalles/productos del documento

Show child attributes

results.details.id

integer

ID único del detalle

Example:

1

results.details.product_name

string

Nombre del producto o servicio

Example:

"Servicio mensual de consultoría"

results.details.description

string

Descripción detallada

Example:

"Consultoría especializada en tecnología"

results.details.quantity

number

Cantidad

Example:

1

results.details.unit_price

number

Precio unitario

Example:

100000

results.details.total

number

Total de la línea

Example:

100000

results.details.unit_of_measurement

string

Unidad de medida

Example:

"UN"

results.created_at

string<date-time>

Fecha de creación

Example:

"2024-01-15T10:00:00Z"

results.updated_at

string<date-time>

Fecha de última actualización

Example:

"2024-01-20T15:30:00Z"

Entidades

Credenciales

Documentos

Documentos Programados

Listar documentos programados

Características principales

Parámetros principales

Respuesta exitosa

Estados de documentos programados

Frecuencias disponibles

Paginación

Campos de respuesta

Formato del campo `details`

Authorizations

Query Parameters

Response

Entidades

Credenciales

Documentos

Documentos Programados

​Características principales

​Parámetros principales

​Respuesta exitosa

​Estados de documentos programados

​Frecuencias disponibles

​Paginación

​Campos de respuesta

​Formato del campo details

Authorizations

Query Parameters

Response

Características principales

Parámetros principales

Respuesta exitosa

Estados de documentos programados

Frecuencias disponibles

Paginación

Campos de respuesta

Formato del campo `details`