cs-invoice-processing-sapi
home
🛡️ cs-invoice-processing-sapi
Esta aplicación gestiona el procesamiento integral de facturas y órdenes de pago. Incluye endpoints para:
- Gestión completa del ciclo de vida de documentos contables
- Consulta de documentos pendientes y procesados
- Administración de proveedores y usuarios externos
- Integración con billeteras digitales para órdenes de pago
- Gestión de adjuntos y archivos asociados a facturas
- Actualización de estados y seguimiento de documentos
- Integración completa con Invoway, Visual Time
- Sincronización bidireccional de transacciones financieras
Todos los servicios se exponen a través de endpoints REST seguros y proporcionan acceso a funcionalidades contables con alta disponibilidad y rendimiento optimizado.
🌐 Información Base
- Título: cs-invoice-processing-sapi
- Versión: 1.0.0
- Plataforma: MuleSoft Anypoint Platform
- URL Base Producción:
https://cs-invoice-processing-sapi-prod.us-e1.cloudhub.io/api/ - URL Base QA:
https://cs-invoice-processing-sapi-qa.us-e1.cloudhub.io/api/ - Protocolo: REST/SOAP
- Formato de Datos: JSON/XML
- Autenticación: OAuth 2.0 + Client ID
🚀 Cómo Comenzar
- Autenticación: Asegúrate de tener el
client_idrequerido y el token BearerOAuth 2.0para acceso seguro. - URL Base: Usa la URL Base proporcionada como prefijo para todos los endpoints.
- Encabezados: Agrega los siguientes encabezados en tus solicitudes:
-H "Content-Type: application/json"
-H "client_id: TU_CLIENT_ID"
-H "Authorization: Bearer TU_ACCESS_TOKEN"
-H "X-Correlation-ID: TU_CORRELATION_ID" # Opcional pero recomendado para trazabilidad🚀 Cómo Consumir
Puedes acceder y consumir esta aplicación a través de las siguientes plataformas:
📍 Endpoints Disponibles
| Método | Endpoint | Descripción |
|---|---|---|
| GET | /api/documents/pending | Consultar documentos pendientes de procesamiento contable |
| GET | /api/documents/returnDocuments | Recuperar documentos con filtros específicos y criterios de búsqueda |
| GET | /api/documents/attachments | Obtener archivos adjuntos asociados a documentos contables |
| POST | /api/documents/processed | Registrar y marcar documentos como procesados en el sistema |
| POST | /api/documents/status | Actualizar estado de procesamiento de documentos contables |
| POST | /api/documents/suppliers | Registrar y gestionar información de proveedores |
| GET | /api/digital-wallets/send-payments-orders | Consultar y enviar órdenes de pago hacia billeteras digitales |
| POST | /api/digital-wallets/receive-payments-orders | Recibir y procesar órdenes de pago desde billeteras digitales |
| POST | /api/suppliers/externalUser | Crear y gestionar usuarios externos para proveedores |
⚠️ Manejo de Errores
Se utilizan códigos de estado HTTP estándar para el manejo de errores:
📊 Códigos de Respuesta
| Código | Estado | Descripción | Causa Común | Acción Recomendada |
|---|---|---|---|---|
200 | ✅ OK | La solicitud fue exitosa | Operación completada correctamente | Continuar con el procesamiento |
400 | ❌ Bad Request | Parámetros faltantes o inválidos | Formato de datos incorrecto | Revisar estructura del JSON y campos requeridos |
401 | 🔒 Unauthorized | Autenticación fallida | Token expirado o client_id inválido | Renovar token de autenticación |
403 | 🚫 Forbidden | Sin permisos suficientes | Client_id sin permisos para el endpoint | Verificar permisos asignados al client_id |
404 | 🔍 Not Found | Endpoint o recurso no encontrado | URL incorrecta o recurso inexistente | Verificar la URL y documentación |
429 | ⏰ Rate Limited | Demasiadas solicitudes | Exceso de requests por minuto | Implementar retry con exponential backoff |
500 | 💥 Internal Server Error | Error inesperado en el servidor | Fallo interno del sistema | Contactar soporte técnico con correlation ID |
503 | 🛠️ Service Unavailable | Servicio temporalmente no disponible | Mantenimiento o sobrecarga | Reintentar más tarde |
❓ Preguntas Frecuentes
🔑 Error 401 - Unauthorized
- Síntomas: Respuesta "Authentication failed"
- Causas: Token expirado, client_id incorrecto, headers malformados
- Solución: Verificar y renovar credenciales, validar formato de headers
⏰ Error 504 - Gateway Timeout
- Síntomas: Timeout después de 60 segundos
- Causas: Servicios externos lentos, sobrecarga del sistema
- Solución: Implementar timeouts más cortos, usar retry con backoff
📊 Error 429 - Rate Limiting
- Síntomas: "Too Many Requests"
- Causas: Exceso de requests por minuto
- Solución: Implementar queue con rate limiting, espaciar requests
📞 Soporte
Para asistencia, contacta al equipo de Coordinación de Servicios de Integración y Aplicaciones.
Correo electrónico: epalma@fgs.co
📅 Información Adicional
Documentación generada en Noviembre 2025 - Fundación Grupo Social - Colmena
© 2025 Fundación Grupo Social - Colmena. Archivo generado para cs-invoice-processing-sapi
📋 Nota Importante: Esta documentación se actualiza continuamente. Para la versión más reciente y cambios en tiempo real, consulta siempre el Portal de Exchange oficial.
🔒 Aviso de Seguridad: Nunca compartas credenciales en repositorios públicos o documentación. Usa siempre variables de entorno para información sensible y rota tokens regularmente.