Diferencia entre revisiones de «API LaFactura.co:NominaIndividual»

De API LaFactura.co
Ir a la navegación Ir a la búsqueda
(Página creada con «==Objeto:nominaIndividual== Es el objeto raiz, del sistema de envio de <b>nómina</b> de nuestra '''API''', es importante respetar todos los elementos aquí contemplados.<b…»)
 
 
(No se muestran 30 ediciones intermedias del mismo usuario)
Línea 1: Línea 1:
 
==Objeto:nominaIndividual==
 
==Objeto:nominaIndividual==
 
Es el objeto raiz, del sistema de envio de <b>nómina</b> de nuestra '''API''', es importante respetar todos los elementos aquí contemplados.<br/>
 
Es el objeto raiz, del sistema de envio de <b>nómina</b> de nuestra '''API''', es importante respetar todos los elementos aquí contemplados.<br/>
 
+
<br><br>
 +
    Ingreso:   
 +
    <nowiki>https://***.tas-la.com/nomina.v10/nomina/</nowiki>
 +
     
 +
    <b>Solicita tu usuario y contraseña +57-601-7466664</b>
 +
    No cobramos por el proceso de pruebas o desarrollo
 +
    Y puedes empezar inmediatamente (sin certificados o papeleos)
 +
<br>
 
=====Ejemplo=====
 
=====Ejemplo=====
  
Línea 29: Línea 36:
 
         "tipoContrato":"2",
 
         "tipoContrato":"2",
 
         "sueldo":"4000000.00",
 
         "sueldo":"4000000.00",
         "tiempoLaborado":"360.00"
+
         "tiempoLaborado":"360.00",
 +
        "correo":"[email protected]",
 +
        "fechaIngreso":"20200101"
 
       },
 
       },
 
       "lugarTrabajo":{
 
       "lugarTrabajo":{
Línea 43: Línea 52:
 
       "devengado":{
 
       "devengado":{
 
         "diasTrabajados":"30",
 
         "diasTrabajados":"30",
         "sueldoTrabajado":"4000000.00",
+
         "sueldoTrabajado":"4000000.00"
 
       },
 
       },
 
       "deducido":{
 
       "deducido":{
Línea 65: Línea 74:
 
=====Explicacion=====
 
=====Explicacion=====
 
----
 
----
 
Se está solicitando la creación de una factura por un total de $134.240 Pesos, para el cliente Pepito Perez y Compañía SA, con:<br><br>
 
Item 1:
 
* 5 Horas de soporte remoto con un costo unitario de $20.000, para un total de $100.000
 
* A estas 5 horas se les hizo un descuento del 4% ($4.000), para un total de $96.000
 
* Se le aplicó el IVA al valor de la línea ($18.240)<br>
 
 
Item 2:
 
* 1 Hora de servicio sin IVA por un valor de $20.000<br>
 
 
Totales:
 
* El total antes de impuestos es de $116.000<br>
 
* Los impuestos son: $ 18.240<br>
 
 
* El total en factura en: $ 134.240<br><br/>
 
 
Adicionalmente en el correo enviado al cliente va un boton de "PAGAR", que lleva a un link.
 
(Esta opción NO está disponible para todos los clientes)
 
  
 
=====Campos=====
 
=====Campos=====
Línea 88: Línea 79:
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
! Parámetro !! Descripción !! Tipo !! Obligatorio !! Notas !! API
+
! Parámetro !! Descripción !! Tipo !! Obligatorio !! Notas
 
|-
 
|-
| rangeKey || Identificador único, del rango de facturación/Documento-soporte a ser usado<br><small>Esta valor es el resultado del servicio: [[API_LaFactura.co:Rangos_Facturacion|Obtener Rangos]]</small>|| cadena || SI || || v2.0 / v3.0
+
| llaveRango || Identificador único, del rango de Nomina a ser utilizado<br><small>Esta valor es el resultado del servicio: [[API_LaFactura.co:traerRangos|traerRangos]]</small>|| cadena || SI ||
 
|-
 
|-
| intID || Identificador único, de este documento en tu base de datos<br><small>Esta valor se utiliza como control para evitar repetir documentos en el sistema</small>|| cadena || SI|| ||  v2.0 / v3.0
+
| intID || Código del documento generado en tu base de datos (Debe ser único para cada documento)<br/><small>Esta valor se utiliza como control para evitar repetir documentos en el sistema</small> || cadena || SI ||
 
|-
 
|-
| issueDate || Fecha del documento<br><small>(YYYYMMDD) Ejemplo: 20200321<br/>No puede ser -/+ 5 Dias de la fecha actual</small> || cadena || SI || ||  v2.0 / v3.0
+
| fechaInicio || Fecha de liquidación inicial<br/><small>(YYYYMMDD) Ejemplo: 20200321</small>|| cadena || SI ||
 
|-
 
|-
| issueTime || Hora del documento<br><small>(HHMMSS) Ejemplo: 175430</small> || cadena || SI || || v2.0 / v3.0
+
| fechaFin || Fecha de liquidacion final<br/><small>(YYYYMMDD) Ejemplo: 20200321</small>|| cadena || SI ||
 
|-
 
|-
| dueDate || Fecha de vencimiento<br><small>(YYYYMMDD) Ejemplo: 20200421<br/>Nunca deberá ser menor a la fecha de la factura</small> || cadena || SI || || v2.0 / v3.0
+
| fechaGen || Fecha de generacion del documento<br/><small>(YYYYMMDD) Ejemplo: 20200321</small> || cadena || SI ||
 
|-
 
|-
| paymentType || Tipo de pago<br><small>Efectivo->1 / Credito->2<br/>Por omisión el sistema supone Credito -> "2"</small> || cadena || NO || || v2.0 / v3.0
+
| horaGen || Hora de generacion del documento<br><small>(HHMMSS) Ejemplo: 175430</small>|| cadena || SI ||
 
|-
 
|-
| paymentCode || Medio de pago<br/><small>Por omisión supone Instrumento No Definido -> "1"<br/>[[API_LaFactura.co:Tabla_Tipos_Medios_Pago|consultar tabla]]</small> || cadena || NO || || v2.0 / v3.0
+
| periodoNomina || Codigo del período de nómina según tabla DIAN<br/><small>[[API_LaFactura.co:Tabla_Tipos_Perido_Nomina|consultar tabla]]</small> || cadena || SI ||
 
|-
 
|-
| note1 || Valor del documento en letras<br/><small>Esto se hace para ayudar a tener una representación gráfica de alta calidad para el cliente final</small> || cadena || SI || || v2.0 / v3.0
+
| notas1 || Nota para ser agregada al documento<br/><small>Aparece en el PDF</small> || cadena || NO ||
 
|-
 
|-
| note2 || Nota para ser agregada en el documento<br/><small>Aparece en el PDF</small>|| cadena || NO || || v2.0 / v3.0
+
| notas2 || Nota para ser agregada al documento<br/><small>Aparece en el PDF</small> || cadena || NO ||
 
|-
 
|-
| note3 || Nota para ser agregada en el documento<br/><small>Aparece en el PDF</small> || cadena || NO || || v2.0 / v3.0
+
| notas3 || Nota para ser agregada al documento<br/><small>Aparece en el PDF</small> || cadena || NO ||
 
|-
 
|-
| note4 || Nota para ser agregada en el documento<br/><small>Aparece en el PDF</small> || cadena || NO || || v2.0 / v3.0
+
| notas4 || Nota para ser agregada al documento<br/><small>Aparece en el PDF</small>|| cadena || NO ||
 
|-
 
|-
| order || Datos correspondientes a la orden de compra del cliente<br/><small>(Solo en facturas)<br/>Ir a: [[API_laFactura.co:order|order]]</small> || objeto || NO || || v3.0
+
| notas5 || Nota para ser agregada al documento<br/><small>Aparece en el PDF</small>|| cadena || NO ||
 
|-
 
|-
| period || Periodo de facturación<br/><small>(Solo en facturas)<br/>Grupo adicional para informar un Periodo de facturación<br><b>Importante: debe ir incluido si se usa el objeto "minsalud" -> API v3.0</b><br>Ir a: [[API_laFactura.co:period|period]]</small> || objeto || NO || || v2.0 / v3.0
+
| trabajador || Datos básicos del trabajador<br/><small>Ir a: [[API_laFactura.co:trabajador|trabajador]]</small> || objeto || SI ||
 
|-
 
|-
| prepaid || Pagos anticipados<br/><small>Grupo adicional para informar un Pago Anticipado<br>Ir a: [[API_laFactura.co:prePaid|prepaid]]</small> || objeto || NO || || v2.0 / v3.0
+
| lugarTrabajo || Datos de la localización del sitio de trabajo<br/><small>Ir a: [[API_laFactura.co:lugarTrabajo|lugarTrabajo]]</small> || objeto || SI ||
 
|-
 
|-
| exchangeRate || Tasas de cambio<small><br>Solo se requiere cuando se trata de un documento generado a un extranjero (Empresa o Persona)<br/>Si se envía y el cliente es Colombiano, es rechazado<br>Ir a: [[API_laFactura.co:exchangeRate|exchangeRate]]</small> || objeto || NO || || v2.0 / v3.0
+
| pago || Medios y métodos de pago de la nómina<br/><small>Ir a: [[API_laFactura.co:pago|pago]]</small>|| objeto || SI ||
 
|-
 
|-
| customer || Datos del cliente (Para generar facturas)<br><small>* Se envia únicamente cuando se trata de factura<br/>* NO se envia cuando se trata de documento soporte.</br>Ir a: [[API_laFactura.co:customer|customer]]</small> || objeto || <small>SI -> para v2.0<br/> SI/NO -> para v3.0</small>|| || v2.0 / v3.0
+
| devengado || Todos los valores a favor del empleado<br/><small>Ir a: [[API_laFactura.co:devengado|devengado]]</small> || objeto || SI ||
 
|-
 
|-
| supplier || Datos del proveedor (Para generar documento soporte)<br><small>* Se envia únicamente cuando se trata de documento soporte<br/>* NO se envia cuando se trata de factura.</br>Ir a: [[API_laFactura.co:supplier|supplier]]</small> || objeto || <small>SI/NO -> para v3.0</small> || || v3.0
+
| deducido || Todos los valores en contra del empleado<br/><small>Ir a: [[API_laFactura.co:deducido|deducido]]</small>|| objeto || SI ||
 
|-
 
|-
| whTaxes || Retenciones efectuadas al documento (para NO autoretenedores)<br><small>Ir a: [[API_laFactura.co:whTaxes|whTaxes]]</small> || objeto || NO || || v3.0
+
| totales || Valores totales del documento<br/><small>Ir a: [[API_laFactura.co:totales|totales]] || objeto || SI ||
|-
+
 
| amounts || Totales del documento<br><small>Ir a: [[API_laFactura.co:amounts|amounts]]</small> || objeto || SI || || v2.0 / v3.0
 
|-
 
| items || Líneas del documento<br><small>(Debe existir almenos una)<br>Ir a: [[API_LaFactura.co:items|items]]</small> || objeto || SI || || v2.0 / v3.0
 
|-
 
| minsalud || Manejo de informacion para el sector salud<br/><small>(Solo en facturas)<br/>Conjunto de informacion requerida para emisión de facturas del sector salud<br/><small>Ir a: [[API_laFactura.co:minsalud|minsalud]]</small> || objeto || NO || || v3.0
 
|-
 
| additional || Objeto con elementos complementarios<small><br>Relaciona elementos específicos para algunos clientes especiales<br/><b>Objetos:</b><br/>usuarios.ms (Sector Salud) -> <b>Solo API v2.0 (ahora obsoleto)</b><br/>[[API_LaFactura.co:documento.gn|documento.gn]] <b>(Requerido para usuarios que manejan su consecutivo de facturación)</b> -> <b>Solo API v3.0</b></small>|| objeto || SI || || v2.0 / v3.0
 
 
|}
 
|}
 
<span style="color:#009999"><b>Notas para migrantes de API v2.0 a v3.0:</b></span>
 
----
 
* Se agregó el objeto order para enviar datos referente a un numero de orden emitida por el cliente<br/>
 
* Se agregó un nuevo objeto para el sector salud "minsalud"<br/>
 
* Se eliminó el objeto usuarios.ms (El cual pasó a ser parte del objeto "minsalud")<br/>
 
* Se agregó el objeto documento.gn, para aquellos usuarios que administran su propio consecutivo.<br/>
 
<br/><b>Importante:</b><br/>
 
* Este objeto sirve ahora para generar Facturas y Documentos de soporte
 
* Para diferenciar fácilmente el uno del otro, las Facturas llevan el objeto "customer" y los documentos equivalentes el objeto "supplier"
 
* Si colocas el objeto "supplier", no se aceptan: "order", "period", "exchangeRate", "minsalud"
 
<br/>
 
  
 
=====Resultados=====
 
=====Resultados=====
 
----
 
----
Devuelve un objeto '''[[API_laFactura.co:invoiceResult|invoiceResult]]''' con el resultado de la operación<br/>
+
Devuelve un objeto '''[[API_laFactura.co:resultadoNomina|resultadoNomina]]''' con el resultado de la operación<br/>
<i>Importante: Verifica toda la informacion que invoiceResult devuelve ingresando al objeto.</i>
+
<i>Importante: Verifica toda la informacion que resultadoNomina devuelve ingresando al objeto.</i>
  
 
   {
 
   {
     "invoiceResult":{
+
     "resultadoNomina":{
 
         "status":{
 
         "status":{
 
           "code":200,
 
           "code":200,
 
           "text":"Operación realizada con exito"
 
           "text":"Operación realizada con exito"
        },
+
        },
        "documento":{
+
        "documento":{
           "type":"Factura",
+
           "type":"nominaIndividual",
 
           "mode":"Creation",
 
           "mode":"Creation",
           "tascode":"fc-54984309jtr0ret90jjrg",
+
           "tascode":"ni-969527772dbe01117b63a3ef6aec715a-v300",
           "intID":"1",
+
           "intID":"2122",
           "document":"FC-2092092",
+
           "document":"NOM156",
           "CUFE":"43059843095203948093248093483048039248093403298409328490348903483094",
+
           "CUNE":"b84b1889239498d4b1f34a63bec5290589a3aa880a9eaa5ab36a6837ae66bf649325130500dec0cbacc0b4c513f00df6",
 
           "process":"0",
 
           "process":"0",
           "retries":"0"
+
           "retries":"0",
        }
+
          "customer":"0"
    }
+
        }
  }
+
    }
 +
  }
  
 
=====A tener presente=====
 
=====A tener presente=====
Línea 177: Línea 150:
  
 
==Objetos empleados==
 
==Objetos empleados==
*[[API_laFactura.co:exchangeRate|exchangeRate]] (Tasas - Para ventas en Dólares)
 
*[[API_laFactura.co:customer|customer]] (Cliente)
 
*[[API_laFactura.co:amounts|amounts]] (Montos)
 
*[[API_laFactura.co:items|items]] (Lineas de la factura)
 
  
 
==Usado por==
 
==Usado por==
 
Los siguientes recursos:
 
Los siguientes recursos:
* [[API_LaFactura.co:Generar_Factura|Generar Factura]]
 
  
 
==Temas complementarios==
 
==Temas complementarios==
* [[API_LaFactura.co:Facturacion|Facturación]]
+
* [[API_LaFactura.co:Nomina|Nomina]]
  
 
==Enlaces==
 
==Enlaces==

Revisión actual del 17:21 23 sep 2021

Objeto:nominaIndividual

Es el objeto raiz, del sistema de envio de nómina de nuestra API, es importante respetar todos los elementos aquí contemplados.


    Ingreso:     
    https://***.tas-la.com/nomina.v10/nomina/
     
    Solicita tu usuario y contraseña +57-601-7466664
    No cobramos por el proceso de pruebas o desarrollo
    Y puedes empezar inmediatamente (sin certificados o papeleos)


Ejemplo
 {
   "nominaIndividual":
   {
     "llaveRango":"rk-7b8842f7d525e2a3dc7eb2bae5641665-v200",
     "intID":"2122",
     "fechaInicio":"20210301",
     "fechaFin":"20210331",
     "fechaGen":"20210331",
     "horaGen":"100000",
     "periodoNomina":"5",
     "notas1":"Esta es una prueba",
     "trabajador":{
       "codigo":"TR79506693",
       "tipo":"01",
       "subTipo":"00",
       "altoRiesgoPension":"falso",
       "tipoDocumento":"13",
       "numeroDocumento":"79506693",
       "primerApellido":"Perez",
       "segundoApellido":"Perez",
       "primerNombre":"Pepito",
       "otrosNombres":"Alberto",
       "salarioIntegral":"falso",
       "tipoContrato":"2",
       "sueldo":"4000000.00",
       "tiempoLaborado":"360.00",
       "correo":"[email protected]",
       "fechaIngreso":"20200101"
     },
     "lugarTrabajo":{
       "pais":"CO",
       "departamento":"11",
       "municipio":"11001",
       "direccion":"xxxx"
     },
     "pago":{
       "fecha":"20210330",
       "metodo":"1"
     },
     "devengado":{
       "diasTrabajados":"30",
       "sueldoTrabajado":"4000000.00"
     },
     "deducido":{
       "salud":{
         "porcentaje":"4.00",
         "deduccion":"160000.00"
       },
       "pension":{
         "porcentaje":"4.00",
         "deduccion":"160000.00"
       }
     },
     "totales":{
        "devengados":"4000000.00",
        "deducidos":"320000.00",
        "comprobante":"3680000.00"
     }
   }
}
Explicacion

Campos

Parámetro Descripción Tipo Obligatorio Notas
llaveRango Identificador único, del rango de Nomina a ser utilizado
Esta valor es el resultado del servicio: traerRangos
cadena SI
intID Código del documento generado en tu base de datos (Debe ser único para cada documento)
Esta valor se utiliza como control para evitar repetir documentos en el sistema
cadena SI
fechaInicio Fecha de liquidación inicial
(YYYYMMDD) Ejemplo: 20200321
cadena SI
fechaFin Fecha de liquidacion final
(YYYYMMDD) Ejemplo: 20200321
cadena SI
fechaGen Fecha de generacion del documento
(YYYYMMDD) Ejemplo: 20200321
cadena SI
horaGen Hora de generacion del documento
(HHMMSS) Ejemplo: 175430
cadena SI
periodoNomina Codigo del período de nómina según tabla DIAN
consultar tabla
cadena SI
notas1 Nota para ser agregada al documento
Aparece en el PDF
cadena NO
notas2 Nota para ser agregada al documento
Aparece en el PDF
cadena NO
notas3 Nota para ser agregada al documento
Aparece en el PDF
cadena NO
notas4 Nota para ser agregada al documento
Aparece en el PDF
cadena NO
notas5 Nota para ser agregada al documento
Aparece en el PDF
cadena NO
trabajador Datos básicos del trabajador
Ir a: trabajador
objeto SI
lugarTrabajo Datos de la localización del sitio de trabajo
Ir a: lugarTrabajo
objeto SI
pago Medios y métodos de pago de la nómina
Ir a: pago
objeto SI
devengado Todos los valores a favor del empleado
Ir a: devengado
objeto SI
deducido Todos los valores en contra del empleado
Ir a: deducido
objeto SI
totales Valores totales del documento
Ir a: totales
objeto SI
Resultados

Devuelve un objeto resultadoNomina con el resultado de la operación
Importante: Verifica toda la informacion que resultadoNomina devuelve ingresando al objeto.

 {
   "resultadoNomina":{
       "status":{
          "code":200,
          "text":"Operación realizada con exito"
        },
        "documento":{
          "type":"nominaIndividual",
          "mode":"Creation",
          "tascode":"ni-969527772dbe01117b63a3ef6aec715a-v300",
          "intID":"2122",
          "document":"NOM156",
          "CUNE":"b84b1889239498d4b1f34a63bec5290589a3aa880a9eaa5ab36a6837ae66bf649325130500dec0cbacc0b4c513f00df6",
          "process":"0",
          "retries":"0",
          "customer":"0"
        }
    }
  }
A tener presente

  • El resultado incluye el campo "tascode", que es el codigo único interno en nuestro sistema e identifica el documento. Es requerido para cualquier acción posterior sobre este documento. (Es importante conservarlo)
  • No se debe considerar un documento como válido por la DIAN, hasta que el resultado de una verificación del documento, muestre a process con: 2

Objetos empleados

Usado por

Los siguientes recursos:

Temas complementarios

Enlaces

Importante

Recuerda que nosotros no te cobramos absolutamente nada por que pruebes nuestra plataforma.
Si deseas tener un usuario y contraseña , comunícate con nosotros.