Mostrar una empresa

🔍 ¿Qué hace este endpoint?

Este endpoint permite consultar la información completa de una empresa registrada en Aleluya, utilizando el identificador único (id) indicado en la ruta. La información incluye:

• Datos básicos: Nombre, número de identificación, dirección, teléfono y correos electrónicos.
• Configuración de nómina: Frecuencia de pago, método de pago, tipo de cuenta bancaria.
• Instituciones asociadas: Banco, proveedor de contabilidad, proveedor de riesgos laborales (ARL) y operador de seguridad social.
• Proceso de configuración inicial: Información sobre en qué etapa se encuentra la empresa durante su registro en Aleluya.
• Archivos documentales: Certificado bancario, documento de identificación de la empresa, documento de identificación del representante legal y documento tributario.

📘

Por defecto, el endpoint devuelve toda la información de la empresa. Sin embargo, puedes usar el parámetro only_files=true para obtener únicamente los archivos documentales sin el resto de la información.

🎯 ¿Cuándo usar este endpoint?

• Cuando se requiere obtener la información completa de una empresa para realizar operaciones administrativas.
• Cuando se requiere obtener únicamente los archivos documentales de la empresa para procesarlos o almacenarlos.
• Para verificar en qué etapa del proceso de registro inicial se encuentra la empresa y determinar qué información falta por completar.
• Para consultar qué banco, proveedores de seguridad social o proveedor de contabilidad tiene configurada la empresa.
• Para conocer qué leyes o decretos aplican a la empresa (por ejemplo, si aplica la Ley de primer empleo o el Decreto 376) y aplicar reglas de negocio específicas

📌 Consideraciones importantes

Permisos y autenticación

• Solo puedes consultar empresas a las que tengas acceso. Si intentas consultar una empresa a la que no tienes permiso, recibirás un error indicando que no estás autorizado 403 No autorizado.

Requisitos previos

• El campo company_id debe existir; de lo contrario, se responde 404 Empresa no existe.
• El parámetro only_files es opcional: puedes enviarlo como true para obtener solo los archivos, o false (o no enviarlo) para obtener toda la información.
• El parámetro interactive_tour_finished es opcional y se usa principalmente desde la aplicación web. Si lo envías como true, se registra que el usuario completó el tour interactivo. Este parámetro no afecta la información que recibes en la respuesta.

Variaciones en la respuesta

✅ 200 Respuesta exitosa (Sin only_files o con only_files=false)

Recibes toda la información de la empresa: datos básicos, configuración, instituciones asociadas, estado del proceso inicial y archivos.

Ejemplo de respuesta:

{
  "data": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "Demo SAS",
    "document_type": "ni",
    "id_number": "123456789",
    "verification_digit": "8",
    "email": "[email protected]",
    "phone": "1234567890",
    "address": "742 Evergreen Terrace",
    "payroll_frequency": "monthly",
    "payment_method": "wire_transfer",
    "city": {
      "id": "f6a7b8c9-d0e1-2345-f678-901234567890",
      "name": "Bogotá"
    },
    "department": {
      "id": "e5f6a7b8-c9d0-1234-ef56-789012345678",
      "name": "Cundinamarca"
    },
    "onboarding": {
      "onboarding_step": "finished",
      "payroll_frequency": "monthly",
      "user_area": "accounting",
      "user_name": "John",
      "workers_number": "1-19"
    },
    "files": {
      "bank_certificate_document": "https://example.com/files/bank_certificate.pdf",
      "identification_document": "https://example.com/files/identification.pdf",
      "legal_representative_document": "https://example.com/files/legal_representative.pdf",
      "tax_document": "https://example.com/files/tax.pdf"
    }
  }
}

✅ 200 Respuesta exitosa (Con only_files=true)

Solo recibes los archivos documentales de la empresa (certificado bancario, documento de identificación de la empresa, documento de identificación del representante legal y documento tributario), sin el resto de la información. Esto es útil cuando solo necesitas los documentos sin cargar toda la información.

Ejemplo de respuesta:

{
  "data": {
    "files": {
      "bank_certificate_document": "https://example.com/files/bank_certificate.pdf",
      "identification_document": "https://example.com/files/identification.pdf",
      "legal_representative_document": "https://example.com/files/legal_representative.pdf",
      "tax_document": "https://example.com/files/tax.pdf"
    }
  }
}