Adquirientes
| API | Description |
|---|---|
| GET Adquirientes/ObtenerDIAN/{tipoDocumento}/{numeroDocumento} |
Servicio que permite consulta el nombre o la razon social y correo electronico del adquiriente de la factura electrónica |
Aliados
| API | Description |
|---|---|
| POST Aliados |
Registra un aliado con el id que ya tiene en GU. Responde 201 si lo crea y 200 si ya existía con ese mismo NIT e id: en ese caso no modifica nada y devuelve sus datos guardados. |
| GET Aliados?nit={nit} |
Busca aliados por NIT exacto (solo dígitos), o los lista todos si no se envía nit. Nunca devuelve los términos comerciales. |
| GET Aliados/{alieId} |
Un aliado por su id. 404 con ALIADO_NO_EXISTE si no existe. |
| PUT Aliados/{alieId} |
Reemplaza los datos de contacto: razón social (obligatoria), correo, teléfono y dirección. Un campo opcional que no viene queda vacío. El NIT y los términos comerciales no se cambian por aquí. |
| DELETE Aliados/{alieId} |
Inactiva el aliado: borrado lógico (Estado = 'Inactivo'), la fila no se borra. 409 con ALIADO_CON_SUSCRIPTORES si todavía tiene suscriptores. Si ya estaba inactivo responde igual 200 y lo dice en el mensaje. |
ApiKeys
| API | Description |
|---|---|
| GET ApiKeys/Listar |
Las keys del suscriptor: nombre, últimos cuatro, estado y último uso. Nunca la key. |
| POST ApiKeys/Crear |
Crea una key. La respuesta es la única vez que se muestra: Kiai solo guarda su hash y no puede recuperarla. Se envía en el header X-Api-Key. |
| POST ApiKeys/Revocar |
Revoca una key (baja lógica). Deja de autenticar de inmediato. |
Auth
| API | Description |
|---|---|
| POST auth/login |
No documentation available. |
DescargaMasiva
| API | Description |
|---|---|
| POST DescargaMasiva/CrearTarea |
Crear una nueva tarea de descarga masiva. |
| GET DescargaMasiva/ObtenerTarea/{id}?suscriptorId={suscriptorId} |
Obtener detalle de una tarea. |
| GET DescargaMasiva/ListarTareas?suscriptorId={suscriptorId} |
Listar tareas por suscriptor. |
| DELETE DescargaMasiva/EliminarTarea/{id}?suscriptorId={suscriptorId} |
Eliminar una tarea. |
DocumentoEquivalente
| API | Description |
|---|---|
| POST DocumentoEquivalente/EmitirDocumento |
Servicio que permite emitir un documento equivalente a ambiente de producción del servicio de validacion previa |
| POST DocumentoEquivalente/CrearSetPrueba |
Servicio que permite emitir un documento equivalente a ambiente de habilitación del servicio de validacion previa |
| GET DocumentoEquivalente/ReprocesarDocumento/{DoceId} |
Servicio que permite reprocesar un documento de pruebas o producción emitido previamente |
DocumentosBorrador
| API | Description |
|---|---|
| POST DocumentosBorrador/{suscriptorId} |
Guarda un borrador de factura de venta |
| GET DocumentosBorrador/consultar-documento-borrador/{suscriptorId} |
Consulta todos los borradores del suscriptor |
| GET DocumentosBorrador/consultar-documento-borrador/{suscriptorId}/{id} |
Obtiene un borrador por su ID |
| PUT DocumentosBorrador/editar-documento-borrador/{suscriptorId}/{id} |
Edita el contenido de un borrador identificándolo por su Id. Solo permitido para borradores en estado "Pendiente por emitir" o "Rechazado". Si el borrador ya fue emitido o eliminado, responde 409 con el mensaje correspondiente. |
| POST DocumentosBorrador/emitir-documento-borrador/{suscriptorId}/{id} |
Emite un borrador identificándolo por su Id. El borrador debe estar en estado editable ("Pendiente por emitir" o "Rechazado"). Recibe el DocumentoFactura completo (ya diligenciado con prefijo/consecutivo en el portal). Antes de emitir valida que el consecutivo no haya sido emitido previamente por el mismo emisor. Luego delega la emisión real al servicio de validación previa y sincroniza el estado del borrador (Emitido/Rechazado), asociando el DoceId resultante. |
| DELETE DocumentosBorrador/eliminar-documento-borrador/{suscriptorId}/{id} |
Elimina un borrador por su ID |
DocumentoSoporte
| API | Description |
|---|---|
| POST DocumentoSoporte/EnviarSetPrueba |
Servicio que permite emitir factura electrónica a ambiente de habilitación del servicio de validacion previa |
| POST DocumentoSoporte/EmitirDocumentoSoporte |
Servicio que permite emitir documento soporte a ambiente de producción del servicio de validacion previa |
| GET DocumentoSoporte/EliminarDS/{Observacion}/{DoceId} |
Servicio que permite eliminar un documento soporte. Este recibe por parámetro la observación o motivo de anulacion y el DoceId del documento que se desea eliminar. Este servicio recrea el documento soporte original y lo envía como nota de ajuste |
| POST DocumentoSoporte/EliminarDS |
Servicio que permite eliminar un documento soporte. Este recibe por parámetro la observación o motivo de anulacion y el DoceId del documento que se desea eliminar. Este servicio recrea el documento soporte original y lo envía como nota de ajuste |
| API | Description |
|---|---|
| POST email/ReceiveNotification |
Exclusivo para recibir trazabilidad de correos de AWS |
Empleadores
| API | Description |
|---|---|
| GET Empleadores/ObtenerPorId/{EmpleadorId} |
No documentation available. |
| GET Empleadores/ObtenerPorAliadoId/{AliadoId} |
No documentation available. |
Icd11
| API | Description |
|---|---|
| GET Icd11/BuscarDiagnostico?q={q}&idioma={idioma} |
Busca diagnósticos CIE-11 por nombre o texto libre. Devuelve solo { codigo, nombre } con el título limpio (sin marcado de resaltado). Ejemplo: GET /Icd11/BuscarDiagnostico?q=diabetes |
| GET Icd11/BuscarPorCodigoExacto?codigo={codigo}&idioma={idioma} |
Consulta exacta por código CIE-11 (theCode). Devuelve el código y su nombre. Ejemplo: GET /Icd11/BuscarPorCodigoExacto?codigo=LD2H.Y |
InventarioUnidades
| API | Description |
|---|---|
| GET api/inventario-unidades |
No documentation available. |
KiaiAppMaestros
| API | Description |
|---|---|
| GET kiai-app/tipos-operaciones?tipoGrupo={tipoGrupo} |
No documentation available. |
| GET kiai-app/formas-pagos |
No documentation available. |
| GET kiai-app/medios-pagos |
No documentation available. |
| GET kiai-app/ciudades?departamentoId={departamentoId} |
No documentation available. |
| GET kiai-app/departamentos |
No documentation available. |
| GET kiai-app/paises |
No documentation available. |
| GET kiai-app/responsabilidades-obligaciones-calidades-atributos |
No documentation available. |
| GET kiai-app/tipos-organizaciones-tributarias |
No documentation available. |
| GET kiai-app/codigos-postales?ciudadId={ciudadId} |
No documentation available. |
| GET kiai-app/regimenes-tributarios |
No documentation available. |
| GET kiai-app/tipos-documento-identificacion |
No documentation available. |
| GET kiai-app/impuestos?filter={filter} |
No documentation available. |
| GET kiai-app/documentos-electronicos-tipos?doetGrupo={doetGrupo} |
No documentation available. |
KiaiSaludMaestros
| API | Description |
|---|---|
| GET kiaisalud/tipootrosservicios |
Obtiene todos los elementos del catálogo. |
| GET kiaisalud/ipsnoreps |
Obtiene todos los elementos del catálogo. |
| GET kiaisalud/ripsfinalidadconsultaversion2 |
Obtiene todos los elementos del catálogo. |
| GET kiaisalud/coberturaplan |
Obtiene todos los elementos del catálogo. |
| GET kiaisalud/municipio |
Obtiene todos los elementos del catálogo. |
| GET kiaisalud/gruposervicios |
Obtiene todos los elementos del catálogo. |
| GET kiaisalud/cie10 |
Obtiene todos los elementos del catálogo. |
| GET kiaisalud/conceptorecaudo |
Obtiene todos los elementos del catálogo. |
| GET kiaisalud/viaingresousuario |
Obtiene todos los elementos del catálogo. |
| GET kiaisalud/servicios |
Obtiene todos los elementos del catálogo. |
| GET kiaisalud/tiponota |
Obtiene todos los elementos del catálogo. |
| GET kiaisalud/sexo |
Obtiene todos los elementos del catálogo. |
| GET kiaisalud/catalogos/{catalog} |
No documentation available. |
| GET kiaisalud/umm |
Obtiene todos los elementos del catálogo. |
| GET kiaisalud/lstsino |
Obtiene todos los elementos del catálogo. |
| GET kiaisalud/ffm |
Obtiene todos los elementos del catálogo. |
| GET kiaisalud/catalogocums |
Obtiene todos los elementos del catálogo. |
| GET kiaisalud/upr |
Obtiene todos los elementos del catálogo. |
| GET kiaisalud/ipscodhabilitacion |
Obtiene todos los elementos del catálogo. |
| GET kiaisalud/ripstipousuarioversion2 |
Obtiene todos los elementos del catálogo. |
| GET kiaisalud/tipomedicamentoposversion2 |
Obtiene todos los elementos del catálogo. |
| GET kiaisalud/zonaversion2 |
Obtiene todos los elementos del catálogo. |
| GET kiaisalud/departamento |
Obtiene todos los elementos del catálogo. |
| GET kiaisalud/ium |
Obtiene todos los elementos del catálogo. |
| GET kiaisalud/modalidadpago |
Obtiene todos los elementos del catálogo. |
| GET kiaisalud/ripscausaexternaversion2 |
Obtiene todos los elementos del catálogo. |
| GET kiaisalud/cupsrips |
Obtiene todos los elementos del catálogo. |
| GET kiaisalud/modalidadatencion |
Obtiene todos los elementos del catálogo. |
| GET kiaisalud/tipoidpisis |
Obtiene todos los elementos del catálogo. |
| GET kiaisalud/dci |
Obtiene todos los elementos del catálogo. |
| GET kiaisalud/pais |
Obtiene todos los elementos del catálogo. |
| GET kiaisalud/condicionydestinoseusuarioegreso |
Obtiene todos los elementos del catálogo. |
| GET kiaisalud/ripstipodiagnosticoprincipalversion2 |
Obtiene todos los elementos del catálogo. |
Mediador
| API | Description |
|---|---|
| GET Mediador/ObtenerRepresentacionVpGenericaAsync/{DoceId} |
Servicio que permite generar la representación gráfica del documento solicitado, recibe por parámetro el DoceId |
| GET Mediador/ObtenerTrazabilidadCorreosAsync/{DoceId} |
Servicio que permite consultar los eventos relacionados al correo emitido con la factura electrónica. Permite conocer si el correo se envió, si fue recibido por la bandeja de entrada del adquiriente, si fue abierto o si rebotó. Este servicio recibe por parámetro el DoceId de la factura solicitada |
| GET Mediador/NotificarDocumentoCorreoAsync/{DoceId}?correos={correos} |
Servicio que permite reenviar un correo electrónico con la factura electrónica. Este servicio recibe por parámetro el DoceId de la factura solicitada |
| POST Mediador/EnviarCorreoGeneral |
Servicio general de envío de correo electrónico. Permite enviar un correo personalizado con destinatarios, asunto, cuerpo HTML/texto y adjuntos en base64. |
| POST Mediador/CrearTicketSoporte |
Servicio que permite crear un ticket la mesa de ayuda de Kiai |
| POST Mediador/InsertarLogoResolucion |
Servicio que permite actualizar un logo para las diferentes resoluciones de un suscriptor |
| POST Mediador/GenerarZipDocumentosSeleccionados |
No documentation available. |
Movil
| API | Description |
|---|---|
| GET Movil/ConsultarTiposDocumentos |
No documentation available. |
| GET Movil/ConsultarUnidadesMedidas |
No documentation available. |
| GET Movil/ConsultarTerceros/{SuscId}/{Valor} |
No documentation available. |
| POST Movil/GestionarTerceros |
No documentation available. |
| GET Movil/ConsultarPaises |
No documentation available. |
| GET Movil/ConsultarDepartamentos/{NombreDepartamento} |
No documentation available. |
| GET Movil/ConsultarCiudades/{DeppId} |
No documentation available. |
| GET Movil/DocumentosRecibidos/{SuscId} |
No documentation available. |
| GET Movil/ConsultarCodigosPostales/{CodigoPostal} |
No documentation available. |
| GET Movil/ConsultarRegimenes |
No documentation available. |
| GET Movil/ConsultarTiposOrganizacionesTributarias |
No documentation available. |
| GET Movil/ConsultarProductos/{SuscId}/{Valor} |
No documentation available. |
| POST Movil/GestionarProductos |
No documentation available. |
NominaElectronica
| API | Description |
|---|---|
| POST NominaElectronica/Emitir |
Servicio que permite emitir una nómina electrónica al servicio de validacion previa de la Dian. Es capaz de procesar ambiente de habilitación y producción |
| GET NominaElectronica/CargarIdNomina/{CardId} |
Servicio que permite reprocesar un documento de pruebas o producción emitido previamente |
| POST NominaElectronica/CrearEmpleador |
Servicio que permite registrar un nuevo emisor de nómina (Empleador) |
| PUT NominaElectronica/ActualizarEmpleador/{EmpleadorId} |
Servicio que permite actualizar un empleador, recibe por parámetro el EmpleadorId y la información de este |
| DELETE NominaElectronica/Eliminar/{CUNEPred}/{consecutivo}/{prefijo} |
3.2. Nota de Ajuste de Documento Soporte de Pago de Nómina Electrónica: NominaIndividualDeAjuste. Permite eliminar un documento de nómina(NominaIndividual, Nota de Ajuste o Nota de eliminación ) enviado y autorizado por la Dian. Este método elimina el documento por completo en la Dian. Es el equivalente al proceso de anular una factura. |
| POST NominaElectronica/HabilitarEmpleador/{EmpleadorId} |
Servicio que permite habilitar empleadores en la Dian |
| GET NominaElectronica/ConsultarXmlDianNomina/{EmpleadorId}/{Cune} |
No documentation available. |
PlantillaRepresentacionGrafica
| API | Description |
|---|---|
| POST PlantillaRepresentacionGrafica/Crear |
No documentation available. |
| GET PlantillaRepresentacionGrafica/Obtener/{Id} |
No documentation available. |
| GET PlantillaRepresentacionGrafica/ObtenerPlantillasPorSuscriptor/{suscriptorId} |
No documentation available. |
| PUT PlantillaRepresentacionGrafica/Actualizar/{Id} |
No documentation available. |
| DELETE PlantillaRepresentacionGrafica/Eliminar/{Id} |
No documentation available. |
Radian
| API | Description |
|---|---|
| POST Radian/EmitirRadian |
Servicio que permite emitirEventos de recepcion y radian |
| GET Radian/ConsultarXmlDianSuscriptor/{SuscriptorId}/{CufeCude} |
Servicio que permite consultar el XML (Invoice) almacenado en la Dian |
| GET Radian/ConsultarEventosFactura/{SuscriptorId}/{CufeCude} |
Servicio que permite consultar los eventos generados por los adquirientes relacionados a las facturas emitidas por los facturadores de Kiai |
Recepcion
| API | Description |
|---|---|
| GET Recepcion/ConsultarDocumentosRecibidosPorFecha/{Anio}/{Mes}/{Dia}/{SuscId} |
Consulta los documentos electrónicos recibidos por un suscriptor (identificado por su ID) en una fecha específica (Año, Mes y Día). |
| GET Recepcion/ConsultarDocumentoRecibidoPorCufe/{CufeCude}/{SuscId} |
Consulta el documento electrónico recibido por un suscriptor mediante su CUFE/CUDE. |
| GET Recepcion/ConsultarDocumentosRecibidosPorRango/{Desde}/{Hasta}/{SuscId}?fecha={fecha} |
Consulta los documentos electronicos recibidos por un suscriptor dentro de un rango de fechas. |
Rips
| API | Description |
|---|---|
| POST Rips/LoginSispro |
No documentation available. |
| POST Rips/CargarFevRIPS |
No documentation available. |
| GET Rips/consultar-borrador-rip/{suscriptorId} |
Lista los borradores RIPS de un suscriptor (más recientes primero). |
| GET Rips/consultar-borrador-rip/{id}/{suscriptorId} |
Obtiene un borrador RIPS por su Id, validando que pertenezca al suscriptor. |
| DELETE Rips/eliminar-rip/{id}/{suscriptorId} |
Elimina (soft-delete) un borrador RIPS por su Id, validando que pertenezca al suscriptor y que su estado lo permita. Un borrador ya emitido NO puede eliminarse: se responde 409 Conflict, igual que EditarBorrador y EmitirBorrador del borrador de documentos. |
| POST Rips/CargarNC |
No documentation available. |
| POST Rips/CargarNCTotal |
No documentation available. |
| POST Rips/CargarND |
No documentation available. |
| POST Rips/CargarNotaAjuste |
No documentation available. |
| POST Rips/CargarRipsSinFactura |
No documentation available. |
| POST Rips/CargarNCAcuerdoVoluntades |
No documentation available. |
| POST Rips/CargarCapitaInicial |
No documentation available. |
| POST Rips/CargarCapitaPeriodo/{numFacturaCapitaPeriodo} |
No documentation available. |
| POST Rips/CargarCapitaFinal |
No documentation available. |
| POST Rips/ConsultarCUV |
No documentation available. |
| POST Rips/DescargarArchivosFevRipsCUV |
No documentation available. |
| GET Rips/ObtenerArchivos/{cuv}?suscriptorId={suscriptorId} |
No documentation available. |
Sedes
| API | Description |
|---|---|
| GET Sedes/Listar |
Las sedes del suscriptor y las resoluciones que todavía no tienen ninguna. |
| POST Sedes/Crear |
Crea una sede y devuelve el identificador que se enviará en Solicitud.SedeId. |
| POST Sedes/Renombrar |
Cambia el nombre visible. El identificador NO cambia: la integración no se toca. |
| POST Sedes/Desactivar |
Baja lógica. La respuesta dice cuántas resoluciones dejan de poder usarse, para que no se descubra emitiendo. |
| POST Sedes/Activar |
No documentation available. |
| POST Sedes/AsignarResolucion |
Asigna una resolución a una sede. Una resolución pertenece a una sola sede: si estaba en otra, se mueve y la respuesta dice de cuál venía. |
Suscriptores
| API | Description |
|---|---|
| POST Suscriptores/CrearSuscriptor |
Permite Crear un Suscriptor para emitir Facturas en el modelo de validación previa. Este método permite crear Suscriptores |
| POST Suscriptores/ControlarBloqueo |
Permite bloquear o desbloquear un Suscriptor para emitir Facturas |
ValidacionPrevia
| API | Description |
|---|---|
| POST ConValidacionPrevia/EmitirDocumento |
Servicio que permite emitir factura electrónica a ambiente de producción del servicio de validacion previa |
| GET ConValidacionPrevia/ReprocesarDocumento/{DoceId} |
Servicio que permite reprocesar un documento de pruebas o producción emitido previamente |
| POST ConValidacionPrevia/CrearSetPrueba |
Servicio que permite emitir factura electrónica a ambiente de habilitación del servicio de validacion previa |
| GET ConValidacionPrevia/ResumenSuscriptor/{SuscriptorId} |
Servicio que permite consultar la información del suscriptor junto con las resoluciones asociadas al proveedor tecnológico en el portal de facturación electrónica de la Dian |
| GET ConValidacionPrevia/SuscriptoresAliado/{AlieId} |
Servicio que permite consultar los suscriptores asociados al aliado y los consumos del mes immediatamente anterior |
| GET ConValidacionPrevia/ConsultarConsumosAliado/{AlieId}/{Anio}/{Mes} |
Servicio que permite consultar los suscriptores asociados al aliado y los consumos del mes que se envía por parametro |
| POST ConValidacionPrevia/CargarAnexos |
Servicio que carga Anexos(.PDF, .DOC, .XLS, JPG etc... ) a la Factura o Notas Débito/Crédito |
| GET ConValidacionPrevia/ConsultarValidacion/{DoceId} |
No documentation available. |
| GET ConValidacionPrevia/RecuperarDocumentoDian/{SuscId}/{CufeCude} |
Metodo que permite recuperar documentos que han quedado en proceso de validación o que en sus proceso de Emisión se genero algun error y no fue posible almacenar toda la informacion del documento. Adicionalmente permite obtener el xml, ApplicationResponse y el AttchaDocument del Documento. |
| POST ConValidacionPrevia/HabilitarFacturador |
Permite Crear/Actualizar un suscriptor para validacion previa, Crear/Actualizar set de pruebas de la Dian |
| POST ConValidacionPrevia/ActualizarTestSetId |
Permite Actualizar un suscriptor para cambiar el TestSetId y proveedor tecnológico |
| GET ConValidacionPrevia/ObtenerJsonDocumento/{DoceId} |
No documentation available. |