cs-billing-sapi
🛡️ cs-billing-sapi
La API cs-billing-sapi provee una solución integral para la gestión de distribuciones contables y el ciclo de vida de pagarés en Deceval, permitiendo la administración completa de operaciones de facturación y titularización dentro del ecosistema de Colmena Seguros.
Expone operaciones REST para:
- Consulta de distribuciones contables por contrato y ejercicio fiscal
- Creación de giradores (drawers) en el sistema Deceval
- Creación, consulta, firma, cancelación y anulación de pagarés en Deceval
La API actúa como una Process API (PAPI) para las distribuciones contables y como System API (SAPI) para las integraciones con Deceval, gestionada desde MuleSoft Anypoint Platform.
🌐 Información Básica
- Nombre de la API: cs-billing-sapi
- Versión: 1.0.0
- Plataforma: MuleSoft Anypoint Platform
- Tipo: System API / Process API
- URL Base Producción:
https://cs-billing-sapi-prod.us-e1.cloudhub.io/api/billing/v1 - URL Base QA:
https://cs-billing-sapi-qa.us-e1.cloudhub.io/api/billing/v1 - Protocolo: HTTPS / REST
- Formato de Datos: JSON
🔐 Autenticación
Para consumir esta API, el consumidor debe enviar obligatoriamente en cada solicitud los siguientes mecanismos de seguridad:
Client ID Enforcement
- Headers requeridos:
client_idclient_secret
- Las credenciales son asignadas a la aplicación consumidora en MuleSoft Anypoint Platform y proporcionadas por el equipo de Colmena Seguros.
- Headers requeridos:
Bearer Token (OAuth 2.0)
- Header requerido:
Authorization: Bearer <access_token>
- El token debe ser obtenido desde el servicio corporativo de autenticación.
- El token debe estar vigente al momento de la solicitud.
- Header requerido:
Ambos mecanismos son requeridos para que la solicitud sea aceptada por la plataforma.
🔒 Aviso de Seguridad
Las credenciales (client_id,client_secret) y los tokens OAuth son información sensible y no deben compartirse ni almacenarse en repositorios públicos.
🚀 Cómo Consumir
La API se encuentra publicada en las siguientes plataformas:
- 🔗 MuleSoft Exchange – cs-billing-sapi https://anypoint.mulesoft.com/exchange/portals/fundacion-grupo-social/
- 🔗 Portal Público FGS https://anypoint.mulesoft.com/exchange/portals/fundacion-grupo-social/
📋 Para consultar detalles de cada método:
Navegar en el menú izquierdo de la documentación
Expandir la sección "Summary"
Seleccionar el método específico que requiere consultar
📍 Endpoints Disponibles
| Método | Endpoint | Descripción |
|---|---|---|
| GET | /accounting-distributions/{distributionId} | Consultar períodos de distribución contable por contrato |
| POST | /deceval/createDrawer | Crear giradores (drawers) en el sistema Deceval |
| POST | /deceval/promissory-notes | Crear pagarés en el sistema Deceval |
| GET | /deceval/promissory-notes/query | Consultar pagarés registrados en Deceval |
| POST | /deceval/promissory-notes/sign | Firmar digitalmente pagarés en Deceval |
| POST | /deceval/promissory-notes/{noteId}/cancel | Cancelar pagarés en Deceval |
| POST | /deceval/promissory-notes/{noteId}/void | Anular pagarés en Deceval |
⚠️ Manejo de Errores
La API utiliza códigos HTTP estándar para indicar el resultado del procesamiento de las solicitudes.
Estos códigos representan condiciones de autenticación, autorización, formato o disponibilidad del servicio, y no validaciones funcionales propias del negocio. Los códigos de error específicos de cada operación (por ejemplo, los propios de Deceval) se encuentran documentados en el detalle de cada endpoint.
| Código | Estado | Descripción |
|---|---|---|
| 200 | OK | Solicitud procesada correctamente |
| 400 | Bad Request | Solicitud inválida o mal formada |
| 401 | Unauthorized | Credenciales inválidas o ausentes |
| 403 | Forbidden | Client ID sin permisos |
| 404 | Not Found | Recurso no encontrado |
| 405 | Method Not Allowed | Método HTTP no permitido |
| 415 | Unsupported Media Type | Tipo de contenido no soportado |
| 429 | Too Many Requests | Límite de solicitudes excedido |
| 500 | Internal Server Error | Error interno inesperado |
| 503 | Service Unavailable | Servicio temporalmente no disponible |
| 504 | Gateway Timeout | Tiempo de espera agotado |
📞 Soporte
Para soporte técnico o incidencias relacionadas con la integración:
Coordinación de Servicios de Integración y Aplicaciones
Correo electrónico: epalma@fgs.co
📅 Información Adicional
Documentación creada en Julio 2026 – Fundación Grupo Social – Colmena
© 2026 Fundación Grupo Social – Colmena
Esta documentación se mantiene actualizada conforme se incorporan nuevos servicios o endpoints relacionados con la distribución contable y el ciclo de vida de pagarés en Deceval.
```