Guía Técnica Para Consumo API Consulta Documento Soporte

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

La acción disponible de la API para consulta del Documento Soporte traerá la información en base al nit y número documento comercial 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. Obligatorio
numeroDtoComercialDS1Corresponde al Número del documento electrónico , que se desea consultar. Obligatorio

Ejemplo:

https://pru.clarisacloud.com:8443/compras/rest/api/v1/docSoporte/validacion?nit=12345&numeroDtoComercial=DS1



Respuesta:


Nombre Tipo dato Descripción
data Contiene el resultado del documento consultado segun estadoEmision
data.cuds Alfanumérico Corresponde al código único de Documento soporte consultado
data.estadoEmision Alfanumérico Corresponde al estado del documento en Clarisa
data.fechaValidación Alfanumérico Corresponde a la fecha en que se valido el documento
data.numero Alfanumérico Corresponde al número de documento consultado
data.result Booleano Determina si el documento esta validado o no
data.errorMessage Alfanumérico Contiene la respuesta de error obtenida en la consulta del documento
lastAction Alfanumérico Nombre de la acción bajo la cual se realizo la consulta
success Booleano Determina si la consulta fue exitosa o no
textResponse Alfanumérico Texto de la consulta realizada
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

Scroll to Top