Guía Técnica Para Consumo API Consulta Nomina Individual

Por /

Clarisa ofrece una API que le permite a su sistema integrarse y consultar si la Nomina Individual se envió correctamente a la DIAN

La acción disponible de la API para consulta de la Nomina Individual traerá el UUID en base al nit y número de nomina consultado.

 Documento electrónico

CABECERAS:

CABECERAVALOR
Content-Typeapplication/json
Authorizationtoken de usuario

METODO: "GET"

Parametros de URL (QueryParam):

LLAVEVALORDESCRIPCIÓN
nit12345Corresponde al Nit de la empresa donde se realizó el documento
numeroNominaNI101Corresponde a el Número del documento electrónico, que se desea consultar.

Ejemplo:

https://pru.clarisacloud.com:8443/nomina/rest/api/v1/nominaIndividual/validar?nit=12345&numeroNomina=NI1



Respuesta:


Nombre Tipo dato Descripción
data Alfanumérico Contiene el UUID y resultado del documento consultado
lastAction Alfanumérico Nombre de la acción bajo la cual se respondió esta respuesta
success Booleano Determina si la operación fué exitosa o no
textResponse Alfanumérico Texto de la respuesta
titleResponse Alfanumérico Título de la respuesta

Respuesta TOKEN

Tiene una vigencia de 12 horas, por favor
recuerde utilizar el token asignado en el login, para poder acceder a la API de documento electrónico.

Correcto

En caso de que la petición se ejecute sin errores se devolverá la siguiente respuesta:

CÓDIGO HTTP: 200

{
  • "data": {
    • "result": true,
    • "uuid": "1db2b55d00e75380aa1f8d710ddb860f98e332024d8b8206487bc25eb606d4f6b782037211c35"
    ...}// 2 items    ,
  • "lastAction": "Acción validar nómina individual",
  • "success": true,
  • "textResponse": "Consultar envío nómina individual",
  • "titleResponse": "SUCCESS"
...}// 5 items

Incorrecto

Si la solicitud no es correcta, recibirá la siguiente respuesta:

CÓDIGO HTTP: 400

{
  • "errores": {
    • "errores": [
      • {
        • "codError": "",
        • "errorMessage": "No se encontraron datos suficientes para validar el estado de la nómina individual NI1"
        ...}// 2 items
      ...]// 1 item      ,
    • "total_errores": 1
    ...}// 2 items    ,
  • "lastAction": "Consultar envío nómina individual",
  • "success": false,
  • "textResponse": "Error al consultar estado de la nómina individual",
  • "titleResponse": "FAILED"
...}// 5 items