Copyright Teleinte SAS 2021
Para mayor información en operaciones@teleinte.com

EndPoint


Observación: Información sujeta a cambios

Método: POST

EndPoint:

Pruebas
https://servicios-pruebas.afacturar.com/api/rips/cargar_fe_rips

Producción
https://servicios.afacturar.com/api/rips/cargar_fe_rips

Seguridad SSL: Afacturar cuenta en sus endpoint con certificados de seguridad (DigiCert SHA2 Extended Validation Server CA), su aplicación debe ser capaz de negociar y validar dicho certificado.

Parámetros de entrada


HEADERS


Accept: application/json

Authorization: Bearer Token asignado a cada cliente


BODY


documento_obligado: Número de identificación del cliente

data: JSON

json_rips: JSON


Estructura de JSON de entrada - data



informacion_documento Objeto Requerido

Información del documento electronico

Especificación:

informacion_documento Objeto Requerido

Información del docukmento electronico

Especificación:

cufe_cude String Requerido

CUFE o CUDE del documento electronico

Especificación: Minimo de 90 caracteres. El CUFE o CUDE debe estar registrado en nuestro sistema

fecha_documento Date Requerido

Fecha de emisión del documento electronico

Especificación: AAAA-MM-DD

numero_documento Parametrizado Requerido

Identificador del documento electronico, prefijo+numero_documento

Especificación: Mínimo 2 caracteres,

generalidades Objeto Requerido

Generalidades

Especificación:

tipo_ambiente_dian Parametrizado Requerido

Ambiente de la DIAN al que se destina el documento enviado.

Especificación:

1= Producción

2= Pruebas

identificador_transmision String Requerido

Código único para identificar el paquete transmitido

Especificación: Mínimo 5 caracteres

integrador Objeto Requerido

Información de quien envia la información

Especificación:

nombre Parametrizado Requerido

Nombre de quien realiza la integración

Especificación: S o N

tipo Parametrizado Requerido

Codigo del medio usado para realizar la integración

Especificación:

MOVIL

WEB

DLL

EXCEL

ERP-XXXXXXXXX

Estructura json

							{
    "informacion_documento": {
        "cufe_cude": "",
        "fecha_documento": "",
        "numero_documento": ""
    },
    "generalidades": {
        "tipo_ambiente_dian": "",
        "identificador_transmision": "",
        "integrador": {
            "nombre": "",
            "tipo": ""
        }
    }
}							

Estructura de JSON de entrada - RIPS



numDocumentoldObligado String Requerido

Número del NIT con el cual se identifique el facturador electrónico en salud.

Especificación:

numFactura String No_Requerido

Número que corresponda al sistema de numeración consecutiva según las disposiciones de la DIAN

Especificación:

tipoNota String No_Requerido

Tipo de nota débito o crédito, o nota ajuste RIPS que se requiere realizar para un ajuste contable o en las facturas, ya sea por errores o por el cambio de condiciones que generan un mayor o menor valor monetario de la respectiva cuenta o la necesidad de ajustar RIPS en aquellos casos cuando no exista ajuste en el valor monetario

Especificación:

numNota String No_Requerido

Número de la nota crédito, débito o nota ajuste RIPS emitida por el facturador electrónico en salud.

Especificación:

usuarios array Requerido

Datos del usuario

Especificación:

tipoDocumentoIdentificacion String - Parametrizado Requerido

Tipo de documento de identificación del usuario.

Especificación:

CodigoDescripción
ASAdulto sin identificacion
CCCedula de Ciudadania
CDCarnet Diplomatico
CECedula de Extranjeria
CNCertificado de nacido vivo
DEDocumento extranjero
MSMenor sin identificacion
NINúmero de identificación tributario NIT
NVCertificado nacido vivo
PAPasaporte
PEPermiso Especial de Permanencia
PTPermiso por protección temporal
RCRegistro civil
SCSalvoconducto
SISin identificación
TITarjeta de Identidad

numDocumentoIdentificacion String Requerido

Corresponde al número del documento de identificación del usuario.

Especificación: Minimo 4 caracteres, maximo 20 caracteres

tipoUsuario String - Parametrizado Requerido

Identificador para determinar la condición del usuario en relación con el Sistema de Salud según la cobertura al momento de la atención.

Especificación:

CodigoDescripción
01Contributivo cotizante
02Contributivo beneficiario
03Contributivo adicional
04Subsidiado
05No afiliado
06Especial o Excepcion cotizante
07Especial o Excepcion beneficiario
08Personas privadas de la libertad a cargo del Fondo Nacional de Salud
09Tomador / Amparado ARL
10Tomador / Amparado SOAT
11Tomador / Amparado Planes voluntarios de salud
12Particular
13Especial o Exepcion no cotizante Ley 352 de 1997

fechaNacimiento Date Requerido

Fecha de nacimiento del usuario.

Especificación: AAAA-MM-DD

codSexo String - Parametrizado Requerido

Identificador de sexo según aparece en el documento de identificación registrado en el campo numDocumentoldentificacion.

Especificación:

CodigoDescripción
HHombre
MMujer
IIndeterminado o Intersexual

codPaisResidencia String - Parametrizado Requerido

Código del país de residencia habitual.

Especificación: Estandar ISO 3166-1. Inf adicional Ver

codMunicipioResidencia Parametrizado Requerido

Código del municipio de residencia habitual, Código a cinco caracteres según la clasificación sociopolitica del DANE. Si el país es Colombia, este campo no puede informarse null.

Especificación: ISO 3166-2:CO. Inf adicional Ver

codZonaTerritorialResidencia String - Parametrizado Requerido

Identificador del DANE para determinar la zona de residencia del usuario.

Especificación:

CodigoDescripción
01Rural
02Urbano

incapacidad String - Parametrizado Requerido

Identificador de la expedición de una incapacidad soportada en la atención en salud que se reporta en RIPS.

Especificación:

CodigoDescripción
SISi
NONo

consecutivo Numerico Requerido

Número consecutivo que identifique el registro.

Especificación: 1...n

codPaisOrigen String - Parametrizado Requerido

Código del país de residencia habitual.

Especificación: Estandar ISO 3166-1. Inf adicional Ver

consultas Objeto Requerido

consultas

Especificación:

codPrestador String Requerido

Código otorgado por el Ministerio de Salud y Protección Social al prestador de servicios de salud o del obligado a reportar. El código del facturador electrónico en salud se debe encontrar en la tabla IPSCodHabilitación para prestadores de servicios de salud o en IPSnoREPS para prestadores exceptuados del registro en REPS.

Especificación: Tamaño de 12 caracteres

fechalnicioAtencion Datetime Requerido

Fecha y hora de la consulta.

Especificación: AAAA-MM-DD HH:MM:SS

numAutorizacion String Requerido

Número asignado por la entidad responsable de pago o demás pagadores a los que aplique, para ordenar la prestación o provisión de servicios o tecnologías de salud. Cuando el servicio de salud no requiera autorización se informa null.

Especificación: Maximo 20 caracteres, permite null

codConsulta String - Parametrizado Requerido

Código de la consulta definido en el Sistema, según la Clasificación Única de Procedimientos en Salud, CUPS.

Especificación: Inf adicional Ver

modalidadGrupoServicioTecSal String - Parametrizado Requerido

Identificador para determinar la forma de prestar un servicio de salud en condiciones particulares en relación con el grupo de servicios

Especificación:

CodigoDescripción
1Intramural
2Extramural unidad móvil
3Extramural domiciliaria
4Extramural jornada de salud
6Telemedicina interactiva
7Telemedicina no interactiva
8Telemedicina telexperticia
9Telemedicina telemonitoreo

grupoServicios String - Parametrizado Requerido

Representa el conjunto de Servicios que se encuentran relacionados entre si y que comparten similitudes en la forma de prestación, en los estándares y criterios que deben cumplir.

Especificación:

CodigoDescripción
1Consulta externa
2Apoyo diagnóstico y complementación terapéutica
3Internación
4Quirúrgico
5Atención inmediata

codServicio String - Parametrizado Requerido

Código del servicio que según la norma de habilitación del SGSSS representa la unidad básica habilitante del Sistema Único de Habilitación, conformado por procesos, procedimientos, actividades, recurso humano, físicos, tecnológicos y de información con un alcance definido, que tiene por objeto satisfacer las necesidades en salud en el marco de la seguridad del paciente y en cualquiera de las fases de atención en salud.

Especificación: Inf adicional Ver

finalidadTecnologiaSalud String - Parametrizado Requerido

Identificador de la finalidad con que se realiza la consulta.

Especificación: Inf adicional Ver

causaMotivoAtencion String - Parametrizado Requerido

Identificador de la causa que origina el servido de salud — consulta.

Especificación: Inf adicional Ver

codDiagnosticoPrincipal String - Parametrizado Requerido

Código del diagnóstico principal confirmado o presuntivo, según la versión vigente de la Clasificación Internacional de Enfermedades — CIE

Especificación: Inf adicional Ver

codDiagnosticoRelacionadol String - Parametrizado Requerido

Código del diagnóstico relacionado número 1 confirmado o presuntivo, según la versión vigente de la Clasificación Internacional de Enfermedades — CIE.

Especificación: Inf adicional Ver

codDiagnosticoRelacionado2 String - Parametrizado Requerido

Código del diagnóstico relacionado número 2 confirmado o presuntivo, según la versión vigente de la Clasificación Internacional de Enfermedades — CIE.

Especificación: Inf adicional Ver

codDiagnosticoRelacionado3 String - Parametrizado Requerido

Código del diagnóstico relacionado número 3 confirmado o presuntivo, según la versión vigente de la Clasificación Internacional de Enfermedades — CIE.

Especificación: Inf adicional Ver

tipoDiagnosticoPrincipal String - Parametrizado Requerido

Identificador para determinar si el diagnóstico es confirmado o presuntivo.

Especificación:

CodigoDescripción
01Impresión diagnóstica
02Confirmado nuevo
03Confirmado repetido

tipoDocumentoIdentificacion String - Parametrizado Requerido

Corresponde al tipo de documento de identificación de la persona que realizó la consulta

Especificación:

CodigoDescripción
ASAdulto sin identificacion
CCCedula de Ciudadania
CDCarnet Diplomatico
CECedula de Extranjeria
CNCertificado de nacido vivo
DEDocumento extranjero
MSMenor sin identificacion
NINúmero de identificación tributario NIT
NVCertificado nacido vivo
PAPasaporte
PEPermiso Especial de Permanencia
PTPermiso por protección temporal
RCRegistro civil
SCSalvoconducto
SISin identificación
TITarjeta de Identidad

numDocumentoIdentificacion String Requerido

Corresponde al número del documento de identificación de la persona que realizó la consulta.

Especificación: Minimo 4 caracteres, maximo 20 caracteres

vrServicio Numerico Requerido

Valor monetario de la consulta según el manual tarifario o la tarifa pactada en el acuerdo de voluntades

Especificación: 1...n

conceptoRecaudo String - Parametrizado Requerido

Tipo de pago moderador según el plan de beneficios o planes o pólizas adquiridas.

Especificación:

CodigoDescripción
01COPAGO
02CUOTA MODERADORA
03PAGOS COMPARTIDOS EN PLANES VOLUNTARIOS DE SALUD
04ANTICIPO
05NO APLICA

valorPagoModerador Numerico Requerido

Valor monetario del pago moderador.

Especificación: 1...n

numFEVPagoModerador String Requerido

Número de factura electrónica de venta o documento equivalente emitido al usuario y que soporte el valor registrado en el campo C19 o informado por la entidad responsable de pago o demás pagadores

Especificación: Cuando no aplique pago moderador se debe informar null

consecutivo Numerico Requerido

Número consecutivo que identifique el registro

Especificación: 1...n

procedimientos Objeto Requerido

procedimientos

Especificación:

codPrestador String Requerido

Código otorgado por el Ministerio de Salud y Protección Social al prestador de servicios de salud o del obligado a reportar. El código del facturador electrónico en salud se debe encontrar en la tabla IPSCodHabilitación para prestadores de servicios de salud o en IPSnoREPS para prestadores exceptuados del registro en REPS

Especificación: Tamaño de 12 caracteres

fechalnicioAtencion Datetime Requerido

Fecha y hora de realización del procedimiento

Especificación: AAAA-MM-DD HH:MM:SS

idMIPRES String Requerido

Corresponde al número de ID que se asigna a la entrega de procedimientos financiados con presupuesto máximo. Cuando el procedimiento no es financiado por presupuesto máximo se debe informar null a menos que el procedimiento sea solicitado a través de la herramienta MIPRES, en este caso debe informar el número de ID de entrega correspondiente. Se puede validar que el número de ID de entrega corresponda al registrado en MIPRES.

Especificación: Maximo de 15 caracteres

numAutorizacion String Requerido

Número asignado por la entidad responsable de pago o demás pagadores a los que aplique, para ordenar la prestación o provisión de servicios o tecnologías de salud. Cuando el servicio de salud no requiera autorización se informa null

Especificación: Maximo 30 caracteres, permite null

codProcedimiento String - Parametrizado Requerido

Código del procedimiento definido en el Sistema, según la Clasificación Única de Procedimientos en Salud, CUPS.

Especificación: Inf adicional Ver

viaIngresoServicioSalud String - Parametrizado Requerido

Identificador para determinar la vía de ingreso del usuario al servicio.

Especificación: Inf adicional Ver

modalidadGrupoServicioTecSal String - Parametrizado Requerido

Identificador para determinarla forma de prestar un servicio de salud en condiciones particulares en relación con el grupo de servicios.

Especificación:

CodigoDescripción
01Intramural
02Extramural unidad móvil
03Extramural domiciliaria
04Extramural jornada de salud
06Telemedicina interactiva
07Telemedicina no interactiva
08Telemedicina telexperticia
09Telemedicina telemonitoreo

grupoServicios String - Parametrizado Requerido

Representa el conjunto de Servicios que se encuentran relacionados entre si y que comparten similitudes en la forma de prestación, en los estándares y criterios que deben cumplir.

Especificación:

CodigoDescripción
1Consulta externa
2Apoyo diagnóstico y complementación terapéutica
3Internación
4Quirúrgico
5Atención inmediata

codServicio String - Parametrizado Requerido

Código del servicio que según la norma de habilitación del SGSSS representa la unidad básica habilitante del Sistema Único de Habilitación, conformado por procesos, procedimientos, actividades, recurso humano, físicos, tecnológicos y de información con un alcance definido, que tiene por objeto satisfacer las necesidades en salud en el marco de la seguridad del paciente y en cualquiera de las fases de atención en salud.

Especificación: Inf adicional Ver

finalidadTecnologiaSalud String - Parametrizado Requerido

Identificador de la finalidad con que serealiza la consulta.

Especificación: Inf adicional Ver

tipoDocumentoIdentificacion String - Parametrizado Requerido

Corresponde al tipo de documento de identificación de la persona que realizó el procedimiento

Especificación:

CodigoDescripción
ASAdulto sin identificacion
CCCedula de Ciudadania
CDCarnet Diplomatico
CECedula de Extranjeria
CNCertificado de nacido vivo
DEDocumento extranjero
MSMenor sin identificacion
NINúmero de identificación tributario NIT
NVCertificado nacido vivo
PAPasaporte
PEPermiso Especial de Permanencia
PTPermiso por protección temporal
RCRegistro civil
SCSalvoconducto
SISin identificación
TITarjeta de Identidad

numDocumentoIdentificacion String Requerido

Corresponde al número del documento de identificación de la persona que realizó el procedimiento.

Especificación: Minimo 4 caracteres, maximo 20 caracteres

codDiagnosticoPrincipal String - Parametrizado Requerido

Código del diagnóstico principal confirmado o presuntivo, según la versión vigente de la Clasificación Internacional de Enfermedades — CIE

Especificación: Inf adicional Ver

codDiagnosticoRelacionado String - Parametrizado Requerido

Código del diagnóstico relacionado número 1 confirmado o presuntivo, según la versión vigente de la Clasificación Internacional de Enfermedades — CIE.

Especificación: Inf adicional Ver

codComplicacion String - Parametrizado Requerido

Código del diagnóstico confirmado o presuntivo, según la versión vigente de la Clasificación Internacional de Enfermedades — CIE.

Especificación: Inf adicional Ver

vrServicio Numerico Requerido

Valor monetario del procedimiento según el manual tarifario o la tarifa pactada en el acuerdo de voluntades.

Especificación: 1...n

conceptoRecaudo String - Parametrizado Requerido

Tipo de pago moderador según el plan de beneficios o planes o pólizas adquiridas.

Especificación:

CodigoDescripción
01COPAGO
02CUOTA MODERADORA
03PAGOS COMPARTIDOS EN PLANES VOLUNTARIOS DE SALUD
04ANTICIPO
05NO APLICA

valorPagoModerador Numerico Requerido

Valor monetario del pago moderador

Especificación: 1...n

numFEVPagoModerador String Requerido

Número de factura electrónica de venta emitida al usuario y que soporte el valor registrado en el campo P18 o informado por la entidad responsable de pago o demás pagadores.

Especificación: Cuando no aplique pago moderador se debe informar null

consecutivo Numerico Requerido

Número consecutivo que identifique el registro

Especificación: 1...n

urgencias Objeto Requerido

urgencias

Especificación:

codPrestador String Requerido

Código otorgado por el Ministerio de Salud y Protección Social al prestador de servicios de salud o del obligado a reportar. El código del facturador electrónico en salud se debe encontrar en la tabla IPSCodHabilitación para prestadores de servicios de salud o en IPSnoREPS para prestadores exceptuados del registro en REPS

Especificación: Tamaño de 12 caracteres

fechalnicioAtencion Datetime Requerido

Fecha y hora de ingreso del usuario a urgencias con observación.La fecha y hora de ingreso no debe ser mayor a la fecha y hora de validación de los RIPS ni menor a la fecha de nacimiento del usuario. Asimismo, no debe ser mayor a la fecha y hora de egreso.

Especificación: AAAA-MM-DD HH:MM:SS

causaMotivoAtencion String - Parametrizado Requerido

Identificador de la causa que origina el servido de salud.

Especificación: Inf adicional Ver

codDiagnosticoPrincipal String - Parametrizado Requerido

Código del diagnóstico principal confirmado o presuntivo, según la versión vigente de la Clasificación Internacional de Enfermedades — CIE.

Especificación: Inf adicional Ver

codDiagnosticoPincipalE String - Parametrizado Requerido

Código del diagnóstico relacionado número 1 confirmado o presuntivo, según la versión vigente de la Clasificación Internacional de Enfermedades — CIE.

Especificación: Inf adicional Ver

codDiagnosticoRelacionadoEl String - Parametrizado Requerido

Código del diagnóstico relacionado número 1 confirmado o presuntivo, según la versión vigente de la Clasificación Internacional de Enfermedades — CIE.

Especificación: Inf adicional Ver

codDiagnosticoRelacionadoE2 String - Parametrizado Requerido

Código del diagnóstico relacionado número 2 confirmado o presuntivo, según la versión vigente de la Clasificación Internacional de Enfermedades — CIE.

Especificación: Inf adicional Ver

codDiagnosticoRelacionadoE3 String - Parametrizado Requerido

Código del diagnóstico relacionado número 3 confirmado o presuntivo, según la versión vigente de la Clasificación Internacional de Enfermedades — CIE.

Especificación: Inf adicional Ver

condicionDestinoUsuarioEgreso String Requerido

Identificador para determinar la condición y el destino del paciente al egreso de la atención de urgencia con observación, según aplique

Especificación:

CodigoDescripción
01PACIENTE CON DESTINO A SU DOMICILIO
02PACIENTE MUERTO
03PACIENTE DERIVADO A OTRO SERVICIO
04REFERIDO A OTRA INSTITUCION
05CONTRAREFERIDO A OTRA INSTITUCION
06DERIVADO O REFERIDO A HISPOTALIZACION DOMICILIARIA
07DERIVADO A SERVICIO SOCIAL
08PACIENTE CONTINUA EN EL SERVICIO(CORTE FACTURACION)

codDiagnosticoCausaMuerte String - Parametrizado Requerido

Código del diagnóstico de causa básica de muerte confirmado o presuntivo, según la versión vigente de la Clasificación Internacional de Enfermedades — CIE.

Especificación: Inf adicional Ver

fechaEgreso Datetime Requerido

Fecha y hora de egreso del usuario de urgencias con observación. En caso de muerte corresponderá a la fecha y hora de la muerte del usuario. El rango comprendido entre la fecha/hora de ingreso y la fecha/hora de egreso no puede superar las 48 horas.

Especificación: AAAA-MM-DD HH:MM:SS

consecutivo Numerico Requerido

Número consecutivo que identifique el registro

Especificación: 1...n

hospitalizacion Objeto Requerido

hospitalizacion

Especificación:

codPrestador String Requerido

Código otorgado por el Ministerio de Salud y Protección Social al prestador de servicios de salud o del obligado a reportar. El código del facturador electrónico en salud se debe encontrar en la tabla IPSCodHabilitación para prestadores de servicios de salud o en IPSnoREPS para prestadores exceptuados del registro en REPS

Especificación: Tamaño de 12 caracteres

viaIngresoServicioSalud String - Parametrizado Requerido

Identificador para determinar la vía de ingreso del usuario al servicio.

Especificación: Inf adicional Ver

fechalnicioAtencion Datetime Requerido

Fecha y hora de ingreso del usuario a hospitalización. La fecha y hora de ingreso no debe ser mayor a la fecha y hora de validación de los RIPS. Así mismo, no debe ser mayor a la fecha y hora de egreso.

Especificación: AAAA-MM-DD HH:MM:SS

numAutorizacion String Requerido

Número asignado por la entidad responsable de pago o demás pagadores a los que aplique, para ordenar la prestación o provisión de servicios o tecnologías de salud. Cuando el servicio de salud no requiera autorización se informa null.

Especificación: Maximo 30 caracteres, permite null

causaMotivoAtencion String - Parametrizado Requerido

Identificador de la causa que origina el servido de salud — consulta.

Especificación: Inf adicional Ver

codDiagnosticoPrincipal String - Parametrizado Requerido

Código del diagnóstico principal confirmado o presuntivo, según la versión vigente de la Clasificación Internacional de Enfermedades — CIE.

Especificación: Inf adicional Ver

codDiagnosticoPincipalE String - Parametrizado Requerido

Código del diagnóstico relacionado número 1 confirmado o presuntivo, según la versión vigente de la Clasificación Internacional de Enfermedades — CIE.

Especificación: Inf adicional Ver

codDiagnosticoRelacionadoEl String - Parametrizado Requerido

Código del diagnóstico relacionado número 1 confirmado o presuntivo, según la versión vigente de la Clasificación Internacional de Enfermedades — CIE.

Especificación: Inf adicional Ver

codDiagnosticoRelacionadoE2 String - Parametrizado Requerido

Código del diagnóstico relacionado número 2 confirmado o presuntivo, según la versión vigente de la Clasificación Internacional de Enfermedades — CIE.

Especificación: Inf adicional Ver

codDiagnosticoRelacionadoE3 String - Parametrizado Requerido

Código del diagnóstico relacionado número 3 confirmado o presuntivo, según la versión vigente de la Clasificación Internacional de Enfermedades — CIE.

Especificación: Inf adicional Ver

codComplicacion String - Parametrizado Requerido

Código del diagnóstico confirmado o presuntivo, según la versión vigente de la Clasificación Internacional de Enfermedades — CIE.

Especificación: Inf adicional Ver

condicionDestinoUsuarioEgreso String Requerido

Identificador para determinar la condición y el destino del paciente al egreso de la atención de urgencia con observación, según aplique

Especificación:

CodigoDescripción
01PACIENTE CON DESTINO A SU DOMICILIO
02PACIENTE MUERTO
03PACIENTE DERIVADO A OTRO SERVICIO
04REFERIDO A OTRA INSTITUCION
05CONTRAREFERIDO A OTRA INSTITUCION
06DERIVADO O REFERIDO A HISPOTALIZACION DOMICILIARIA
07DERIVADO A SERVICIO SOCIAL
08PACIENTE CONTINUA EN EL SERVICIO(CORTE FACTURACION)

codDiagnosticoCausaMuerte String - Parametrizado Requerido

Código del diagnóstico de causa básica de muerte confirmado o presuntivo, según la versión vigente de la Clasificación Internacional de Enfermedades — CIE.

Especificación: Inf adicional Ver

fechaEgreso Datetime Requerido

Fecha y hora de egreso del usuario de hospitalizadon. En caso de muerte corresponderá a la fecha y hora de la muerte del usuario. La fecha y hora de egreso no debe ser mayor a la fecha y hora de validación de los RIPS. Asi mismo, no debe encontrarse por fuera del periodo de facturación según los datos de la factura electrónica de venta.

Especificación: AAAA-MM-DD HH:MM:SS

consecutivo Numerico Requerido

Número consecutivo que identifique el registro.

Especificación: 1...n

recienNacidos Objeto Requerido

recienNacidos

Especificación:

codPrestador String Requerido

Código otorgado por el Ministerio de Salud y Protección Social al prestador de servicios de salud o del obligado a reportar. El código del facturador electrónico en salud se debe encontrar en la tabla IPSCodHabilitación para prestadores de servicios de salud o en IPSnoREPS para prestadores exceptuados del registro en REPS

Especificación: Tamaño de 12 caracteres

tipoDocumentoldentificacion String - Parametrizado Requerido

Identificador del tipo de identificación del recién nacido de acuerdo con su documento de identificación. De acuerdo con la Resolución 3280 de 2018 todo recién nacido debe contar con el certificado de nacido vivo expedido por el médico que atendió el parto, únicamente se podrá usar la opción MS: Menor sin identificar de acuerdo con la Resolución 1133 de 2021.

Especificación:

CodigoDescripción
CNCertificado de nacido vivo
MSMenor sin identificacion
RCRegistro civil

numDocumentoIdentificacion String Requerido

Corresponde al número del documento de identificación del recién nacido.

Especificación: Minimo 4 caracteres, maximo 20 caracteres

fechaNacimiento Date Requerido

Fecha y hora de nacimiento del recién nacido

Especificación: AAAA-MM-DD

edadGestacional Numerico Requerido

Número de semanas de gestación de la madre al momento del parto

Especificación: Tamaño de 2 caracteres

numConsultasCPrenatal Numerico Requerido

Número de consultas para el cuidado prenatal.

Especificación: Tamaño de 2 caracteres

codSexoBiologico String - Parametrizado Requerido

Identificador de sexo según aparece en el documento de identificación registrado en el campo numDocumentoldentificacion

Especificación:

CodigoDescripción
HHombre
MMujer
IIndeterminado o Intersexual

peso Numerico Requerido

Peso en gramos del recién nacido.

Especificación: Tamaño de maximo 4 caracteres

codDiagnosticoPrincipal String - Parametrizado Requerido

Código del diagnóstico principal confirmado o presuntivo, según la versión vigente de la Clasificación Internacional de Enfermedades — CIE

Especificación: Inf adicional Ver

condicionDestinoUsuarioEgreso String Requerido

Identificador para determinar la condición y el destino del paciente al egreso de la atención de urgencia con observación, según aplique

Especificación:

CodigoDescripción
01PACIENTE CON DESTINO A SU DOMICILIO
02PACIENTE MUERTO
03PACIENTE DERIVADO A OTRO SERVICIO
04REFERIDO A OTRA INSTITUCION
05CONTRAREFERIDO A OTRA INSTITUCION
06DERIVADO O REFERIDO A HISPOTALIZACION DOMICILIARIA
07DERIVADO A SERVICIO SOCIAL
08PACIENTE CONTINUA EN EL SERVICIO(CORTE FACTURACION)

codDiagnosticoCausaMuerte String - Parametrizado Requerido

Código del diagnóstico de causa básica de muerte confirmado o presuntivo, según la versión vigente de la Clasificación Internacional de Enfermedades — CIE.

Especificación: Inf adicional Ver

fechaEgreso Datetime Requerido

Fecha y hora de egreso del recién nacido. En caso de muerte corresponderá a la fecha y hora de la muerte del recién nacido. La fecha y hora de egreso no debe ser mayor a la fecha y hora de validación de los RIPS. Asi mismo, no debe encontrarse por fuera del periodo de facturación según los datos de la factura electrónica de venta.

Especificación: AAAA-MM-DD HH:MM:SS

consecutivo Numerico Requerido

Número consecutivo que identifique el registro

Especificación: 1...n

medicamentos Objeto Requerido

medicamentos

Especificación:

codPrestador String Requerido

Código otorgado por el Ministerio de Salud y Protección Social al prestador de servicios de salud o del obligado a reportar. El código del facturador electrónico en salud se debe encontrar en la tabla IPSCodHabilitación para prestadores de servicios de salud o en IPSnoREPS para prestadores exceptuados del registro en REPS

Especificación: Tamaño de 12 caracteres

numAutorizacion String Requerido

Número asignado por la entidad responsable de pago o demás pagadores a los que aplique, para ordenar la prestación o provisión de servicios o tecnologías de salud. Cuando el servicio de salud no requiera autorización se informa null

Especificación: Maximo 20 caracteres, permite null

idMIPRES String Requerido

Corresponde al número de ID que se asigna a la entrega de procedimientos financiados con presupuesto máximo. Cuando el procedimiento no es financiado por presupuesto máximo se debe informar null a menos que el procedimiento sea solicitado a través de la herramienta MIPRES, en este caso debe informar el número .de ID de entrega correspondiente. Se puede validar que el número de ID de entrega corresponda al registrado en MIPRES

Especificación: Maximo de 15 caracteres

fechaDispensAdmon Datetime Requerido

Corresponde a la fecha y hora en la cual se dispensó o administró el medicamento al paciente. La fecha y hora de dispensación no debe ser mayor a la fecha y hora de validación de los RIPS, ni menor a la fecha y hora de nacimiento del usuario. Asi mismo, no podrá encontrarse por fuera del periodo de facturación según los datos de la factura electrónica de venta.

Especificación: AAAA-MM-DD HH:MM:SS

codDiagnosticoPrincipal String - Parametrizado Requerido

Código del diagnóstico principal confirmado o presuntivo, según la versión vigente de la Clasificación Internacional de Enfermedades — CIE

Especificación: Inf adicional Ver

codDiagnosticoRelacionado String - Parametrizado Requerido

Código del diagnóstico relacionado número 1 confirmado o presuntivo, según la versión vigente de la Clasificación Internacional de Enfermedades — CIE.

Especificación: Inf adicional Ver

tipoMedicamento String - Parametrizado Requerido

Identificador para determinar el tipo de medicamento de acuerdo con uso.

Especificación:

CodigoDescripción
01Medicamento con uso con registro sanitario
02Medicamento con uso como vital no disponible definido por INVIMA
03Preparacion magistral
04Medicamento con uso no incluido en el registro sanitario (Listado UNIRS)
05Medicamento con autorizacion sanitaria de uso emergencia ASUE

codTecnologiaSalud String - Parametrizado Requerido

Código del medicamento de acuerdo con las codificaciones vigentes para medicamentos esenciales codificación vigente.

Especificación: Inf adicional IUM- Ver Identificar Unico de Medicamento - IUM
CUMs Ver Código Único de Medicamento CUMs

nomTecnologiaSalud String - Parametrizado Requerido

Descripción textual del medicamento en nombre genérico

Especificación: Inf adicional Ver Donominación Común Internacional DCI

concentracionMedicamento Numerico Requerido

Descripción de la concentración del medicamento indicando la cantidad del principio activo. Para los otros tipos de medicamentos puede informar null.

Especificación: 0...3

unidadMedida String - Parametrizado Requerido

Unidad de medida del principio activo.Para los otros tipos de medicamentos puede informar null.

Especificación: Inf adicional Ver Unidad de Medida de Medicamento(UMM)

formaFarmaceutica String - Parametrizado Requerido

Código de la forma farmacéutica del medicamento.

Especificación: Inf adicional Ver Forma Farmacéutica del Medicamento(FFM)

unidadMinDispensa String - Parametrizado Requerido

Código de la unidad de medida del medicamento.

Especificación: Inf adicional Ver URP

cantidadMedicamento Numerico Requerido

Cantidad de unidades minimas del medicamento dispensadas o administradas

Especificación: 1...0

diasTratamiento Numerico Requerido

Corresponde al número de días para los cuales se realiza la dispensación del medicamento.

Especificación: 1...3

tipoDocumentoIdentificacion String - Parametrizado Requerido

Corresponde al tipo de documento de identificación de la persona que realizó el procedimiento

Especificación:

CodigoDescripción
ASAdulto sin identificacion
CCCedula de Ciudadania
CDCarnet Diplomatico
CECedula de Extranjeria
CNCertificado de nacido vivo
DEDocumento extranjero
MSMenor sin identificacion
NINúmero de identificación tributario NIT
NVCertificado nacido vivo
PAPasaporte
PEPermiso Especial de Permanencia
PTPermiso por protección temporal
RCRegistro civil
SCSalvoconducto
SISin identificación
TITarjeta de Identidad

numDocumentoIdentificacion String Requerido

Corresponde al número del documento de identificación de la persona que realizó el procedimiento.

Especificación: Minimo 4 caracteres, maximo 20 caracteres

vrUnitMedicamento Numerico Requerido

Valor monetario unitario del medicamento por unidad mínima de dispensación, según el manual tarifado o la tarifa pactada en el acuerdo de voluntades.

Especificación: 1...15

vrServicio Numerico Requerido

Valor monetario total del medicamento dispensado, según el manual tarifario o la tarifa pactada en el acuerdo de voluntades.

Especificación: 1...15

conceptoRecaudo String - Parametrizado Requerido

Tipo de pago moderador según el plan de beneficios o planes o pólizas adquiridas.

Especificación:

CodigoDescripción
01COPAGO
02CUOTA MODERADORA
03PAGOS COMPARTIDOS EN PLANES VOLUNTARIOS DE SALUD
04ANTICIPO
05NO APLICA

valorPagoModerador Numerico Requerido

Valor monetario del pago moderador.

Especificación: 1...n

numFEVPagoModerador String Requerido

Número de factura electrónica de venta emitida al usuario y que soporte el valor registrado en el campo M21 o informado por la entidad responsable de pago o demás pagadores.

Especificación: Cuando no aplique pago moderador se debe informar null

consecutivo Numerico Requerido

Número consecutivo que identifique el registro

Especificación: 1...n

otros_servicios Objeto Requerido

otros servicios

Especificación:

codPrestador String Requerido

Código otorgado por el Ministerio de Salud y Protección Social al prestador de servicios de salud o del obligado a reportar. El código del facturador electrónico en salud se debe encontrar en la tabla IPSCodHabilitación para prestadores de servicios de salud o en IPSnoREPS para prestadores exceptuados del registro en REPS

Especificación: Tamaño de 12 caracteres

numAutorizacion String Requerido

Número asignado por la entidad responsable de pago o demás pagadores a los que aplique, para ordenar la prestación o provisión de servicios o tecnologías de salud. Cuando el servicio de salud no requiera autorización se informa null

Especificación: Maximo 30 caracteres, permite null

idMIPRES String Requerido

Corresponde al número de ID que se asigna a la entrega de procedimientos financiados con presupuesto máximo. Cuando el procedimiento no es financiado por presupuesto máximo se debe informar null a menos que el procedimiento sea solicitado a través de la herramienta MIPRES, en este caso debe informar el número .de ID de entrega correspondiente. Se puede validar que el número de ID de entrega corresponda al registrado en MIPRES

Especificación: Maximo de 15 caracteres

fechaSuministroTecnologia Datetime Requerido

Corresponde a la fecha y hora en la cual se realizó, dispensó,administró o entregó otros servicios, según aplique

Especificación: AAAA-MM-DD HH:MM:SS

tipoOS String Requerido

Identificador para determinar el tipo de otros servicios.

Especificación:

<>Codigo
Descripción
01DISPOSITIVOS MEDICOS E INSUMOS
02TRASLADOS
03ESTANCIAS
04SERVICIOS COMPLEMENTARIOS
05HONORARIOS

codTecnologiaSalud String Requerido

Código del otro servicio de acuerdo con las codificaciones vigentes o aquella utilizada por el facturador electrónico en salud para casos excepcionales.

Especificación: Cuando corresponda a la opción 01:Dispositivos médicos e insumos, en el campo SO6,-codTecnologiaSalud-.El código del traslado, transporte o estancia debe corresponder al código dado por la Clasificación Única de Procedimientos en Salud - CUPS. El código de honorarios debe corresponder al código del procedimiento realizado por el personal de salud, dado por la Clasificación Única de Procedimientos en Salud - CUPS. El código de servicios complementarios debe corresponder al código dado por la tabla de referencia MIPRES.

nomTecnologiaSalud String Requerido

Nombre del otro servicio.

Especificación: Descripción del dispositivo médico e insumo de la entidad obligada a reportar. Si el tipo de otro servicio es diferente a 01. Dispositivos médicos e insumos puede informar este campo como null.

cantidadOS Numerico Requerido

Cantidad entregada de otros servicios. Para dispositivos médicos, insumos, traslados y servicios complementarios informar en unidades. Para honorarios informar siempre 1. Solo se permite reporter 1 honorario por procedimiento y por profesional de la salud. Para estancia informar la cantidad de ellas

Especificación: 5

tipoDocumentoIdentificacion String - Parametrizado Requerido

Corresponde al tipo de documento de identificación de la persona que realizó el procedimiento

Especificación:

CodigoDescripción
ASAdulto sin identificacion
CCCedula de Ciudadania
CDCarnet Diplomatico
CECedula de Extranjeria
CNCertificado de nacido vivo
DEDocumento extranjero
MSMenor sin identificacion
NINúmero de identificación tributario NIT
NVCertificado nacido vivo
PAPasaporte
PEPermiso Especial de Permanencia
PTPermiso por protección temporal
RCRegistro civil
SCSalvoconducto
SISin identificación
TITarjeta de Identidad

numDocumentoIdentificacion String Requerido

Corresponde al número del documento de identificación de la persona que realizó el procedimiento.

Especificación: Minimo 4 caracteres, maximo 20 caracteres

vrUnitOS Numerico Requerido

Valor monetario unitario de otros servidos según el manual tarifado o la tarifa pactada en el acuerdo de voluntades. Diligenciar el valor mayor a cero (0) si la modalidad de pago corresponde a -Pago por evento-. Para las demás modalidades informar cero (0).

Especificación: 1-15

vrServicio Numerico Requerido

Valor monetario total de otros servicios según el manual tarifado o la tarifa pactada en el acuerdo de voluntades. Este valor NO incluye la cuota moderadora. Diligenciar el valor mayor a cero (0) si la modalidad de pago corresponde a -Pago por evento-. Para las demás modalidades informar cero (0).

Especificación: 1...15

conceptoRecaudo String - Parametrizado Requerido

Tipo de pago moderador según el plan de beneficios o planes o pólizas adquiridas.

Especificación:

CodigoDescripción
01COPAGO
02CUOTA MODERADORA
03PAGOS COMPARTIDOS EN PLANES VOLUNTARIOS DE SALUD
04ANTICIPO
05NO APLICA

valorPagoModerador Numerico Requerido

Valor monetario del pago moderador

Especificación: 1...n

numFEVPagoModerador String Requerido

Número de factura electrónica de venta emitida al usuario y que soporte el valor registrado en el campo S14 o informado por la entidad responsable de pago o demás pagadores

Especificación: Cuando no aplique pago moderador se debe informar null

consecutivo Numerico Requerido

Número consecutivo que identifique el registro

Especificación: 1...n

Estructura json

							{
    "numDocumentoIdObligado": "",
    "numFactura": "",
    "tipoNota": null,
    "numNota": null,
    "usuarios": [
        {
            "tipoDocumentoIdentificacion": "",
            "numDocumentoIdentificacion": "",
            "tipoUsuario": "",
            "fechaNacimiento": "",
            "codSexo": "",
            "codPaisResidencia": "",
            "codMunicipioResidencia": "",
            "codZonaTerritorialResidencia": "",
            "incapacidad": "",
            "consecutivo": "",
            "codPaisOrigen": "",
            "servicios": {
                "consultas": [
                    {
                        "codPrestador": "",
                        "fechaInicioAtencion": "",
                        "numAutorizacion": "",
                        "codConsulta": "",
                        "modalidadGrupoServicioTecSal": "",
                        "grupoServicios": "",
                        "codServicio": "",
                        "finalidadTecnologiaSalud": "",
                        "causaMotivoAtencion": "",
                        "codDiagnosticoPrincipal": "",
                        "codDiagnosticoRelacionado1": null,
                        "codDiagnosticoRelacionado2": null,
                        "codDiagnosticoRelacionado3": null,
                        "tipoDiagnosticoPrincipal": "",
                        "tipoDocumentoIdentificacion": "",
                        "numDocumentoIdentificacion": "",
                        "vrServicio": 0,
                        "conceptoRecaudo": "",
                        "valorPagoModerador": 0,
                        "numFEVPagoModerador": null,
                        "consecutivo": 0
                    }
                ]
            }
        }
    ]
}							

Estructura JSON de respuesta


Salida Exitosa



{
	"codigo_error": 0,
	"descripcion_error": "OK",
	"tiempo_ejecucion": 2.8475100994110109,
	"transaccion": "5e5e5e5e5e55e",
	"resultado": {
		"cufe": "111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111",
		"id_factura": "SETP990001502",
		"url_representacion_qr_svg": "https://afacturar.archivamos.com/XXXXXXXX/123123123123123123123123123123123123112/AAAA/MM/DD/QR_111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111.svg",
		"qr_url_imagen_base_64": "https://afacturar.archivamos.com/XXXXXXXX/123123123123123123123123123123123123112/AAAA/MM/DD/QR64_111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111.txt",
		"url_representacion_xml": "https://afacturar.archivamos.com/XXXXXXXX/123123123123123123123123123123123123112/AAAA/MM/DD/fv083002047005520SETP990001502.xml",
		"url_application_response": "https://afacturar.archivamos.com/XXXXXXXX/123123123123123123123123123123123123112/AAAA/MM/DD/ar083002047005520SETP990001502.xml",
		"url_attached_document_url": "https://afacturar.archivamos.com/XXXXXXXX/123123123123123123123123123123123123112/AAAA/MM/DD/ad083002047005520SETP990001502.xml",
		"url_representacion_grafica": "https://afacturar.archivamos.com/XXXXXXXX/123123123123123123123123123123123123112/AAAA/MM/DD/111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111.pdf",
		"url_notificacion_aceptacion_rechazo": "http://app.afacturar.com/consulta_documento/?uid=5e5e5e5e5e55e"
	},
	"entorno": "Este documento se envia al entorno: DOCUMENTO_NO_VALIDO",
	"ErrorMessage_DIAN": ""
}
							  
							 

Salida con errores de semantica



{
    "codigo_error": 400,
    "descripcion_error": "Parametro de entrada json_rips",
    "tiempo_ejecucion": 0.068549156188964844,
    "resultado": [
        {
            "propiedad": "numFactura",
            "descripcion": "json_rips => The property numFactura is required"
        }
    ],
    "entorno": "Este documento se envia al entorno: DOCUMENTO_NO_VALIDO"
}						
						
					  

Salida con errores de datos



{
    "codigo_error": 400,
    "descripcion_error": "Parametro de entrada json_rips",
    "tiempo_ejecucion": 0.068549156188964844,
    "resultado": [
        {
            "propiedad": "usuarios[0].tipoDocumentoIdentificacion",
            "descripcion": "json_rips => Does not have a value in the enumeration [\"CC\",\"CE\",\"CD\",\"PA\",\"PE\",\"RC\",\"TI\",\"CN\",\"AS\",\"MS\",\"DE\",\"SI\",\"NI\",\"NV\",\"PT\",\"SC\"]"
        },
        {
            "propiedad": "usuarios[0].codSexo",
            "descripcion": "json_rips => Does not have a value in the enumeration [\"M\",\"H\",\"I\"]"
        },
        {
            "propiedad": "",
            "descripcion": "json_rips => The property numFactra is not defined and the definition does not allow additional properties"
        }
    ],
    "entorno": "Este documento se envia al entorno: DOCUMENTO_NO_VALIDO"
}									
						
						

Salida con errores HTTP



{
	"codigo_error": 500,
	"descripcion_error": "Unauthenticated."
}
						

Ejemplos


Factura de salud, modalidad de pago por evento y con anticipo

JSON data

{
    "informacion_documento": {
        "cufe_cude": "be27ab71fea9c9fd8c01231235d221115d063a9be5b618d97597cb5792d86f857fe12345667890ca99f3613d3f6b7a97af",
        "fecha_documento": "2025-01-30",
		"numero_documento": "SETT28"
    },
    "generalidades": {
        "tipo_ambiente_dian": 2,
        "identificador_transmision": "20250130",
        "integrador": {
            "nombre": "WEB",
            "tipo": "WEB"
        }
    }
}

JSON factura

 {
    "facturas": [
        {
            "encabezado": {
                "id_factura": "28",
                "fecha": "2025-01-29",
                "hora": "16:15:15",
                "nota": [
                    "{'SON':'PESOS MCTE.'",
                    "'variable':'0'}'"
                ],
                "moneda": "COP",
                "tipo_factura": 10,
                "metodo_de_pago": 2,
                "tipo_de_pago": 45,
                "numero_orden": "",
                "numero_resolucion_facturacion": "18760000001",
                "fecha_vencimiento": "2025-02-27",
                "prefijo": "SETT"
            },
            "sector": {
                "tipo": "SALUD",
                "tipo_operacion": "SS-CUFE",
                "coleccion": [
                    {
                        "nombre": "usuario",
                        "informacion_adicional": [
                            {
                                "variable": "CODIGO_PRESTADOR",
                                "valor": "111111111111"
                            },
                            {
                                "variable": "MODALIDAD_PAGO",
                                "valor": "04"
                            },
                            {
                                "variable": "COBERTURA_PLAN_BENEFICIOS",
                                "valor": "08"
                            },
                            {
                                "variable": "NUMERO_CONTRATO",
                                "valor": "NA"
                            },
                            {
                                "variable": "NUMERO_POLIZA",
                                "valor": "NA"
                            },
                            {
                                "variable": "COPAGO",
                                "valor": "0.00"
                            },
                            {
                                "variable": "CUOTA_MODERADORA",
                                "valor": "0.00"
                            },
                            {
                                "variable": "PAGOS_COMPARTIDOS",
                                "valor": "0.00"
                            },
                            {
                                "variable": "CUOTA_RECUPERACION",
                                "valor": "0.00"
                            }
                        ]
                    }
                ]
            },
            "periodo_facturacion": {
                "fecha_inicio": "2025-01-01",
                "fecha_fin": "2025-01-25"
            },
            "informacion_adquiriente": {
                "tipo_contribuyente": 1,
                "tipo_regimen": 2,
                "tipo_identificacion": 31,
                "identificacion": "90000000",
                "correo_electronico": "info@ejejmplo.co",
                "numero_movil": "7777777",
                "nombre": {
                    "razon_social": "Empresa de ejemplo",
                    "primer_nombre": "",
                    "segundo_nombre": "",
                    "apellido": ""
                },
                "pais": "CO",
                "departamento": "11",
                "ciudad": "11001",
                "zona": "",
                "direccion": "AK 10",
                "RUT": {
                    "resp_calidades_atributos": [
                        "R-99-PN"
                    ],
                    "usuario_aduanero": [
                    ]
                }
            },
            "detalle_factura": [
                {
                    "numero_linea": 1,
                    "cantidad": 1,
                    "unidad_de_cantidad": "94",
                    "valor_unitario": "74500.00",
                    "descripcion": "CONSULTA DE PRIMERA VEZ POR ESPECIALISTA EN DERMATOLOGIA",
                    "cargo_descuento": {
                        "es_descuento": false,
                        "porcentaje_cargo_descuento": "0",
                        "valor_base_cargo_descuento": "74500.00",
                        "valor_cargo_descuento": "0.00"
                    },
                    "regalo": {
                        "es_regalo": false,
                        "cod_precio_referencia": 0,
                        "precio_referencia": "0.00"
                    },
                    "impuestos_detalle": {
                        "codigo_impuesto": 0,
                        "porcentaje_impuesto": "0.00",
                        "valor_base_impuesto": "0.00",
                        "valor_impuesto": "0.00"
                    },
                    "retenciones_detalle": [
                        {
                            "codigo": 0,
                            "porcentaje": "0.00",
                            "valor_base": "0.00",
                            "valor_retenido": "0.00"
                        }
                    ],
                    "valor_total_detalle_con_cargo_descuento": "74500.00",
                    "valor_total_detalle": "74500.00",
                    "informacion_adicional": [
                        {
                            "variable": "DESCRIPCION",
                            "valor": "CONSULTA DE PRIMERA VEZ POR ESPECIALISTA EN DERMATOLOGIA"
                        },
                        {
                            "variable": "IDENTIFICACION_USUARIO",
                            "valor": "1010066265"
                        },
                        {
                            "variable": "NUMERO_AUTORIZACION",
                            "valor": "2000272"
                        },
                        {
                            "variable": "CODIGO_PRESTADOR_SERVICIO",
                            "valor": "4100100150"
                        }
                    ]
                },
                {
                    "numero_linea": 2,
                    "cantidad": 1,
                    "unidad_de_cantidad": "94",
                    "valor_unitario": "74500.00",
                    "descripcion": "CONSULTA DE PRIMERA VEZ POR ESPECIALISTA EN DERMATOLOGIA",
                    "cargo_descuento": {
                        "es_descuento": false,
                        "porcentaje_cargo_descuento": "0",
                        "valor_base_cargo_descuento": "74500.00",
                        "valor_cargo_descuento": "0.00"
                    },
                    "regalo": {
                        "es_regalo": false,
                        "cod_precio_referencia": 0,
                        "precio_referencia": "0.00"
                    },
                    "impuestos_detalle": {
                        "codigo_impuesto": 0,
                        "porcentaje_impuesto": "0.00",
                        "valor_base_impuesto": "0.00",
                        "valor_impuesto": "0.00"
                    },
                    "retenciones_detalle": [
                        {
                            "codigo": 0,
                            "porcentaje": "0.00",
                            "valor_base": "0.00",
                            "valor_retenido": "0.00"
                        }
                    ],
                    "valor_total_detalle_con_cargo_descuento": "74500.00",
                    "valor_total_detalle": "74500.00",
                    "informacion_adicional": [
                        {
                            "variable": "DESCRIPCION",
                            "valor": "CONSULTA DE PRIMERA VEZ POR ESPECIALISTA EN DERMATOLOGIA"
                        },
                        {
                            "variable": "IDENTIFICACION_USUARIO",
                            "valor": "1020842114"
                        },
                        {
                            "variable": "NUMERO_AUTORIZACION",
                            "valor": "8774537"
                        },
                        {
                            "variable": "CODIGO_PRESTADOR_SERVICIO",
                            "valor": "4100100150"
                        }
                    ]
                }
            ],
            "impuestos": [
                {
                    "codigo_impuesto": 0,
                    "porcentaje_impuesto": "0.00",
                    "valor_base_calculo_impuesto": "0.00",
                    "valor_total_impuesto": "0.00"
                }
            ],
            "retenciones": [
                {
                    "codigo": 0,
                    "porcentaje": "0.00",
                    "valor_base": "0.00",
                    "valor_retenido": "0.00"
                }
            ],
            "descuentos": [
                {
                    "codigo_descuento": 99,
                    "porcentaje_descuento": "0.00",
                    "valor_base_calculo_descuento": "0.00",
                    "valor_total_descuento": "0.00"
                }
            ],
            "recargos": [
                {
                    "nombre_recargo": "",
                    "porcentaje_recargo": "0.00",
                    "valor_base_calculo_recargo": "0.00",
                    "valor_total_recargo": "0.00"
                }
            ],
            "valor_factura": {
                "valor_base": "149000",
                "valor_base_calculo_impuestos": "0.00",
                "valor_base_mas_impuestos": "149000.00",
                "valor_anticipo": "87000.00",
                "valor_descuento_total": "0.00",
                "valor_total_recargos": "0.00",
                "valor_total_impuesto_1": "0.00",
                "valor_total_impuesto_2": "0.00",
                "valor_total_impuesto_3": "0.00",
                "valor_total_impuesto_4": "0.00",
                "valor_total_reteiva": "0.00",
                "valor_total_retefuente": "0.00",
                "valor_total_reteica": "0.00",
                "total_factura": "149000.00",
                "valor_total_a_pagar": "62000.00"
            }
        }
    ],
    "generalidades": {
        "tipo_ambiente_dian": 2,
        "version": 2,
        "identificador_transmision": "20250130",
        "rg_tipo": "",
        "rg_base_64": "",
        "integrador": {
            "nombre": "WEB",
            "tipo": "WEB"
        }
    }
}

JSON RIPS

{
    "numDocumentoIdObligado": "11223344",
    "numFactura": "SETT28",
    "tipoNota": null,
    "numNota": null,
    "usuarios": [
        {
            "tipoDocumentoIdentificacion": "CC",
            "numDocumentoIdentificacion": "10101010101",
            "tipoUsuario": "01",
            "fechaNacimiento": "1990-08-02",
            "codSexo": "F",
            "codPaisResidencia": "170",
            "codMunicipioResidencia": "41001",
            "codZonaTerritorialResidencia": "02",
            "incapacidad": "NO",
            "consecutivo": 1,
            "codPaisOrigen": "170",
            "servicios": {
                "consultas": [
                    {
                        "codPrestador": "111111111111",
                        "fechaInicioAtencion": "2025-01-22 13:20",
                        "numAutorizacion": "2000272",
                        "codConsulta": "890242",
                        "modalidadGrupoServicioTecSal": "01",
                        "grupoServicios": "01",
                        "codServicio": 308,
                        "finalidadTecnologiaSalud": "44",
                        "causaMotivoAtencion": "38",
                        "codDiagnosticoPrincipal": "B86X",
                        "codDiagnosticoRelacionado1": null,
                        "codDiagnosticoRelacionado2": null,
                        "codDiagnosticoRelacionado3": null,
                        "tipoDiagnosticoPrincipal": "01",
                        "tipoDocumentoIdentificacion": "CC",
                        "numDocumentoIdentificacion": "7691730",
                        "vrServicio": 149000,
                        "conceptoRecaudo": "03",
                        "valorPagoModerador": 87000,
                        "numFEVPagoModerador": null,
                        "consecutivo": 1
                    }
                ]
            }
        }
    ]
}

Codigo de respuesta


Cuando usted hace un llamado a la API, puede recibir los siguientes mensajes de error en la respuesta. Puede que haya algo mal con su solicitud o puede que algo esté mal de nuestra parte. Los errores responden con un código de error y JSON que contiene un mensaje, una descripción y un código API más preciso.

Códigos de ERROR


Tabla de Errores
Código Estado Descripción Acción sugerida
28 Timeout La operación duro más de 60 seg
15 Error retornado por la DIAN La información enviada no cumple con el estandar del XML o los valores no estan bien calculados
400 Solicitud incorrecta Hay un problema con su solicitud Compruebe que su solicitud sigue la documentación de la API y utiliza la sintaxis correcta.
401 No autorizado No tiene la autorización necesaria para realizar la solicitud. Asegúrese de estar utilizando una clave API válida con los permisos necesarios para su solicitud.
403 Prohibido El servidor entendió la solicitud, pero se negó a cumplirla. Vea si su plan en Afacturar.com incluye el recurso que está solicitando y su clave API tiene las autorizaciones necesarias.
404 No encontrado El servidor no pudo encontrar el recurso solicitado. Cambie su URL de solicitud para que coincida con un punto final API válido.
405 Método no permitido El recurso no tiene el método especificado. (por ejemplo, PUT en las transmisiones) Cambie el método para seguir la documentación del recurso.
409 Conflicto Un conflicto surgió de su solicitud. (por ejemplo, el OFE no esta asociado al código de autorización) Modificar la carga útil para eliminar el conflicto..
415 Tipo de medio no admitido La solicitud no está en un formato compatible. Verifique que su encabezado Content-Type sea compatible y que su solicitud cumpla con la documentación.
422 Entidad no procesable La solicitud fue sintácticamente correcta pero falló debido a errores semánticos. Asegúrese de que su solicitud incluya todos los campos obligatorios y que sus datos sean válidos.
429 Exceder el límite de envío Se excede el numero de transacciones permitido (120 por minuto). Verifique que se encuentra dentro de los límites acordados con Afacturar.
500 Error de servidor interno Algo salió mal de nuestro lado. Pruebe la solicitud nuevamente más tarde. Si el error no se resuelve, póngase en contacto con el soporte técnico soporte@afacturar.com.
503 Servicio no disponible Estamos experimentando niveles de tráfico más altos de lo normal. Prueba la solicitud nuevamente, ya estamos enterado del problema para aumentar la capacidad.

Consumo del API


CURL

								curl --location 'https://servicios-pruebas.afacturar.com/api/rips/cargar_fe_rips' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer token_obligado' \
--form 'json_rips="{
    \"numDocumentoIdObligado\": \"123123123\",
    \"numFactra\": \"SETT32\",
    \"tipoNota\": null,
    \"numNota\": null,
    \"usuarios\": [
        {
            \"tipoDocumentoIdentificacion\": \"CW\",
            \"numDocumentoIdentificacion\": \"3333333\",
            \"tipoUsuario\": \"01\",
            \"fechaNacimiento\": \"1990-08-02\",
            \"codSexo\": \"F\",
            \"codPaisResidencia\": \"170\",
            \"codMunicipioResidencia\": \"41001\",
            \"codZonaTerritorialResidencia\": \"02\",
            \"incapacidad\": \"NO\",
            \"consecutivo\": 1,
            \"codPaisOrigen\": \"170\",
            \"servicios\": {
                \"consultas\": [
                    {
                        \"codPrestador\": \"111111111111\",
                        \"fechaInicioAtencion\": \"2025-01-22 13:20\",
                        \"numAutorizacion\": \"2000272\",
                        \"codConsulta\": \"890242\",
                        \"modalidadGrupoServicioTecSal\": \"01\",
                        \"grupoServicios\": \"01\",
                        \"codServicio\": 308,
                        \"finalidadTecnologiaSalud\": \"44\",
                        \"causaMotivoAtencion\": \"38\",
                        \"codDiagnosticoPrincipal\": \"B86X\",
                        \"codDiagnosticoRelacionado1\": null,
                        \"codDiagnosticoRelacionado2\": null,
                        \"codDiagnosticoRelacionado3\": null,
                        \"tipoDiagnosticoPrincipal\": \"01\",
                        \"tipoDocumentoIdentificacion\": \"CC\",
                        \"numDocumentoIdentificacion\": \"2222222\",
                        \"vrServicio\": 149000,
                        \"conceptoRecaudo\": \"03\",
                        \"valorPagoModerador\": 87000,
                        \"numFEVPagoModerador\": null,
                        \"consecutivo\": 1
                    }
                ]
            }
        }
    ]
}"' \
--form 'documento_obligado="7691730"' \
--form 'data="{
    \"informacion_documento\": {
        \"cufe_cude\": \"be27ab71fea9c9fd8c0a07fd3d21111111111222228d97597cb5792d86f857fe3ba1561f02ca99f3613d3f6b7a97af\",
        \"fecha_documento\": \"2025-01-30\",
		\"numero_documento\": \"SETT32\"
    },
    \"generalidades\": {
        \"tipo_ambiente_dian\": 2,
        \"identificador_transmision\": \"20220913_122843\",
        \"integrador\": {
            \"nombre\": \"WEB\",
            \"tipo\": \"WEB\"
        }
    }
}"'								

C#

								var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://servicios-pruebas.afacturar.com/api/rips/cargar_fe_rips");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer token_obligado");
var content = new MultipartFormDataContent();
content.Add(new StringContent("{
    \"numDocumentoIdObligado\": \"123123123\",
    \"numFactra\": \"SETT32\",
    \"tipoNota\": null,
    \"numNota\": null,
    \"usuarios\": [
        {
            \"tipoDocumentoIdentificacion\": \"CW\",
            \"numDocumentoIdentificacion\": \"5555555\",
            \"tipoUsuario\": \"01\",
            \"fechaNacimiento\": \"1990-08-02\",
            \"codSexo\": \"F\",
            \"codPaisResidencia\": \"170\",
            \"codMunicipioResidencia\": \"41001\",
            \"codZonaTerritorialResidencia\": \"02\",
            \"incapacidad\": \"NO\",
            \"consecutivo\": 1,
            \"codPaisOrigen\": \"170\",
            \"servicios\": {
                \"consultas\": [
                    {
                        \"codPrestador\": \"111111111\",
                        \"fechaInicioAtencion\": \"2025-01-22 13:20\",
                        \"numAutorizacion\": \"2000272\",
                        \"codConsulta\": \"890242\",
                        \"modalidadGrupoServicioTecSal\": \"01\",
                        \"grupoServicios\": \"01\",
                        \"codServicio\": 308,
                        \"finalidadTecnologiaSalud\": \"44\",
                        \"causaMotivoAtencion\": \"38\",
                        \"codDiagnosticoPrincipal\": \"B86X\",
                        \"codDiagnosticoRelacionado1\": null,
                        \"codDiagnosticoRelacionado2\": null,
                        \"codDiagnosticoRelacionado3\": null,
                        \"tipoDiagnosticoPrincipal\": \"01\",
                        \"tipoDocumentoIdentificacion\": \"CC\",
                        \"numDocumentoIdentificacion\": \"2222222\",
                        \"vrServicio\": 149000,
                        \"conceptoRecaudo\": \"03\",
                        \"valorPagoModerador\": 87000,
                        \"numFEVPagoModerador\": null,
                        \"consecutivo\": 1
                    }
                ]
            }
        }
    ]
}"), "json_rips");
content.Add(new StringContent("123123123"), "documento_obligado");
content.Add(new StringContent("{
    \"informacion_documento\": {
        \"cufe_cude\": \"be27ab71fea9c9fd8c0a07fd3d221111111111b618d97597cb5792d86f857fe3ba1561f02ca99f3613d3f6b7a97af\",
        \"fecha_documento\": \"2025-01-30\",
		\"numero_documento\": \"SETT32\"
    },
    \"generalidades\": {
        \"tipo_ambiente_dian\": 2,
        \"identificador_transmision\": \"20220913_122843\",
        \"integrador\": {
            \"nombre\": \"WEB\",
            \"tipo\": \"WEB\"
        }
    }
}"), "data");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
								

Historico de cambios


Versión Cambios Fecha de liberación
2 Publicación del API| 30 de enero de 2025