Listar documentos programados
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
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
- 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
