Administración
Herramientas de onboarding y gestión de la plataforma: alta de tenants, API keys, autorización de sectores, rangos CAFC y configuración de puntos de venta.listarTenants
Lista todos los tenants activos: código, nombre, NIT, estado, si tiene
API Key y si es sandbox.
verTenant
Detalle de un tenant, incluyendo sus companies, sucursales y puntos de venta.
crearTenantCompleto
Crea tenant + company + sucursal (Casa Matriz) + POS + API Key en una
sola operación. Retorna la API Key (se muestra una vez).
generarApiKey
Genera o regenera la API Key de un tenant. La anterior se invalida.
revocarApiKey
Revoca la API Key de un tenant, desactivando su acceso de inmediato.
cambiarEstadoTenant
Activa o desactiva un tenant. Un tenant inactivo no puede autenticarse.
agregarSectorCompany
Autoriza un documento sector SIAT adicional para una company (catálogo
multi-sector).
cargarRangoCafc
Carga un rango CAFC (autorización de facturación por contingencia manual)
para una company.
configurarPos
Marca un punto de venta como configurado (listo para facturar).
listarTenants \
Lista todos los tenants activos del sistema: código, nombre, NIT, estado, si tiene API Key y si es sandbox.| Parámetro | Tipo | Requerido | Descripción |
|---|---|---|---|
| (ninguno) | - | - | No requiere parámetros |
“Lista todos los tenants”
verTenant \
Ver el detalle de un tenant específico, incluyendo sus companies, sucursales y puntos de venta.| Parámetro | Tipo | Requerido | Descripción |
|---|---|---|---|
tenantCode | String | Sí | Código del tenant (ej. mi-cliente) |
“Muéstrame el detalle del tenant mi-cliente”
crearTenantCompleto \
Crea un tenant completo con company, sucursal (Casa Matriz), punto de venta y API Key en una sola operación. Retorna la API Key (se muestra una sola vez).| Parámetro | Tipo | Requerido | Descripción |
|---|---|---|---|
requestJson | String | Sí | JSON con los datos del tenant (ver abajo) |
“Crea un tenant para EMPRESA DEMO S.R.L. con NIT 1023456789 en sandbox”
generarApiKey \
Genera o regenera la API Key de un tenant. La key anterior se invalida. La nueva se muestra una sola vez.| Parámetro | Tipo | Requerido | Descripción |
|---|---|---|---|
tenantCode | String | Sí | Código del tenant |
sandbox | boolean | Sí | true para sandbox (sk_test_), false para producción (sk_live_) |
“Regenera la API Key de producción del tenant mi-cliente”
revocarApiKey \
Revoca la API Key de un tenant, desactivando su acceso inmediatamente.| Parámetro | Tipo | Requerido | Descripción |
|---|---|---|---|
tenantCode | String | Sí | Código del tenant a revocar |
“Revoca la API Key del tenant mi-cliente”
cambiarEstadoTenant \
Activa o desactiva un tenant. Un tenant inactivo no puede autenticarse.| Parámetro | Tipo | Requerido | Descripción |
|---|---|---|---|
tenantCode | String | Sí | Código del tenant |
activo | boolean | Sí | true para activar, false para desactivar |
“Desactiva el tenant mi-cliente”
agregarSectorCompany \
Autoriza un documento sector SIAT adicional para una company (catálogo multi-sector). La autorización del SIN debe cubrir ese sector.| Parámetro | Tipo | Requerido | Descripción |
|---|---|---|---|
companyId | String | Sí | UUID de la company |
sectorCode | int | Sí | Código de documento sector SIAT (1 Compra-Venta, 17 Hospitales, 24 Notas, …). Ver catálogo de sectores |
“Autoriza el sector 16 (Hoteles) para la company abc123”
cargarRangoCafc \
Carga un rango CAFC (Código de Autorización de Facturación por Contingencia, emitido por el Portal SIAT) para una company. Se usa en la facturación manual de contingencia.| Parámetro | Tipo | Requerido | Descripción |
|---|---|---|---|
companyId | String | Sí | UUID de la company |
cafc | String | Sí | Código CAFC emitido por el Portal SIAT |
sectorCode | int | Sí | Código de documento sector SIAT del rango |
posId | String | No | UUID del punto de venta (vacío = toda la company) |
“Carga el CAFC ABC123 para la company abc123, sector 1”
configurarPos \
Marca un punto de venta como configurado (listo para facturar). Llamar después de sincronizar CUIS, CUFD y catálogos.| Parámetro | Tipo | Requerido | Descripción |
|---|---|---|---|
posId | String | Sí | UUID del punto de venta |
“Marca el POS 660e… como configurado”