Skip to main content

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.
Todas estas herramientas requieren permisos de administrador CUCU. Un tenant regular con sk_live_/sk_test_ recibe acceso denegado.

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ámetroTipoRequeridoDescripción
(ninguno)--No requiere parámetros
Requiere autenticación: Sí (admin CUCU) Ejemplo de uso con AI:
“Lista todos los tenants”

verTenant \

Ver el detalle de un tenant específico, incluyendo sus companies, sucursales y puntos de venta.
ParámetroTipoRequeridoDescripción
tenantCodeStringCódigo del tenant (ej. mi-cliente)
Requiere autenticación: Sí (admin CUCU) Ejemplo de uso con AI:
“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ámetroTipoRequeridoDescripción
requestJsonStringJSON con los datos del tenant (ver abajo)
Requiere autenticación: Sí (admin CUCU) Ejemplo de uso con AI:
“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ámetroTipoRequeridoDescripción
tenantCodeStringCódigo del tenant
sandboxbooleantrue para sandbox (sk_test_), false para producción (sk_live_)
Requiere autenticación: Sí (admin CUCU) Ejemplo de uso con AI:
“Regenera la API Key de producción del tenant mi-cliente”

revocarApiKey \

Revoca la API Key de un tenant, desactivando su acceso inmediatamente.
ParámetroTipoRequeridoDescripción
tenantCodeStringCódigo del tenant a revocar
Requiere autenticación: Sí (admin CUCU) Ejemplo de uso con AI:
“Revoca la API Key del tenant mi-cliente”

cambiarEstadoTenant \

Activa o desactiva un tenant. Un tenant inactivo no puede autenticarse.
ParámetroTipoRequeridoDescripción
tenantCodeStringCódigo del tenant
activobooleantrue para activar, false para desactivar
Requiere autenticación: Sí (admin CUCU) Ejemplo de uso con AI:
“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ámetroTipoRequeridoDescripción
companyIdStringUUID de la company
sectorCodeintCódigo de documento sector SIAT (1 Compra-Venta, 17 Hospitales, 24 Notas, …). Ver catálogo de sectores
Requiere autenticación: Sí (admin CUCU) Ejemplo de uso con AI:
“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ámetroTipoRequeridoDescripción
companyIdStringUUID de la company
cafcStringCódigo CAFC emitido por el Portal SIAT
sectorCodeintCódigo de documento sector SIAT del rango
posIdStringNoUUID del punto de venta (vacío = toda la company)
Requiere autenticación: Sí (admin CUCU) Ejemplo de uso con AI:
“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ámetroTipoRequeridoDescripción
posIdStringUUID del punto de venta
Requiere autenticación: Sí (admin CUCU) Ejemplo de uso con AI:
“Marca el POS 660e… como configurado”