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:
| CABECERA | VALOR |
| Content-Type | application/json |
| Authorization | token de usuario |
Esta versión no se va a utilizar a partir de 01 de enero de 2024
METODO : "POST"
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 resolucion 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. revisar tabla medios de pago |
| Observación | Alfanumérico | 100 | Observación. |
| formaPago | numérico | 100 | Código de la DIAN asociado a la forma de pago del documento electrónico. revisar tablaformaPago |
| total | numérico | 100 | Valor total del documento electrónico. |
| cliente | Datos del Cliente del documento electrónico | ||
| cliente.nombreRazonSocial | Alfanumérico | 100 | Cliente: Razón social o Nombre |
| cliente.tipoIdentificacion | Alfanumérico | 100 | Código del tipo de identificación, vease la lista tipo de identificación. |
| cliente.numIdentificacion | númerico | 100 | Número de identificación de cliente |
| cliente.naturaleza | String | 100 | Naturaleza del cliente Juridica o Natural revisar tabla Naturaleza |
| cliente.direccion | Alfanumérico | 100 | Dirección Cliente |
| cliente.ciudad | Alfanumérico | 100 | Hace referencia a el código DANE de la ciudad. La ciudad del cliente, vease la tabla ciudad |
| cliente.telefono | numérico | 100 | Telefono del cliente |
| cliente.email | Alfanumérico | 100 | correo Electronico |
| cliente.responsabilidadesFiscales | Alfanumérico | 100 | Código de responsabilidades fiscales, véase tabla Responsabilidades fiscales cliente |
| cliente.respTributarias | Alfanumérico | 100 | Código de responsabilidades tributarias, véase tabla Valores para Responsabilidades tributarias cliente |
| codigoDescuento | Alfanumérico | 100 | Código de la dian del tipo de descuento aplicado al item |
| porcentajeDescuentoGeneral | numérico | 100 | Porcentaje de descuento aplicado al valor total |
| items | Array [] | Lineas de la factura. | |
| items.nombreItemVenta | Alfanumérico | 100 | Nombre del producto vendido |
| items.precioVentaUnitario | numérico | 100 | Precio de venta unitario del producto |
| items.cantidad | numérico | 100 | Cantidad vendida del item |
| items.codigo | Alfanumérico | 100 | Código del producto vendido. |
| items.descuentoPorcentaje | numérico | 100 | porcentaje de descuento aplicado al item |
| items.observacion | Alfanumérico | 100 | Observación del item |
| items.unidad | Alfanumérico | 100 | código de la DIAN de la Unidad del producto. REVISAR tabla unidad |
| items.codigoDescuento | Alfanuméricos | 100 | Código de la dian del tipo de descuento aplicado al item. |
| items.impuesto | ImpuestoEnum | 100 | Impuesto aplicado, revisar tabla ImpuestoEnum |
| items.anticipo | AnticipoFactura | Items de la factura. | |
| items.anticipo.valor | numerico | Valor del anticipo. | |
| items.anticipo.instrucciones | Alfanumerico | 5000 | Instrucciones o Descripción del anticipo. |
| items.retenciones | Array | Información relacionada con las retenciones | |
| items.retenciones.retencion | numérico | Código asociado a la retención, véase lista de retenciones. | |
| items.retenciones.valor | numérico | Valor de retención | |
| items.retenciones.porcentaje | numérico | VPorcentaje de la retención | |
| items.retenciones.baseGravable | numérico | Base Gravable de la retención | |
| items.informacionMedica | Array | líneas de información médica | |
| items.informacionMedica.autorizacion | String | número del aval para la prestación de un servicio de salud a un usuario por parte de una entidad responsable de pago. | |
| items.informacionMedica.codigoPS | String | Código del prestador de servicios de salud | |
| items.informacionMedica.modalidadContratacion | String | Código de la modalidad de contratación y de pago pactada objeto de facturación. Véase la lista de Modalidades de Contratación | |
| items.informacionMedica.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. Véase la lista de Modalidades de Contratación | |
| items.informacionMedica.numeroMiPres | String | Número que asigna MIPRES a la prescripción de servicios y tecnologías en salud o servicios complementarios no financiados con recursos de la UPC que un profesional de la salud ordena a una persona. | |
| items.informacionMedica.idEntregaMiPres | String | Número de ID que se asigna a la entrega de servicios y tecnologías en salud o servicios complementarios no financiados con recursos de la UPC. | |
| items.informacionMedica.numeroContrato | String | Número del contrato objeto de facturación. | |
| items.informacionMedica.numeroPoliza | String | Número de póliza SOAT o del número de póliza de planes voluntarios de salud. | |
| items.informacionMedica.copago | numérico | Valor total del copago cancelado por el usuario. | |
| items.informacionMedica.cuotaModeradora | numérico | Valor efectivamente pagado por el usuario y recaudado por el prestador de servicios de salud, correspondiente a la cuota moderadora. | |
| items.informacionMedica.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. | |
| items.informacionMedica.pagosCompartidos | numérico | Valor efectivamente pagado por el usuario y recaudado por el prestador de servicios de salud, correspondiente a la cuota moderadora. | |
| items.informacionMedica.paciente | Paciente | Datos del paciente. | |
| items.informacionMedica.paciente.primerNombre | Alfanumérico | 100 | Primer nombre del paciente. |
| items.informacionMedica.paciente.segundoNombre | Alfanumérico | 100 | Segundo nombre del paciente. |
| items.informacionMedica.paciente.primerApellido | Alfanumérico | 100 | Primer apellido del paciente. |
| items.informacionMedica.paciente.segundoApellido | Alfanumérico | 100 | Segundo apellido del paciente. |
| items.informacionMedica.paciente.fechaNacimiento | Alfanumérico | 100 | Fecha de nacimiento del paciente. |
| items.informacionMedica.paciente.email | Alfanumérico | 100 | Correo Electrónico. |
| items.informacionMedica.paciente.telefono | Alfanumérico | 100 | Número Telefonico. |
| items.informacionMedica.paciente.tipoUsuario | Alfanumérico | Código del tipo de afiliación o el relacionamiento de la persona frente a la cobertura o el plan de beneficios a través de la cual se prestan los servicios o tecnologías en salud reportados en la factura de venta. Ver valores de tipo de usuario | |
| items.informacionMedica.paciente.tipoIdentificacion | Alfanumérico | Tipo de Identificación paciente (Nombre CORTO de la tabla de tipos de documento. ) | |
| items.informacionMedica.paciente.numIdentificacion | Alfanumérico | 20 | Número de identificación |
| periodoFacturacion | Información del periodo de facturación asociado a la factura. | ||
| periodoFacturacion.fechaInicial | String | 10 | Fecha de inicio del periodo de facturación en formato YYYY-MM-DD. |
| periodoFacturacion.horaInicial | String | Hora de la fecha de inicio del periodo de facturación en formato hh:mm:ss | |
| periodoFacturacion.fechaFinal | String | Fecha de inicio del periodo de facturación en formato YYYY-MM-DD | |
| periodoFacturacion.horaFinal | String | Hora de la fecha de finalización del periodo de facturación en formato hh:mm:ss | |
| urlDescargaAdjuntos | Describe los datos donde el emisor dispone de la información complementaria a los documentos electrónicos que el adquiriente puede ingresar y descargar directamente sin la necesidad de ingresas credenciales (Usuario/Contraseña) | ||
| urlDescargaAdjuntos.url | Dirección donde se accede a la información complementaria | ||
| urlDescargaAdjuntos.parametros |
Parámetros de la URL con sus respectivos valores. Cada parámetro se
separa por coma “,” y a su vez el nombre y valor del parámetro va
separado por el símbolo dos puntos “:”.
Ejemplo: nombre:Andrea;edad:24 Indica los parámetros: nombre = Andrea edad= 24 |
||
| wsEntregaEventos | Grupo de información utilizado para la recepción los eventos que se genere por parte de Adquiriente. Corresponde a un acuerdo o formalidad entre las partes (Emisor y Receptor). | ||
| wsEntregaEventos.url | String | Dirección del Web Service | |
| wsEntregaEventos.parametros | String |
Parámetros del Web Service con sus respectivos valores. Cada parámetro
se separa por coma “,” y a su vez el nombre y valor del parámetro va
separado por el símbolo dos puntos “:”.
Ejemplo: nombre:Andrea;edad:24
Indica los parámetros: nombre = Andrea edad= 24 |
| 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 |
| 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 Neogcio 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 |
Si el cliente presenta varias responsabilidades fiscales, sus códigos deben ir separados por coma
| Nombre | Código |
|---|---|
| Gran contribuyente | O-13 |
| Autorretenedor | O-15 |
| Agente de retención en el impuesto sobre las ventas | O-23 |
| Régimen de tributación- SIMPLE | O-47 |
| No responsable | R-99-PN |
| Nombre | Código |
|---|---|
| Impuesto al valor agregado | IVA |
| Impuesto Nacional al Consumo | INC |
| IVA + INC | IVA_E_INC |
| No aplica | NO_APLICA |
| 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 |
| Nombre del campo | Código |
|---|---|
| Paquete / canasta / Conjunto Integral salud | 01 |
| Grupos Relacionados por Diagnóstico | 02 |
| Integral por grupo de Riesgo | 03 |
| Pago por contacto por especialidad | 04 |
| Pago por escenario de atención | 05 |
| Pago por tipo de servicio | 06 |
| Pago global prospectivo por episodio | 07 |
| Pago global prospectivo por grupo de riesgo | 08 |
| Pago global prospectivo por especialidad | 09 |
| Pago global prospectivo nivel de complejidad | 10 |
| Capacitación | 11 |
| Por servicio | 12 |
| 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 |
|---|---|
| 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 |
|---|---|
| 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 |
| código | Descripción |
|---|---|
| NATURALES | Persona natural |
| JURIDICAS | Persona Jurídica |
| Revisar el excel con los datos de las ciudades |
| 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 |
| Nombre | Código |
|---|---|
| Contributivo cotizante | 01 |
| Contributivo beneficiario | 02 |
| Contributivo adicional | 03 |
| Subsidiado | 04 |
| Sin régimen | 05 |
| Especiales o de Excepción cotizante | 06 |
| Especiales o de Excepción beneficiario | 07 |
| Particular | 08 |
| Tomador/Amparado ARL | 09 |
| Tomador/Amparado SOAT | 10 |
| Tomador/Amparado Planes voluntarios de salud | 11 |
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
Crear Nota Débito
Contamos con la verificación y validación de tus notas débito para lograr ser aceptadas y reportadas a la DIAN :
CABECERAS:
| CABECERA | VALOR |
| Content-Type | application/json |
| Authorization | token de usuario |
Petición
| Nombre del campo | Formato | Tamaño | Descripción |
|---|---|---|---|
| nit | Alfanumérico | 100 | Hace referencia del NIT de la empresa. |
| numeroFacturaAsociada | String | 100 | Numero de la factura asociada a la nota débito. |
| tipo | String | 100 | Código de la DIAN que identifica el Tipo de la nota débito,Son: INTERESES GASTOS_POR_COBRAR CAMBIO_POR_COBRAR OTRO |
| numeroDocumentoComercial | String | 100 | Numero de la Nota Débito |
| codigoDescuento | String | 100 | Código de la dian del tipo de descuento aplicado al item, vease la tabla Valores para codigoDescuento |
| porcentajeDescuentoGeneral | String | 100 | Porcentaje de descuento aplicado al valor total |
| cliente | Datos del Cliente del documento electrónico | ||
| cliente.nombreRazonSocial | Alfanumérico | 100 | Cliente: Razón social o Nombre |
| cliente.tipoIdentificacion | Alfanumérico | 100 | Codigo del tipo de identificación, vease la lista tipo de identificación. |
| cliente.numIdentificacion | númerico | 100 | Número de identificación de cliente |
| cliente.naturaleza | String | 100 | Naturaleza del cliente Juridica o Natural revisar tabla Naturaleza |
| cliente.direccion | Alfanumérico | 100 | Dirección Cliente |
| cliente.ciudad | numérico | 100 | Identificador de la ciudad del cliente, vease la tabla ciudad |
| cliente.telefono | numérico | 100 | Telefono del cliente |
| cliente.email | Alfanumérico | 100 | correo Electronico |
| 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. revisar tabla medios de pago |
| Observación | Alfanumérico | 100 | Observación. |
| formaPago | numérico | 100 | Código de la DIAN asociado a la forma de pago del documento electrónico. revisar tablaformaPago |
| total | numérico | 100 | Valor total del documento electrónico. |
| items | Array [] | Lineas de la factura. | |
| items.nombreItemVenta | Alfanumérico | 100 | Nombre del producto vendido |
| items.precioVentaUnitario | numérico | 100 | Precio de venta unitario del producto |
| items.precioBaseUnitario | numérico | 100 | Precio base unitario del producto. Este atributo remplaza a items.precioVentaUnitario en caso que desee que los cálculos del item se hagan a partir del precio base y no a partir del precio con impuesto. |
| items.precioReferencia | numérico | 100 | Precio de referencia del producto cuando éste se considera un regalo, es decir, su precio resultante es igual a cero. Este campo es obligatorio si items.descuentoPorcentaje = 100 o si items.precioVentaUnitario = 0 o items.precioBaseUnitario = 0 |
| items.cantidad | numérico | 100 | Cantidad vendida del item |
| items.codigo | Alfanumérico | 100 | Código del producto vendido. |
| items.descuentoPorcentaje | numérico | 100 | porcentaje de descuento aplicado al item |
| items.observacion | Alfanumérico | 100 | Observación del item |
| items.unidad | Alfanumérico | 100 | código de la DIAN de la Unidad del producto. REVISAR tabla unidad |
| items.codigoDescuento | Alfanuméricos | 100 | Código de la dian del tipo de descuento aplicado al item. |
| items.impuesto | ImpuestoEnum | 100 | Impuesto aplicado, revisar tabla ImpuestoEnum |
| items.anticipo | AnticipoFactura | Items de la factura. | |
| items.anticipo.valor | numerico | Valor del anticipo. | |
| items.anticipo.instrucciones | Alfanumerico | 5000 | Instrucciones o Descripción del anticipo. |
| items.retenciones | Array | Información relacionada con las retenciones | |
| items.retenciones.retencion | numérico | Código asociado a la retención, véase lista de retenciones. | |
| items.retenciones.valor | numérico | Valor de retención | |
| items.retenciones.porcentaje | numérico | VPorcentaje de la retención | |
| items.retenciones.baseGravable | numérico | Base Gravable de la retención | |
| items.informacionMedica | Array | líneas de información médica | |
| items.informacionMedica.autorizacion | String | número del aval para la prestación de un servicio de salud a un usuario por parte de una entidad responsable de pago. | |
| items.informacionMedica.codigoPS | String | Código del prestador de servicios de salud | |
| items.informacionMedica.modalidadContratacion | String | Código de la modalidad de contratación y de pago pactada objeto de facturación. Véase la lista de Modalidades de Contratación | |
| items.informacionMedica.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. Véase la lista de Modalidades de Contratación | |
| items.informacionMedica.numeroMiPres | String | Número que asigna MIPRES a la prescripción de servicios y tecnologías en salud o servicios complementarios no financiados con recursos de la UPC que un profesional de la salud ordena a una persona. | |
| items.informacionMedica.idEntregaMiPres | String | Número de ID que se asigna a la entrega de servicios y tecnologías en salud o servicios complementarios no financiados con recursos de la UPC. | |
| items.informacionMedica.numeroContrato | String | Número del contrato objeto de facturación. | |
| items.informacionMedica.numeroPoliza | String | Número de póliza SOAT o del número de póliza de planes voluntarios de salud. | |
| items.informacionMedica.copago | numérico | Valor total del copago cancelado por el usuario. | |
| items.informacionMedica.cuotaModeradora | numérico | Valor efectivamente pagado por el usuario y recaudado por el prestador de servicios de salud, correspondiente a la cuota moderadora. | |
| items.informacionMedica.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. | |
| items.informacionMedica.pagosCompartidos | numérico | Valor efectivamente pagado por el usuario y recaudado por el prestador de servicios de salud, correspondiente a la cuota moderadora. | |
| items.informacionMedica.paciente | Paciente | Datos del paciente. | |
| items.informacionMedica.paciente.primerNombre | Alfanumérico | 100 | Primer nombre del paciente. |
| items.informacionMedica.paciente.segundoNombre | Alfanumérico | 100 | Segundo nombre del paciente. |
| items.informacionMedica.paciente.primerApellido | Alfanumérico | 100 | Primer apellido del paciente. |
| items.informacionMedica.paciente.segundoApellido | Alfanumérico | 100 | Segundo apellido del paciente. |
| items.informacionMedica.paciente.fechaNacimiento | Alfanumérico | 100 | Fecha de nacimiento del paciente. |
| items.informacionMedica.paciente.email | Alfanumérico | 100 | Correo Electrónico. |
| items.informacionMedica.paciente.telefono | Alfanumérico | 100 | Número Telefonico. |
| items.informacionMedica.paciente.tipoUsuario | Alfanumérico | Código del tipo de afiliación o el relacionamiento de la persona frente a la cobertura o el plan de beneficios a través de la cual se prestan los servicios o tecnologías en salud reportados en la factura de venta. Ver valores de tipo de usuario | |
| items.informacionMedica.paciente.tipoIdentificacion | Alfanumérico | Tipo de Identificación paciente (Nombre CORTO de la tabla de tipos de documento. ) | |
| items.informacionMedica.paciente.numIdentificacion | Alfanumérico | 20 | Número de identificación |
| periodoFacturacion | Información del periodo de facturación asociado a la factura. | ||
| periodoFacturacion.fechaInicial | String | 10 | Fecha de inicio del periodo de facturación en formato YYYY-MM-DD. |
| periodoFacturacion.horaInicial | String | Hora de la fecha de inicio del periodo de facturación en formato hh:mm:ss | |
| periodoFacturacion.fechaFinal | String | Fecha de inicio del periodo de facturación en formato YYYY-MM-DD | |
| periodoFacturacion.horaFinal | String | Hora de la fecha de finalización del periodo de facturación en formato hh:mm:ss | |
| urlDescargaAdjuntos | Describe los datos donde el emisor dispone de la información complementaria a los documentos electrónicos que el adquiriente puede ingresar y descargar directamente sin la necesidad de ingresas credenciales (Usuario/Contraseña) | ||
| urlDescargaAdjuntos.url | Dirección donde se accede a la información complementaria | ||
| urlDescargaAdjuntos.parametros |
Parámetros de la URL con sus respectivos valores. Cada parámetro se
separa por coma “,” y a su vez el nombre y valor del parámetro va
separado por el símbolo dos puntos “:”.
Ejemplo: nombre:Andrea;edad:24 Indica los parámetros: nombre = Andrea edad= 24 |
||
| wsEntregaEventos | Grupo de información utilizado para la recepción los eventos que se genere por parte de Adquiriente. Corresponde a un acuerdo o formalidad entre las partes (Emisor y Receptor). | ||
| wsEntregaEventos.url | String | Dirección del Web Service | |
| wsEntregaEventos.parametros | String |
Parámetros del Web Service con sus respectivos valores. Cada parámetro
se separa por coma “,” y a su vez el nombre y valor del parámetro va
separado por el símbolo dos puntos “:”.
Ejemplo: nombre:Andrea;edad:24
Indica los parámetros: nombre = Andrea edad= 24 |
| Nombre | codigo |
|---|---|
| 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 |
Consideraciones:
- Si desea que el origen de los cálculos de los ítems de la factura sea el precio con impuesto, debe enviar el atributo items.precioVentaUnitario. Si por el contrario desea que el origen de los cálculos sea el precio base unitario, envíe el atributo items.precioBaseUnitario.
- No envíe en un mismo ítem los atributos items.precioBaseUnitario e items.precioVentaUnitario a la vez.
Respuesta:
| 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 la acción bajo la cual se respondió esta respuesta |
| data.numeroNotaDebito | Alfanumérico | Datos de respuesta |
| data.cufe | Alfanumérico | Cufe de la nota débito creada |
Correcto
En caso de que la petición se ejecute sin errores se devolverá la siguiente respuesta:
Error
Si la solicitud no es correcta, recibirás un estado HTTP o por consiguiente un mensaje explicando el posible error.
Crear Nota Crédito.
Contamos con la verificación y validación de tus notas crédito para lograr ser aceptadas y reportadas a la DIAN :
CABECERAS:
| CABECERAS | VALOR |
| Content-Type | application/json |
| Authorization | token de usuario |
METODO: "POST"
Consideraciones:
- Si desea que el origen de los cálculos de los ítems de la factura sea el precio con impuesto, debe enviar el atributo items.precioVentaUnitario. Si por el contrario desea que el origen de los cálculos sea el precio base unitario, envíe el atributo items.precioBaseUnitario.
- No envíe en un mismo ítem los atributos items.precioBaseUnitario e items.precioVentaUnitario a la vez.
Petición
| Nombre del campo | Formato | Tamaño | Descripción |
|---|---|---|---|
| nit | Alfanumérico | 100 | Hace referencia del NIT de la empresa. |
| numeroDocumentoComercial | numérico | 100 | Numero de la nota crédito |
| 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) |
| numeroFacturaAsociada | String | 100 | Numero de la factura asociada a la nota crédito. |
| tipo | String | 100 | Código de la DIAN que identifica el Tipo de la nota crédito, puede ser de tipo DEVOLUCION_BIENES o ANULACION |
| 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. revisar tabla medios de pago |
| Observación | Alfanumérico | 100 | Observación. |
| formaPago | numérico | 100 | Código de la DIAN asociado a la forma de pago del documento electrónico. revisar tablaformaPago |
| total | numérico | 100 | Valor total del documento electrónico. |
| cliente | Datos del Cliente del documento electrónico | ||
| cliente.nombreRazonSocial | Alfanumérico | 100 | Cliente: Razón social o Nombre |
| cliente.tipoIdentificacion | Alfanumérico | 100 | Codigo del tipo de identificación, vease la lista tipo de identificación. |
| cliente.numIdentificacion | númerico | 100 | Número de identificación de cliente |
| cliente.naturaleza | String | 100 | Naturaleza del cliente Juridica o Natural revisar tabla Naturaleza |
| cliente.direccion | Alfanumérico | 100 | Dirección Cliente |
| cliente.ciudad | numérico | 100 | Identificador de la ciudad del cliente, si la factura a la que se hace la nota es de tipo exportación. De lo contrario, enviar código DANE de la ciudad, véase la tabla ciudad |
| cliente.telefono | numérico | 100 | Telefono del cliente |
| cliente.email | Alfanumérico | 100 | correo Electronico |
| items | Array [] | Lineas de la factura. | |
| items.nombreItemVenta | Alfanumérico | 100 | Nombre del producto vendido |
| items.precioVentaUnitario | numérico | 100 | Precio de venta unitario del producto |
| items.precioBaseUnitario | numérico | 100 | Precio base unitario del producto. Este atributo remplaza a items.precioVentaUnitario en caso que desee que los cálculos del item se hagan a partir del precio base y no a partir del precio con impuesto. |
| items.precioReferencia | numérico | 100 | Precio de referencia del producto cuando éste se considera un regalo, es decir, su precio resultante es igual a cero. Este campo es obligatorio si items.descuentoPorcentaje = 100 o si items.precioVentaUnitario = 0 o items.precioBaseUnitario = 0 |
| items.cantidad | numérico | 100 | Cantidad vendida del item |
| items.impuesto | ImpuestoEnum | 100 | Impuesto aplicado, revisar tabla ImpuestoEnum |
| items.codigo | Alfanumérico | 100 | Código del producto vendido. |
| items.unidad | Alfanumérico | 100 | código de la DIAN de la Unidad del producto. REVISAR tabla unidad |
| items.codigoDescuento | Alfanuméricos | 100 | Código de la dian del tipo de descuento aplicado al item. |
| items.descuentoPorcentaje | numérico | 100 | porcentaje de descuento aplicado al item |
| items.observacion | Alfanumérico | 100 | Observación del item |
| items.anticipo | AnticipoFactura | Items de la factura. | |
| items.anticipo.valor | numerico | Valor del anticipo. | |
| items.anticipo.instrucciones | Alfanumerico | 5000 | Instrucciones o Descripción del anticipo. |
| items.retenciones | Array | Información relacionada con las retenciones | |
| items.retenciones.retencion | numérico | Código asociado a la retención, véase lista de retenciones. | |
| items.retenciones.valor | numérico | Valor de retención | |
| items.retenciones.porcentaje | numérico | VPorcentaje de la retención | |
| items.retenciones.baseGravable | numérico | Base Gravable de la retención | |
| items.informacionMedica | Array | líneas de información médica | |
| items.informacionMedica.autorizacion | String | número del aval para la prestación de un servicio de salud a un usuario por parte de una entidad responsable de pago. | |
| items.informacionMedica.codigoPS | String | Código del prestador de servicios de salud | |
| items.informacionMedica.modalidadContratacion | String | Código de la modalidad de contratación y de pago pactada objeto de facturación. Véase la lista de Modalidades de Contratación | |
| items.informacionMedica.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. Véase la lista de Modalidades de Contratación | |
| items.informacionMedica.numeroMiPres | String | Número que asigna MIPRES a la prescripción de servicios y tecnologías en salud o servicios complementarios no financiados con recursos de la UPC que un profesional de la salud ordena a una persona. | |
| items.informacionMedica.idEntregaMiPres | String | Número de ID que se asigna a la entrega de servicios y tecnologías en salud o servicios complementarios no financiados con recursos de la UPC. | |
| items.informacionMedica.numeroContrato | String | Número del contrato objeto de facturación. | |
| items.informacionMedica.numeroPoliza | String | Número de póliza SOAT o del número de póliza de planes voluntarios de salud. | |
| items.informacionMedica.copago | numérico | Valor total del copago cancelado por el usuario. | |
| items.informacionMedica.cuotaModeradora | numérico | Valor efectivamente pagado por el usuario y recaudado por el prestador de servicios de salud, correspondiente a la cuota moderadora. | |
| items.informacionMedica.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. | |
| items.informacionMedica.pagosCompartidos | numérico | Valor efectivamente pagado por el usuario y recaudado por el prestador de servicios de salud, correspondiente a la cuota moderadora. | |
| items.informacionMedica.paciente | Paciente | Datos del paciente. | |
| items.informacionMedica.paciente.primerNombre | Alfanumérico | 100 | Primer nombre del paciente. |
| items.informacionMedica.paciente.segundoNombre | Alfanumérico | 100 | Segundo nombre del paciente. |
| items.informacionMedica.paciente.primerApellido | Alfanumérico | 100 | Primer apellido del paciente. |
| items.informacionMedica.paciente.segundoApellido | Alfanumérico | 100 | Segundo apellido del paciente. |
| items.informacionMedica.paciente.fechaNacimiento | Alfanumérico | 100 | Fecha de nacimiento del paciente. |
| items.informacionMedica.paciente.email | Alfanumérico | 100 | Correo Electrónico. |
| items.informacionMedica.paciente.telefono | Alfanumérico | 100 | Número Telefonico. |
| items.informacionMedica.paciente.tipoUsuario | Alfanumérico | Código del tipo de afiliación o el relacionamiento de la persona frente a la cobertura o el plan de beneficios a través de la cual se prestan los servicios o tecnologías en salud reportados en la factura de venta. Ver valores de tipo de usuario | |
| items.informacionMedica.paciente.tipoIdentificacion | Alfanumérico | Tipo de Identificación paciente (Nombre CORTO de la tabla de tipos de documento. ) | |
| items.informacionMedica.paciente.numIdentificacion | Alfanumérico | 20 | Número de identificación |
| periodoFacturacion | Información del periodo de facturación asociado a la factura. | ||
| periodoFacturacion.fechaInicial | String | 10 | Fecha de inicio del periodo de facturación en formato YYYY-MM-DD. |
| periodoFacturacion.horaInicial | String | Hora de la fecha de inicio del periodo de facturación en formato hh:mm:ss | |
| periodoFacturacion.fechaFinal | String | Fecha de inicio del periodo de facturación en formato YYYY-MM-DD | |
| periodoFacturacion.horaFinal | String | Hora de la fecha de finalización del periodo de facturación en formato hh:mm:ss | |
| urlDescargaAdjuntos | Describe los datos donde el emisor dispone de la información complementaria a los documentos electrónicos que el adquiriente puede ingresar y descargar directamente sin la necesidad de ingresas credenciales (Usuario/Contraseña) | ||
| urlDescargaAdjuntos.url | Dirección donde se accede a la información complementaria | ||
| urlDescargaAdjuntos.parametros |
Parámetros de la URL con sus respectivos valores. Cada parámetro se
separa por coma “,” y a su vez el nombre y valor del parámetro va
separado por el símbolo dos puntos “:”.
Ejemplo: nombre:Andrea;edad:24 Indica los parámetros: nombre = Andrea edad= 24 |
||
| wsEntregaEventos | Grupo de información utilizado para la recepción los eventos que se genere por parte de Adquiriente. Corresponde a un acuerdo o formalidad entre las partes (Emisor y Receptor). | ||
| wsEntregaEventos.url | String | Dirección del Web Service | |
| wsEntregaEventos.parametros | String |
Parámetros del Web Service con sus respectivos valores. Cada parámetro
se separa por coma “,” y a su vez el nombre y valor del parámetro va
separado por el símbolo dos puntos “:”.
Ejemplo: nombre:Andrea;edad:24
Indica los parámetros: nombre = Andrea edad= 24 |
Para tener en cuenta:
Si desea realizar una nota crédito cuyo atributo Tipo sea : ANULACION , el atributo items debe ser igual a null o vació.
Respuesta
| 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 la acción bajo la cual se respondió esta respuesta |
| data.numeroNotaCredito | Alfanumérico | Datos de respuesta |
| data.cufe | Alfanumérico | Cufe de la nota crédito creada |
| errores | Alfanumérico | Objeto con detalles globales de errores. |
| total_errores | Numérico | Número total de errores |
| errores.errores | Array | Array, con la lista de errores. |
| errores.errores.codError | Alfanúmerico | Código de error. |
| errores.errores.errorMessage | Alfanúmerico | Mensaje del error. |
Correcto
En caso de que la petición se ejecute sin errores se devolverá la siguiente respuesta:
Error
Si la solicitud no es correcta, recibiras un estado HTTP o por consiguiente un mensaje explicando el posible error.
Los comentarios están cerrados.