Estado Onboarding

Obtener Estado de Onboarding (Checklist)

• URL: GET /api/partner/v1/companies/onboarding-status
• Cabeceras Obligatorias:
  • Authorization: Bearer <TOKEN_PARTNER_API>
  • tenant-key: <COMPANY_KEY_DE_LA_SUB_CUENTA>
• Descripción: Devuelve un informe en vivo del checklist de alta de la empresa.
• Nota Importante sobre CUFD: El estado de cufd_active se incluye como información pero no es un bloqueante para que is_ready sea verdadero, ya que el CUFD es volátil (24h) y se auto-generará on-the-fly en la primera factura.
• Rendimiento y Caché (Polling): Para proteger el sistema de consultas masivas (ej. un frontend haciendo polling constante), este endpoint guarda su respuesta completa en caché por 5 minutos. Acciones explícitas de configuración (subir logo, credenciales o asignar plantillas) y la conclusión de trabajos asíncronos invalidan el caché automáticamente para reflejar cambios en tiempo real.
• Payload: No requiere payload.

:::tip Recomendación de Integración Al recibir la notificación del webhook update_parametrics en tu servidor callback, la caché de este endpoint habrá sido invalidada automáticamente. Ese es el momento óptimo para realizar una petición a GET /onboarding-status y verificar si la empresa pasó al estado "is_ready": true para habilitar la facturación. :::

Respuestas de Error

• 404 Not Found: tenant-key inválido o empresa no encontrada.

Ejemplo de Respuesta (200 OK)

{
  "success": true,
  "onboarding": {
    "is_ready": false,
    "company": {
      "system_codes": [
        "221000"
      ],
      "document_sectors": [
        {
          "code": 1,
          "name": "Factura Compra Venta"
        }
      ],
      "logo_uploaded": false,
      "logo_uploaded_message": "Falta subir el logo corporativo de la empresa.",
      "credentials_valid": true,
      "parametrics_synced": false,
      "parametrics_synced_message": "Falta sincronizar las paramétricas del SIN.",
      "pending_parametrics": [
        "activity",
        "activity-document-sector"
      ]
    },
    "branches": [
      {
        "code": "0",
        "name": "Casa Matriz",
        "template_selected": true,
        "pos": [
          {
            "code": "0",
            "name": "Punto de Venta 0",
            "cuis_active": true,
            "cufd_active": true
          }
        ]
      }
    ]
  }
}

Detalles de los Campos de la Respuesta

Campo	Tipo	Descripción
onboarding.is_ready	Boolean	true indica que todos los requisitos globales y por sucursal se completaron y la empresa puede emitir.
onboarding.company.logo_uploaded	Boolean	true si se ha cargado el logo gráfico.
onboarding.company.credentials_valid	Boolean	true si el certificado y/o token de impuestos están cargados y no han expirado.
onboarding.company.parametrics_synced	Boolean	true si todas las paramétricas requeridas concluyeron su sincronización.
onboarding.branches[].template_selected	Boolean	true si todas las plantillas requeridas de la sucursal fueron asignadas.
onboarding.branches[].pos[].cuis_active	Boolean	true si el punto de venta posee un código CUIS activo obtenido del SIN.
onboarding.branches[].pos[].cufd_active	Boolean	true si el punto de venta cuenta con un código CUFD diario generado.