Skip to main content
El servicio permite a los usuarios registrar el documento soporte de pago de nómina electrónica (nómina individual) de un empleado para un periodo de liquidación, en línea en formato JSON. Si el empleado no existe en la plataforma, se registra automáticamente junto con su contrato; si ya existe, se actualizan sus datos y los de su contrato con la información enviada. El método de solicitud es POST y se requiere un encabezado “Authorization” para la autenticación, que debe contener un token JWT obtenido previamente del servicio de autenticación.

Prerequisitos

Antes de realizar el registro de una nómina individual, se debe contar con los siguientes datos:
  • Token solicitado mediante el API de autenticación
  • Empresa habilitada ante la DIAN para emitir nómina electrónica
  • Nómina creada en la plataforma, con un prefijo de nómina electrónica asociado
  • Periodo de nómina electrónica abierto que contenga la fecha inicial de liquidación

Registrar nómina individual

Request URL: https://{{Ambiente}}/API_FE/api/DocumentosElectronicos/NominaIndividualInsertar
Tipo: POST
Content Type: application/json

Datos generales

string
required
Email del usuario de la plataforma con el cual se registra el documento.
string
required
Fecha de inicio del periodo de liquidación del documento, en formato AAAA-MM-DD.
string
required
Fecha de fin del periodo de liquidación del documento, en formato AAAA-MM-DD.
object
required
Periodo de nómina electrónica del documento.
number
Tasa de cambio a pesos colombianos. Es obligatoria cuando la moneda del empleado es diferente a COP.
string
Observaciones generales del documento (máx. 5000 caracteres).

Empleado

object
required
Información del trabajador, aprendiz o pasante.

Liquidación y devengos

string
Fecha de retiro del trabajador, en formato AAAA-MM-DD. Si se envía, el contrato del empleado queda en estado retirado.
int
required
Cantidad de días laborados durante el periodo de pago.
number
required
Sueldo correspondiente a los días laborados.
number
Valor del auxilio de transporte, según aplique.
int
Cantidad de días a los que corresponde el pago de la prima legal. Es obligatorio si se envía ValorPrima.
number
Valor pagado por prima legal. Es obligatorio si se envía DiasBasePrima.
number
Valor pagado por prima no salarial.
number
Valor pagado por cesantías. Si se envía, PorcentajeInteresCesantias y ValorInteresCesantias son obligatorios.
number
Porcentaje de intereses de cesantías (0 a 100).
number
Valor pagado por intereses de cesantías.
number
Valor de viáticos, manutención y alojamiento de carácter salarial.
number
Valor de viáticos, manutención y alojamiento de carácter no salarial.
number
Valor pagado por dotación.
number
Valor pagado por apoyo de sostenimiento.
number
Valor pagado por teletrabajo.
number
Valor pagado por bonificación de retiro.
number
Valor pagado por indemnización.
number
Valor pagado por reintegro por parte del empleador.

Deducciones

number
required
Porcentaje de deducción de salud que paga el trabajador (0 a 100).
number
required
Valor de la deducción de salud del trabajador.
number
required
Porcentaje de deducción de pensión que paga el trabajador.
number
required
Valor de la deducción de pensión del trabajador.
number
Porcentaje de deducción al fondo de solidaridad pensional (0 a 100). Se envía junto con ValorSolidaridadPensional.
number
Valor de la deducción al fondo de solidaridad pensional.
number
Porcentaje de deducción al fondo de subsistencia (0 a 100). Se envía junto con FondoSubsistenciaValor.
number
Valor de la deducción al fondo de subsistencia.
number
Valor de la deducción por cooperativas.
number
Valor de la deducción por embargos fiscales.
number
Valor de la deducción por planes complementarios.
number
Valor de la deducción por conceptos educativos.
number
Valor de la deducción por reintegro por parte del trabajador.
number
Valor de la deducción por deudas del trabajador con la empresa.
number
Valor de la deducción por aportes a pensión voluntaria.
number
Valor de la retención en la fuente del trabajador.
number
Valor de la deducción por aportes a cuentas AFC.

Soportes de pago

array
required
Fechas de pago del documento. Debe contener al menos una fecha.
array
Horas extra y recargos del periodo.
array
Vacaciones del periodo.
array
Incapacidades del periodo.
array
Licencias del periodo.
array
Auxilios salariales o no salariales.
array
Bonificaciones salariales o no salariales.
array
Bonos electrónicos o de papel de servicio, cheques, tarjetas y vales.
array
Comisiones del periodo.
array
Compensaciones del periodo.
array
Otros conceptos devengados.
array
Anticipos devengados: Valor (requerido).
array
Pagos a terceros por beneficios en cabeza del trabajador: Valor (requerido).
array
Anticipos deducidos: Valor (requerido).
array
Pagos a terceros por deducciones en cabeza del trabajador: Valor (requerido).
array
Libranzas del trabajador con entidades financieras.
array
Deducciones por aportes a sindicatos.
array
Otras deducciones: Valor (requerido).

Novedades

array
Novedades de nómina del empleado en el mismo periodo. Cada novedad genera un documento de nómina adicional, asociado al documento principal y con su propio consecutivo.Cada novedad admite los mismos campos de la sección Liquidación y devengos, Deducciones y Soportes de pago (incluida al menos una fecha de pago), además de los siguientes:

Validaciones

El servicio realiza las siguientes validaciones antes de registrar el documento. Si alguna no se cumple, no se registra la nómina y se retorna el error correspondiente. Empresa, nómina y periodo
  • La empresa debe estar habilitada ante la DIAN para emitir nómina electrónica.
  • La nómina debe estar creada en la plataforma y tener asociado un prefijo de nómina electrónica.
  • Debe existir un periodo de nómina electrónica abierto que contenga la FechaInicial.
  • El documento debe contener al menos una fecha de pago en SoportesPagosFechasPagos.
Empleado
  • El TipoDocumento debe estar configurado en la plataforma.
  • El Documento debe tener al menos 5 caracteres y no puede contener guiones.
  • El TipoEmpleado, el SubTipoEmpleado y el TipoContrato deben ser códigos válidos.
  • La moneda debe estar configurada en la plataforma. Si es diferente a COP, la TasaCambio es obligatoria.
  • La FormaPago debe corresponder a un medio de pago definido por la DIAN. Si no está configurado en la plataforma, se registra automáticamente.
  • El TipoCuentaBanco, si se envía, debe ser válido.
  • Los datos del contrato del empleado deben ser válidos para la emisión del documento.
Valores
  • El Salario es obligatorio si no se envía ValorApoyoSostenimiento.
  • DiasBasePrima y ValorPrima se deben enviar juntos.
  • ValorCesantias, PorcentajeInteresCesantias y ValorInteresCesantias se deben enviar juntos.
  • Los porcentajes de salud, intereses de cesantías, solidaridad pensional y fondo de subsistencia deben estar entre 0 y 100.
  • El porcentaje y el valor de solidaridad pensional se deben enviar juntos; lo mismo aplica para el fondo de subsistencia.
  • Los tipos enviados en los soportes de pago (devengo, compensación, hora extra, incapacidad, licencia y vacaciones) deben ser válidos.
  • Los valores se redondean según el número de decimales configurado en el prefijo de nómina electrónica.
Las mismas validaciones de valores y soportes aplican para cada novedad.

Respuesta

string
Resultado de la operación: “OK” o “Error”.
int
Código único del documento de nómina individual registrado (ID). Retorna -1 cuando ocurre un error.
string
“Transacción Exitosa” cuando el registro es correcto, o el detalle del error precedido de “Error:”.