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

API, Descargas Soportes, Facturacion
Clarisa ofrece una API que le permite a su sistema integrarse y consultar si el documento electrónico se encuentra en el portal de la DIAN La acción disponible de la API para consulta de la (Factura / Nota debito / Nota crédito) traerá el UUID en base al tipo y número documento comercial consultado  Documento electrónico CABECERAS: CABECERAVALORContent-Typeapplication/jsonAuthorizationtoken de usuario URL Pruebas URL Producción https://central.clarisacloud.com:8443/facturas/rest/api/v1/resultado/validacion https://csi.clarisa.co:8443/facturas/rest/api/v1/resultado/validacion METODO: "GET" Parametros de URL (QueryParam): LLAVEVALORDESCRIPCIÓNnit80254788Corresponde al Nit de la empresa donde se realizó el documentotipoDocumento01Corresponde al Tipo de documento electrónico que se desea consultar.numeroDocumentoSETP991001332Corresponde a el Número del documento electrónico, que se desea consultar. https://central.clarisacloud.com:8443/facturas/rest/api/v1/resultado/validacion?nit=80254788&tipoDocumento=01&numeroDocumento=SETP991001332 Petición: Variables para tipo de documento a consultar Tipo de Documento Codigo Factura Electrónica 01 Nota Crédito 02 Nota Debito 03 Respuesta: Variables de respuesta API en consulta documento Nombre Tipo…
Leer más

Guía para consumir API de Login

Comun
La comunicación entre la aplicación del cliente y la API de clarisa es segura, antes de poder mandar peticiones a la API es necesario loguearse con (usuario ) y una contraseña. Clarisa ofrece una API que le permite a su sistema autenticarse . Autenticación CABECERAS: CABECERASVALOR Content-Type  application/json URL Pruebas URL Producción https://central.clarisacloud.com:8443/seguridad/rest/api/v1/login/ https://csi.clarisa.co:8443/seguridad/rest/api/v1/login/ METODO: "POST" CUERPO: Variables usadas para login Nombre del campo Formato Tamaño Descripción usuario Alfanúmerico 5 hasta 255 caracteres Corresponde al usuario proporcionado por clarisa. contrasenia Alfanumérico 5 hasta 255 caracteres Clave que se debe ingresar para iniciar sesión Respuesta: Variables usadas para respuesta al login Nombre Tipo dato Descripción success Booleano Determina si la operación fué exitosa o no titleResponse Alfanumérico Título de la respuesta textResponse Alfanumérico Texto de la respuesta lastAction Alfanumérico Nombre de…
Leer más

Guía Técnica Para Consumo API Salud Nueva Versión

API, Factura Nacional, Facturacion
Clarisa ofrece una API que le permite a su sistema integrarse y realizar facturas electrónicas para el sector Salud. Importante ! Para el envío masivo de facturas, es decir mas de una factura, se debe enviar cada petición con intervalo de 5 segundos como mínimo. Crear Factura electrónica de salud CABECERAS: CABECERAVALORContent-Type application/jsonAuthorizationtoken de usuario URL Pruebas URL Producción https://central.clarisacloud.com:8443/facturas/rest/api/v2/facturaMedica https://csi.clarisa.co:8443/facturas/rest/api/v2/facturaMedica METODO : "POST" Ejemplo factura Salud con Tipo de Operación SS-CUFE, que activa el método de calculo del sector salud . Información adicional para enviar a nivel de ítem CUERPO: Variables para crear Factura Electrónica de Salud Nombre Formato Tamaño Descripción nit Alfanumérico 100 Hace referencia del NIT de la empresa. numeroResolucion numérico 100 Número de resolución aprobada en la DIAN numeroDocumentoComercial numérico 100 Numero del documento electrónico fechaGeneracion String 100 Fecha…
Leer más

Guía Técnica Para Consumo API Descarga XML Documento Soporte

API, Documento soporte
Clarisa ofrece una API que le permite a su sistema integrarse y descargar el XML de un Documento Soporte que ya se haya creado y reportado. La acción disponible para la API de Descarga XML del Documento Soporte, solo podrá traer Documentos que correspondan a su NIT y que ya estén creados. Documento electrónico CABECERAS: CABECERASVALORContent-Typeapplication/jsonAuthorizationtoken de usuario URL Pruebas URL Producción https://central.clarisacloud.com:8443/reporte/rest/api/v1/xml/docSoporte https://csi.clarisa.co:8443/reporte/rest/api/v1/xml/docSoporte METODO: "GET" Parámetros de URL: LLAVEVALORDESCRIPCIÓNnit123123124Corresponde al Nit de la empresa donde se realizó el Documento Soporte.numeroDocumentoDS10Corresponde a el número de Documento Soporte, que desea descargar en formato XML Ejemplo: https://central.clarisacloud.com:8443/reporte/rest/api/v1/xml/docSoporte?nit=123123124&numeroDocumento=DS10 Respuesta: Variables en la respuesta de API Descarga XML Documento Soporte Nombre Tipo dato Descripción data Alfanumérico Contiene el archivo XML lastAction Alfanumérico Nombre de la acción bajo la cual se indica la respuesta success Booleano Determina si la operación fué…
Leer más

Guía Técnica Para Consumo API Descarga PDF Documento Soporte

API, Descargas Soportes, Facturacion
Clarisa ofrece una API que le permite a su sistema integrarse y descargar el PDF de un Documento Soporte que ya se haya creado. La acción disponible para la API de Descarga PDF del Documento Soporte, solo podrá traer Documentos que correspondan a su NIT y que ya estén creados. Documento electrónico CABECERAS: CABECERASVALORContent-Typeapplication/jsonAuthorizationtoken de usuario URL Pruebas URL Producción https://central.clarisacloud.com:8443/reporte/rest/api/v1/pdf/docSoporte https://csi.clarisa.co:8443/reporte/rest/api/v1/pdf/docSoporte METODO: "GET" Parámetros de URL: LLAVEVALORDESCRIPCIÓNnit123123124Corresponde al Nit de la empresa donde se realizó el Documento Soporte.numeroDocSoporteDS10Corresponde a el número de Documento Soporte, que desea descargar en formato PDF Ejemplo: https://central.clarisacloud.com:8443/reporte/rest/api/v1/pdf/docSoporte?nit=123123124&numeroDocSoporte=DS10 Respuesta: Variables en la respuesta de API Descarga PDF Documento Soporte Nombre Tipo dato Descripción data Alfanumérico Contiene el archivo PDF en base64 lastAction Alfanumérico Nombre de la acción bajo la cual se indica la respuesta success Booleano Determina si la operación fué…
Leer más

Guía Técnica Para Consumo API Eventos Factura Electrónica

API, Evento RADIAN, Facturacion
Clarisa ofrece una API que le permite a su sistema integrarse y reportar eventos asociados a su factura electrónica de compra. Tipos de eventos Acuse de recibo de la Factura Electrónica de compra Recibo del bien o prestación del servicio Aceptación expresa / Reclamo de la Factura Electrónica de venta CABECERAS: CABECERAVALORContent-Type application/jsonAuthorizationtoken de usuario Generar Evento Acuse de Recibo de la Factura Electrónica de Venta URL Pruebas URL Producción https://central.clarisacloud.com:8443/compras/rest/api/v1/generar/evento https://csi.clarisa.co:8443/compras/rest/api/v1/generar/evento METODO : "POST" Recibo del bien o prestación del servicio METODO : "POST" Petición: Variables para crear eventos a Factura Electrónica Nombre Formato Tamaño Descripción nit Alfanumérico 100 NIT de la empresa sin dígito de verificación tipoEvento String 100 Especifica el tipo de evento que se va a emitir, ver tabla Eventos. conceptoRechazo String 100 Se indica motivo de…
Leer más

Guía Técnica Para Consumo API Documento Soporte / Nota de Ajuste

API, Documento soporte
Clarisa ofrece una API que le permite a su sistema integrarse para generar Documentos Soporte y Notas de Ajuste. Las acciones disponibles para la API son: Crear Documento Soporte Crear Nota de Ajuste Tener en cuenta que para el campo cliente/proveedor con Procedencia tipo RESIDENTE, únicamente se permite el tipo de identificación NIT cuyo código es NI. Crear Documento Soporte CABECERAS: CABECERASVALORContent-Type application/jsonAuthorizationtoken de usuario URL Pruebas URL Producción https://central.clarisacloud.com:8443/compras/rest/api/v1/docsoporte https://csi.clarisa.co:8443/compras/rest/api/v1/docsoporte METODO : "POST" Información adicional para enviar a nivel de ítem NOTA: Si la forma de generación y transmisión es POR_OPERACION el campo fechaCompra debe ser la fecha actual es decir misma fecha de generación del documento. Si es por ACUMULADO_SEMANAL el campo fechaCompra solo puede ser dentro de los 6 días anteriores a la fecha actual. Petición: Variables para crear Documento Soporte Nombre…
Leer más

Guía Técnica Para Consumo API Consulta estado de la factura

API, Descargas Soportes, Facturacion
Clarisa ofrece una API que le permite a su sistema integrarse y saber el estado de la factura que ha sido enviada. La acción disponible de la API para la consulta del estado de la factura, traerá el estado y el CUFE en base al NIT y al numero del documento consultado Documento electrónico CABECERAVALORContent-Typeapplication/jsonAuthorizationtoken de usuario URL Pruebas URL Producción https://central.clarisacloud.com:8443/facturas/rest/api/v1/obtenerEstadoFactura https://csi.clarisa.co:8443/facturas/rest/api/v1/obtenerEstadoFactura METODO: "GET" Parametros de URL (QueryParam): LLAVEVALORDESCRIPCIÓNnit123123124Corresponde al Nit de la empresa donde se realizó la Nota débito.numeroDocumentoComercialFE12Corresponde a el número de la factura electrónica, que desea consultar el estado Ejemplo: https://central.clarisacloud.com:8443/facturas/rest/api/v1/obtenerEstadoFactura?nit=123123124&numeroDocumentoComercial=FE12 Respuesta: Variables en la respuesta de API consulta estado de documento Nombre Tipo dato Descripción data Alfanumérico Contiene el cufe, consecutivo, estado de la factura consultada y respuesta de la DIAN lastAction Alfanumérico Nombre de la acción bajo la…
Leer más

Guía Técnica Para Consumo API Nómina individual

API, Nomina
Clarisa ofrece una API que le permite a su sistema integrarse y reportar nóminas individuales electrónicas. Crear Nómina individual electrónica CABECERAS: CABECERAVALORContent-Type application/jsonAuthorizationtoken de usuario URL Pruebas URL Producción https://central.clarisacloud.com:8443/nomina/rest/api/v1/nominaIndividual https://csi.clarisa.co:8443/nomina/rest/api/v1/nominaIndividual METODO : "POST" Nota: Antes de crear una nómina individual, debe registrar una numeración de Nómina Individual en el sistema. CUERPO: Variables para crear una nómina individual electrónica Nombre Formato Tamaño Descripción Obligatorio fechaLiquidacionInicio String 10 Fecha inicial de liquidación de la nómina (Formato: yyyy-MM-dd) Si fechaLiquidacionFin String 10 Fecha final de liquidación de la nómina (Formato: yyyy-MM-dd) Si notas String 500 Utilizado para agregar notas al documento No prefijo String 255 Prefijo de la numeración a utilizar Si consecutivo String 20 Número de consecutivo de la numeración Si fechasPago String 10 Fechas en las que realizó el pago de la nómina…
Leer más

Guía Técnica Para Consumo API Descarga XML Nota Débito

API, Descargas Soportes, Facturacion, Notas débito
Clarisa ofrece una API que le permite a su sistema integrarse y descargar el XML de la Nota débito que ya se haya creado. La acción disponible para la API de Descarga XML , solo podrá traer Documentos de Notas débito que correspondan a su NIT y que ya estén creadas.  Documento electrónico CABECERAS: CABECERAVALORContent-Typeapplication/jsonAuthorizationtoken de usuario URL para obtener documento en Base 64 URL Pruebas URL Producción https://central.clarisacloud.com:8443/reporte/rest/api/v1/xml/notaDebito https://csi.clarisa.co:8443/reporte/rest/api/v1/xml/notaDebito URL para obtener documento en XML URL Pruebas URL Producción https://central.clarisacloud.com:8443/facturas/rest/notasDebito/reporteXml/ https://csi.clarisa.co:8443/facturas/rest/notasDebito/reporteXml/ METODO: "GET" Parametros de URL: LLAVEVALORDESCRIPCIÓNnit123123124Corresponde al Nit de la empresa donde se realizó la Nota débito.numeroNotaDebitoND12Corresponde a el número de Nota débito, que desea descargar en formato XML Base 64 https://central.clarisacloud.com:8443/reporte/rest/api/v1/xml/notaDebito?nit=123123124&numeroNotaDebito=ND12 XML https://central.clarisacloud.com:8443/facturas/rest/notasDebito/reporteXml/?nit=123123124&numeroNotaDebito=ND12 Respuesta: Variables en la respuesta de API de Descarga XML Nombre Tipo dato Descripción data Alfanumérico Contiene el archivo XML en…
Leer más