Clarisa ofrece una API que le permite a su sistema integrarse y reportar nóminas individuales electrónicas.
Crear Nómina individual electrónica
CABECERAS:
| CABECERA | VALOR |
| Content-Type | application/json |
| Authorization | token de usuario |
METODO : "POST"
Nota: Antes de crear una nómina individual, debe registrar una numeración de Nómina Individual en el sistema.
CUERPO:
| Nombre | Formato | Tamaño | Descripción | Obligatorio |
|---|---|---|---|---|
| fechaLiquidacionInicio | String | 10 | Fecha inicial de liquidación de la nómina (Formato: yyyy-MM-dd) | Si |
| fechaLiquidacionFin | String | 10 | Fecha final de liquidación de la nómina (Formato: yyyy-MM-dd) | Si |
| notas | String | 500 | Utilizado para agregar notas al documento | No |
| prefijo | String | 255 | Prefijo de la numeración a utilizar | Si |
| consecutivo | String | 20 | Número de consecutivo de la numeración | Si |
| fechasPago | String | 10 | Fechas en las que realizó el pago de la nómina (Formato: yyyy-MM-dd) | Si |
| fechaGeneracion | String | 19 | Fecha y hora en la que se genera la nómina (Formato: yyyy-MM-dd hh:mm:ss) | Si |
| comprobanteTotal | Numérico | 100000000 | Resta de la suma de los devengados y la suma de las deducciones | Si |
| deduccionTotal | Numérico | 100000000 | Suma total de las deducciones | Si |
| devengadoTotal | Numérico | 100000000 | Suma total de los devengados | Si |
| empleado | Objeto | - | Datos del trabajador al cual se crea la nómina | Si |
| empleado.numeroIdentificacion | String | 20 | Número de identificación del empleado | Si |
| empleado.primerNombre | String | 100 | Primer nombre del empleado | Si |
| empleado.otrosNombres | String | 100 | Otros nombres del empleado | No |
| empleado.primerApellido | String | 100 | Primer apellido del empleado | Si |
| empleado.segundoApellido | String | 100 | Segundo apellido del empleado | No |
| empleado.tipoIdentificacion | String | - | Código del tipo de identificación del empleado. Véase Valores para Tipo de identificación | Si |
| empleado.altoRiesgoPension | boolean | - | Indica si el empleado desarrollo durante el presente periodo alguna de las actividades descritas en el Decreto 2090 de 2003 | Si |
| empleado.salarioIntegral | boolean | - | Indica si el empleado cuenta con salario integral | Si |
| empleado.ciudad | String | - | Código DANE de la ciudad donde se encuentra ubicado el empleado. Véase Valores para Ciudad | Si |
| empleado.direccion | String | 255 | Dirección del empleado | Si |
| empleado.fechaIngreso | String | 10 | Fecha de ingreso del empleado a la empresa (Formato: yyyy-MM-dd) | No |
| empleado.fechaRetiro | String | 10 | Fecha del retiro del empleado de la empresa (Formato: yyyy-MM-dd) | No |
| empleado.tipoCuenta | String | - | Hace referencia al código del tipo de cuenta bancaria del empleado. Véase Valores para Tipo de cuenta | Si |
| empleado.numeroCuenta | String | 255 | Número de cuenta bancaria del empleado | Si |
| empleado.salario | Numérico | 100000000 | Salario del empleado | Si |
| empleado.tipoTrabajador | String | - | Hace referencia al código del tipo de empleado. Véase Valores para Tipo de trabajador | Si |
| empleado.subtipoTrabajador | String | - | Hace referencia al código del subtipo de empleado. Véase Valores para Subtipo de trabajador | Si |
| empleado.tipoContrato | String | - | Hace referencia al código del tipo de contrato del empleado. Véase Valores para Tipo de contrato | Si |
| empleado.periodoNomina | String | - | Hace referencia al código del periodo de pago de la nómina al empleado. Véase Valores para Tipo de periodo de nómina | Si |
| empleado.metodoPago | String | - | Hace referencia al código del método de pago de la nómina. Véase Valores para Métodos de pago | Si |
| empleado.entidadBancaria | String | - | Hace referencia al código de la entidad bancaria donde se deposita la nómina. Véase Valores para Entidades bancarias | Si |
| devengados | Objeto | - | Devengados de la nómina individual | Si |
| devengados.auxilioTransporte | Numérico | 100000000 | Auxilio de transporte para el trabajador | Si |
| devengados.sueldoTrabajado | Numérico | 100000000 | Sueldo trabajado en el mes | Si |
| devengados.diasTrabajados | Numérico | 31 | Días trabajados en el mes | Si |
| devengados.horasExtrasRecargos | Array[] | - | Horas extras hechas por el empleado | No |
| devengados.horasExtrasRecargos.tipo | String | - | Hace referencia al código del tipo de hora extra a reportar. Véase Valores para Tipos de hora extra recargo | Si |
| devengados.horasExtrasRecargos.pago | Numérico | 100000000 | Pago por las horas extras laboradas | Si |
| devengados.horasExtrasRecargos.cantidad | Numérico | 750 | Número de horas extras laboradas | Si |
| devengados.vacaciones | Array[] | - | Vacaciones del empleado | No |
| devengados.vacaciones.tipo | String | - | Hace referencia al código del tipo de vacaciones a reportar. Véase Valores para Tipos de Vacaciones | Si |
| devengados.vacaciones.fechaInicio | String | 10 | Fecha de inicio de las vacaciones (Formato: (yyyy-MM-dd)) | No |
| devengados.vacaciones.fechaFin | String | 10 | Fecha de finalización de las vacaciones (Formato: yyyy-MM-dd) | No |
| devengados.vacaciones.cantidadDias | Numérico | 31 | Cantidad de días de vacaciones | No |
| devengados.vacaciones.pago | Numérico | 100000000 | Pago por las vacaciones | Si |
| devengados.primas | Objeto | - | Prima a reportar | No |
| devengados.primas.cantidadDias | Numérico | 366 | Cantidad de días a pagar en la prima | Si |
| devengados.primas.pago | Numérico | 100000000 | Pago salarial por la prima | Si |
| devengados.primas.pagoNS | Numérico | 100000000 | Pago no salarial por la prima | No |
| devengados.cesantias | Objeto | - | Cesantías a reportar | No |
| devengados.cesantias.porcentaje | Numérico | 100 | Porcentaje de interés de las cesantías | Si |
| devengados.cesantias.pago | Numérico | 100000000 | Pago por las cesantías | Si |
| devengados.cesantias.pagoIntereses | Numérico | 100000000 | Pago por los intereses de las cesantías | Si |
| devengados.incapacidades | Array[] | - | Incapacidades presentadas por el empleado | No |
| devengados.incapacidades.tipo | String | - | Hace referencia al código de la incapacidad a reportar. Véase Valores para Tipos de incapacidades | Si |
| devengados.incapacidades.fechaInicio | String | 10 | Fecha de inicio de la incapacidad (Formato: yyyy-MM-dd) | Si |
| devengados.incapacidades.fechaFin | String | 10 | Fecha de finalización de la incapacidad (Formato: yyyy-MM-dd) | Si |
| devengados.incapacidades.cantidadDias | Numérico | 31 | Número de días que duró la incapacidad | Si |
| devengados.incapacidades.pago | Numérico | 100000000 | Pago realizado por la incapacidad | Si |
| devengados.licencias | Array[] | - | Licencias a reportar | No |
| devengados.licencias.fechaInicio | String | 10 | Fecha en la que inicia la licencia (Formato: yyyy-MM-dd) | Si |
| devengados.licencias.fechaFin | String | 10 | Fecha en la que finaliza la licencia (Formato: yyyy-MM-dd) | Si |
| devengados.licencias.cantidadDias | Numérico | 31 | Número de días que duró la licencia | Si |
| devengados.licencias.pago | Numérico | 100000000 | Pago realizado por la licencia | Si |
| devengados.licencias.tipo | String | - | Hace referencia al código del tipo de licencia a reportar. Véase Valores para Tipos de licencias | Si |
| devengados.huelgasLegales | Array[] | - | Huelgas legales a reportar | No |
| devengados.huelgasLegales.fechaInicio | String | 10 | Fecha en la que inicia la huelga (Formato: yyyy-MM-dd) | Si |
| devengados.huelgasLegales.fechaFin | String | 10 | Fecha en la que finaliza la huelga (Formato: yyyy-MM-dd) | Si |
| devengados.huelgasLegales.cantidadDias | Numérico | 31 | Número de días que duró la huelga | Si |
| devengados.otrosConceptos | Array[] | - | Otros conceptos a reportar | No |
| devengados.otrosConceptos.descripcion | String | 255 | Descripción del concepto | Si |
| devengados.otrosConceptos.conceptoSalarial | Numérico | 1000000000 | Pago salarial por el concepto | No |
| devengados.otrosConceptos.conceptoNoSalarial | Numérico | 1000000000 | Pago no salarial por el concepto | No |
| devengados.otrosDevengados | Objeto | - | Otros devengados a reportar | No |
| devengados.otrosDevengados.tipo | String | - | Hace referencia al código del tipo de devengado a reportar. Véase Valores para Tipos de devengados | Si |
| devengados.otrosDevengados.valor | Numérico | 1000000000 | Valor del devengado | Si |
| deducciones | Objeto | - | Deducciones a reportar | Si |
| deducciones.pagoSalud | Numérico | 1000000000 | Pago realizado por el concepto de salud | Si |
| deducciones.pagoPension | Numérico | 1000000000 | Pago realizado por el concepto de pensión | Si |
| deducciones.deduccionesPorcentuales | Array[] | - | Deducciones porcentuales a reportar | No |
| deducciones.deduccionesPorcentuales.tipo | String | - | Hace referencia al código del tipo de deducción porcentual a reportar. Véase Valores para Tipos de deducciones porcentuales | Si |
| deducciones.deduccionesPorcentuales.porcentaje | Numérico | 100 | Porcentaje de la deducción | Si |
| deducciones.deduccionesPorcentuales.valorDeduccion | Numérico | 1000000000 | Valor de la deducción | Si |
| deducciones.deduccionesValor | Array[] | - | Deducciones valor a reportar | No |
| deducciones.deduccionesValor.tipo | String | - | Hace referencia al código del tipo de deducción valor a reportar. Véase Valores para Tipos de deducciones valor | Si |
| deducciones.deduccionesValor.valor | Numérico | 1000000000 | Valor de la deducción | Si |
| deducciones.sindicatos | Array | - | Deducciones por sindicatos a reportar | No |
| deducciones.sindicatos.porcentaje | Numérico | 100 | Porcentaje de aporte al sindicato | Si |
| deducciones.sindicatos.deduccion | Numérico | 1000000000 | Valor de aporte al sindicato | Si |
| deducciones.libranzas | Array | - | Deducciones por libranzas a reportar | No |
| deducciones.libranzas.descripcion | String | 250 | Descripción de la libranza | Si |
| deducciones.libranzas.deduccion | Numérico | 1000000000 | Valor de la libranza | Si |
| Nombre | Código |
|---|---|
| Cédula de ciudadania | CC |
| NIT | NIT |
| tarjeta de identidad | TI |
| Pasaporte | PA |
| Tarjeta de extranjería | TE |
| Cédula de extranjería | CE |
| Registro civil de nacimiento | RC |
| Nit de otro país | NIT_OP |
| NUIP | NUIP |
| Documento de identificación extranjero | DIE |
| PEP | PEP |
| Puedes descargar el siguiente archivo Excel con las ciudades de Colombia o puedes consultarlas a través del siguiente servicio: Guía técnica para consumo de API Ciudades |
| Nombre | Código |
|---|---|
| Acuerdo mutuo | ZZZ |
| Efectivo | 10 |
| Consiganción bancaria | 42 |
| Transferencia Crédito | 30 |
| Transferencia Débito | 31 |
| Tarjeta Débito | 49 |
| Tarjeta Crédito | 48 |
| Bonos | 71 |
| Bookentry Crédito | 15 |
| Bookentry Débito | 16 |
| Cheque | 20 |
| Cheque bancario | 23 |
| Cheque certificado | 25 |
| Cheque Local | 26 |
| Cheque local transferible | 92 |
| Clearing entre partners | 97 |
| Clearing Nacional o Regional | 9 |
| Concentración de la demanda en efectivo / Desembolso (CCD) débito | 18 |
| Concentración de la demanda en efectivo /Desembolso Crédito (CCD) | 17 |
| Concentración Efectivo / Desembolso Crédito plus (CCD) | 32 |
| Concentración efectivo / Desembolso Débito plus (CCD) | 43 |
| Concentración Efectivo / Desembolso Débito plus (CCD) | 33 |
| Concentración efectivo ahorros / Desembolso Crédito (CCD) | 35 |
| Concentración efectivo ahorros / Desembolso Drédito (CCD) | 36 |
| Concentración efectivo/Desembolso Crédito plus (CCD) | 41 |
| Crédito ACH | 2 |
| Crédito Ahorro | 13 |
| Crédito de demanda ACH | 6 |
| Crédito Negocio Intercambio Corporativo (CTX) | 28 |
| Crédito Negocio Intercambio Corporativo (CTX) | 39 |
| Crédito Pago negocio corporativo (CTP) | 19 |
| Débito ACH | 3 |
| Débito Ahorro | 14 |
| Débito de demanda ACH | 7 |
| Débito Negocio Intercambio Corporativo (CTX) | 40 |
| Débito Negocio Intercambio Corporativo (CTX) | 29 |
| Débito Pago Negocio Corporativo (CTP) | 27 |
| Giro formato abierto | 95 |
| Giro referenciado | 93 |
| Giro urgente | 94 |
| Instrumento no definido | 1 |
| Mantener | 8 |
| Método de pago solicitado no usuado | 96 |
| Nota bancaria transferible | 91 |
| Nota cambiaria | 44 |
| Nota cambiaria esperando aceptación | 24 |
| Nota promisoria | 60 |
| Nota promisoria firmada | 66 |
| Nota promisoria firmada por el acreedor | 61 |
| Nota promisoria firmada por el acreedor, avalada por el banco | 62 |
| Nota promisoria firmada por el acreedor, avalada por un tercero | 63 |
| Nota promisoria firmada por el banco | 64 |
| Nota promisoria firmada por un banco avalada por otro banco | 65 |
| Nota promisoria firmada por un tercero avalada por un banco | 67 |
| Pago comercial urgente | 52 |
| Pago Negocio Corporativo Ahorros Crédito (CTP) | 37 |
| Pago Neogcio Corporativo Ahorros Débito (CTP) | 38 |
| Pago Tesorería Urgente | 53 |
| Pago y depósito pre acordado (PPD) | 34 |
| Postgiro | 50 |
| Poyecto bancario | 21 |
| Proyecto bancario certificado | 22 |
| Retiro de nota por el acreedor | 70 |
| Retiro de nota por el acreedor sobre un banco | 74 |
| Retiro de nota por el acreedor, avalada por otro banco | 75 |
| Retiro de nota por el acreedor, sobre un banco avalada por un tercero | 76 |
| Retiro de una nota por el acreedor sobre un tercero | 77 |
| Retiro de una nota por el acreedor sobre un tercero avalada por un banco | 78 |
| Reversión Crédito Ahorro | 11 |
| Reversión crédito de demanda ACH | 5 |
| Reversión Débito Ahorro | 12 |
| Reversión débito de demanda ACH | 4 |
| Telex estándar bancario francés | 51 |
| Transferencia Crédito Bancario | 45 |
| Transferencia Débito Bancaria | 47 |
| Transferencia Débito Interbancario | 46 |
| Vales | 72 |
| Nombre | Código |
|---|---|
| Ahorros | AHORROS |
| Corriente | CORRIENTE |
| Nombre | Código |
|---|---|
| Dependiente | DEPENDIENTE |
| Servicio doméstico | SERVICIO_DOMESTICO |
| Madre comunitaria | MADRE_COMUNITARIA |
| Aprendices del Sena en etapa lectiva | APRENDIZ_SENA_LECTIVA |
| Funcionarios públicos sin tope máximo de ibc | FUNC_PUBLICOS_MAX_IBC |
| Aprendices del SENA en etapa productiva | APRENDIZ_SENA_PRODUCTIVA |
| Estudiantes de postgrado en salud | ESTUDIANTES_POSTGRADO_SALUD |
| Profesor de establecimiento particular | PROFESOR_EST_PARTICULAR |
| Estudiantes aportes solo riesgos laborales | ESTUDIANTE_ARL |
| Dependiente entidades o universidades públicas con régimen especial en salud | DEP_ENT_UNI_PUB_REG_ESP_SALUD |
| Cooperados o pre cooperativas de trabajo asociado | COO_TRABAJO_ASOCIADO |
| Trabajador dependiente de entidad beneficiaria del sistema general de participaciones - aportes patronales | TRA_DEP_APORTES_PATRONALES |
| Trabajador de tiempo parcial | TRABAJO_TIEMPO_PARCIAL |
| Pre pensionado de entidad en liquidación | PRE_PRENSIONADO_LIQUIDACION |
| Pre pensionado con aporte voluntario a salud | PRE_PRESNIONADO_APO_VOL_SALUD |
| Estudiantes de prácticas laborales en el sector público | ESTUDANTE_PL_SECTOR_PUBLICO |
| Nombre | Código |
|---|---|
| No Aplica | NO_APLICA |
| Dependiente pensionado por vejez activo | DEP_PENSIONADO_VEJEZ_ACTIVO |
| Nombre | Código |
|---|---|
| Termino Fijo | TERMINO_FIJO |
| Termino Indefinido | TERMINO_INDEFINIDO |
| Obra o Labor | OBRA_LABOR |
| Aprendizaje | APRENDIZAJE |
| Prácticas o Pasantía | PRACTICAS_PASANTIA |
| Nombre | Código |
|---|---|
| Semanal | SEMANAL |
| Decenal | DECENAL |
| Catorcenal | CATORCENAL |
| Quincenal | QUINCENAL |
| Mensual | MENSUAL |
| Otro | OTRO |
| Nombre | Código |
|---|---|
| Banco Agrario | 40 |
| Banco Av Villas | 52 |
| Banco Caja Social | 32 |
| Banco Colpatria | 19 |
| Banco Compartir | 67 |
| Banco Corpbanca | 6 |
| Banco Davivienda S.A. | 51 |
| Banco de Bogota | 1 |
| Banco de Occidente | 23 |
| Banco Falabella S.A. | 62 |
| Banco Finandina S.A. | 63 |
| Banco GNB Sudameris | 12 |
| Banco Multibank | 64 |
| Banco Pichincha S.A. | 60 |
| Banco Popular | 2 |
| Banco Procredit | 58 |
| Banco Santander de Negocios Colombia S.A. | 65 |
| Bancolombia | 7 |
| Bancoomeva | 61 |
| BBVA Colombia | 13 |
| BNP Paribas | 42 |
| Citibank | 9 |
| Coltefinanciera | 370 |
| Confiar S.A | 292 |
| Coopcentral | 66 |
| Cooperativa Financiera De Antioquia | 283 |
| Corficolombiana | 90 |
| Cotrafa Cooperativa Financiera | 289 |
| Financiera Juridiscoop | 121 |
| Itaú | 14 |
| Nequi | 507 |
| Nombre | Código |
|---|---|
| Hora Extra Diurna | H_EXTRA_DIURNA |
| Hora Extra Nocturna | H_EXTRA_NOCTURNA |
| Hora Recargo Nocturno | H_RECARGO_NOCTURNA |
| Hora Extra Diurna Dominical y Festivos | H_EXTRA_DIURNA_DOM_FEST |
| Hora Recargo Diurno Dominical y Festivos | H_REC_DIURNO_DOM_FEST |
| Hora Extra Nocturna Dominical y Festivos | H_EXT_NOCT_DOM_FEST |
| Hora Recargo Nocturno Dominical y Festivos | H_REC_NOCT_DOM_FEST |
| Nombre | Código |
|---|---|
| Vacaciones comunes | VAC |
| Vacaciones compensadas | VAC_COM |
| Código | Nombre |
|---|---|
| COMUN | Común |
| PROFESIONAL | Profesional |
| LABORAL | Laboral |
| Nombre | Código |
|---|---|
| Licencia de maternidad o paternidad | LICENCIA_MP |
| Licencia remunerada | LICENCIA_R |
| Licencia no remunerada | LICENCIA_NR |
| Nombre | Código |
|---|---|
| Viático manutención y alojamiento | VIATICO_MANU_ALOJ_S |
| Viático manutención y alojamiento no salarial | VIATICO_MANU_ALOJ_NS |
| Bonificación salarial | BONIFICACION_S |
| Bonificación no salarial | BONIFICACION_NS |
| Auxilios no salariales | AUXILIO_NS |
| Compensaciones ordinarias | COMPENSACION_O |
| Compensaciones extraordinarias | COMPENSACION_E |
| Valor que el trabajador recibe como concepto salarial | PAGO_S |
| Valor que el trabajador recibe como concepto no salarial | PAGO_NS |
| Alimentación salarial | PAGO_ALIMENTACION_S |
| Alimentación no salarial | PAGO_ALIMENTACION_NS |
| Pago tercero | PAGO_TERCERO |
| Dotación | DOTACION |
| Teletrabajo | TELETRABAJO |
| Reintegro | REINTEGRO |
| Bonificación por retiro | BONIF_RETIRO |
| Indemnización | INDEMNIZACION |
| Apoyo sostenimeinto | APOYO_SOST |
| Nombre | Código |
|---|---|
| Fondo de solidaridad pensional | DEDUCCION_SP |
| Fondo de subsistencia | DEDUCCION_SUB |
| Sindicato | SINDICATO |
| Nombre | Código |
|---|---|
| Sanción pública | SANCION_PUBLIC |
| Sanción privada | SANCION_PRIV |
| Pago tercero | PAGO_TERCERO |
| Anticipo | ANTICIPO |
| Otra deducción | OTRA_DEDUCCION |
| Pensión voluntaria | PENSION_VOLUNTARIA |
| Retención en la fuente | RETENCION_FUENTE |
| Ahorro fomento a la construcción | AFC |
| Cooperativa | COOPERATIVA |
| Embargo fiscal | EMBARGO_FISCAL |
| Planes complementarios | PLAN_COMPLEMENTARIOS |
| Educación | EDUCACION |
| Reintegro | REINTEGRO |
| Deuda | DEUDA |
En caso de que no se pueda obtener la información de la nómina individual, se debe tener en cuenta la variable success y los valores de titleResponse y textResponse para poder mostrar los mensajes respectivos al usuario. La variable titleResponse contiene el código del error y la variable textResponse contiene la descripción del error la cual debe ser mostrada al usuario. Si es errores por validación de datos, en data se retorna el total de errores y un array con los errores.
Correcto
En caso de que la petición se ejecute sin errores, devolverá la siguiente respuesta:
CÓDIGO HTTP: 200
Error
Si la solicitud no es correcta, recibirá la siguiente respuesta:
CÓDIGO HTTP: 400 | 401 | 500
Crear Nómina de Ajuste
Contamos con la verificación y validación de tus ajustes de nómina para que sean reportadas a la DIAN.
CABECERAS:
| CABECERA | VALOR |
| Content-Type | application/json |
| Authorization | token de usuario |
METODO : "POST"
Nota: Antes de crear una nómina individual de ajuste, debe registrar una numeración de Nómina de ajuste en el sistema.
CUERPO:
| Nombre | Formato | Tamaño | Descripción | Obligatorio |
|---|---|---|---|---|
| fechaGeneracion | String | 19 | Fecha y hora en la que se genera la nómina de ajuste (Formato: yyyy-MM-dd hh:mm:ss) | Si |
| notas | String | 500 | Descripción del ajuste de nómina | No |
| prefijo | String | 255 | Prefijo asociado al número de la nómina | Si |
| consecutivo | String | 20 | Consecutivo del número de la nómina | Si |
| nominaIndividualAsociada | String | 20 | Número de la nómina individual a la cual se realizará el ajuste. | Si |
En caso de que no se pueda obtener la información de la nómina individual de ajuste, se debe tener en cuenta la variable success y los valores de titleResponse y textResponse para poder mostrar los mensajes respectivos al usuario. La variable titleResponse contiene el código del error y la variable textResponse contiene la descripción del error la cual debe ser mostrada al usuario. Si es errores por validación de datos, en data se retorna el total de errores y un array con los errores.
Correcto
En caso de que la petición se ejecute sin errores, devolverá la siguiente respuesta:
CÓDIGO HTTP: 200
Error
Si la solicitud no es correcta, recibirá la siguiente respuesta:
CÓDIGO HTTP: 400 | 401 | 500