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

De API LaFactura.co
Ir a la navegación Ir a la búsqueda
Línea 70: Línea 70:
 
{| 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
 
−
|-
 
−
| 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
 
−
|-
 
−
| 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
 
−
|-
 
−
| issueTime || Hora del documento<br><small>(HHMMSS) Ejemplo: 175430</small> || cadena || SI || || v2.0 / v3.0
 
−
|-
 
−
| 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
 
−
|-
 
−
| 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
 
−
|-
 
−
| 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
 
−
|-
 
−
| 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
 
−
|-
 
−
| note2 || Nota para ser agregada en el documento<br/><small>Aparece en el PDF</small>|| cadena || NO || || v2.0 / v3.0
 
−
|-
 
−
| note3 || Nota para ser agregada en el documento<br/><small>Aparece en el PDF</small> || cadena || NO || || v2.0 / v3.0
 
−
|-
 
−
| note4 || Nota para ser agregada en el documento<br/><small>Aparece en el PDF</small> || cadena || NO || || v2.0 / v3.0
 
−
|-
 
−
| 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
 
−
|-
 
−
| 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
 
−
|-
 
−
| 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
 
−
|-
 
−
| 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
 
−
|-
 
−
| 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
 
−
|-
 
−
| 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
 
−
|-
 
−
| whTaxes || Retenciones efectuadas al documento (para NO autoretenedores)<br><small>Ir a: [[API_laFactura.co:whTaxes|whTaxes]]</small> || objeto || NO || || v3.0
 
−
|-
 
−
| 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=====

Revisión del 12:41 11 jun 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.

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"
     },
     "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
Resultados

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

 {
   "invoiceResult":{
       "status":{
          "code":200,
          "text":"Operación realizada con exito"
       },
       "documento":{
          "type":"Factura",
          "mode":"Creation",
          "tascode":"fc-54984309jtr0ret90jjrg",
          "intID":"1",
          "document":"FC-2092092",
          "CUFE":"43059843095203948093248093483048039248093403298409328490348903483094",
          "process":"0",
          "retries":"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.

Obtenido de «https://wiki.lafactura.co/index.php?title=API_LaFactura.co:NominaIndividual&oldid=1585»