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

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:

CABECERAVALOR
Content-Type application/json
Authorizationtoken de usuario

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:


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 de generación del documento electrónico (Formato: yyyy-MM-ddThh:mm:ss)
fechaVencimiento String 100 Fecha de vencimiento del documento electrónico(Formato: yyyy-MM-ddThh:mm:ss)
mediosPago Alfanumérico 100 Códigos de la DIAN de los medios de pago con los que se pagó el documento electrónico, dichos códigos van separados por coma. Ver tabla Medios de Pago
formaPago numérico 100 Código de la DIAN asociado a la forma de pago del documento electrónico. Ver tablaFormas de Pago
codigoDescuento Alfanumérico 100 Código de la dian del tipo de descuento aplicado a la factura Ver tabla Valores para Codigo Descuento
porcentajeDescuentoGeneral numérico 100 Porcentaje de descuento aplicado al valor total
total numérico 100 Valor total del documento electrónico.
Observación Alfanumérico 100 Observación.
modo Alfanumérico 100 Código para tipos de Operacion en Salud, Ver tabla Tipos de operacion Salud.
sectorSalud {} Lineas de informacion medica
codigoPrestador String Código del prestador de servicios de salud
modalidad Alfanumerico 100 Código de la modalidad de contratación y de pago pactada objeto de facturación. Ver tabla, Modalidades de Pago
otroDescripcion String
cobertura String Entidad responsable de financiar la cobertura o plan de beneficios, y de pagar la prestación de los servicios y tecnologías de salud incluidas en la factura de venta. Ver tabla, Valores para Cobertura
numeroContrato String Número del contrato objeto de facturación.
numeroPoliza String Número de póliza SOAT o del número de póliza de planes voluntarios de salud.
copago numérico Valor total del copago cancelado por el usuario.
cuotaModeradora numérico Valor efectivamente pagado por el usuario y recaudado por el prestador de servicios de salud, correspondiente a la cuota moderadora.
cuotaRecuperacion numérico Valor efectivamente pagado por el usuario y recaudado por el prestador de servicios de salud, correspondiente por la cuota de recuperación que debe pagar el usuario directamente a las Instituciones Prestadoras de Servicios de Salud en los casos previstos en el artículo 18 Decreto 2357 de 1995.
pagosCompartidos numérico Correspondiente al pago compartido en los planes voluntarios de salud (medicina prepagada, pólizas de salud y planes complementarios en salud).
periodoFacturacion {} Información del periodo de facturación asociado a la factura.
fechaInicial String 10 Fecha de inicio del periodo de facturación en formato YYYY-MM-DD.
fechaFinal String Fecha de inicio del periodo de facturación en formato YYYY-MM-DD
horaInicial String Hora de la fecha de inicio del periodo de facturación en formato hh:mm:ss
horaFinal String Hora de la fecha de finalización del periodo de facturación en formato hh:mm:ss
cliente {} Datos del Cliente del documento electrónico
nombreRazonSocial Alfanumérico 100 Cliente: Razón social o Nombre
tipoIdentificacion Alfanumérico 100 Código del tipo de identificación, Ver tabla Valores Tipo de identificación.
numIdentificacion númerico 100 Número de identificación de cliente
naturaleza String 100 Naturaleza del cliente Juridica o Natural Ver tabla Naturaleza
direccion Alfanumérico 100 Dirección Cliente
ciudad Alfanumérico 100 Hace referencia a el código DANE de la ciudad. La ciudad del cliente, vease la tabla ciudad
telefono numérico 100 Telefono del cliente
email Alfanumérico 100 correo Electronico del cliente
items Array [] Lineas de la factura.
nombreItemVenta Alfanumérico 100 Nombre del producto vendido
precioVentaUnitario numérico 100 Precio de venta unitario del producto
cantidad numérico 100 Cantidad vendida del item
codigo Alfanumérico 100 Código del producto vendido.
descuentoPorcentaje numérico 100 porcentaje de descuento aplicado al item
observacion Alfanumérico 100 Observación del item
unidad Alfanumérico 100 código de la DIAN de la Unidad del producto. Ver tabla Valores para Unidad
codigoDescuento Alfanuméricos 100 Código de la dian del tipo de descuento aplicado al item, ver TablaValores para Codigo Descuento
impuesto ImpuestoEnum 100 Impuesto aplicado al item, Ver tabla Valores para Impuestos
anticipo AnticipoFactura{} Corresponde al valor aplicado por ítem de venta
valor numerico Valor del anticipo.
fecha String 10 Fecha de anticipo YYYY-MM-DD.
Campos Adicionales
retenciones Array [] Información relacionada con las retenciones
retencion numérico Código asociado a la retención, Ver tabla de Retenciones.
valor numérico Valor de retención
porcentaje numérico Porcentaje de la retención
baseGravable numérico Base Gravable de la retención
ordenReferencia {}
numeroDocumento Alfanumérico 100 Número de Orden de Referencia
fechaEmision String 10 Fecha de emision de la orden de Referencia YYYY-MM-DD.
urlDescargaAdjuntos String 100 Dirección donde se accede a la información complementaria
wsEntregaEventos String 100 Dirección del Web Service

Nombre código
Acuerdo mutuo ZZZ
Efectivo 10
Consiganción bancaria 42
Tarjeta crédito 30
Tarjeta Débito 49
Bonos 71
Bookentry Crédito 15
Bookentry Débito 16
Cheque 20
Cheque bancario 23
Cheque certificado 25
Cheque Local 26
Cheque local transferible 92
Clearing entre partners 97
Clearing Nacional o Regional 9
Concentración de la demanda en efectivo / Desembolso (CCD) débito 18
Concentración de la demanda en efectivo /Desembolso Crédito (CCD) 17
Concentración Efectivo / Desembolso Crédito plus (CCD+) 32
Concentración efectivo / Desembolso Débito plus (CCD+) 43
Concentración Efectivo / Desembolso Débito plus (CCD+) 33
Concentración efectivo ahorros / Desembolso Crédito (CCD) 35
Concentración efectivo ahorros / Desembolso Drédito (CCD) 36
Concentración efectivo/Desembolso Crédito plus (CCD+) 41
Crédito ACH 2
Crédito Ahorro 13
Crédito de demanda ACH 6
Crédito Negocio Intercambio Corporativo (CTX) 28
Crédito Negocio Intercambio Corporativo (CTX) 39
Crédito Pago negocio corporativo (CTP) 19
Débito ACH 3
Débito Ahorro 14
Débito de demanda ACH 7
Débito Negocio Intercambio Corporativo (CTX) 40
Débito Negocio Intercambio Corporativo (CTX) 29
Débito Pago Negocio Corporativo (CTP) 27
Giro formato abierto 95
Giro referenciado 93
Giro urgente 94
Instrumento no definido 1
Mantener 8
Método de pago solicitado no usuado 96
Nota bancaria transferible 91
Nota cambiaria 44
Nota cambiaria esperando aceptación 24
Nota promisoria 60
Nota promisoria firmada 66
Nota promisoria firmada por el acreedor 61
Nota promisoria firmada por el acreedor, avalada por el banco 62
Nota promisoria firmada por el acreedor, avalada por un tercero 63
Nota promisoria firmada por el banco 64
Nota promisoria firmada por un banco avalada por otro banco 65
Nota promisoria firmada por un tercero avalada por un banco 67
Pago comercial urgente 52
Pago Negocio Corporativo Ahorros Crédito (CTP) 37
Pago Negocio Corporativo Ahorros Débito (CTP) 38
Pago Tesorería Urgente 53
Pago y depósito pre acordado (PPD) 34
Postgiro 50
Poyecto bancario 21
Proyecto bancario certificado 22
Retiro de nota por el acreedor 70
Retiro de nota por el acreedor sobre un banco 74
Retiro de nota por el acreedor, avalada por otro banco 75
Retiro de nota por el acreedor, sobre un banco avalada por un tercero 76
Retiro de una nota por el acreedor sobre un tercero 77
Retiro de una nota por el acreedor sobre un tercero avalada por un banco 78
Reversión Crédito Ahorro 11
Reversión crédito de demanda ACH 5
Reversión Débito Ahorro 12
Reversión débito de demanda ACH 4
Tarjeta Crédito 48
Tarjeta débito 31
Telex estándar bancario francés 51
Transferencia Crédito Bancario 45
Transferencia Débito Bancaria 47
Transferencia Débito Interbancario 46
Vales 72

Nombre Código
Contado 1
Crédito 2

Nombre Código
Descuento por impuesto asumido 00
Pague uno lleve otro 01
Descuentos contractulales 02
Descuento por pronto pago 03
Envío gratis 04
Descuentos específicos por inventarios 05
Descuento por monto de compras 06
Descuento de temporada 07
Descuento por actualización de productos / servicios 08
Descuento general 09
Descuento por volumen 10
Otro descuento 11

Descripción Código
Activa el Método de cálculo del Sector Salud, el cual comprueba el recaudo de Cuotas Moderadoras, Copagos o Cuotas de Recuperación como anticipos SS_CUFE
No Activa el Método de cálculo del Sector Salud. Comprobante de recaudo de Cuotas Moderadores, Copagos o Cuotas de Recuperación, como recursos a favor de terceros. SS_RECAUDO
No activa el Método de cálculo del Sector Salud. Reporta referencias que comprueban recaudo de Cuotas Moderadoras, Copagos o Cuotas de Recuperación, que tienen tratamiento contable. SS_REPORTE
Sin aporte ni recaudo, No activa el Método de cálculo del Sector Salud SS_SINAPORTE

Nombre del campo Código
Pago individual por caso / Conjunto integral de atenciones / Paquete / Canasta 01
Pago Global Prospectivo 02
Pago por capitación 03
Pago por evento 04
Otra modalidad (específica) 05

Nombre del campo Código
Plan de beneficios en salud financiado con UPC 01
Presupuesto máximo 02
Prima EPS / EOC, no asegurados SOAT 03
Cobertura Póliza SOAT 04
Cobertura ARL 05
Cobertura ADRES 06
Cobertura Salud Pública 07
Cobertura entidad territorial, recursos de oferta 08
Urgencias población migrante 09
Plan complementario en salud 10
Plan medica prepagada 11
Otras pólizas en salud 12
Cobertura Régimen Especial o Excepción 13
Cobertura Fondo Nacional de Salud de las Personas Privadas de la Libertad 14
Particular 15

Nombre Código
cedula de ciudadania CC
NIT NI
tarjeta de identidad TI
Pasaporte PA
Tarjeta de extranjeria TE
Cedula de extranjeria CE
Registro civil de nacimiento RC
Nit de otro país NO
NUIP NU
Carné diplomatico CD
Salvonconducto SC
Permiso Especial de permanencia PE
Certificado de nacido vivo CN
Adulto sin identificar AS
Menor sin identificar MS
Documento extranjero DE
Sin identificación SI
Documento de identificación extranjero DE
PEP PE

código Descripción
NATURALES Persona natural
JURIDICAS Persona Jurídica

Revisar el excel con los datos de las ciudades

Nombre del campo Código
Unidad 94
Pieza 94
Centímetro CMT
Metro MTR
Pulgada INH
Centímetro cuadrado CMK
Metro cuadrado (m2) MTK
Pulgada cuadrada INK
Mililitro MLT
Litro LTR
Galón A76
Gramo GGR
Kilogramo KGM
Tonelada 54
Libra LBR
Servicio 94
Centímetro Cúbico (cm3) CMQ
Metro Cúbico MTQ

Descripción Código
Excluido de impuesto EXCLUIDO
Exento de impuesto EXENTO
Impuesto al consumo 4% IMPUESTO_CONSUMO_4
Impuesto al consumo 8% IMPUESTO_CONSUMO_8
Impuesto al consumo 16% IMPUESTO_CONSUMO_16
IVA 5% IVA_5
IVA 19% IVA_19

Nombre Código
Arrendamiento de bienes inmuebles (declarantes) 1
Compras generales (declarantes) 3
Compras generales (no declarantes) 4
Honorarios y comisiones (no declarantes)) 5
Honorarios y comisiones (personas jurídicas) 6
Servicios de aseo y vigilancia 7
Servicios de hoteles y restaurantes (no declarantes) 8
Servicios generales (declarantes) 9
Servicios generales (no declarantes) 10
ReteICA 11
ReteIVA 15% 12
Transporte de Carga 13
ReteIVA 100% 16
Arrendamiento de bienes inmuebles (no declarantes) 17
Arrendamiento de bienes muebles 18
Compras con tarjeta débito o crédito 19
Compras de bienes o productos agrícolas o pecuarios sin procesamiento industrial 20
Compras de bienes o productos agrícolas o pecuarios con procesamiento industrial (declarantes) 21
Compras de bienes o productos agrícolas o pecuarios con procesamiento industrial declarantes (no declarantes) 22
Compras de café pergamino o cereza 23
Compras de combustibles derivados del petróleo 24
Enajenación de activos fijos de personas naturales (notarías y tránsito son agentes retenedores) 25
Compras de vehículos 26
Compras de bienes raíces cuya destinación y uso sea vivienda de habitación (por las primeras 20.000 UVT, es decir hasta $637.780.000) 27
Compras de bienes raíces cuya destinación y uso sea vivienda de habitación (exceso de las primeras 20.000 UVT, es decir superior a $637.780.000) 28
Compras de bienes raíces cuya destinación y uso sea distinto a vivienda de habitación 29
Por emolumentos eclesiásticos (declarantes) 30
Por emolumentos eclesiásticos (no declarantes) 31
Servicios de transporte de carga 32
Servicios de transporte nacional de pasajeros por vía terrestre (declarantes) 33
Servicios de transporte nacional de pasajeros por vía terrestre (no declarantes) 34
Servicios de transporte nacional de pasajeros por vía aérea o marítima/td> 35
Servicios prestados por empresas de servicios temporales (sobre AIU) 36
Servicios prestados por empresas de vigilancia y aseo (sobre AIU) 37
Servicios integrales de salud prestados por IPS 38
Servicios de hoteles y restaurantes (declarantes) 39
Otros ingresos tributarios (declarantes) 40
Otros ingresos tributarios (no declarantes) 41
Honorarios y comisiones personas naturales que suscriban contrato o cuya sumatoria de los pagos o abonos en cuenta superen las 3.300 UVT ($105.135.000) 42
Servicios de licenciamiento o derecho de uso de software 43
Intereses o rendimientos financieros 44
Rendimientos financieros provenientes de títulos de renta fija 45
Loterías, rifas, apuestas y similares 46
Retención en colocación independiente de juegos de suerte y azar 47
Contratos de construcción y urbanización 48

Puedes descargar el siguiente archivo de excel con las ciudades de Colombia 


Si lo deseas puedes acceder directamente a nuestra API de ciudades y cargar la ciudad de ese modo, Guía Técnica para Consumo API Ciudades


En caso de que no se pueda obtener la información de la factura se debe tener en cuenta la variable success y los valores detitleResponse y textResponse para poder mostrar los mensajes respectivos al usuario. La variable titleResponse contiene el código del error y la variable textResponse contiene la descripción del error la cual debe ser mostrada al usuario. Si es errores por validación de datos en data se retorna el total de errores  y un array con los errores.

Correcto

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

CÓDIGO HTTP: 200


  Error

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

CÓDIGO HTTP: 400 | 401 | 500