CompanyDocumentType
Tipo de documento de identificación de la empresa.
Valores posibles:
ni— NIT (Número de Identificación Tributaria)cc— Cédula de Ciudadaníace— Cédula de Extranjeríati— Tarjeta de Identidadpa— Pasaporte
UserAccessRole
Rol del usuario en la empresa.
Valores posibles:
admin— Administrador (acceso total)accountant— Contador (acceso a nómina y contabilidad)reviewer— Revisor (acceso de solo lectura)worker— Persona (acceso a su propio perfil)
WorkersNumberRange
Rango del número de personas activas en la empresa.
Valores posibles:
1-19— Entre 1 y 19 personas20-49— Entre 20 y 49 personas50-99— Entre 50 y 99 personas100-149— Entre 100 y 149 personas150-200— Entre 150 y 200 personasover_200— Más de 200 personas
PayrollFrequency
Frecuencia de liquidación de nómina.
Valores posibles:
monthly— Mensualfortnightly— Quincenalmixed— Mixta (algunos empleados mensual, otros quincenal)
PaymentMethod
Método de pago de nómina.
Valores posibles:
wire_transfer— Transferencia bancariacash— Efectivo
UserArea
Área funcional del usuario en la empresa:
accounting— Contabilidad.administrative— Administrativa.general_management— Gerencia general.hr— Recursos humanos.other— Otra área (especificar enarea_other_info).student— Estudiante en práctica.
CompanyAccess
Nivel de acceso de la empresa según su suscripción activa:
free— Sin suscripción activa.premium— Suscripción básica activa.premium_hr— Suscripción con módulo de gestión humana.premium_full— Suscripción con acceso completo a todos los módulos.premium_plus— Suscripción extendida con funcionalidades adicionales.
UserInformation
activeIndica si el acceso del usuario a la empresa está activo. Es null si no tiene empresa asociada.
Área funcional del usuario en la empresa.
Nivel de acceso de la empresa según su suscripción activa.
company_created_atFecha de creación de la empresa como cadena numérica con marca de tiempo Unix en segundos (UTC).
company_idIdentificador único (ID) asignado a la empresa en la base de datos.
company_nameRazón social o nombre comercial de la empresa.
emailCorreo electrónico del usuario.
idIdentificador único (ID) asignado al usuario en la base de datos.
is_new_invited_admin_userIndica si el usuario fue creado después de la fecha de corte definida para "nuevo admin invitado".
multicompanyIndica si el usuario no tiene una única empresa asociada en este contexto.
nameNombre corto mostrable del usuario.
pictureURL de la imagen de perfil del usuario.
phoneTeléfono celular del usuario.
premiumIndica si la empresa tiene plan premium o suscripción premium activa.
roleRol del usuario en la empresa.
Valores posibles:
admin— Administrador (acceso total)accountant— Contador (acceso a nómina y contabilidad)reviewer— Revisor (acceso de solo lectura)worker— Persona (acceso a su propio perfil)
worker_idIdentificador único (ID) de la persona en la empresa, si existe vínculo.
worker_with_benefitsIndica si la empresa tiene módulo o personas con beneficios configurados.
workers_handle_noveltiesIndica si en la configuración de empresa las personas pueden autogestionar novedades.
workers_income_certificate_accessIndica si aplica acceso a certificados de ingresos según configuración de empresa.
workers_labor_certificate_accessIndica si aplica acceso a certificados laborales según configuración de empresa.
workers_payslips_accessIndica si aplica acceso a colillas según configuración de empresa.
distributorIdentificador del distribuidor asociado a la empresa.
sign_upIndica si es la primera vez que el usuario inicia sesión. Solo está presente cuando la empresa tiene un distribuidor asociado.
WorkerDocumentType
Tipo de documento de identificación de la persona.
Valores posibles:
cc— Cédula de Ciudadaníace— Cédula de Extranjeríati— Tarjeta de Identidadrc— Registro Civilpa— Pasaportepe— Permiso Especial de Permanencia (PEP)ce_no_pension— Cédula de Extranjería sin obligación de pensiónpe_no_pension— Permiso Especial de Permanencia sin obligación de pensiónpt— Permiso por Protección Temporal (PPT)pt_no_pension— Permiso por Protección Temporal sin obligación de pensión
AccountType
Tipo de cuenta bancaria.
Valores posibles:
savings_account— Cuenta de ahorroscurrent_account— Cuenta corriente
ContractCategory
Categoría del contrato laboral.
Valores posibles:
employee— Empleadocontractor— Contratistaschooling_trainee— Aprendiz SENA etapa lectivaproductive_trainee— Aprendiz SENA etapa productivadual_trainee— Aprendiz SENA formación dualintern— Practicante universitariostudent_decree_055— Estudiante pasantía (Decreto 055 de 2015)student_law_789— Estudiante (Régimen especial Ley 789 de 2002)part_time_contract— Contrato a tiempo parcial
SalaryCategory
Modalidad del salario.
Valores posibles:
monthly— Salario mensual fijoper_hour— Salario por horaintegral_salary— Salario integralpart_time— Tiempo parcial
ApplicationPeriod
Periodo de nómina en el que se aplica el descuento del préstamo.
Valores posibles:
all_periods— Todos los periodosfirst_fortnightly— Primera quincenasecond_fortnightly— Segunda quincena
NoveltyRequestStatus
Estado actual de la solicitud de novedad.
Valores posibles:
pending— Pendiente de revisión por el administradorapproved— Aprobada por el administradorrejected— Rechazada por el administrador
PayslipType
Tipo de colilla de pago.
Valores posibles:
payroll— Nómina estándar (valor por defecto)termination— Liquidación de contratopayroll_termination— Nómina con liquidación de contratosocial_benefit— Prestación social (prima, cesantías o intereses)payroll_social_benefit— Nómina con prestación socialservice_bonus— Prima de servicios (alias desocial_benefit)severance_interests— Intereses de cesantías (alias desocial_benefit)payroll_service_bonus— Nómina con prima de servicios (alias depayroll_social_benefit)payroll_severance_interests— Nómina con intereses de cesantías (alias depayroll_social_benefit)
RecurrentConceptCategory
Categoría del concepto recurrente de nómina.
Valores posibles:
incomes— Ingresos (salariales y no salariales)salary_income— Ingresos salarialesnon_salary_income— Ingresos no salarialesdeductions_and_loans— Deducciones y préstamosdeductions— Deduccionesloans— Préstamos
AccountingCategory
Categoría contable de los conceptos de nómina.
Valores posibles:
incapacities_licenses— Incapacidades y licenciassalary_income— Ingresos salarialesnon_salary_income— Ingresos no salarialesoccasional_non_salary_income— Ingresos no salariales ocasionalesovertime— Horas extras y recargosdeductions— Deduccionessocial_benefits— Prestaciones socialessocial_security— Seguridad socialretentions— Retencionestermination— Liquidaciónpayment_method— Método de pagolegal— Legalesloan— Préstamos
AccountingDocumentType
Tipo de documento contable para la integración con el proveedor.
Valores posibles:
payroll— Nómina (provisión)social_benefits— Prestaciones sociales (provisión)social_security— Seguridad social (provisión)payroll_payment— Nómina y prestaciones (comprobante de egreso)social_security_payment— Seguridad social (comprobante de egreso)
ContractTerm
Tipo de duración del contrato.
Valores posibles:
indefinite— Contrato a término indefinidofixed— Contrato a término fijoproject— Contrato por obra o labor
ContributorSubtype
Subtipo de cotizante aplicado al contrato para la liquidación de seguridad social.
Valores posibles:
no_subtype— Sin subtipopensioner— Pensionadoage_exempt_contributor— Cotizante exonerado por edadqualified_for_pension— Habilitado para pensióncompensated_contributor— Cotizante compensado
RiskType
Código del tipo de riesgo laboral ARL (Administradora de Riesgos Laborales).
Valores posibles:
risk_1— Clase I: Riesgo mínimo (ej. oficinas, trabajo administrativo)risk_2— Clase II: Riesgo bajo (ej. algunos procesos manufactureros)risk_3— Clase III: Riesgo medio (ej. maquinaria industrial)risk_4— Clase IV: Riesgo alto (ej. minería, construcción)risk_5— Clase V: Riesgo máximo (ej. manejo de explosivos)
ElectronicPayrollSocialBenefits
Modo de reporte de prestaciones sociales en la nómina electrónica ante la DIAN.
Valores posibles:
provision_per_month— Las prestaciones sociales se incluyen mensualmente de acuerdo al concepto de devengoat_the_time_of_payment— Las prestaciones sociales se incluyen al momento del pagopayment_in_year— Las cesantías e intereses se reportan en diciembre si no se han pagado durante el año; la prima al momento del pago
ElectronicPayrollGovernmentStatus
Estado de habilitación de la empresa ante la DIAN para emitir nómina electrónica.
Valores posibles:
unauthorized— No habilitada, sin envío previo a la DIANauthorized— Habilitada y autorizada por la DIANwaiting_response— Esperando respuesta de la DIANpending_to_send— Pendiente de envío a la DIANrejected— Rechazada por la DIANfailed— Error en el proceso de habilitación
ElectronicPayrollHolidays
Modo de reporte de vacaciones en la nómina electrónica ante la DIAN.
Valores posibles:
holidays_provision_per_month— Las vacaciones se incluyen mensualmente de acuerdo al concepto de devengoholidays_at_the_time_of_payment— Las vacaciones se incluyen al momento del pagoholidays_payment_in_year— Las vacaciones se reportan en diciembre si no se han pagado durante el año
SubscriptionPaymentType
Frecuencia de pago de la suscripción a cobrar.
Valores posibles:
month— Mensualyear— Anual
EarlyPaymentType
Tipo de pago anticipado de vacaciones aplicado a la nómina.
Valores posibles:
no_early_payment— Sin pago anticipado de vacaciones.early_payment_holidays_only— Solo vacaciones anticipadas.early_payment_holidays_and_payroll— Vacaciones y nómina anticipadas.
PayrollBankPaymentType
Tipo de pago a incluir en el archivo bancario de una nómina individual.
Valores posibles:
payroll— Solo nómina (valor por defecto)service_bonus— Solo prima de serviciospayroll_service_bonus— Nómina más prima de serviciostermination— Solo liquidación de contratopayroll_termination— Nómina más liquidación (solo liquidados)severance_interests— Solo intereses de cesantíaspayroll_severance_interests— Nómina más intereses de cesantíassocial_benefit— Solo prestaciones sociales (cuando hay múltiples categorías)payroll_social_benefit— Nómina más prestaciones sociales (cuando hay múltiples categorías)
PayrollRange
Tramo de la nómina a incluir en la colilla. Solo aplica cuando la nómina fue liquidada con vacaciones anticipadas; en ese caso el periodo se divide en tramos según los conceptos de cada parte.
Valores posibles:
full_period— Periodo completo0,1,2... — Índice del tramo (los disponibles varían por nómina)
Los valores exactos se obtienen del campo payroll_range del endpoint
GET /v1/{company_id}/payrolls/{payroll_id}/payslip_options.
Si no se envía, se usa full_period por defecto.
PeriodBankPaymentType
Tipo de pago a incluir en el archivo bancario de un periodo completo.
Valores posibles:
payroll— Solo nómina (valor por defecto)service_bonus— Solo prima de serviciospayroll_service_bonus— Nómina más prima de serviciostermination— Solo liquidaciones de contratopayroll_termination— Nómina más liquidaciones (solo liquidados)payroll_termination_full— Nómina completa (sin pago anticipado) más liquidacionesseverance_interests— Solo intereses de cesantíaspayroll_severance_interests— Nómina más intereses de cesantíassocial_benefit— Solo prestaciones sociales (cuando hay múltiples categorías)payroll_social_benefit— Nómina más prestaciones sociales (cuando hay múltiples categorías)
FiltersModel
pageNúmero de página actual en la paginación
per_pageNúmero de registros por página
searchTérmino de búsqueda aplicado. Cadena vacía si no se aplicó ningún filtro de búsqueda.
total_recordsNúmero total de registros que coinciden con los filtros