Diferencia entre revisiones de «Métodos Servicio Emisión Nómina Electrónica - Indice Manual Integración Nómina Electrónica»
(→Método Enviar) |
(→Método Enviar) |
||
(No se muestran 7 ediciones intermedias de otro usuario) | |||
Línea 12: | Línea 12: | ||
|String | |String | ||
|idSoftware | |idSoftware | ||
− | | | + | |Corresponde al NIT del Empleador emisor |
− | |||
− | |||
|- | |- | ||
|rowspan="2"|String | |rowspan="2"|String | ||
Línea 397: | Línea 395: | ||
: '''PATH''': …/root.Deducciones/sindicatos | : '''PATH''': …/root.Deducciones/sindicatos | ||
: (ver detalle en [[#Class.Sindicato|Class.Sindicato]]) | : (ver detalle en [[#Class.Sindicato|Class.Sindicato]]) | ||
+ | |- | ||
+ | |reintegro | ||
+ | |String | ||
+ | |<nowiki>N|..</nowiki> | ||
+ | |NO | ||
+ | | | ||
+ | : Valor que le regresa el trabajador a la empresa por un devengo mal realizado en otro pago de nómina | ||
+ | : '''PATH''': …/root.Deducciones/reintegro | ||
|} | |} | ||
=====Class.AnticiposNom===== | =====Class.AnticiposNom===== | ||
Línea 602: | Línea 608: | ||
: '''PATH''': /root./@porcentaje | : '''PATH''': /root./@porcentaje | ||
|- | |- | ||
− | | | + | |deduccion |
|String | |String | ||
|<nowiki>N|..</nowiki> | |<nowiki>N|..</nowiki> | ||
Línea 618: | Línea 624: | ||
: '''PATH''': /No definido | : '''PATH''': /No definido | ||
|} | |} | ||
+ | |||
=====Class.Sancion===== | =====Class.Sancion===== | ||
{| class="mw-collapsible mw-collapsed wikitable" | {| class="mw-collapsible mw-collapsed wikitable" | ||
Línea 666: | Línea 673: | ||
: '''PATH''': /root./@porcentaje | : '''PATH''': /root./@porcentaje | ||
|- | |- | ||
− | | | + | |deduccion |
|String | |String | ||
|<nowiki>N|..</nowiki> | |<nowiki>N|..</nowiki> | ||
Línea 682: | Línea 689: | ||
: '''PATH''': /No definido | : '''PATH''': /No definido | ||
|} | |} | ||
+ | |||
====Class.Devengados==== | ====Class.Devengados==== | ||
{| class="mw-collapsible mw-collapsed wikitable" | {| class="mw-collapsible mw-collapsed wikitable" | ||
Línea 1007: | Línea 1015: | ||
|String | |String | ||
|<nowiki>N|..</nowiki> | |<nowiki>N|..</nowiki> | ||
− | | | + | |NO |
| | | | ||
:Corresponde al valor que el empleador paga de forma periódica al trabajador como contraprestación por el trabajo realizado. | :Corresponde al valor que el empleador paga de forma periódica al trabajador como contraprestación por el trabajo realizado. | ||
Línea 1020: | Línea 1028: | ||
: '''PATH''': /No definido | : '''PATH''': /No definido | ||
|} | |} | ||
+ | |||
=====Class.BonoEPCTV===== | =====Class.BonoEPCTV===== | ||
{| class="mw-collapsible mw-collapsed wikitable" | {| class="mw-collapsible mw-collapsed wikitable" | ||
Línea 1541: | Línea 1550: | ||
| | | | ||
:Nombre del Concepto que corresponde a los demás pagos fijos o variables realizados al trabajador que remuneren en dinero o en especie como contraprestación directa del servicio. | :Nombre del Concepto que corresponde a los demás pagos fijos o variables realizados al trabajador que remuneren en dinero o en especie como contraprestación directa del servicio. | ||
+ | :'''@IMPORTANTE''': Este campo solo admite 100 caracteres según el anexo técnico. | ||
: '''PATH''': /root/@descripcionConcepto | : '''PATH''': /root/@descripcionConcepto | ||
|- | |- | ||
Línea 1551: | Línea 1561: | ||
: '''PATH''': /No definido | : '''PATH''': /No definido | ||
|} | |} | ||
+ | |||
=====Class.PagoTercero===== | =====Class.PagoTercero===== | ||
{| class="mw-collapsible mw-collapsed wikitable" | {| class="mw-collapsible mw-collapsed wikitable" | ||
Línea 2180: | Línea 2191: | ||
|SI | |SI | ||
| | | | ||
− | :Si el trabajador tiene un salario integral, el cual es el tipo de remuneración que incluye todos los conceptos que puedan constituir salario en un solo monto o pago (prestaciones sociales y recargos nocturno, dominical y festivo, y el trabajo extra) y que sea superior a 10 SMLMV mas un 30% correspondiente a factor prestacional. | + | :Si el trabajador tiene un salario integral, el cual es el tipo de remuneración que incluye todos los conceptos que puedan constituir salario en un solo monto o pago (prestaciones sociales y recargos nocturno, dominical y festivo, y el trabajo extra) y que sea superior a 10 SMLMV mas un 30% correspondiente a factor prestacional. '''True = 1 False = 0''' |
: '''PATH''': /root.Trabajador/@salarioIntegral | : '''PATH''': /root.Trabajador/@salarioIntegral | ||
|- | |- | ||
Línea 2321: | Línea 2332: | ||
|Reglas de validación en caso de rechazo DIAN | |Reglas de validación en caso de rechazo DIAN | ||
|} | |} | ||
+ | |||
+ | ===Método ConsultarDocumento=== | ||
+ | |||
+ | Permite consultar el estado de un documento Soporte de Pago de Nómina Electrónica y Nómina de Ajuste, ante la DIAN, el tipo de entrega y si la misma fue exitosa,además otros parámetros de interés que puedes ser útil en los procesos de control del software de Nómina (ERP) o para el modelo de negocio del empleador emisor. | ||
+ | |||
+ | ; REQUEST: Parámetros a Enviar | ||
+ | {| class="mw-collapsible mw-collapsed wikitable" | ||
+ | ! style="background:#f2f2f2; text-align:center;"|Tipo | ||
+ | ! style="background:#f2f2f2; text-align:center;"|Identificador | ||
+ | ! style="background:#f2f2f2; text-align:center;"|Descripción | ||
+ | |- valign="center" | ||
+ | |- | ||
+ | |rowspan="3"|String | ||
+ | |tokenEmpresa | ||
+ | |rowspan="2"|Suministrado por The Factory HKA Colombia | ||
+ | |- | ||
+ | |tokenPassword | ||
+ | |- | ||
+ | |consecutivoDocumentoNom | ||
+ | |Prefijo y Consecutivo del Documento electrónico concatenado sin separadores. Ejemplo “PRUE980338212 | ||
+ | |} | ||
+ | |||
+ | ; RESPONSE: Parámetros a Recibir | ||
+ | {| class="mw-collapsible mw-collapsed wikitable" | ||
+ | ! style="background:#f2f2f2; text-align:center;"|Tipo | ||
+ | ! style="background:#f2f2f2; text-align:center;"|Identificador | ||
+ | ! style="background:#f2f2f2; text-align:center;"|Descripción | ||
+ | |- valign="center" | ||
+ | |- | ||
+ | |String | ||
+ | |ambiente | ||
+ | |Tipo de ambiente de generación del documento: | ||
+ | :: “ambienteDePruebas” | ||
+ | :: “ambienteDeProducción” | ||
+ | |- | ||
+ | |String | ||
+ | |cadenaCodigoQR | ||
+ | |Concatenación cadena del código QR (elemento de control) | ||
+ | |- | ||
+ | |String | ||
+ | |cadenaCune | ||
+ | |Concatenación cadena del código CUNE previo al cálculo por el algoritmo correspondiente del servicio | ||
+ | |- | ||
+ | |Int | ||
+ | |código | ||
+ | |Indica el estado de la operación retornado por el servicio | ||
+ | |- | ||
+ | |String | ||
+ | |cune | ||
+ | |“Código Único de Nómina Electrónica” correspondiente al documento consultado, calculado por el algoritmo correspondiente del servicio. | ||
+ | |- | ||
+ | |String | ||
+ | |descripcionDocumento | ||
+ | |Identificador del tipo de documento de referencia, | ||
+ | : Ejemplo: “Nómina Individual o Nómina Ajuste” | ||
+ | |- | ||
+ | |String | ||
+ | |descripcionEstatusDocumento | ||
+ | |Descripción correspondiente al estatusDocumento ante la DIAN: “La Nomina Individual, ha sido autorizada” | ||
+ | |- | ||
+ | |String | ||
+ | |estatusDocumento | ||
+ | |Código obtenido en la respuesta correspondiente al estado del documento ante la DIAN ("200","109") | ||
+ | |- | ||
+ | |String | ||
+ | |esValidoDIAN | ||
+ | | | ||
+ | : “true” Si es válido | ||
+ | : “false” Si no es válido | ||
+ | |- | ||
+ | |String | ||
+ | |fechaAceptacionDIAN | ||
+ | |Día y Hora en la que la DIAN aceptó el documento electrónico, en formato AAAA-MM-DD HH:MM:SS | ||
+ | |- | ||
+ | |String | ||
+ | |fechaDocumento | ||
+ | |Fecha en la que se generó el documento, en formato: AAAA-MM-DD | ||
+ | |- | ||
+ | |String | ||
+ | |mensaje | ||
+ | |Este mensaje está asociado al código, útil para identificación de errores | ||
+ | |- | ||
+ | |String | ||
+ | |mensajeDocumento | ||
+ | |Entrega una descripción del error de cada una de las validaciones iniciales. Si no hay errores no entrega descripción | ||
+ | |- | ||
+ | |String | ||
+ | |reglasValidacionDIAN | ||
+ | |Mensajes de validación por parte de la DIAN | ||
+ | |- | ||
+ | |String | ||
+ | |resultado | ||
+ | |Resultado del consumo del método: | ||
+ | : “Procesado” ó “Error” | ||
+ | |- | ||
+ | |String | ||
+ | |trackID | ||
+ | |Este elemento corresponde al TrackId del documento procesado | ||
+ | |- | ||
+ | |String | ||
+ | |tipoDocumento | ||
+ | |Identificador del tipo de documento de referencia | ||
+ | : Ver [[Catálogos de códigos para generación de Nómina Electrónica - Indice Manual Integración Nómina Electrónica #Tabla 9|Tabla 9]] | ||
+ | |} | ||
+ | |||
+ | ===Método ConsultarFolios=== | ||
+ | |||
+ | Permite consultar la cantidad de folios para procesar el Soporte de Pago de Nómina Electrónica y Nómina de Ajuste. | ||
+ | |||
+ | ; REQUEST: Parámetros a Enviar | ||
+ | {| class="mw-collapsible mw-collapsed wikitable" | ||
+ | ! style="background:#f2f2f2; text-align:center;"|Tipo | ||
+ | ! style="background:#f2f2f2; text-align:center;"|Identificador | ||
+ | ! style="background:#f2f2f2; text-align:center;"|Descripción | ||
+ | |- valign="center" | ||
+ | |- | ||
+ | |rowspan="3"|String | ||
+ | |tokenEmpresa | ||
+ | |rowspan="2"|Suministrado por The Factory HKA Colombia | ||
+ | |- | ||
+ | |tokenPassword | ||
+ | |} | ||
+ | |||
+ | ; RESPONSE: Parámetros a Recibir | ||
+ | {| class="mw-collapsible mw-collapsed wikitable" | ||
+ | ! style="background:#f2f2f2; text-align:center;"|Tipo | ||
+ | ! style="background:#f2f2f2; text-align:center;"|Identificador | ||
+ | ! style="background:#f2f2f2; text-align:center;"|Descripción | ||
+ | |- valign="center" | ||
+ | |- | ||
+ | |Int | ||
+ | |código | ||
+ | |Indica el estado de la operación retornado por el servicio | ||
+ | |- | ||
+ | |String | ||
+ | |mensaje | ||
+ | |Este mensaje está asociado al código, útil para identificación de errores | ||
+ | |- | ||
+ | |String | ||
+ | |resultado | ||
+ | |Resultado del consumo del método: | ||
+ | : “Procesado” ó “Error” | ||
+ | |- | ||
+ | |Int | ||
+ | |foliosRestantes | ||
+ | |Cantidad de folios disponibles | ||
+ | |} | ||
+ | |||
+ | ===Método EnviarCorreo=== | ||
+ | |||
+ | Permite reenviar a una direccion de correo electrónico el Soporte de Pago de Nómina Electrónica y Nómina de Ajuste. | ||
+ | |||
+ | ; REQUEST: Parámetros a Enviar | ||
+ | {| class="mw-collapsible mw-collapsed wikitable" | ||
+ | ! style="background:#f2f2f2; text-align:center;"|Tipo | ||
+ | ! style="background:#f2f2f2; text-align:center;"|Identificador | ||
+ | ! style="background:#f2f2f2; text-align:center;"|Descripción | ||
+ | |- valign="center" | ||
+ | |- | ||
+ | |rowspan="4"|String | ||
+ | |tokenEmpresa | ||
+ | |rowspan="2"|Suministrado por The Factory HKA Colombia | ||
+ | |- | ||
+ | |tokenPassword | ||
+ | |- | ||
+ | |email | ||
+ | |Direccion de correo electrónico del empleado | ||
+ | |- | ||
+ | |consecutivoDocumentoNom | ||
+ | |Prefijo y Consecutivo del Documento electrónico concatenado sin separadores. Ejemplo “PRUE980338212 | ||
+ | |} | ||
+ | |||
+ | ; RESPONSE: Parámetros a Recibir | ||
+ | {| class="mw-collapsible mw-collapsed wikitable" | ||
+ | ! style="background:#f2f2f2; text-align:center;"|Tipo | ||
+ | ! style="background:#f2f2f2; text-align:center;"|Identificador | ||
+ | ! style="background:#f2f2f2; text-align:center;"|Descripción | ||
+ | |- valign="center" | ||
+ | |- | ||
+ | |Int | ||
+ | |código | ||
+ | |Indica el estado de la operación retornado por el servicio | ||
+ | |- | ||
+ | |String | ||
+ | |mensaje | ||
+ | |Este mensaje está asociado al código, útil para identificación de errores | ||
+ | |- | ||
+ | |String | ||
+ | |resultado | ||
+ | |Resultado del consumo del método: | ||
+ | : “Procesado” ó “Error” | ||
+ | |} | ||
+ | |||
+ | ===Método DescargarXML=== | ||
+ | |||
+ | Permite descargar documento Soporte de Pago de Nómina Electrónica, Nota de Ajuste de Documento Soporte de Pago de Nómina Electrónica en formato XML. | ||
+ | |||
+ | ; REQUEST: Parámetros a Enviar | ||
+ | {| class="mw-collapsible mw-collapsed wikitable" | ||
+ | ! style="background:#f2f2f2; text-align:center;"|Tipo | ||
+ | ! style="background:#f2f2f2; text-align:center;"|Identificador | ||
+ | ! style="background:#f2f2f2; text-align:center;"|Descripción | ||
+ | |- valign="center" | ||
+ | |- | ||
+ | |rowspan="3"|String | ||
+ | |tokenEmpresa | ||
+ | |rowspan="2"|Suministrado por The Factory HKA Colombia | ||
+ | |- | ||
+ | |tokenPassword | ||
+ | |- | ||
+ | |consecutivoDocumentoNom | ||
+ | |Prefijo y Consecutivo del Documento electrónico concatenado sin separadores. Ejemplo “PRUE980338212 | ||
+ | |} | ||
+ | |||
+ | ; RESPONSE: Parámetros a Recibir | ||
+ | {| class="mw-collapsible mw-collapsed wikitable" | ||
+ | ! style="background:#f2f2f2; text-align:center;"|Tipo | ||
+ | ! style="background:#f2f2f2; text-align:center;"|Identificador | ||
+ | ! style="background:#f2f2f2; text-align:center;"|Descripción | ||
+ | |- valign="center" | ||
+ | |- | ||
+ | |Int | ||
+ | |código | ||
+ | |Indica el estado de la operación retornado por el servicio | ||
+ | |- | ||
+ | |String | ||
+ | |cune | ||
+ | |“Código Único de Nómina Electrónica” correspondiente al documento consultado, calculado por el algoritmo correspondiente del servicio. | ||
+ | |- | ||
+ | |String | ||
+ | |documento | ||
+ | |Documento XML codificado en Base64 | ||
+ | |- | ||
+ | |String | ||
+ | |hash | ||
+ | |Código de detección de errores | ||
+ | |- | ||
+ | |String | ||
+ | |mensaje | ||
+ | |Este mensaje está asociado al código, útil para identificación de errores | ||
+ | |- | ||
+ | |String | ||
+ | |nombre | ||
+ | |Prefijo y consecutivo del Documento Electrónico concatenado sin separadores. Ejemplo “PRUE980338212” | ||
+ | |- | ||
+ | |String | ||
+ | |resultado | ||
+ | |Resultado del consumo del método: | ||
+ | : “Procesado” ó “Error” | ||
+ | |} | ||
+ | |||
+ | ===Método DescargarPDF=== | ||
+ | |||
+ | Permite descargar la representación gráfica de un documento Soporte de Pago de Nómina Electrónica y Nómina de Ajuste. | ||
+ | |||
+ | ; REQUEST: Parámetros a Enviar | ||
+ | {| class="mw-collapsible mw-collapsed wikitable" | ||
+ | ! style="background:#f2f2f2; text-align:center;"|Tipo | ||
+ | ! style="background:#f2f2f2; text-align:center;"|Identificador | ||
+ | ! style="background:#f2f2f2; text-align:center;"|Descripción | ||
+ | |- valign="center" | ||
+ | |- | ||
+ | |rowspan="3"|String | ||
+ | |tokenEmpresa | ||
+ | |rowspan="2"|Suministrado por The Factory HKA Colombia | ||
+ | |- | ||
+ | |tokenPassword | ||
+ | |- | ||
+ | |consecutivoDocumentoNom | ||
+ | |Prefijo y Consecutivo del Documento electrónico concatenado sin separadores. Ejemplo “PRUE980338212 | ||
+ | |} | ||
+ | |||
+ | ; RESPONSE: Parámetros a Recibir | ||
+ | {| class="mw-collapsible mw-collapsed wikitable" | ||
+ | ! style="background:#f2f2f2; text-align:center;"|Tipo | ||
+ | ! style="background:#f2f2f2; text-align:center;"|Identificador | ||
+ | ! style="background:#f2f2f2; text-align:center;"|Descripción | ||
+ | |- valign="center" | ||
+ | |- | ||
+ | |Int | ||
+ | |código | ||
+ | |Indica el estado de la operación retornado por el servicio | ||
+ | |- | ||
+ | |String | ||
+ | |cune | ||
+ | |“Código Único de Nómina Electrónica” correspondiente al documento consultado, calculado por el algoritmo correspondiente del servicio. | ||
+ | |- | ||
+ | |String | ||
+ | |documento | ||
+ | |Documento PDF codificado en Base64 | ||
+ | |- | ||
+ | |String | ||
+ | |hash | ||
+ | |Código de detección de errores | ||
+ | |- | ||
+ | |String | ||
+ | |mensaje | ||
+ | |Este mensaje está asociado al código, útil para identificación de errores | ||
+ | |- | ||
+ | |String | ||
+ | |nombre | ||
+ | |Prefijo y consecutivo del Documento Electrónico concatenado sin separadores. Ejemplo “PRUE980338212” | ||
+ | |- | ||
+ | |String | ||
+ | |resultado | ||
+ | |Resultado del consumo del método: | ||
+ | : “Procesado” ó “Error” | ||
+ | |} | ||
+ | |||
{{clear}} | {{clear}} |
Revisión actual del 03:16 16 jun 2023
Sumario
- 1 Método Enviar
- 1.1 Class.Nómina Electrónica
- 1.2 Class.Deducciones
- 1.3 Class.Devengados
- 1.3.1 Class.AnticiposNom
- 1.3.2 Class.Auxilio
- 1.3.3 Class.Basico
- 1.3.4 Class.Bonificación
- 1.3.5 Class.BonoEPCTV
- 1.3.6 Class.Cesantia
- 1.3.7 Class.Comisión
- 1.3.8 Class.Compensación
- 1.3.9 Class.HoraExtra
- 1.3.10 Class.HuelgaLegal
- 1.3.11 Class.Incapacidad
- 1.3.12 Class.Licencia
- 1.3.13 Class.OtroConcepto
- 1.3.14 Class.PagoTercero
- 1.3.15 Class.Prima
- 1.3.16 Class.Transporte
- 1.3.17 Class.Vacaciónes
- 1.4 Class.DocumentosReferenciadosNom
- 1.5 Class.Nota
- 1.6 Class.LugarGeneracionXML
- 1.7 Class.Pago
- 1.8 Class.Periodo
- 1.9 Class.Trabajador
- 1.10 Class.ExtrasNom
- 2 Método ConsultarDocumento
- 3 Método ConsultarFolios
- 4 Método EnviarCorreo
- 5 Método DescargarXML
- 6 Método DescargarPDF
Método Enviar
La función encargada de construir y enviar los documentos de soporte de pago de Nómina Electrónica a la DIAN.
- REQUEST
- Parámetros a Enviar
Tipo | Identificador | Descripción |
---|---|---|
String | idSoftware | Corresponde al NIT del Empleador emisor |
String | tokenEmpresa | Utilice los Suministrado por el proveedor tecnológico en ambiente Demo. |
tokenPassword | ||
String | nitEmpleador | Debe corresponder al NIT del Empleador que realiza el DE |
Objeto | Nomina | Ver el detalle del Objeto Nomina más abajo |
Class.Nómina Electrónica
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
consecutivoDocumentoNom | String | AN..20 | Si |
|
deducciones | Class | - | SI |
|
devengados | Class | SI |
| |
documentosReferenciadosNom | Array<DocumentosReferenciadosNom> | - | SI |
|
extrasNom | Array<ExtensibleNom> | - | NO |
|
fechaEmisionNom | String | AN|19 | SI |
|
notas | Array<Nota> | - | NO |
|
novedad | String | N|1 | SI |
|
novedadCUNE | String | N|96 | C/C |
|
lugarGeneracionXML | Class | - | SI |
|
pagos | Array<Pago> | - | SI |
|
periodoNomina | String | N|1 | SI |
|
periodos | Array<Periodo> | AN|19 | SI |
|
rangoNumeracionNom | String | AN..20 | SI |
|
redondeo | String | N|.. | NO |
|
tipoDocumentoNom | String | N|3 | SI |
|
tipoMonedaNom | String | AN|3 | SI |
|
tipoNota | String | N|1 | SI |
|
totalComprobante | String | N|.. | SI |
|
totalDeducciones | String | N|.. | SI |
|
totalDevengados | String | N|.. | SI |
|
trm | String | N|.. | NO |
|
trabajador | Class | - | SI |
|
Class.Deducciones
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
afc | String | N|.. | NO |
|
anticiposNom | Array<AnticiposNom> | NO |
| |
cooperativa | String | N|.. | NO |
|
deuda | String | N|.. | NO |
|
extrasNom | Array<ExtensibleNom> | - | NO |
|
educación | String | N|.. | NO |
|
embargoFiscal | String | N|.. | NO |
|
fondosPensiones | Array<FondoPension> | - | SI |
|
fondosSP | Array<FondosSP> | - | NO |
|
libranzas | Array<Libranza> | N|.. | NO |
|
otrasDeducciones | Array<OtrasDeducciones> | - | NO |
|
pagosTerceros | Array<PagoTerceros> | - | NO |
|
pensionVoluntaria | String | N|.. | NO |
|
planComplementarios | String | N|.. | NO |
|
retencionFuente | String | N|.. | NO |
|
salud | Array<Salud> | - | SI |
|
sanciones | Array<Sanción> | - | NO |
|
sindicatos | Array<Sindicato> | - | NO |
|
reintegro | String | N|.. | NO |
|
Class.AnticiposNom
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
montoanticipo | String | N|.. | NO |
|
extrasNom | Array<ExtensibleNom> | - | NO |
|
Class.FondoPension
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
deducción | String | N|.. | SI |
|
extrasNom | Array<ExtensibleNom> | - | NO |
|
porcentaje | String | N|4-6 | SI |
|
Class.FondoSP
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
deduccionSP | String | N|.. | NO |
|
deduccionSub | String | N|.. | NO |
|
extrasNom | Array<ExtensibleNom> | - | NO |
|
porcentaje | String | N|4-6 | NO |
|
porcentajeSub | String | N|4-6 | NO |
|
Class.Libranza
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
descripción | String | AN|.. | SI |
|
deduccion | String | N|.. | SI |
|
extrasNom | Array<ExtensibleNom> | - | NO |
|
Class.OtraDeduccion
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
montootraDeduccion | String | N|.. | NO |
|
extrasNom | Array<ExtensibleNom> | - | NO |
|
Class.PagoTercero
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
pagoTercero | String | N|... | NO |
|
extrasNom | Array<ExtensibleNom> | - | NO |
|
Class.Salud
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
porcentaje | String | N|.. | SI |
|
deduccion | String | N|.. | SI |
|
extrasNom | Array<ExtensibleNom> | - | NO |
|
Class.Sancion
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
sancionPublic | String | N|.. | SI |
|
sancionPriv | String | N|.. | SI |
|
extrasNom | Array<ExtensibleNom> | - | NO |
|
Class.Sindicato
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
porcentaje | String | N|.. | SI |
|
deduccion | String | N|.. | SI |
|
extrasNom | Array<ExtensibleNom> | - | NO |
|
Class.Devengados
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
anticiposNom | Array<AnticiposNom> | - | NO |
|
auxilios | Array<Auxilios> | - | NO |
|
apoyoSost | String | N|.. | NO |
|
basico | Array<Basico> | - | SI |
|
bonificaciones | Array<Bonificaciones> | - | NO |
|
bonifRetiro | String | N|.. | NO |
|
bonoEPCTVs | Array<BonoEPCTVs> | - | NO |
|
cesantías | Array<Cesantía> | - | NO |
|
comisiones | Array<Comisión> | - | NO |
|
compensaciones | Array<Compensación> | - | NO |
|
dotación | String | N|.. | NO |
|
extrasNom | Array<ExtensibleNom> | - | NO |
|
horasExtras | Array<HoraExtra> | - | NO |
|
huelgasLegales | Array<HuelgaLegal> | - | NO |
|
indemnización | String | N|.. | NO |
|
incapacidades | Array<Incapacidad> | - | NO |
|
licencias | Class | - | NO |
|
otrosConceptos | Array<OtroConcepto> | - | NO |
|
pagosTerceros | Array<PagoTercero> | - | NO |
|
primas | Array<Prima> | - | NO |
|
reintegro | String | N|.. | NO |
|
teletrabajo | String | N|.. | NO |
|
transporte | Array<Transporte> | - | NO |
|
vacaciones | Class | - | NO |
|
Class.AnticiposNom
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
montoanticipo | String | N|.. | NO |
|
extrasNom | Array<ExtensibleNom> | - | NO |
|
Class.Auxilio
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
auxilioNS | String | N|.. | NO |
|
auxilioS | String | N|.. | NO |
|
extrasNom | Array<ExtensibleNom> | - | NO |
|
Class.Basico
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
diasTrabajados | String | N|1-2 | SI |
|
extrasNom | Array<ExtensibleNom> | - | NO |
|
sueldoTrabajado | String | N|.. | SI |
|
Class.Bonificación
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
bonificacionNS | String | N|.. | NO |
|
bonificacionS | String | N|.. | NO |
|
extrasNom | Array<ExtensibleNom> | - | NO |
|
Class.BonoEPCTV
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
pagoAlimentacionNS | String | N|.. | NO |
|
pagoAlimentacionS | String | N|.. | NO |
|
extrasNom | Array<ExtensibleNom> | - | NO |
|
pagoNS | String | N|.. | NO |
|
pagoS | String | N|.. | NO |
|
Class.Cesantia
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
extrasNom | Array<ExtensibleNom> | - | NO |
|
pago | String | N|.. | SI |
|
pagoIntereses | String | N|.. | SI |
|
porcentaje | String | N|.. | SI |
|
Class.Comisión
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
extrasNom | Array<ExtensibleNom> | - | NO |
|
montocomision | String | N|.. | NO |
|
Class.Compensación
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
compensacionE | String | N|.. | SI |
|
compensacionO | String | N|.. | SI |
|
extrasNom | Array<ExtensibleNom> | - | NO |
|
Class.HoraExtra
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
cantidad | String | N|.. | SI |
|
extrasNom | Array<ExtensibleNom> | - | NO |
|
horaInicio | String | AN|19 | NO |
|
horaFin | String | AN|19 | NO |
|
pago | String | N|.. | SI |
|
porcentaje | String | N|4-6 | SI |
|
tipoHorasExtra | String | N|1 | C/C |
|
Class.HuelgaLegal
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
cantidad | String | N|.. | SI |
|
extrasNom | Array<ExtensibleNom> | - | NO |
|
fechaInicio | String | AN|10 | NO |
|
fechaFin | String | AN|10 | NO |
|
Class.Incapacidad
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
cantidad | String | N|.. | SI |
|
extrasNom | Array<ExtensibleNom> | - | NO |
|
fechaInicio | String | AN|10 | NO |
|
fechaFin | String | AN|10 | NO |
|
pago | String | N|.. | SI |
|
tipo | String | N|1 | SI |
|
Class.Licencia
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
extrasNom | Array<ExtensibleNom> | - | NO |
|
licenciaMP | Array<LicenciaMP> | - | SI |
|
licenciaNR | Array<LicenciaNR> | - | SI |
|
licenciaR | Array<LicenciaR> | - | SI |
|
Class.LicenciaMP
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
cantidad | String | N|.. | SI |
|
extrasNom | Array<ExtensibleNom> | - | NO |
|
fechaInicio | String | AN|10 | NO |
|
fechaFin | String | AN|10 | NO |
|
pago | String | N|.. | SI |
|
Class.LicenciaNR
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
cantidad | String | N|.. | SI |
|
extrasNom | Array<ExtensibleNom> | - | NO |
|
fechaInicio | String | AN|10 | NO |
|
fechaFin | String | AN|10 | NO |
|
Class.LicenciaR
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
cantidad | String | N|.. | SI |
|
extrasNom | Array<ExtensibleNom> | - | NO |
|
fechaInicio | String | AN|10 | NO |
|
fechaFin | String | AN|10 | NO |
|
pago | String | N|.. | SI |
|
Class.OtroConcepto
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
conceptoNS | String | N|.. | NO |
|
conceptoS | String | N|.. | NO |
|
descripcionConcepto | String | AN|.. | SI |
|
extrasNom | Array<ExtensibleNom> | - | NO |
|
Class.PagoTercero
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
montopagoTercero | String | N|.. | NO |
|
extrasNom | Array<ExtensibleNom> | - | NO |
|
Class.Prima
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
cantidad | String | N|.. | SI |
|
extrasNom | Array<ExtensibleNom> | - | NO |
|
pago | String | N|.. | SI |
|
pagoNS | String | N|.. | NO |
|
Class.Transporte
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
auxilioTransporte | String | N|.. | NO |
|
extrasNom | Array<ExtensibleNom> | - | NO |
|
ViaticoManuAlojS | String | N|.. | NO |
|
viaticoManuAlojNS | String | N|.. | NO |
|
Class.Vacaciónes
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
extrasNom | Array<ExtensibleNom> | - | NO |
|
vacaciónesComunes | Array<VacaciónesComunes> | - | NO |
|
vacaciónesCompensadas | Array<VacaciónesCompensadas> | - | NO |
|
Class.VacaciónesComunes
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
cantidad | String | N|.. | SI |
- Número de días que el trabajador estuvo activo durante el mes sin disfrutar sus vacaciones. (Vacaciones NO disfrutadas).
|
extrasNom | Array<ExtensibleNom> | - | NO |
|
fechaInicio | String | AN|10 | NO |
|
fechaFin | String | AN|10 | NO |
|
pago | String | N|.. | SI |
determinado tiempo. (Vacaciones disfrutadas) Corresponde al valor pagado al trabajador, por el descanso remunerado que no disfrutó y que tiene derecho por haber trabajado un determinado tiempo. (Vacaciones NO disfrutadas).
|
Class.VacaciónesCompensadas
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
cantidad | String | N|.. | SI |
- Número de días que el trabajador estuvo activo durante el mes sin disfrutar sus vacaciones. (Vacaciones NO disfrutadas).
|
extrasNom | Array<ExtensibleNom> | - | NO |
|
fechaInicio | String | AN|10 | NO |
|
fechaFin | String | AN|10 | NO |
|
pago | String | N|.. | SI |
determinado tiempo. (Vacaciones disfrutadas) Corresponde al valor pagado al trabajador, por el descanso remunerado que no disfrutó y que tiene derecho por haber trabajado un determinado tiempo. (Vacaciones NO disfrutadas).
|
Class.DocumentosReferenciadosNom
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
cunePred | String | AN..20 | SI |
|
extrasNom | Array<ExtensibleNom> | - | NO |
|
fechaGenPred | String | AN|10 | SI |
|
numeroPred | String | AN..20 | SI |
|
Class.Nota
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
descripción | String | - | NO |
|
extrasNom | Array<ExtensibleNom> | - | NO |
|
Class.LugarGeneracionXML
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
departamentoEstado | String | N|2 | SI |
|
extrasNom | Array<ExtensibleNom> | - | NO |
|
idioma | String | N|2 | SI |
|
municipioCiudad | String | N|5 | SI |
|
pais | String | AN|2 | SI |
|
Class.Pago
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
extrasNom | Array<ExtensibleNom> | - | NO |
|
fechasPagos | Array<FechasPago> | - | SI |
|
fechapagonomina | String | AN|10 | SI |
|
metodoDePago | String | N|1 | SI |
|
medioPago | String | AN|3 | SI |
|
nombreBanco | String | AN|..50 | NC |
|
tipoCuenta | String | AN|..50 | NC |
|
numeroCuenta | String | AN|..50 | NC |
|
Class.FechasPagos
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
extrasNom | Array<ExtensibleNom> | - | NO |
|
fechapagonomina | String | AN|10 | SI |
|
Class.Periodo
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
extrasNom | Array<ExtensibleNom> | - | NO |
|
fechaIngreso | String | AN|10 | SI |
|
fechaLiquidacionInicio | String | AN|10 | SI |
|
fechaLiquidacionFin | String | AN|10 | SI |
|
fechaRetiro | String | AN|10 | NO |
|
tiempoLaborado | String | 5 caracteres enteros n decimales (días) | NO |
|
Class.Trabajador
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
altoRiesgoPension | String | N|1 | SI |
|
codigoTrabajador | String | N|2 | SI |
|
String | - | SI |
| |
extrasNom | Array<ExtensibleNom> | - | NO |
|
lugarTrabajoDepartamentoEstado | String | N|2 | SI |
|
lugarTrabajoDireccion | String | AN|...100 | SI |
|
lugarTrabajoMunicipioCiudad | String | N|5 | SI |
|
lugarTrabajoPais | String | AN|2 | SI |
|
numeroDocumento | String | AN|...60 | SI |
|
primerApellido | String | AN|...60 | SI |
|
primerNombre | String | AN|...60 | SI |
|
otrosNombres | String | AN|...60 | NO |
|
salarioIntegral | String | N|1 | SI |
|
segundoApellido | String | AN|...60 | SI |
|
subTipoTrabajador | String | N|2 | SI |
|
sueldo | String | N|.. | SI |
|
tipoContrato | String | N|1 | SI |
|
tipoIdentificacion | String | N|2 | SI |
|
tipoTrabajador | String | N|2 | SI |
|
Class.ExtrasNom
Atributo | Tipo Dato | Formato | Requerido | Descripción |
---|---|---|---|---|
controlInterno1 | String | AN|.. | C/C |
|
controlInterno2 | String | AN|.. | C/C |
|
nombre | String | AN|.. | SI |
|
valor | String | AN|.. | SI |
|
- RESPONSE
- Parámetros a Recibir
Tipo | Identificación | Descripción |
---|---|---|
int | código | Indica el Estado de la operación retornado por el servicio, (Por definir catálogo) |
String | mensaje | Este mensaje está asociado al código de respuesta, útil para identificación de errores |
String | resultado | Resultado del consumo del método:" Procesado” ó “Error”. |
String | consecutivoDocumento | Prefijo y Consecutivo del Documento concatenado sin separadores. Para el ejemplo anterior corresponde a: “PRUE980338337” |
String | cune | Código Único de Nómina Electrónica” correspondiente al documento consultado. |
String | trackId | Número de seguimiento, es un UUID, para consultar posteriormente el proceso asíncrono |
Array<String> | reglasNotificacionesTFHKA | Reglas de validación en caso de notificación TFHKA |
Array<String> | reglasNotificacionesDIAN | Reglas de validación en caso de notificación DIAN |
Array<String> | reglasRechazoTFHKA | Reglas de validación en caso de rechazo TFHKA |
Array<String> | reglasRechazoDIAN | Reglas de validación en caso de rechazo DIAN |
Método ConsultarDocumento
Permite consultar el estado de un documento Soporte de Pago de Nómina Electrónica y Nómina de Ajuste, ante la DIAN, el tipo de entrega y si la misma fue exitosa,además otros parámetros de interés que puedes ser útil en los procesos de control del software de Nómina (ERP) o para el modelo de negocio del empleador emisor.
- REQUEST
- Parámetros a Enviar
Tipo | Identificador | Descripción |
---|---|---|
String | tokenEmpresa | Suministrado por The Factory HKA Colombia |
tokenPassword | ||
consecutivoDocumentoNom | Prefijo y Consecutivo del Documento electrónico concatenado sin separadores. Ejemplo “PRUE980338212 |
- RESPONSE
- Parámetros a Recibir
Tipo | Identificador | Descripción |
---|---|---|
String | ambiente | Tipo de ambiente de generación del documento:
|
String | cadenaCodigoQR | Concatenación cadena del código QR (elemento de control) |
String | cadenaCune | Concatenación cadena del código CUNE previo al cálculo por el algoritmo correspondiente del servicio |
Int | código | Indica el estado de la operación retornado por el servicio |
String | cune | “Código Único de Nómina Electrónica” correspondiente al documento consultado, calculado por el algoritmo correspondiente del servicio. |
String | descripcionDocumento | Identificador del tipo de documento de referencia,
|
String | descripcionEstatusDocumento | Descripción correspondiente al estatusDocumento ante la DIAN: “La Nomina Individual, ha sido autorizada” |
String | estatusDocumento | Código obtenido en la respuesta correspondiente al estado del documento ante la DIAN ("200","109") |
String | esValidoDIAN |
|
String | fechaAceptacionDIAN | Día y Hora en la que la DIAN aceptó el documento electrónico, en formato AAAA-MM-DD HH:MM:SS |
String | fechaDocumento | Fecha en la que se generó el documento, en formato: AAAA-MM-DD |
String | mensaje | Este mensaje está asociado al código, útil para identificación de errores |
String | mensajeDocumento | Entrega una descripción del error de cada una de las validaciones iniciales. Si no hay errores no entrega descripción |
String | reglasValidacionDIAN | Mensajes de validación por parte de la DIAN |
String | resultado | Resultado del consumo del método:
|
String | trackID | Este elemento corresponde al TrackId del documento procesado |
String | tipoDocumento | Identificador del tipo de documento de referencia
|
Método ConsultarFolios
Permite consultar la cantidad de folios para procesar el Soporte de Pago de Nómina Electrónica y Nómina de Ajuste.
- REQUEST
- Parámetros a Enviar
Tipo | Identificador | Descripción |
---|---|---|
String | tokenEmpresa | Suministrado por The Factory HKA Colombia |
tokenPassword |
- RESPONSE
- Parámetros a Recibir
Tipo | Identificador | Descripción |
---|---|---|
Int | código | Indica el estado de la operación retornado por el servicio |
String | mensaje | Este mensaje está asociado al código, útil para identificación de errores |
String | resultado | Resultado del consumo del método:
|
Int | foliosRestantes | Cantidad de folios disponibles |
Método EnviarCorreo
Permite reenviar a una direccion de correo electrónico el Soporte de Pago de Nómina Electrónica y Nómina de Ajuste.
- REQUEST
- Parámetros a Enviar
Tipo | Identificador | Descripción |
---|---|---|
String | tokenEmpresa | Suministrado por The Factory HKA Colombia |
tokenPassword | ||
Direccion de correo electrónico del empleado | ||
consecutivoDocumentoNom | Prefijo y Consecutivo del Documento electrónico concatenado sin separadores. Ejemplo “PRUE980338212 |
- RESPONSE
- Parámetros a Recibir
Tipo | Identificador | Descripción |
---|---|---|
Int | código | Indica el estado de la operación retornado por el servicio |
String | mensaje | Este mensaje está asociado al código, útil para identificación de errores |
String | resultado | Resultado del consumo del método:
|
Método DescargarXML
Permite descargar documento Soporte de Pago de Nómina Electrónica, Nota de Ajuste de Documento Soporte de Pago de Nómina Electrónica en formato XML.
- REQUEST
- Parámetros a Enviar
Tipo | Identificador | Descripción |
---|---|---|
String | tokenEmpresa | Suministrado por The Factory HKA Colombia |
tokenPassword | ||
consecutivoDocumentoNom | Prefijo y Consecutivo del Documento electrónico concatenado sin separadores. Ejemplo “PRUE980338212 |
- RESPONSE
- Parámetros a Recibir
Tipo | Identificador | Descripción |
---|---|---|
Int | código | Indica el estado de la operación retornado por el servicio |
String | cune | “Código Único de Nómina Electrónica” correspondiente al documento consultado, calculado por el algoritmo correspondiente del servicio. |
String | documento | Documento XML codificado en Base64 |
String | hash | Código de detección de errores |
String | mensaje | Este mensaje está asociado al código, útil para identificación de errores |
String | nombre | Prefijo y consecutivo del Documento Electrónico concatenado sin separadores. Ejemplo “PRUE980338212” |
String | resultado | Resultado del consumo del método:
|
Método DescargarPDF
Permite descargar la representación gráfica de un documento Soporte de Pago de Nómina Electrónica y Nómina de Ajuste.
- REQUEST
- Parámetros a Enviar
Tipo | Identificador | Descripción |
---|---|---|
String | tokenEmpresa | Suministrado por The Factory HKA Colombia |
tokenPassword | ||
consecutivoDocumentoNom | Prefijo y Consecutivo del Documento electrónico concatenado sin separadores. Ejemplo “PRUE980338212 |
- RESPONSE
- Parámetros a Recibir
Tipo | Identificador | Descripción |
---|---|---|
Int | código | Indica el estado de la operación retornado por el servicio |
String | cune | “Código Único de Nómina Electrónica” correspondiente al documento consultado, calculado por el algoritmo correspondiente del servicio. |
String | documento | Documento PDF codificado en Base64 |
String | hash | Código de detección de errores |
String | mensaje | Este mensaje está asociado al código, útil para identificación de errores |
String | nombre | Prefijo y consecutivo del Documento Electrónico concatenado sin separadores. Ejemplo “PRUE980338212” |
String | resultado | Resultado del consumo del método:
|