Skip to main content
GET
/
scheduled-documents
Listar documentos programados
curl --request GET \
  --url https://api.tupana.ai/v1/scheduled-documents \
  --header 'Authorization: <api-key>'
{
  "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,
          "item_total": 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"
    }
  ]
}

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[]