Guía Técnica Para Consumo API Descarga XML Nómina de Ajuste

Clarisa ofrece una API que le permite a su sistema integrarse y descargar el XML de la Nómina de Ajuste que ya se haya creado.

La acción disponible para la API de Descarga XML , solo podrá traer Documentos de Nómina de Ajuste que correspondan a su NIT .

 Documento electrónico

CABECERAS:

CABECERAVALOR
Content-Typeapplication/json
Authorizationtoken de usuario

URL para obtener documento en Base 64


METODO: "GET"

Parametros de URL:

LLAVEVALORDESCRIPCIÓN
nit123123124Corresponde al Nit de la empresa donde se realizó la Nómina de Ajuste.
numeroNominaAjusteNOMA1Corresponde al número de Nómina de Ajuste, que desea descargar en formato XML

Ejemplo:

https://central.clarisacloud.com:8443/reporte/rest/api/v1/xml/nominaAjuste?nit=123123124&numeroNominaAjuste=NOMA1




Respuesta:


Nombre Tipo dato Descripción
data Alfanumérico Contiene el archivo XML en base64
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


Incorrecto

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

CÓDIGO HTTP: 400 | 401 | 500