MinSalud.SIIFA.API.Contrato
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
Version: v1.0.5
BasePath:
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html
Access
- HTTP Bearer Token authentication (JWT)
[ Jump to Models ]
Table of Contents
Up
get /api/CodigoReferencia/GetByIdDominio/{IdDominio}
Obtiene la lista de códigos de referencia filtrados por identificador de dominio. (apiCodigoReferenciaGetByIdDominioIdDominioGet)
Este endpoint permite consultar códigos de referencia asociados a un dominio específico mediante su ID.
Los resultados incluyen el identificador y la descripción de cada código de referencia.
Sample request:
GET /api/CodigoReferencia/GetByIdDominio/6
Path parameters
IdDominio (required)
Path Parameter — default: null format: int32
Return type
Example data
Content-Type: application/json
[ {
"descripcion" : "descripcion",
"idCodigoReferencia" : 0,
"activo" : true
}, {
"descripcion" : "descripcion",
"idCodigoReferencia" : 0,
"activo" : true
} ]
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Lista de códigos de referencia obtenida exitosamente.
400
Solicitud incorrecta. El ID del dominio no es válido.
Microsoft_AspNetCore_Mvc_ProblemDetails
401
No autorizado. El token de autenticación es inválido o no se proporcionó.
Microsoft_AspNetCore_Mvc_ProblemDetails
404
No se encontraron códigos de referencia para el dominio especificado.
Microsoft_AspNetCore_Mvc_ProblemDetails
500
Error interno del servidor.
Microsoft_AspNetCore_Mvc_ProblemDetails
Up
get /api/CodigoReferencia/GetByNombreDominio/{NombreDominio}
Obtiene la lista de códigos de referencia filtrados por nombre de dominio. (apiCodigoReferenciaGetByNombreDominioNombreDominioGet)
Este endpoint permite consultar códigos de referencia asociados a un dominio específico mediante su nombre.
Los resultados incluyen el identificador y la descripción de cada código de referencia.
Sample request:
GET /api/CodigoReferencia/GetByNombreDominio/TipoContrato
Path parameters
NombreDominio (required)
Path Parameter — default: null
Return type
Example data
Content-Type: application/json
[ {
"descripcion" : "descripcion",
"idCodigoReferencia" : 0,
"activo" : true
}, {
"descripcion" : "descripcion",
"idCodigoReferencia" : 0,
"activo" : true
} ]
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Lista de códigos de referencia obtenida exitosamente.
400
Solicitud incorrecta. El nombre del dominio no es válido.
Microsoft_AspNetCore_Mvc_ProblemDetails
401
No autorizado. El token de autenticación es inválido o no se proporcionó.
Microsoft_AspNetCore_Mvc_ProblemDetails
404
No se encontraron códigos de referencia para el dominio especificado.
Microsoft_AspNetCore_Mvc_ProblemDetails
500
Error interno del servidor.
Microsoft_AspNetCore_Mvc_ProblemDetails
Up
get /api/CodigoReferenciaDominio
Obtiene la lista de todos los dominios de código de referencia activos. (apiCodigoReferenciaDominioGet)
Este endpoint permite consultar todos los dominios de código de referencia disponibles en el sistema,
incluyendo información como unidad de análisis, nombre, descripción y estado activo.
Los resultados se devuelven ordenados por nombre y solo incluyen dominios activos.
Sample request:
GET /api/CodigoReferenciaDominio
Return type
Example data
Content-Type: application/json
[ {
"descripcion" : "descripcion",
"idCodigoReferenciaDominio" : 0,
"unidadAnalisis" : "unidadAnalisis",
"nombre" : "nombre",
"activo" : true
}, {
"descripcion" : "descripcion",
"idCodigoReferenciaDominio" : 0,
"unidadAnalisis" : "unidadAnalisis",
"nombre" : "nombre",
"activo" : true
} ]
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Lista de dominios obtenida exitosamente.
401
No autorizado. El token de autenticación es inválido o no se proporcionó.
Microsoft_AspNetCore_Mvc_ProblemDetails
500
Error interno del servidor.
Microsoft_AspNetCore_Mvc_ProblemDetails
Obtiene una lista paginada de contratos con filtros opcionales. (apiContratoGet)
Este endpoint permite consultar contratos aplicando múltiples filtros opcionales:
Filtros disponibles:
- IdContrato: Filtro por identificador específico del contrato
- NitContratante: Filtro por NIT del contratante (entidad que contrata)
- NitContratista: Filtro por NIT del contratista (prestador de servicios)
- Nombre: Búsqueda parcial por nombre del contrato
- CodigoEstado: Filtro por estado del contrato (102001=En creación, 102002=Activo, etc.)
- AnioSuscripcion: Filtro por año de suscripción del contrato
- NumeroPagina: Número de página para paginación (debe ser mayor a 0, default: 1)
- RegistrosPorPagina: Cantidad de registros por página (debe ser mayor a 0 y menor o igual a 100, default: 10)
Seguridad y roles:
- SIIFA_Admin: Acceso a todos los contratos sin restricciones
- SIIFA_IPS: Solo puede consultar contratos donde sea el contratista (NitContratista filtrado automáticamente)
- SIIFA_ERP: Solo puede consultar contratos donde sea el contratante (NitContratante filtrado automáticamente)
Los resultados se devuelven paginados con metadatos que incluyen:
- Total de registros encontrados
- Total de páginas disponibles
- Página actual
- Registros por página
Validaciones:
- NumeroPagina debe ser mayor a 0
- RegistrosPorPagina debe ser mayor a 0 y no superar 100
Sample request:
GET /api/Contrato?NumeroPagina=1&RegistrosPorPagina=10&CodigoEstado=102001
GET /api/Contrato?NitContratista=800123456&AnioSuscripcion=2025
GET /api/Contrato?Nombre=Servicios%20de%20Salud
Query parameters
IdContrato (optional)
Query Parameter — default: null format: int32
NitContratante (optional)
Query Parameter — default: null
NitContratista (optional)
Query Parameter — default: null
Nombre (optional)
Query Parameter — default: null
CodigoEstado (optional)
Query Parameter — default: null format: int32
AnioSuscripcion (optional)
Query Parameter — default: null format: int32
NumeroPagina (optional)
Query Parameter — default: null format: int32
RegistrosPorPagina (optional)
Query Parameter — default: null format: int32
Return type
Example data
Content-Type: application/json
{
"totalRegistros" : 1,
"paginaActual" : 0,
"resultado" : [ {
"vigencia" : 2,
"regimenes" : [ {
"descripcion" : "descripcion",
"fechaInicioAplicacion" : "2000-01-23T04:56:07.000+00:00",
"fechaFinalizacionAplicacion" : "2000-01-23T04:56:07.000+00:00",
"codigoRegimen" : 7
}, {
"descripcion" : "descripcion",
"fechaInicioAplicacion" : "2000-01-23T04:56:07.000+00:00",
"fechaFinalizacionAplicacion" : "2000-01-23T04:56:07.000+00:00",
"codigoRegimen" : 7
} ],
"estado" : "estado",
"valor" : 9.301444243932576,
"codigoEstado" : 1,
"nombre" : "nombre",
"fechaFin" : "2000-01-23T04:56:07.000+00:00",
"nitContratante" : 2,
"fechaInicio" : "2000-01-23T04:56:07.000+00:00",
"empresaContratista" : {
"razonSocial" : "razonSocial",
"nit" : 4
},
"cucon" : "cucon",
"empresaContratante" : {
"razonSocial" : "razonSocial",
"nit" : 4
},
"fechaSuscripcion" : "2000-01-23T04:56:07.000+00:00",
"idContrato" : 5,
"nitContratista" : 7,
"codigoModalidadPago" : 3
}, {
"vigencia" : 2,
"regimenes" : [ {
"descripcion" : "descripcion",
"fechaInicioAplicacion" : "2000-01-23T04:56:07.000+00:00",
"fechaFinalizacionAplicacion" : "2000-01-23T04:56:07.000+00:00",
"codigoRegimen" : 7
}, {
"descripcion" : "descripcion",
"fechaInicioAplicacion" : "2000-01-23T04:56:07.000+00:00",
"fechaFinalizacionAplicacion" : "2000-01-23T04:56:07.000+00:00",
"codigoRegimen" : 7
} ],
"estado" : "estado",
"valor" : 9.301444243932576,
"codigoEstado" : 1,
"nombre" : "nombre",
"fechaFin" : "2000-01-23T04:56:07.000+00:00",
"nitContratante" : 2,
"fechaInicio" : "2000-01-23T04:56:07.000+00:00",
"empresaContratista" : {
"razonSocial" : "razonSocial",
"nit" : 4
},
"cucon" : "cucon",
"empresaContratante" : {
"razonSocial" : "razonSocial",
"nit" : 4
},
"fechaSuscripcion" : "2000-01-23T04:56:07.000+00:00",
"idContrato" : 5,
"nitContratista" : 7,
"codigoModalidadPago" : 3
} ],
"totalPaginas" : 5,
"registrosPorPagina" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Lista paginada de contratos obtenida exitosamente.
PaginadorGenerico_Minsalud_SIIFA_API_Features_Contrato_Queries_ListContrato_Result
400
Parámetros de consulta inválidos. Verifique que NumeroPagina y RegistrosPorPagina sean mayores a 0 y que RegistrosPorPagina no supere 100.
Microsoft_AspNetCore_Mvc_ProblemDetails
401
No autorizado. El token de autenticación es inválido, expiró o no se proporcionó.
Microsoft_AspNetCore_Mvc_ProblemDetails
500
Error interno del servidor al procesar la consulta.
Microsoft_AspNetCore_Mvc_ProblemDetails
Up
delete /api/Contrato/{IdContrato}
Elimina permanentemente un contrato del sistema por su identificador. (apiContratoIdContratoDelete)
Este endpoint permite eliminar un contrato específico del sistema de forma permanente.
Esta operación es irreversible y debe usarse con precaución.
Restricciones importantes:
- Solo se permiten eliminaciones de contratos que estén en estado "En creación" (102001)
- Los contratos en estados Activo (102002), Terminado (102003) o Inactivo (102004) no pueden eliminarse
- El contrato debe existir en la base de datos
- El IdContrato debe ser un número positivo mayor a 0
Validaciones automáticas:
- El IdContrato debe ser mayor a 0
- El contrato debe existir en la base de datos
Eliminaciones en cascada:
Al eliminar un contrato, se eliminarán automáticamente todos los registros relacionados:
- ContratoEstado: Todos los estados históricos del contrato
- ContratoModalidadPago: Todas las modalidades de pago asociadas
- ContratoAgrupador: Todos los agrupadores poblacionales relacionados
- ContratoRegimen: Todos los regímenes aplicables al contrato
- ContratoOperacion: Todas las operaciones de cobertura poblacional
- ContratoPrestadorServicio: Todos los servicios asociados
- ContratoCums: Todos los medicamentos asociados
- ContratoCups: Todos los procedimientos asociados
- ContratoOtrosi: Todos los otros sí (modificaciones) del contrato
- ContratoAnticipo: Todos los anticipos registrados
- ContratoLiquidacion: Todas las liquidaciones asociadas
Nota importante: Esta operación elimina el contrato y TODOS sus datos relacionados
de forma permanente. No es posible recuperar la información después de la eliminación.
Para contratos que ya están activos o han sido utilizados, considere usar cambio de estado
en lugar de eliminación física.
Sample request:
DELETE /api/Contrato/1
DELETE /api/Contrato/150
Path parameters
IdContrato (required)
Path Parameter — default: null format: int32
Return type
Example data
Content-Type: application/json
{
"idContrato" : 0
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Contrato eliminado exitosamente junto con todos sus registros relacionados.
Minsalud_SIIFA_API_Features_Contrato_Commands_DeleteContrato_Result
400
ID de contrato inválido. El ID debe ser un número positivo mayor a 0.
Microsoft_AspNetCore_Mvc_ProblemDetails
401
No autorizado. El token de autenticación es inválido, expiró o no se proporcionó.
Microsoft_AspNetCore_Mvc_ProblemDetails
404
Contrato no encontrado. No existe un contrato con el ID especificado.
Microsoft_AspNetCore_Mvc_ProblemDetails
409
Conflicto. El contrato no puede ser eliminado porque no está en estado "En creación" (102001) o tiene dependencias que no permiten su eliminación.
Microsoft_AspNetCore_Mvc_ProblemDetails
500
Error interno del servidor al eliminar el contrato.
Microsoft_AspNetCore_Mvc_ProblemDetails
Up
get /api/Contrato/{IdContrato}
Obtiene los detalles completos de un contrato específico por su identificador. (apiContratoIdContratoGet)
Este endpoint devuelve información detallada y completa de un contrato específico, incluyendo:
Información básica:
- Identificador del contrato (IdContrato)
- Tipo de contrato (CodigoTipoContrato y descripción)
- Nombre del contrato
- Fechas: suscripción, inicio y fin
- Valor total del contrato
- Código CUCON (hash único del contrato)
- Estado actual y código de estado
Información de las partes:
- Datos del contratante (NIT y razón social)
- Datos del contratista (NIT y razón social)
Información de configuración:
- Modalidades de pago asociadas (si aplica)
- Regímenes aplicables al contrato
- Agrupadores relacionados (para contratos tipo 104001)
Información complementaria:
- Lista de otros sí (modificaciones contractuales)
- Número de servicios asociados
- Número de medicamentos (CUMS) asociados
- Número de procedimientos (CUPS) asociados
Validaciones:
- El IdContrato debe ser un número positivo mayor a 0
- El contrato debe existir en la base de datos
Sample request:
GET /api/Contrato/1
GET /api/Contrato/150
Path parameters
IdContrato (required)
Path Parameter — default: null format: int32
Return type
Example data
Content-Type: application/json
{
"estado" : "estado",
"codigoEstado" : 5,
"nombre" : "nombre",
"numeroProcedimientos" : 6,
"codigoReferenciaModalidadPago" : [ 9, 9 ],
"fechaInicio" : "2000-01-23T04:56:07.000+00:00",
"empresaContratista" : {
"razonSocial" : "razonSocial",
"nit" : 5
},
"tipoContrato" : {
"descripcion" : "descripcion",
"codigoTipoContrato" : 1
},
"codigoReferenciaRegimen" : [ 1, 1 ],
"empresaContratante" : {
"razonSocial" : "razonSocial",
"nit" : 5
},
"codigoTipoContrato" : 6,
"contratoAgrupador" : [ {
"descripcion" : "descripcion",
"codigoAgrupador" : 1,
"idContratoAgrupador" : 7
}, {
"descripcion" : "descripcion",
"codigoAgrupador" : 1,
"idContratoAgrupador" : 7
} ],
"valor" : 7.061401241503109,
"numeroMedicamentos" : 9,
"fechaFin" : "2000-01-23T04:56:07.000+00:00",
"nitContratante" : 5,
"contratoRegimen" : [ {
"descripcion" : "descripcion",
"idContratoRegimen" : 1,
"codigoRegimen" : 6
}, {
"descripcion" : "descripcion",
"idContratoRegimen" : 1,
"codigoRegimen" : 6
} ],
"numeroServicios" : 9,
"cucon" : "cucon",
"contratoModalidadPago" : [ {
"descripcion" : "descripcion",
"idContratoModalidadPago" : 3,
"codigoModalidadPago" : 2
}, {
"descripcion" : "descripcion",
"idContratoModalidadPago" : 3,
"codigoModalidadPago" : 2
} ],
"otrosis" : [ {
"estado" : "estado",
"fechaRegistro" : "2000-01-23T04:56:07.000+00:00",
"valor" : 1.1730742509559433,
"codigoEstado" : 4,
"nombre" : "nombre",
"idContratoOtrosi" : 7,
"fechaFinalizacion" : "2000-01-23T04:56:07.000+00:00"
}, {
"estado" : "estado",
"fechaRegistro" : "2000-01-23T04:56:07.000+00:00",
"valor" : 1.1730742509559433,
"codigoEstado" : 4,
"nombre" : "nombre",
"idContratoOtrosi" : 7,
"fechaFinalizacion" : "2000-01-23T04:56:07.000+00:00"
} ],
"fechaSuscripcion" : "2000-01-23T04:56:07.000+00:00",
"idContrato" : 0,
"nitContratista" : 2,
"codigoReferenciaAgrupador" : [ 4, 4 ]
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Detalles del contrato obtenidos exitosamente con toda la información relacionada.
Minsalud_SIIFA_API_Features_Contrato_Queries_DetailContrato_Result
400
ID de contrato inválido. El ID debe ser un número positivo mayor a 0.
Microsoft_AspNetCore_Mvc_ProblemDetails
401
No autorizado. El token de autenticación es inválido, expiró o no se proporcionó.
Microsoft_AspNetCore_Mvc_ProblemDetails
404
Contrato no encontrado. No existe un contrato con el ID especificado.
Microsoft_AspNetCore_Mvc_ProblemDetails
500
Error interno del servidor al obtener los detalles del contrato.
Microsoft_AspNetCore_Mvc_ProblemDetails
Registra un nuevo contrato en el sistema SIIFA. (apiContratoPost)
Este endpoint permite crear un nuevo contrato con validaciones automáticas de integridad.
El contrato se crea en estado "En creación" (102001) por defecto.
Datos requeridos:
- CodigoTipoContrato: Tipo de contrato (104001 = Contrato de prestación de servicios)
- NitContratante: NIT del contratante (debe existir en tabla Empresa)
- NitContratista: NIT del contratista (debe existir en tabla Empresa)
- Nombre: Nombre descriptivo del contrato
- FechaSuscripcion: Fecha de firma del contrato
- FechaInicio: Fecha de inicio de vigencia
- FechaFin: Fecha de finalización (opcional)
- Valor: Valor total del contrato (debe ser mayor a 0)
Datos condicionales (requeridos para contratos tipo 104001):
- CodigoReferenciaModalidadPago: Lista de modalidades de pago (ej: [1, 2])
- CodigoReferenciaAgrupador: Lista de agrupadores poblacionales (ej: [5, 6])
- CodigoReferenciaRegimen: Lista de regímenes aplicables (ej: [3])
Validaciones automáticas aplicadas:
-
Validación de NITs:
- NitContratante debe existir en dbo.Empresa
- NitContratista debe existir en dbo.Empresa
-
Validación de fechas:
- FechaSuscripcion debe ser menor o igual a FechaInicio
- FechaInicio debe ser menor que FechaFin (si FechaFin está presente)
-
Validación de duplicidad:
- No puede existir otro contrato con el mismo hash CUCON
- El hash se genera con: SHA256(TipoContrato + NitContratante + NitContratista + Nombre + FechaSuscripcion)
-
Validaciones condicionales (tipo 104001):
- ModalidadPago es obligatoria
- Agrupador es obligatorio
- Regimen es obligatorio
-
Validaciones de datos:
- Valor debe ser mayor a 0
- Nombre no puede estar vacío
- CodigoTipoContrato debe existir en CodigoReferencia
Registros creados:
- 1 registro en tabla Contrato
- 1 registro en tabla ContratoEstado (estado inicial 102001)
- N registros en tabla ContratoModalidadPago (si aplica)
- N registros en tabla ContratoRegimen (si aplica)
- N registros en tabla ContratoAgrupador (si aplica)
Sample request:
POST /api/Contrato
{
"codigoTipoContrato": 104001,
"nitContratante": 900123456,
"nitContratista": 800654321,
"nombre": "Contrato de Prestación de Servicios de Salud 2025",
"fechaSuscripcion": "2025-01-15",
"fechaInicio": "2025-02-01",
"fechaFin": "2025-12-31",
"valor": 500000000,
"codigoReferenciaModalidadPago": [1, 2],
"codigoReferenciaAgrupador": [5, 6],
"codigoReferenciaRegimen": [3]
}
Consumes
This API call consumes the following media types via the request header:
application/json
text/json
application/*+json
Request body
Return type
Example data
Content-Type: application/json
{
"idContrato" : 0
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
Contrato creado exitosamente. Retorna el ID del nuevo contrato y la URL para consultarlo.
Minsalud_SIIFA_API_Features_Contrato_Commands_AddContrato_Result
400
Datos inválidos o validaciones fallidas. El detalle incluye la lista de errores de validación con el campo y el mensaje correspondiente.
Microsoft_AspNetCore_Mvc_ProblemDetails
401
No autorizado. El token de autenticación es inválido, expiró o no se proporcionó.
Microsoft_AspNetCore_Mvc_ProblemDetails
409
Conflicto. Ya existe un contrato con los mismos datos (hash CUCON duplicado).
Microsoft_AspNetCore_Mvc_ProblemDetails
500
Error interno del servidor al crear el contrato.
Microsoft_AspNetCore_Mvc_ProblemDetails
Actualiza la información de un contrato existente. (apiContratoPut)
Este endpoint permite modificar los datos de un contrato existente aplicando las mismas
validaciones que en la creación del contrato.
Restricciones importantes:
- Solo se permiten actualizaciones en contratos que estén en estado "En creación" (102001)
- Los contratos en estados Activo (102002), Terminado (102003) o Inactivo (102004) no pueden modificarse
- El contrato debe existir en la base de datos
Campos actualizables:
- CodigoTipoContrato: Tipo de contrato
- NitContratante: NIT del contratante (debe existir en tabla Empresa)
- NitContratista: NIT del contratista (debe existir en tabla Empresa)
- Nombre: Nombre descriptivo del contrato
- FechaSuscripcion: Fecha de firma del contrato
- FechaInicio: Fecha de inicio de vigencia
- FechaFin: Fecha de finalización (opcional)
- Valor: Valor total del contrato
- CodigoReferenciaModalidadPago: Lista de modalidades de pago (para tipo 104001)
- CodigoReferenciaAgrupador: Lista de agrupadores (para tipo 104001)
- CodigoReferenciaRegimen: Lista de regímenes (para tipo 104001)
Validaciones automáticas aplicadas:
-
Validación de existencia:
- El IdContrato debe existir en la base de datos
-
Validación de NITs:
- NitContratante debe existir en dbo.Empresa
- NitContratista debe existir en dbo.Empresa
-
Validación de fechas:
- FechaSuscripcion debe ser menor o igual a FechaInicio
- FechaInicio debe ser menor que FechaFin (si FechaFin está presente)
-
Validación de duplicidad:
- No puede existir otro contrato (diferente al actual) con el mismo hash CUCON
- El hash se recalcula con los nuevos datos
-
Validaciones condicionales (tipo 104001):
- ModalidadPago es obligatoria
- Agrupador es obligatorio
- Regimen es obligatorio
Operaciones realizadas:
- Actualización del registro en tabla Contrato
- Eliminación de registros antiguos en ContratoModalidadPago, ContratoRegimen, ContratoAgrupador
- Creación de nuevos registros según los datos proporcionados
- Recálculo del hash CUCON
Nota importante: Si se eliminan valores de las listas (ModalidadPago, Regimen, Agrupador),
los registros relacionados se eliminarán automáticamente de la base de datos.
Sample request:
PUT /api/Contrato
{
"idContrato": 1,
"codigoTipoContrato": 104001,
"nitContratante": 900123456,
"nitContratista": 800654321,
"nombre": "Contrato Actualizado 2025",
"fechaSuscripcion": "2025-01-15",
"fechaInicio": "2025-02-01",
"fechaFin": "2025-12-31",
"valor": 550000000,
"codigoReferenciaModalidadPago": [1, 2, 3],
"codigoReferenciaAgrupador": [5],
"codigoReferenciaRegimen": [3, 4]
}
Consumes
This API call consumes the following media types via the request header:
application/json
text/json
application/*+json
Request body
Return type
Example data
Content-Type: application/json
{
"idContrato" : 0
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Contrato actualizado exitosamente. Retorna el ID del contrato modificado.
Minsalud_SIIFA_API_Features_Contrato_Commands_UpdateContrato_Result
400
Datos inválidos o validaciones fallidas. El detalle incluye la lista de errores de validación.
Microsoft_AspNetCore_Mvc_ProblemDetails
401
No autorizado. El token de autenticación es inválido, expiró o no se proporcionó.
Microsoft_AspNetCore_Mvc_ProblemDetails
404
Contrato no encontrado. No existe un contrato con el ID especificado.
Microsoft_AspNetCore_Mvc_ProblemDetails
409
Conflicto. El contrato no puede ser editado porque no está en estado "En creación" (102001) o porque generaría un CUCON duplicado.
Microsoft_AspNetCore_Mvc_ProblemDetails
500
Error interno del servidor al actualizar el contrato.
Microsoft_AspNetCore_Mvc_ProblemDetails
Up
get /api/ContratoAnticipo/ByIdContrato/{IdContrato}
Obtiene la lista de anticipos asociados a un contrato específico. (apiContratoAnticipoByIdContratoIdContratoGet)
Este endpoint permite consultar todos los anticipos registrados para un contrato, filtrando por el identificador del contrato.
Path parameters
IdContrato (required)
Path Parameter — default: null format: int32
Return type
Example data
Content-Type: application/json
{
"fechaAnticipo" : "2000-01-23T04:56:07.000+00:00",
"fechaRegistro" : "2000-01-23T04:56:07.000+00:00",
"valorAnticipo" : 5.962133916683182,
"idContratoAnticipo" : 0,
"codigoFuente" : 1,
"idContrato" : 6,
"referencia" : "referencia"
}
Example data
Content-Type: text/json
Custom MIME type example not yet supported: text/json
Example data
Content-Type: text/plain
Custom MIME type example not yet supported: text/plain
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
text/plain
application/json
text/json
Responses
200
Lista de anticipos obtenida exitosamente.
Minsalud_SIIFA_API_Contrato_Features_ContratoAnticipo_Queries_ListContratoAnticipoByIdContrato_Result
404
No se encontraron anticipos para el contrato especificado.
Up
delete /api/ContratoAnticipo/{IdContratoAnticipo}
Elimina un anticipo de contrato por su identificador. (apiContratoAnticipoIdContratoAnticipoDelete)
Este endpoint permite eliminar un anticipo de contrato existente, identificándolo por su ID único.
Path parameters
IdContratoAnticipo (required)
Path Parameter — default: null format: int64
Return type
Example data
Content-Type: application/json
{
"idContratoAnticipo" : 0
}
Example data
Content-Type: text/json
Custom MIME type example not yet supported: text/json
Example data
Content-Type: text/plain
Custom MIME type example not yet supported: text/plain
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
text/plain
application/json
text/json
Responses
200
Anticipo eliminado exitosamente.
Minsalud_SIIFA_API_Contrato_Features_ContratoAnticipo_Commands_DeleteContratoAnticipo_Result
404
No se encontró el anticipo a eliminar.
Up
get /api/ContratoAnticipo/{IdContratoAnticipo}
Obtiene el detalle de un anticipo de contrato por su identificador. (apiContratoAnticipoIdContratoAnticipoGet)
Este endpoint devuelve la información detallada de un anticipo de contrato específico, incluyendo valores, fechas y referencias.
Path parameters
IdContratoAnticipo (required)
Path Parameter — default: null format: int64
Return type
Example data
Content-Type: application/json
{
"fechaAnticipo" : "2000-01-23T04:56:07.000+00:00",
"fechaRegistro" : "2000-01-23T04:56:07.000+00:00",
"valorAnticipo" : 5.962133916683182,
"idContratoAnticipo" : 0,
"codigoFuente" : 1,
"idContrato" : 6,
"referencia" : "referencia"
}
Example data
Content-Type: text/json
Custom MIME type example not yet supported: text/json
Example data
Content-Type: text/plain
Custom MIME type example not yet supported: text/plain
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
text/plain
application/json
text/json
Responses
200
Detalle del anticipo obtenido exitosamente.
Minsalud_SIIFA_API_Contrato_Features_ContratoAnticipo_Queries_DetailContratoAnticipo_Result
404
No se encontró el anticipo solicitado.
Up
post /api/ContratoAnticipo
Registra un nuevo anticipo para un contrato. (apiContratoAnticipoPost)
Este endpoint permite crear un nuevo registro de anticipo asociado a un contrato, especificando los datos requeridos como valor, fecha y referencia.
Consumes
This API call consumes the following media types via the request header:
application/json
text/json
application/*+json
Request body
Return type
Example data
Content-Type: application/json
{
"idContratoAnticipo" : 0
}
Example data
Content-Type: text/json
Custom MIME type example not yet supported: text/json
Example data
Content-Type: text/plain
Custom MIME type example not yet supported: text/plain
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
text/plain
application/json
text/json
Responses
200
Anticipo registrado exitosamente.
Minsalud_SIIFA_API_Contrato_Features_ContratoAnticipo_Commands_AddContratoAnticipo_Result
400
Datos inválidos o faltantes en la solicitud.
Up
put /api/ContratoAnticipo
Actualiza la información de un anticipo de contrato existente. (apiContratoAnticipoPut)
Este endpoint permite modificar los datos de un anticipo previamente registrado, como el valor, la fecha o la referencia.
Consumes
This API call consumes the following media types via the request header:
application/json
text/json
application/*+json
Request body
Return type
Example data
Content-Type: application/json
{
"idContratoAnticipo" : 0
}
Example data
Content-Type: text/json
Custom MIME type example not yet supported: text/json
Example data
Content-Type: text/plain
Custom MIME type example not yet supported: text/plain
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
text/plain
application/json
text/json
Responses
200
Anticipo actualizado exitosamente.
Minsalud_SIIFA_API_Contrato_Features_ContratoAnticipo_Commands_UpdateContratoAnticipo_Result
404
No se encontró el anticipo a actualizar.
400
Datos inválidos en la solicitud.
Up
get /api/ContratoCums/ByIdContrato/{IdContrato}
Obtiene la lista de CUMS (medicamentos y suministros) asociados a un contrato específico. (apiContratoCumsByIdContratoIdContratoGet)
Este endpoint permite consultar todos los CUMS registrados para un contrato, filtrando por el identificador del contrato.
Información retornada:
- Código CUMS del medicamento o suministro
- Descripción y nombre comercial
- Principio activo
- Concentración y forma farmacéutica
- Valor unitario y modalidades de pago asociadas
- Cantidad contratada
Validaciones:
- El IdContrato debe ser un número positivo mayor a 0
- El contrato debe existir en la base de datos
Sample request:
GET /api/ContratoCums/ByIdContrato/1
GET /api/ContratoCums/ByIdContrato/150
Path parameters
IdContrato (required)
Path Parameter — default: null format: int32
Return type
Example data
Content-Type: application/json
{
"idContratoCums" : 0,
"fechaRegistro" : "2000-01-23T04:56:07.000+00:00",
"cums" : {
"descripcion" : "descripcion",
"codigoAtc" : "codigoAtc",
"expedienteCum" : 2,
"registroSanitario" : "registroSanitario",
"incluidoPbs" : true,
"idCums" : 5,
"nombre" : "nombre"
},
"cantidad" : 5,
"idContrato" : 6,
"idCums" : 1
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Lista de CUMS obtenida exitosamente con toda la información de medicamentos y suministros del contrato.
Minsalud_SIIFA_API_Features_Contrato_Queries_ListContratoCumsByIdContrato_Result
400
ID de contrato inválido. El ID debe ser un número positivo mayor a 0.
Microsoft_AspNetCore_Mvc_ProblemDetails
401
No autorizado. El token de autenticación es inválido, expiró o no se proporcionó.
Microsoft_AspNetCore_Mvc_ProblemDetails
404
Contrato no encontrado o sin CUMS asociados.
Microsoft_AspNetCore_Mvc_ProblemDetails
500
Error interno del servidor al obtener la lista de CUMS.
Microsoft_AspNetCore_Mvc_ProblemDetails
Up
delete /api/ContratoCums/{IdContratoCums}
Elimina permanentemente un CUMS de contrato del sistema por su identificador. (apiContratoCumsIdContratoCumsDelete)
Este endpoint permite eliminar un CUMS de contrato específico del sistema de forma permanente.
Esta operación es irreversible y debe usarse con precaución.
Restricciones importantes:
- Solo se permiten eliminaciones de CUMS en contratos que estén en estado "En creación" (102001)
- Los CUMS de contratos en estados Activo, Terminado o Inactivo no pueden eliminarse
- El CUMS debe existir en la base de datos
- El IdContratoCums debe ser un número positivo mayor a 0
Validaciones automáticas:
- El IdContratoCums debe ser mayor a 0
- El CUMS debe existir en la base de datos
- El contrato asociado debe estar en estado "En creación" (102001)
Eliminaciones en cascada:
Al eliminar un CUMS de contrato, se eliminarán automáticamente todos los registros relacionados:
- ContratoCumsModalidadPago: Todas las modalidades de pago asociadas al CUMS
Nota importante: Esta operación elimina el CUMS y TODOS sus datos relacionados
de forma permanente. No es posible recuperar la información después de la eliminación.
Para contratos que ya están activos, considere usar cambio de estado en lugar de eliminación física.
Sample request:
DELETE /api/ContratoCums/1
DELETE /api/ContratoCums/250
Path parameters
IdContratoCums (required)
Path Parameter — default: null format: int32
Return type
Example data
Content-Type: application/json
{
"idContratoCums" : 0
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
CUMS eliminado exitosamente junto con todos sus registros relacionados.
Minsalud_SIIFA_API_Features_Contrato_Commands_DeleteContratoCums_Result
400
ID de CUMS inválido. El ID debe ser un número positivo mayor a 0.
Microsoft_AspNetCore_Mvc_ProblemDetails
401
No autorizado. El token de autenticación es inválido, expiró o no se proporcionó.
Microsoft_AspNetCore_Mvc_ProblemDetails
404
CUMS de contrato no encontrado. No existe un registro con el ID especificado.
Microsoft_AspNetCore_Mvc_ProblemDetails
409
Conflicto. El CUMS no puede ser eliminado porque el contrato no está en estado "En creación" (102001) o tiene dependencias que no permiten su eliminación.
Microsoft_AspNetCore_Mvc_ProblemDetails
500
Error interno del servidor al eliminar el CUMS.
Microsoft_AspNetCore_Mvc_ProblemDetails
Up
get /api/ContratoCums/{IdContratoCums}
Obtiene el detalle completo de un CUMS de contrato por su identificador. (apiContratoCumsIdContratoCumsGet)
Este endpoint devuelve información detallada y completa de un CUMS de contrato específico, incluyendo:
Información del medicamento/suministro:
- Código CUMS completo
- Nombre genérico y comercial
- Principio activo y composición
- Concentración y forma farmacéutica
- Vía de administración
- Presentación comercial
Información contractual:
- Identificador del contrato asociado
- Valor unitario pactado
- Cantidad contratada
- Modalidades de pago aplicables
- Vigencia de la asociación
Validaciones:
- El IdContratoCums debe ser un número positivo mayor a 0
- El registro debe existir en la base de datos
Sample request:
GET /api/ContratoCums/1
GET /api/ContratoCums/250
Path parameters
IdContratoCums (required)
Path Parameter — default: null format: int32
Return type
Example data
Content-Type: application/json
{
"idContratoCums" : 0,
"fechaRegistro" : "2000-01-23T04:56:07.000+00:00",
"cums" : {
"descripcion" : "descripcion",
"codigoAtc" : "codigoAtc",
"expedienteCum" : 2,
"registroSanitario" : "registroSanitario",
"incluidoPbs" : true,
"idCums" : 5,
"nombre" : "nombre"
},
"cantidad" : 5,
"idContrato" : 6,
"idCums" : 1
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Detalle del CUMS obtenido exitosamente con toda la información relacionada.
Minsalud_SIIFA_API_Features_Contrato_Queries_DetailContratoCums_Result
400
ID de CUMS inválido. El ID debe ser un número positivo mayor a 0.
Microsoft_AspNetCore_Mvc_ProblemDetails
401
No autorizado. El token de autenticación es inválido, expiró o no se proporcionó.
Microsoft_AspNetCore_Mvc_ProblemDetails
404
CUMS de contrato no encontrado. No existe un registro con el ID especificado.
Microsoft_AspNetCore_Mvc_ProblemDetails
500
Error interno del servidor al obtener el detalle del CUMS.
Microsoft_AspNetCore_Mvc_ProblemDetails
Up
post /api/ContratoCums
Registra un nuevo CUMS (medicamento o suministro) asociado a un contrato. (apiContratoCumsPost)
Este endpoint permite crear un nuevo registro de CUMS vinculado a un contrato con validaciones automáticas de integridad.
Datos requeridos:
- IdContrato: Identificador del contrato (debe existir)
- CodigoCums: Código único del medicamento o suministro (debe existir en ReferenciaCums)
- ValorUnitario: Valor unitario del CUMS (debe ser mayor a 0)
- Cantidad: Cantidad contratada (debe ser mayor a 0)
Datos opcionales:
- CodigoReferenciaModalidadPago: Lista de modalidades de pago aplicables
- Observaciones: Notas adicionales sobre el CUMS contratado
Validaciones automáticas aplicadas:
-
Validación de existencia:
- El IdContrato debe existir en la tabla Contrato
- El CodigoCums debe existir en la tabla ReferenciaCums
-
Validación de valores:
- ValorUnitario debe ser mayor a 0
- Cantidad debe ser mayor a 0
-
Validación de duplicidad:
- No puede existir el mismo CodigoCums asociado al mismo IdContrato
-
Validación de estado del contrato:
- El contrato debe estar en estado "En creación" (102001) para permitir agregar CUMS
Registros creados:
- 1 registro en tabla ContratoCums
- N registros en tabla ContratoCumsModalidadPago (si se especifican modalidades)
Sample request:
POST /api/ContratoCums
{
"idContrato": 1,
"codigoCums": "19934455-1",
"valorUnitario": 15000.50,
"cantidad": 1000,
"codigoReferenciaModalidadPago": [1, 2],
"observaciones": "Medicamento de alto costo"
}
Consumes
This API call consumes the following media types via the request header:
application/json
text/json
application/*+json
Request body
Return type
Example data
Content-Type: application/json
{
"idContratoCums" : 0,
"idContrato" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
CUMS registrado exitosamente. Retorna el ID del nuevo registro.
Minsalud_SIIFA_API_Features_Contrato_Commands_AddContratoCums_Result
400
Datos inválidos o validaciones fallidas. El detalle incluye la lista de errores de validación con el campo y el mensaje correspondiente.
Microsoft_AspNetCore_Mvc_ProblemDetails
401
No autorizado. El token de autenticación es inválido, expiró o no se proporcionó.
Microsoft_AspNetCore_Mvc_ProblemDetails
409
Conflicto. Ya existe un CUMS con el mismo código asociado al contrato o el contrato no está en estado editable.
Microsoft_AspNetCore_Mvc_ProblemDetails
500
Error interno del servidor al crear el CUMS.
Microsoft_AspNetCore_Mvc_ProblemDetails
Actualiza la información de un CUMS de contrato existente. (apiContratoCumsPut)
Este endpoint permite modificar los datos de un CUMS previamente registrado aplicando las mismas
validaciones que en la creación del CUMS.
Restricciones importantes:
- Solo se permiten actualizaciones en contratos que estén en estado "En creación" (102001)
- Los contratos en estados Activo, Terminado o Inactivo no pueden modificar sus CUMS
- El CUMS debe existir en la base de datos
Campos actualizables:
- CodigoCums: Código del medicamento o suministro (debe existir en ReferenciaCums)
- ValorUnitario: Valor unitario del CUMS (debe ser mayor a 0)
- Cantidad: Cantidad contratada (debe ser mayor a 0)
- CodigoReferenciaModalidadPago: Lista de modalidades de pago
- Observaciones: Notas adicionales
Validaciones automáticas aplicadas:
-
Validación de existencia:
- El IdContratoCums debe existir en la base de datos
- El CodigoCums debe existir en ReferenciaCums
-
Validación de valores:
- ValorUnitario debe ser mayor a 0
- Cantidad debe ser mayor a 0
-
Validación de duplicidad:
- No puede existir otro registro (diferente al actual) con el mismo CodigoCums para el mismo contrato
-
Validación de estado:
- El contrato asociado debe estar en estado "En creación" (102001)
Operaciones realizadas:
- Actualización del registro en tabla ContratoCums
- Eliminación de registros antiguos en ContratoCumsModalidadPago
- Creación de nuevos registros de modalidades de pago según los datos proporcionados
Sample request:
PUT /api/ContratoCums
{
"idContratoCums": 1,
"idContrato": 1,
"codigoCums": "19934455-1",
"valorUnitario": 16500.00,
"cantidad": 1500,
"codigoReferenciaModalidadPago": [1, 2, 3],
"observaciones": "Actualización de precio y cantidad"
}
Consumes
This API call consumes the following media types via the request header:
application/json
text/json
application/*+json
Request body
Return type
Example data
Content-Type: application/json
{
"idContratoCums" : 0,
"idContrato" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
CUMS actualizado exitosamente. Retorna el ID del registro modificado.
Minsalud_SIIFA_API_Features_Contrato_Commands_UpdateContratoCums_Result
400
Datos inválidos o validaciones fallidas. El detalle incluye la lista de errores de validación.
Microsoft_AspNetCore_Mvc_ProblemDetails
401
No autorizado. El token de autenticación es inválido, expiró o no se proporcionó.
Microsoft_AspNetCore_Mvc_ProblemDetails
404
CUMS de contrato no encontrado. No existe un registro con el ID especificado.
Microsoft_AspNetCore_Mvc_ProblemDetails
409
Conflicto. El CUMS no puede ser editado porque el contrato no está en estado "En creación" (102001) o porque generaría un código duplicado.
Microsoft_AspNetCore_Mvc_ProblemDetails
500
Error interno del servidor al actualizar el CUMS.
Microsoft_AspNetCore_Mvc_ProblemDetails
Up
delete /api/ContratoCumsModalidadPago/{IdContratoCumsModalidadPago}
Elimina una modalidad de pago de CUMS de contrato por su identificador. (apiContratoCumsModalidadPagoIdContratoCumsModalidadPagoDelete)
Este endpoint permite eliminar una modalidad de pago asociada a un CUMS de contrato, identificándola por su ID único.
Path parameters
IdContratoCumsModalidadPago (required)
Path Parameter — default: null format: int32
Return type
Example data
Content-Type: application/json
{
"idContratoCumsModalidadPago" : 0
}
Example data
Content-Type: text/json
Custom MIME type example not yet supported: text/json
Example data
Content-Type: text/plain
Custom MIME type example not yet supported: text/plain
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
text/plain
application/json
text/json
Responses
200
Modalidad de pago eliminada exitosamente.
Minsalud_SIIFA_API_Features_ContratoCumsModalidadPago_Commands_DeleteContratoCumsModalidadPago_Result
404
No se encontró la modalidad de pago a eliminar.
Up
get /api/ContratoCumsModalidadPago/{IdContratoCumsModalidadPago}
Obtiene el detalle de una modalidad de pago de CUMS de contrato por su identificador. (apiContratoCumsModalidadPagoIdContratoCumsModalidadPagoGet)
Este endpoint devuelve la información detallada de una modalidad de pago asociada a un CUMS de contrato específico.
Path parameters
IdContratoCumsModalidadPago (required)
Path Parameter — default: null format: int64
Return type
Example data
Content-Type: application/json
{
"idContratoCums" : 6,
"idContratoModalidadPago" : 1,
"fechaRegistro" : "2000-01-23T04:56:07.000+00:00",
"valor" : 5.962133916683182,
"idContratoCumsModalidadPago" : 0
}
Example data
Content-Type: text/json
Custom MIME type example not yet supported: text/json
Example data
Content-Type: text/plain
Custom MIME type example not yet supported: text/plain
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
text/plain
application/json
text/json
Responses
200
Detalle de la modalidad de pago obtenido exitosamente.
Minsalud_SIIFA_API_Contrato_Features_ContratoCumsModalidadPago_Queries_DetailContratoCumsModalidadPago_Result
404
No se encontró la modalidad de pago solicitada.
Up
post /api/ContratoCumsModalidadPago
Registra una nueva modalidad de pago para un CUMS de contrato. (apiContratoCumsModalidadPagoPost)
Este endpoint permite crear un nuevo registro de modalidad de pago asociada a un CUMS de contrato, especificando los datos requeridos.
Consumes
This API call consumes the following media types via the request header:
application/json
text/json
application/*+json
Request body
Return type
Example data
Content-Type: application/json
{
"idContratoCumsModalidadPago" : 0
}
Example data
Content-Type: text/json
Custom MIME type example not yet supported: text/json
Example data
Content-Type: text/plain
Custom MIME type example not yet supported: text/plain
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
text/plain
application/json
text/json
Responses
200
Modalidad de pago registrada exitosamente.
Minsalud_SIIFA_API_Features_ContratoCumsModalidadPago_Commands_AddContratoCumsModalidadPago_Result
400
Datos inválidos o faltantes en la solicitud.
Up
put /api/ContratoCumsModalidadPago
Actualiza la información de una modalidad de pago de CUMS de contrato existente. (apiContratoCumsModalidadPagoPut)
Este endpoint permite modificar los datos de una modalidad de pago previamente registrada para un CUMS de contrato.
Consumes
This API call consumes the following media types via the request header:
application/json
text/json
application/*+json
Request body
Return type
Example data
Content-Type: application/json
{
"idContratoCumsModalidaPago" : 0
}
Example data
Content-Type: text/json
Custom MIME type example not yet supported: text/json
Example data
Content-Type: text/plain
Custom MIME type example not yet supported: text/plain
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
text/plain
application/json
text/json
Responses
200
Modalidad de pago actualizada exitosamente.
Minsalud_SIIFA_API_Features_ContratoCumsModalidadPago_Commands_UpdateContratoCumsModalidadPago_Result
404
No se encontró la modalidad de pago a actualizar.
400
Datos inválidos en la solicitud.
Up
get /api/ContratoCups/ByIdContrato/{IdContrato}
Obtiene la lista de CUPS asociados a un contrato específico. (apiContratoCupsByIdContratoIdContratoGet)
Este endpoint permite consultar todos los CUPS registrados para un contrato, filtrando por el identificador del contrato.
Path parameters
IdContrato (required)
Path Parameter — default: null format: int32
Return type
Example data
Content-Type: application/json
{
"codigoCupsSispro" : "codigoCupsSispro",
"idContratoCups" : 0,
"fechaRegistro" : "2000-01-23T04:56:07.000+00:00",
"cantidad" : 1,
"cups" : {
"codigoCupsSispro" : "codigoCupsSispro",
"codigoCupsNumerico" : 5,
"incluidoPbs" : true,
"nombre" : "nombre"
},
"idContrato" : 6
}
Example data
Content-Type: text/json
Custom MIME type example not yet supported: text/json
Example data
Content-Type: text/plain
Custom MIME type example not yet supported: text/plain
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
text/plain
application/json
text/json
Responses
200
Lista de CUPS obtenida exitosamente.
Minsalud_SIIFA_API_Features_ContratoCups_Queries_ListContratoCupsByIdContrato_Result
404
No se encontraron CUPS para el contrato especificado.
Up
delete /api/ContratoCups/{IdContratoCups}
Elimina un CUPS de contrato por su identificador. (apiContratoCupsIdContratoCupsDelete)
Este endpoint permite eliminar un CUPS de contrato existente, identificándolo por su ID único.
Path parameters
IdContratoCups (required)
Path Parameter — default: null format: int32
Return type
Example data
Content-Type: application/json
{
"idContratoCums" : 0
}
Example data
Content-Type: text/json
Custom MIME type example not yet supported: text/json
Example data
Content-Type: text/plain
Custom MIME type example not yet supported: text/plain
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
text/plain
application/json
text/json
Responses
200
CUPS eliminado exitosamente.
Minsalud_SIIFA_API_Features_ContratoCups_Commands_DeleteContratoCups_Result
404
No se encontró el CUPS a eliminar.
Up
get /api/ContratoCups/{IdContratoCups}
Obtiene el detalle de un CUPS de contrato por su identificador. (apiContratoCupsIdContratoCupsGet)
Este endpoint devuelve la información detallada de un CUPS de contrato específico, incluyendo datos del procedimiento o servicio.
Path parameters
IdContratoCups (required)
Path Parameter — default: null format: int32
Return type
Example data
Content-Type: application/json
{
"codigoCupsSispro" : "codigoCupsSispro",
"idContratoCups" : 0,
"fechaRegistro" : "2000-01-23T04:56:07.000+00:00",
"cantidad" : 1,
"cups" : {
"codigoCupsSispro" : "codigoCupsSispro",
"codigoCupsNumerico" : 5,
"incluidoPbs" : true,
"nombre" : "nombre"
},
"idContrato" : 6
}
Example data
Content-Type: text/json
Custom MIME type example not yet supported: text/json
Example data
Content-Type: text/plain
Custom MIME type example not yet supported: text/plain
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
text/plain
application/json
text/json
Responses
200
Detalle del CUPS obtenido exitosamente.
Minsalud_SIIFA_API_Features_ContratoCups_Queries_DetailContratoCups_Result
404
No se encontró el CUPS solicitado.
Up
post /api/ContratoCups
Registra un nuevo CUPS para un contrato. (apiContratoCupsPost)
Este endpoint permite crear un nuevo registro de CUPS asociado a un contrato, especificando los datos requeridos como código, descripción y valor.
Consumes
This API call consumes the following media types via the request header:
application/json
text/json
application/*+json
Request body
Return type
Example data
Content-Type: application/json
{
"idContratoCups" : 0,
"idContrato" : 6
}
Example data
Content-Type: text/json
Custom MIME type example not yet supported: text/json
Example data
Content-Type: text/plain
Custom MIME type example not yet supported: text/plain
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
text/plain
application/json
text/json
Responses
200
CUPS registrado exitosamente.
Minsalud_SIIFA_API_Features_ContratoCups_Commands_AddContratoCups_Result
400
Datos inválidos o faltantes en la solicitud.
Actualiza la información de un CUPS de contrato existente. (apiContratoCupsPut)
Este endpoint permite modificar los datos de un CUPS previamente registrado, como el código, la descripción o el valor.
Consumes
This API call consumes the following media types via the request header:
application/json
text/json
application/*+json
Request body
Return type
Example data
Content-Type: application/json
{
"idContratoCups" : 0,
"idContrato" : 6
}
Example data
Content-Type: text/json
Custom MIME type example not yet supported: text/json
Example data
Content-Type: text/plain
Custom MIME type example not yet supported: text/plain
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
text/plain
application/json
text/json
Responses
200
CUPS actualizado exitosamente.
Minsalud_SIIFA_API_Features_ContratoCups_Commands_UpdateContratoCups_Result
404
No se encontró el CUPS a actualizar.
400
Datos inválidos en la solicitud.
Up
delete /api/ContratoCupsModalidadPago/{IdContratoCupsModalidadPago}
Elimina una modalidad de pago de CUPS de contrato por su identificador. (apiContratoCupsModalidadPagoIdContratoCupsModalidadPagoDelete)
Este endpoint permite eliminar una modalidad de pago asociada a un procedimiento (CUPS) de contrato, identificándola por su ID único.
Path parameters
IdContratoCupsModalidadPago (required)
Path Parameter — default: null format: int32
Return type
Example data
Content-Type: application/json
{
"idContratoCupsModalidadPago" : 0
}
Example data
Content-Type: text/json
Custom MIME type example not yet supported: text/json
Example data
Content-Type: text/plain
Custom MIME type example not yet supported: text/plain
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
text/plain
application/json
text/json
Responses
200
Modalidad de pago eliminada exitosamente.
Minsalud_SIIFA_API_Features_ContratoCupsModalidadPago_Commands_DeleteContratoCupsModalidadPago_Result
404
No se encontró la modalidad de pago a eliminar.
Up
get /api/ContratoCupsModalidadPago/{IdContratoCupsModalidadPago}
Obtiene el detalle de una modalidad de pago de CUPS de contrato por su identificador. (apiContratoCupsModalidadPagoIdContratoCupsModalidadPagoGet)
Este endpoint devuelve la información detallada de una modalidad de pago asociada a un procedimiento (CUPS) de contrato específico.
Path parameters
IdContratoCupsModalidadPago (required)
Path Parameter — default: null format: int64
Return type
Example data
Content-Type: application/json
{
"idContratoCups" : 6,
"idContratoModalidadPago" : 1,
"fechaRegistro" : "2000-01-23T04:56:07.000+00:00",
"valor" : 5.962133916683182,
"idContratoCupsModalidadPago" : 0
}
Example data
Content-Type: text/json
Custom MIME type example not yet supported: text/json
Example data
Content-Type: text/plain
Custom MIME type example not yet supported: text/plain
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
text/plain
application/json
text/json
Responses
200
Detalle de la modalidad de pago obtenido exitosamente.
Minsalud_SIIFA_API_Contrato_Features_ContratoCupsModalidadPago_Queries_DetailContratoCupsModalidadPago_Result
404
No se encontró la modalidad de pago solicitada.
Up
post /api/ContratoCupsModalidadPago
Registra una nueva modalidad de pago para un CUPS de contrato. (apiContratoCupsModalidadPagoPost)
Este endpoint permite crear un nuevo registro de modalidad de pago asociada a un procedimiento (CUPS) de contrato, especificando los datos requeridos.
Consumes
This API call consumes the following media types via the request header:
application/json
text/json
application/*+json
Request body
Return type
Example data
Content-Type: application/json
{
"idContratoCupsModalidadPago" : 0
}
Example data
Content-Type: text/json
Custom MIME type example not yet supported: text/json
Example data
Content-Type: text/plain
Custom MIME type example not yet supported: text/plain
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
text/plain
application/json
text/json
Responses
200
Modalidad de pago registrada exitosamente.
Minsalud_SIIFA_API_Features_ContratoCupsModalidadPago_Commands_AddContratoCupsModalidadPago_Result
400
Datos inválidos o faltantes en la solicitud.
Up
put /api/ContratoCupsModalidadPago
Actualiza la información de una modalidad de pago de CUPS de contrato existente. (apiContratoCupsModalidadPagoPut)
Este endpoint permite modificar los datos de una modalidad de pago previamente registrada para un procedimiento (CUPS) de contrato.
Consumes
This API call consumes the following media types via the request header:
application/json
text/json
application/*+json
Request body
Return type
Example data
Content-Type: application/json
{
"idContratoCupsModalidaPago" : 0
}
Example data
Content-Type: text/json
Custom MIME type example not yet supported: text/json
Example data
Content-Type: text/plain
Custom MIME type example not yet supported: text/plain
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
text/plain
application/json
text/json
Responses
200
Modalidad de pago actualizada exitosamente.
Minsalud_SIIFA_API_Features_ContratoCupsModalidadPago_Commands_UpdateContratoCupsModalidadPago_Result
404
No se encontró la modalidad de pago a actualizar.
400
Datos inválidos en la solicitud.
Up
get /api/ContratoEstado/ByIdContrato/{IdContrato}
Obtiene el historial de estados asociados a un contrato específico. (apiContratoEstadoByIdContratoIdContratoGet)
Este endpoint permite consultar todos los estados registrados para un contrato, filtrando por el identificador del contrato.
El resultado incluye información detallada de cada cambio de estado, como fechas, observaciones y descripción del estado.
Path parameters
IdContrato (required)
Path Parameter — default: null format: int32
Return type
Example data
Content-Type: application/json
{
"fechaCambio" : "2000-01-23T04:56:07.000+00:00",
"nombreEstado" : "nombreEstado",
"fechaRegistro" : "2000-01-23T04:56:07.000+00:00",
"codigoEstado" : 1,
"idContrato" : 6,
"observacion" : "observacion",
"idContratoEstado" : 0
}
Example data
Content-Type: text/json
Custom MIME type example not yet supported: text/json
Example data
Content-Type: text/plain
Custom MIME type example not yet supported: text/plain
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
text/plain
application/json
text/json
Responses
200
Lista de estados obtenida exitosamente.
Minsalud_SIIFA_API_Features_ContratoEstado_Queries_ListContratoEstadoByIdContrato_Result
404
No se encontraron estados para el contrato especificado.
Up
post /api/ContratoEstado
Registra un nuevo cambio de estado para un contrato. (apiContratoEstadoPost)
Este endpoint permite crear un nuevo registro de cambio de estado asociado a un contrato, especificando los datos requeridos como el código de estado, observación y fecha.
Consumes
This API call consumes the following media types via the request header:
application/json
text/json
application/*+json
Request body
Return type
Example data
Content-Type: application/json
{
"idContrato" : 6,
"idContratoEstado" : 0
}
Example data
Content-Type: text/json
Custom MIME type example not yet supported: text/json
Example data
Content-Type: text/plain
Custom MIME type example not yet supported: text/plain
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
text/plain
application/json
text/json
Responses
200
Cambio de estado registrado exitosamente.
Minsalud_SIIFA_API_Features_ContratoEstado_Commands_AddContratoEstado_Result
400
Datos inválidos o faltantes en la solicitud.
Up
get /api/ContratoLiquidacion/ByIdContrato/{IdContrato}
Obtiene la lista de liquidaciones asociadas a un contrato específico. (apiContratoLiquidacionByIdContratoIdContratoGet)
Este endpoint permite consultar todas las liquidaciones registradas para un contrato, filtrando por el identificador del contrato.
Path parameters
IdContrato (required)
Path Parameter — default: null format: int32
Return type
Example data
Content-Type: application/json
{
"valorNetoPagar" : 4.145608029883936,
"fechaRegistro" : "2000-01-23T04:56:07.000+00:00",
"valorTotalPagado" : 2.3021358869347655,
"valorMultas" : 7.386281948385884,
"valorTotalEjecutado" : 5.637376656633329,
"codigoCausal" : 1,
"valorDeducciones" : 2.027123023002322,
"valorTotalContrato" : 5.962133916683182,
"idContratoLiquidacion" : 0,
"causalLiquidacion" : {
"descripcion" : "descripcion",
"codigoReferencia" : 1
},
"valorSaldoFavorContratante" : 9.301444243932576,
"fechaLiquidacion" : "2000-01-23T04:56:07.000+00:00",
"idContrato" : 6,
"valorIndemnizacion" : 3.616076749251911,
"valorSaldoFavorContratista" : 7.061401241503109
}
Example data
Content-Type: text/json
Custom MIME type example not yet supported: text/json
Example data
Content-Type: text/plain
Custom MIME type example not yet supported: text/plain
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
text/plain
application/json
text/json
Responses
200
Lista de liquidaciones obtenida exitosamente.
Minsalud_SIIFA_API_Features_ContratoLiquidacion_Queries_ListContratoLiquidacionByIdContrato_Result
404
No se encontraron liquidaciones para el contrato especificado.
Up
delete /api/ContratoLiquidacion/{IdContratoLiquidacion}
Elimina una liquidación de contrato por su identificador. (apiContratoLiquidacionIdContratoLiquidacionDelete)
Este endpoint permite eliminar una liquidación de contrato existente, identificándola por su ID único.
Path parameters
IdContratoLiquidacion (required)
Path Parameter — default: null format: int64
Return type
Example data
Content-Type: application/json
{
"idContratoLiquidacion" : 0
}
Example data
Content-Type: text/json
Custom MIME type example not yet supported: text/json
Example data
Content-Type: text/plain
Custom MIME type example not yet supported: text/plain
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
text/plain
application/json
text/json
Responses
200
Liquidación eliminada exitosamente.
Minsalud_SIIFA_API_Features_ContratoLiquidacion_Commands_DeleteContratoLiquidacion_Result
404
No se encontró la liquidación a eliminar.
Up
get /api/ContratoLiquidacion/{IdContratoLiquidacion}
Obtiene el detalle de una liquidación de contrato por su identificador. (apiContratoLiquidacionIdContratoLiquidacionGet)
Este endpoint devuelve la información detallada de una liquidación de contrato específica, incluyendo valores, fechas y observaciones.
Path parameters
IdContratoLiquidacion (required)
Path Parameter — default: null format: int64
Return type
Example data
Content-Type: application/json
{
"valorNetoPagar" : 4.145608029883936,
"fechaRegistro" : "2000-01-23T04:56:07.000+00:00",
"valorTotalPagado" : 2.3021358869347655,
"valorMultas" : 7.386281948385884,
"valorTotalEjecutado" : 5.637376656633329,
"codigoCausal" : 1,
"valorDeducciones" : 2.027123023002322,
"valorTotalContrato" : 5.962133916683182,
"idContratoLiquidacion" : 0,
"causalLiquidacion" : {
"descripcion" : "descripcion",
"codigoReferencia" : 1
},
"valorSaldoFavorContratante" : 9.301444243932576,
"fechaLiquidacion" : "2000-01-23T04:56:07.000+00:00",
"idContrato" : 6,
"valorIndemnizacion" : 3.616076749251911,
"valorSaldoFavorContratista" : 7.061401241503109
}
Example data
Content-Type: text/json
Custom MIME type example not yet supported: text/json
Example data
Content-Type: text/plain
Custom MIME type example not yet supported: text/plain
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
text/plain
application/json
text/json
Responses
200
Detalle de la liquidación obtenido exitosamente.
Minsalud_SIIFA_API_Features_ContratoLiquidacion_Queries_DetailContratoLiquidacion_Result
404
No se encontró la liquidación solicitada.
Up
post /api/ContratoLiquidacion
Registra una nueva liquidación para un contrato. (apiContratoLiquidacionPost)
Este endpoint permite crear un nuevo registro de liquidación asociada a un contrato, especificando los datos requeridos como valores, fechas y observaciones.
Consumes
This API call consumes the following media types via the request header:
application/json
text/json
application/*+json
Request body
Return type
Example data
Content-Type: application/json
{
"idContratoLiquidacion" : 0,
"idContrato" : 6
}
Example data
Content-Type: text/json
Custom MIME type example not yet supported: text/json
Example data
Content-Type: text/plain
Custom MIME type example not yet supported: text/plain
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
text/plain
application/json
text/json
Responses
200
Liquidación registrada exitosamente.
Minsalud_SIIFA_API_Features_ContratoLiquidacion_Commands_AddContratoLiquidacion_Result
400
Datos inválidos o faltantes en la solicitud.
Up
put /api/ContratoLiquidacion
Actualiza la información de una liquidación de contrato existente. (apiContratoLiquidacionPut)
Este endpoint permite modificar los datos de una liquidación previamente registrada, como valores, fechas u observaciones.
Consumes
This API call consumes the following media types via the request header:
application/json
text/json
application/*+json
Request body
Return type
Example data
Content-Type: application/json
{
"idContratoLiquidacion" : 0
}
Example data
Content-Type: text/json
Custom MIME type example not yet supported: text/json
Example data
Content-Type: text/plain
Custom MIME type example not yet supported: text/plain
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
text/plain
application/json
text/json
Responses
200
Liquidación actualizada exitosamente.
Minsalud_SIIFA_API_Features_ContratoLiquidacion_Commands_UpdateContratoLiquidacion_Result
404
No se encontró la liquidación a actualizar.
400
Datos inválidos en la solicitud.
Up
get /api/ContratoModalidadPago/ByIdContrato/{IdContrato}
Obtiene la lista de modalidades de pago asociadas a un contrato específico. (apiContratoModalidadPagoByIdContratoIdContratoGet)
Este endpoint permite consultar todas las modalidades de pago registradas para un contrato, filtrando por el identificador del contrato.
Path parameters
IdContrato (required)
Path Parameter — default: null format: int32
Return type
Example data
Content-Type: application/json
{
"idContratoModalidadPago" : 0,
"fechaRegistro" : "2000-01-23T04:56:07.000+00:00",
"idContrato" : 6,
"codigoModalidad" : 1
}
Example data
Content-Type: text/json
Custom MIME type example not yet supported: text/json
Example data
Content-Type: text/plain
Custom MIME type example not yet supported: text/plain
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
text/plain
application/json
text/json
Responses
200
Lista de modalidades de pago obtenida exitosamente.
Minsalud_SIIFA_API_Contrato_Features_ContratoModalidadPago_Queries_ListContratoModalidadPagoByIdContrato_Result
404
No se encontraron modalidades de pago para el contrato especificado.
Up
delete /api/ContratoModalidadPago/{IdContratoModalidadPago}
Elimina una modalidad de pago de contrato por su identificador. (apiContratoModalidadPagoIdContratoModalidadPagoDelete)
Este endpoint permite eliminar una modalidad de pago asociada a un contrato, identificándola por su ID único.
Path parameters
IdContratoModalidadPago (required)
Path Parameter — default: null format: int64
Return type
Example data
Content-Type: application/json
{
"idContratoModalidadPago" : 0
}
Example data
Content-Type: text/json
Custom MIME type example not yet supported: text/json
Example data
Content-Type: text/plain
Custom MIME type example not yet supported: text/plain
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
text/plain
application/json
text/json
Responses
200
Modalidad de pago eliminada exitosamente.
Minsalud_SIIFA_API_Contrato_Features_ContratoModalidadPago_Commands_DeleteContratoModalidadPago_Result
404
No se encontró la modalidad de pago a eliminar.
Up
get /api/ContratoModalidadPago/{IdContratoModalidadPago}
Obtiene el detalle de una modalidad de pago de contrato por su identificador. (apiContratoModalidadPagoIdContratoModalidadPagoGet)
Este endpoint devuelve la información detallada de una modalidad de pago asociada a un contrato específico.
Path parameters
IdContratoModalidadPago (required)
Path Parameter — default: null format: int64
Return type
Example data
Content-Type: application/json
{
"idContratoModalidadPago" : 0,
"fechaRegistro" : "2000-01-23T04:56:07.000+00:00",
"idContrato" : 6,
"codigoModalidad" : 1
}
Example data
Content-Type: text/json
Custom MIME type example not yet supported: text/json
Example data
Content-Type: text/plain
Custom MIME type example not yet supported: text/plain
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
text/plain
application/json
text/json
Responses
200
Detalle de la modalidad de pago obtenido exitosamente.
Minsalud_SIIFA_API_Contrato_Features_ContratoModalidadPago_Queries_DetailContratoModalidadPago_Result
404
No se encontró la modalidad de pago solicitada.
Up
post /api/ContratoModalidadPago
Registra una nueva modalidad de pago para un contrato. (apiContratoModalidadPagoPost)
Este endpoint permite crear un nuevo registro de modalidad de pago asociada a un contrato, especificando los datos requeridos.
Consumes
This API call consumes the following media types via the request header:
application/json
text/json
application/*+json
Request body
Return type
Example data
Content-Type: application/json
{
"idContratoModalidadPago" : 0,
"idContrato" : 6
}
Example data
Content-Type: text/json
Custom MIME type example not yet supported: text/json
Example data
Content-Type: text/plain
Custom MIME type example not yet supported: text/plain
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
text/plain
application/json
text/json
Responses
200
Modalidad de pago registrada exitosamente.
Minsalud_SIIFA_API_Contrato_Features_ContratoModalidadPago_Commands_AddContratoModalidadPago_Result
400
Datos inválidos o faltantes en la solicitud.
Up
put /api/ContratoModalidadPago
Actualiza la información de una modalidad de pago de contrato existente. (apiContratoModalidadPagoPut)
Este endpoint permite modificar los datos de una modalidad de pago previamente registrada para un contrato.
Consumes
This API call consumes the following media types via the request header:
application/json
text/json
application/*+json
Request body
Return type
Example data
Content-Type: application/json
{
"idContratoModalidadPago" : 0,
"idContrato" : 6
}
Example data
Content-Type: text/json
Custom MIME type example not yet supported: text/json
Example data
Content-Type: text/plain
Custom MIME type example not yet supported: text/plain
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
text/plain
application/json
text/json
Responses
200
Modalidad de pago actualizada exitosamente.
Minsalud_SIIFA_API_Contrato_Features_ContratoModalidadPago_Commands_UpdateContratoModalidadPago_Result
404
No se encontró la modalidad de pago a actualizar.
400
Datos inválidos en la solicitud.
Up
get /api/ContratoOperacion/ByIdContrato
Obtiene una lista paginada de operaciones asociadas a un contrato específico con filtros opcionales. (apiContratoOperacionByIdContratoGet)
Este endpoint permite consultar las operaciones de cobertura geográfica y poblacional registradas para un contrato.
Filtros disponibles:
- IdContrato: Identificador del contrato (obligatorio en el query string)
- CodigoMunicipio: Filtro opcional por código de municipio
- CodigoDepartamento: Filtro opcional por código de departamento
- NumeroPagina: Número de página para paginación (debe ser mayor a 0, default: 1)
- RegistrosPorPagina: Cantidad de registros por página (debe ser mayor a 0 y menor o igual a 100, default: 10)
Información devuelta por cada operación:
- Identificador de la operación (IdContratoOperacion)
- Identificador del contrato (IdContrato)
- Código y nombre del municipio (si aplica según el alcance)
- Código y nombre del departamento (si aplica según el alcance)
- Población cubierta (número de personas)
- Fecha de registro de la operación
Los resultados se ordenan por fecha de registro descendente y se devuelven paginados con metadatos que incluyen:
- Total de registros encontrados
- Total de páginas disponibles
- Página actual
- Registros por página
Validaciones:
- IdContrato es obligatorio y debe ser mayor a 0
- NumeroPagina debe ser mayor a 0 (si se proporciona)
- RegistrosPorPagina debe ser mayor a 0 y no superar 100 (si se proporciona)
Sample request:
GET /api/ContratoOperacion/ByIdContrato?IdContrato=1&NumeroPagina=1&RegistrosPorPagina=10
GET /api/ContratoOperacion/ByIdContrato?IdContrato=1&CodigoDepartamento=25
GET /api/ContratoOperacion/ByIdContrato?IdContrato=1&CodigoMunicipio=25001
Query parameters
IdContrato (optional)
Query Parameter — default: null format: int32
CodigoMunicipio (optional)
Query Parameter — default: null
CodigoDepartamento (optional)
Query Parameter — default: null
NumeroPagina (optional)
Query Parameter — default: null format: int32
RegistrosPorPagina (optional)
Query Parameter — default: null format: int32
Return type
Example data
Content-Type: application/json
{
"totalRegistros" : 1,
"paginaActual" : 0,
"resultado" : [ {
"idContratoOperacion" : 5,
"codigoDepartamento" : "codigoDepartamento",
"nombreDepartamento" : "nombreDepartamento",
"fechaRegistro" : "2000-01-23T04:56:07.000+00:00",
"nombreMunicipio" : "nombreMunicipio",
"idContrato" : 2,
"codigoAlcance" : 7,
"codigoMunicipio" : "codigoMunicipio",
"alcance" : {
"descripcion" : "descripcion",
"idCondigoReferencia" : 9
},
"poblacionCubierta" : 3
}, {
"idContratoOperacion" : 5,
"codigoDepartamento" : "codigoDepartamento",
"nombreDepartamento" : "nombreDepartamento",
"fechaRegistro" : "2000-01-23T04:56:07.000+00:00",
"nombreMunicipio" : "nombreMunicipio",
"idContrato" : 2,
"codigoAlcance" : 7,
"codigoMunicipio" : "codigoMunicipio",
"alcance" : {
"descripcion" : "descripcion",
"idCondigoReferencia" : 9
},
"poblacionCubierta" : 3
} ],
"totalPaginas" : 5,
"registrosPorPagina" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Lista paginada de operaciones obtenida exitosamente.
PaginadorGenerico_Minsalud_SIIFA_API_Contrato_Features_ContratoOperacion_Queries_ListContratoOperacionByIdContrato_ResultContratoOperacion
400
Parámetros de consulta inválidos. Verifique que IdContrato sea mayor a 0 y que los parámetros de paginación cumplan con los límites.
Microsoft_AspNetCore_Mvc_ProblemDetails
401
No autorizado. Token de autenticación inválido o no proporcionado.
Microsoft_AspNetCore_Mvc_ProblemDetails
500
Error interno del servidor al procesar la consulta.
Microsoft_AspNetCore_Mvc_ProblemDetails
Up
delete /api/ContratoOperacion/{IdContratoOperacion}
Elimina una operación de contrato por su identificador. (apiContratoOperacionIdContratoOperacionDelete)
Este endpoint permite eliminar una operación de cobertura geográfica y poblacional de un contrato.
Solo se pueden eliminar operaciones de contratos en estado "En creación" (102001).
Restricciones:
- El contrato asociado debe estar en estado 102001 (En creación)
- La operación debe existir en la base de datos
Validaciones automáticas aplicadas:
-
Validación de existencia:
- El IdContratoOperacion debe corresponder a una operación existente
-
Validación de estado:
- El contrato asociado debe estar en estado 102001
- No se pueden eliminar operaciones de contratos en otros estados
Nota importante:
- La eliminación es permanente y no se puede deshacer
- Al eliminar una operación, se libera la restricción de duplicados
(ej: se puede volver a registrar el mismo municipio o alcance nacional)
Sample request:
DELETE /api/ContratoOperacion/1
DELETE /api/ContratoOperacion/150
Path parameters
IdContratoOperacion (required)
Path Parameter — default: null format: int64
Return type
Example data
Content-Type: application/json
{
"idContratoOperacion" : 0
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Operación eliminada exitosamente. Retorna confirmación de la eliminación.
Minsalud_SIIFA_API_Contrato_Features_ContratoOperacion_Commands_DeleteContratoOperacion_Result
400
ID de operación inválido.
Microsoft_AspNetCore_Mvc_ProblemDetails
401
No autorizado. Token de autenticación inválido o no proporcionado.
Microsoft_AspNetCore_Mvc_ProblemDetails
404
Operación no encontrada. No existe una operación con el ID especificado.
Microsoft_AspNetCore_Mvc_ProblemDetails
409
Conflicto. El contrato no permite eliminaciones en su estado actual.
Microsoft_AspNetCore_Mvc_ProblemDetails
500
Error interno del servidor al eliminar la operación.
Microsoft_AspNetCore_Mvc_ProblemDetails
Up
get /api/ContratoOperacion/{IdContratoOperacion}
Obtiene los detalles completos de una operación de contrato por su identificador. (apiContratoOperacionIdContratoOperacionGet)
Este endpoint devuelve información detallada de una operación de contrato específica, incluyendo:
Información básica:
- Identificador de la operación (IdContratoOperacion)
- Identificador del contrato asociado (IdContrato)
- Código de alcance (CodigoAlcance)
- Descripción del tipo de alcance (Nacional, Departamental o Municipal)
Información geográfica:
- Código y nombre del municipio (para alcance municipal)
- Código y nombre del departamento (para alcance departamental o municipal)
Información de cobertura:
- Población cubierta (número de personas)
- Fecha de registro de la operación
Validaciones:
- El IdContratoOperacion debe ser un número positivo mayor a 0
- La operación debe existir en la base de datos
Sample request:
GET /api/ContratoOperacion/1
GET /api/ContratoOperacion/150
Path parameters
IdContratoOperacion (required)
Path Parameter — default: null format: int64
Return type
Example data
Content-Type: application/json
{
"idContratoOperacion" : 0,
"codigoDepartamento" : "codigoDepartamento",
"nombreDepartamento" : "nombreDepartamento",
"fechaRegistro" : "2000-01-23T04:56:07.000+00:00",
"nombreMunicipio" : "nombreMunicipio",
"idContrato" : 6,
"codigoAlcance" : 1,
"codigoMunicipio" : "codigoMunicipio",
"alcance" : {
"descripcion" : "descripcion",
"idCondigoReferencia" : 5
},
"poblacionCubierta" : 5
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Detalles de la operación obtenidos exitosamente con toda la información relacionada.
Minsalud_SIIFA_API_Contrato_Features_ContratoOperacion_Queries_DetailContratoOperacion_Result
400
ID de operación inválido. El ID debe ser un número positivo mayor a 0.
Microsoft_AspNetCore_Mvc_ProblemDetails
401
No autorizado. Token de autenticación inválido o no proporcionado.
Microsoft_AspNetCore_Mvc_ProblemDetails
404
Operación no encontrada. No existe una operación con el ID especificado.
Microsoft_AspNetCore_Mvc_ProblemDetails
500
Error interno del servidor al obtener los detalles de la operación.
Microsoft_AspNetCore_Mvc_ProblemDetails
Up
post /api/ContratoOperacion
Registra una nueva operación de cobertura geográfica y poblacional para un contrato. (apiContratoOperacionPost)
Este endpoint permite crear un nuevo registro de operación que define el alcance de cobertura de un contrato.
El contrato debe estar en estado "En creación" (102001) para permitir el registro.
Datos requeridos:
- IdContrato: Identificador del contrato (debe existir y estar en estado 102001)
- CodigoAlcance: Código del tipo de alcance del dominio 7 (107001, 107002 o 107003)
Datos condicionales según el tipo de alcance:
Para alcance Nacional (107001):
- CodigoDepartamento: Debe ser NULL
- CodigoMunicipio: Debe ser NULL
- PoblacionCubierta: Debe ser NULL
- Solo se permite UN registro de alcance nacional por contrato
Para alcance Departamental (107002):
- CodigoDepartamento: OBLIGATORIO (debe existir en dbo.ReferenciaDepartamento)
- CodigoMunicipio: Debe ser NULL
- PoblacionCubierta: Debe ser NULL
Para alcance Municipal (107003):
- CodigoDepartamento: OBLIGATORIO (debe existir en dbo.ReferenciaDepartamento)
- CodigoMunicipio: OBLIGATORIO (debe existir en dbo.ReferenciaMunicipio)
- PoblacionCubierta: OBLIGATORIO (debe ser mayor a 0)
- No se permiten duplicados del mismo municipio en el contrato
Validaciones automáticas aplicadas:
-
Validación de alcance:
- El CodigoAlcance debe existir en el dominio 7 de CODIGO_REFERENCIA
- El código debe estar activo
-
Validación de estado:
- El contrato debe estar en estado 102001 (En creación)
-
Validación de duplicados:
- Para alcance nacional: solo un registro por contrato
- Para alcance municipal: no duplicar mismo municipio
-
Validación de población:
- Si se proporciona PoblacionCubierta, debe ser mayor a 0
Sample request:
POST /api/ContratoOperacion
{
"idContrato": 1,
"codigoAlcance": 107003,
"codigoDepartamento": "25",
"codigoMunicipio": "25001",
"poblacionCubierta": 100000
}
Consumes
This API call consumes the following media types via the request header:
application/json
text/json
application/*+json
Request body
Return type
Example data
Content-Type: application/json
{
"idContratoOperacion" : 0,
"idContrato" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Operación registrada exitosamente. Retorna el ID de la operación creada y el ID del contrato.
Minsalud_SIIFA_API_Contrato_Features_ContratoOperacion_Commands_AddContratoOperacion_Result
400
Datos inválidos. Verifique las validaciones según el tipo de alcance.
Microsoft_AspNetCore_Mvc_ProblemDetails
401
No autorizado. Token de autenticación inválido o no proporcionado.
Microsoft_AspNetCore_Mvc_ProblemDetails
409
Conflicto. Ya existe un registro con la misma configuración de alcance.
Microsoft_AspNetCore_Mvc_ProblemDetails
500
Error interno del servidor al registrar la operación.
Microsoft_AspNetCore_Mvc_ProblemDetails
Up
put /api/ContratoOperacion
Actualiza la información de una operación de contrato existente. (apiContratoOperacionPut)
Este endpoint permite modificar los datos de una operación de cobertura previamente registrada.
El contrato debe estar en estado "En creación" (102001) para permitir modificaciones.
Datos requeridos:
- IdContratoOperacion: Identificador de la operación a actualizar (debe existir)
- CodigoAlcance: Código del tipo de alcance del dominio 7 (107001, 107002 o 107003)
Datos condicionales según el tipo de alcance:
(Aplican las mismas reglas que en el registro, ver documentación de POST)
Restricciones:
- Solo se pueden modificar operaciones de contratos en estado 102001 (En creación)
- No se permiten duplicados al actualizar (excepto el registro actual)
- Para alcance nacional: solo puede existir un registro por contrato
- Para alcance municipal: no puede duplicar municipios existentes
Validaciones automáticas aplicadas:
-
Validación de existencia:
- La operación debe existir en la base de datos
-
Validación de alcance:
- El CodigoAlcance debe existir en el dominio 7 y estar activo
-
Validación de estado:
- El contrato asociado debe estar en estado 102001
-
Validación de campos según alcance:
- Nacional: departamento, municipio y población deben ser NULL
- Departamental: departamento obligatorio, municipio y población NULL
- Municipal: departamento, municipio y población obligatorios (población > 0)
Sample request:
PUT /api/ContratoOperacion
{
"idContratoOperacion": 1,
"codigoAlcance": 107003,
"codigoDepartamento": "25",
"codigoMunicipio": "25754",
"poblacionCubierta": 150000
}
Consumes
This API call consumes the following media types via the request header:
application/json
text/json
application/*+json
Request body
Return type
Example data
Content-Type: application/json
{
"idContratoOperacion" : 0,
"idContrato" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Operación actualizada exitosamente. Retorna el IdContratoOperacion y el IdContrato.
Minsalud_SIIFA_API_Contrato_Features_ContratoOperacion_Commands_UpdateContratoOperacion_Result
400
Datos inválidos. Verifique las validaciones según el tipo de alcance.
Microsoft_AspNetCore_Mvc_ProblemDetails
401
No autorizado. Token de autenticación inválido o no proporcionado.
Microsoft_AspNetCore_Mvc_ProblemDetails
404
Operación no encontrada. No existe una operación con el ID especificado.
Microsoft_AspNetCore_Mvc_ProblemDetails
409
Conflicto. Ya existe otro registro con la misma configuración de alcance o el contrato no permite modificaciones.
Microsoft_AspNetCore_Mvc_ProblemDetails
500
Error interno del servidor al actualizar la operación.
Microsoft_AspNetCore_Mvc_ProblemDetails
Up
get /api/ContratoOtrosi/ByIdContrato/{IdContrato}
Obtiene la lista de otrosí asociados a un contrato específico. (apiContratoOtrosiByIdContratoIdContratoGet)
Filtra los otrosí por el identificador del contrato padre, retornando todas las modificaciones,
adiciones o prórrogas vinculadas a ese contrato. Los resultados incluyen el estado actual
de cada otrosí y sus datos principales.
Validaciones:
- IdContrato debe ser un número entero positivo mayor a 0.
Seguridad y roles:
- SIIFA_Admin: Acceso sin restricciones.
- SIIFA_ERP / SIIFA_ERP_Gestor: Solo contratos donde sea el contratante.
- SIIFA_IPS / SIIFA_IPS_Gestor / SIIFA_FITS / SIIFA_FITS_Gestor: Solo contratos donde sea el contratista.
Sample request:
GET /api/ContratoOtrosi/ByIdContrato/42
Path parameters
IdContrato (required)
Path Parameter — default: null format: int32
Return type
Example data
Content-Type: application/json
[ {
"estado" : "estado",
"tipoAdicion" : true,
"tipoProrroga" : true,
"tipoModificacion" : true,
"fechaRegistro" : "2000-01-23T04:56:07.000+00:00",
"valor" : 1.4658129805029452,
"codigoEstado" : 5,
"idContrato" : 6,
"nombre" : "nombre",
"idContratoOtrosi" : 0,
"fechaFinalizacion" : "2000-01-23T04:56:07.000+00:00"
}, {
"estado" : "estado",
"tipoAdicion" : true,
"tipoProrroga" : true,
"tipoModificacion" : true,
"fechaRegistro" : "2000-01-23T04:56:07.000+00:00",
"valor" : 1.4658129805029452,
"codigoEstado" : 5,
"idContrato" : 6,
"nombre" : "nombre",
"idContratoOtrosi" : 0,
"fechaFinalizacion" : "2000-01-23T04:56:07.000+00:00"
} ]
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Lista de otrosí del contrato obtenida exitosamente.
400
IdContrato inválido. Debe ser un número positivo mayor a 0.
Microsoft_AspNetCore_Mvc_ProblemDetails
401
No autorizado. El token de autenticación es inválido, expiró o no se proporcionó.
Microsoft_AspNetCore_Mvc_ProblemDetails
500
Error interno del servidor al procesar la consulta.
Microsoft_AspNetCore_Mvc_ProblemDetails
Up
get /api/ContratoOtrosi
Obtiene la lista de todos los otrosí registrados en el sistema. (apiContratoOtrosiGet)
Este endpoint retorna todos los otrosí existentes sin filtros adicionales.
Se recomienda usar el endpoint filtrado por contrato (ByIdContrato) para consultas
más eficientes en entornos con alto volumen de datos.
Seguridad y roles:
- SIIFA_Admin: Acceso a todos los otrosí sin restricciones.
- SIIFA_ERP / SIIFA_ERP_Gestor: Puede consultar otrosí de contratos donde sea el contratante.
- SIIFA_IPS / SIIFA_IPS_Gestor / SIIFA_FITS / SIIFA_FITS_Gestor: Puede consultar otrosí de contratos donde sea el contratista.
Sample request:
GET /api/ContratoOtrosi
Return type
Example data
Content-Type: application/json
[ {
"estado" : "estado",
"tipoAdicion" : true,
"tipoProrroga" : true,
"tipoModificacion" : true,
"fechaRegistro" : "2000-01-23T04:56:07.000+00:00",
"valor" : 1.4658129805029452,
"codigoEstado" : 5,
"idContrato" : 6,
"nombre" : "nombre",
"idContratoOtrosi" : 0,
"fechaFinalizacion" : "2000-01-23T04:56:07.000+00:00"
}, {
"estado" : "estado",
"tipoAdicion" : true,
"tipoProrroga" : true,
"tipoModificacion" : true,
"fechaRegistro" : "2000-01-23T04:56:07.000+00:00",
"valor" : 1.4658129805029452,
"codigoEstado" : 5,
"idContrato" : 6,
"nombre" : "nombre",
"idContratoOtrosi" : 0,
"fechaFinalizacion" : "2000-01-23T04:56:07.000+00:00"
} ]
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Lista de otrosí obtenida exitosamente.
401
No autorizado. El token de autenticación es inválido, expiró o no se proporcionó.
Microsoft_AspNetCore_Mvc_ProblemDetails
500
Error interno del servidor al procesar la consulta.
Microsoft_AspNetCore_Mvc_ProblemDetails
Up
delete /api/ContratoOtrosi/{IdContratoOtrosi}
Elimina permanentemente un otrosí de contrato por su identificador. (apiContratoOtrosiIdContratoOtrosiDelete)
Elimina de forma definitiva el otrosí especificado junto con sus registros de estado
asociados en la tabla CONTRATO_OTROSI_ESTADO. Esta operación es irreversible
y solo debe ejecutarse en otrosí que estén en estado En creación (102001).
Validaciones:
- IdContratoOtrosi debe existir en la base de datos.
- Se recomienda verificar el estado del otrosí antes de eliminarlo.
Sample request:
DELETE /api/ContratoOtrosi/15
Path parameters
IdContratoOtrosi (required)
Path Parameter — default: null format: int64
Return type
Example data
Content-Type: application/json
{
"idContratoOtroSi" : 0
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Otrosí eliminado exitosamente.
Minsalud_SIIFA_API_Features_ContratoOtrosi_Commands_DeleteContratoOtrosi_Result
401
No autorizado. El token de autenticación es inválido, expiró o no se proporcionó.
Microsoft_AspNetCore_Mvc_ProblemDetails
404
Otrosí no encontrado. No existe un otrosí con el ID especificado.
Microsoft_AspNetCore_Mvc_ProblemDetails
500
Error interno del servidor al eliminar el otrosí.
Microsoft_AspNetCore_Mvc_ProblemDetails
Up
get /api/ContratoOtrosi/{IdContratoOtrosi}
Obtiene el detalle completo de un otrosí de contrato por su identificador. (apiContratoOtrosiIdContratoOtrosiGet)
Retorna la información detallada del otrosí incluyendo sus datos principales,
el estado actual y la información completa del contrato padre asociado.
Información retornada:
- Identificador, nombre, valor y fechas del otrosí.
- Indicadores de tipo: adición (
TipoAdicion), modificación (TipoModificacion), prórroga (TipoProrroga).
- Estado actual del otrosí (código y descripción).
- Datos del contrato padre: NITs, razón social del contratante y contratista, modalidad de pago, regímenes.
Validaciones:
- IdContratoOtrosi debe ser un número entero positivo mayor a 0.
Sample request:
GET /api/ContratoOtrosi/15
Path parameters
IdContratoOtrosi (required)
Path Parameter — default: null format: int32
Return type
Example data
Content-Type: application/json
{
"estado" : "estado",
"tipoAdicion" : true,
"tipoProrroga" : true,
"tipoModificacion" : true,
"fechaRegistro" : "2000-01-23T04:56:07.000+00:00",
"valor" : 1.4658129805029452,
"contrato" : {
"regimenes" : [ {
"descripcion" : "descripcion",
"fechaInicioAplicacion" : "2000-01-23T04:56:07.000+00:00",
"fechaFinalizacionAplicacion" : "2000-01-23T04:56:07.000+00:00",
"codigoRegimen" : 4
}, {
"descripcion" : "descripcion",
"fechaInicioAplicacion" : "2000-01-23T04:56:07.000+00:00",
"fechaFinalizacionAplicacion" : "2000-01-23T04:56:07.000+00:00",
"codigoRegimen" : 4
} ],
"estado" : "estado",
"valor" : 9.301444243932576,
"codigoEstado" : 7,
"nombre" : "nombre",
"fechaFin" : "2000-01-23T04:56:07.000+00:00",
"nitContratante" : 2,
"modalidadPago" : 3,
"fechaInicio" : "2000-01-23T04:56:07.000+00:00",
"empresaContratista" : {
"razonSocial" : "razonSocial",
"nit" : 2
},
"cucon" : "cucon",
"empresaContratante" : {
"razonSocial" : "razonSocial",
"nit" : 2
},
"fechaSuscripcion" : "2000-01-23T04:56:07.000+00:00",
"idContrato" : 5,
"nitContratista" : 7
},
"codigoEstado" : 5,
"idContrato" : 6,
"nombre" : "nombre",
"idContratoOtrosi" : 0,
"fechaFinalizacion" : "2000-01-23T04:56:07.000+00:00"
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Detalle del otrosí obtenido exitosamente.
Minsalud_SIIFA_API_Features_ContratoOtrosi_Queries_DetailContratoOtrosi_Result
400
IdContratoOtrosi inválido. Debe ser un número positivo mayor a 0.
Microsoft_AspNetCore_Mvc_ProblemDetails
401
No autorizado. El token de autenticación es inválido, expiró o no se proporcionó.
Microsoft_AspNetCore_Mvc_ProblemDetails
404
Otrosí no encontrado. No existe un otrosí con el ID especificado.
Microsoft_AspNetCore_Mvc_ProblemDetails
500
Error interno del servidor al obtener el detalle del otrosí.
Microsoft_AspNetCore_Mvc_ProblemDetails
Up
post /api/ContratoOtrosi
Registra un nuevo otrosí para un contrato existente. (apiContratoOtrosiPost)
Crea un nuevo otrosí vinculado al contrato indicado. El otrosí se crea automáticamente
en estado inicial En creación (102001) y genera un registro en la tabla
CONTRATO_OTROSI_ESTADO.
Datos requeridos:
- IdContrato: Identificador del contrato padre al que se asocia el otrosí.
- Nombre: Nombre o descripción del otrosí (opcional).
- Valor: Valor económico del otrosí (opcional).
- FechaFinalizacion: Fecha de fin de vigencia del otrosí (opcional).
- TipoAdicion: Indica si es una adición al contrato (booleano, opcional).
- TipoModificacion: Indica si es una modificación al contrato (booleano, opcional).
- TipoProrroga: Indica si es una prórroga al contrato (booleano, opcional).
Validaciones automáticas aplicadas:
- El usuario debe tener alguno de los roles:
SIIFA_Admin, SIIFA_ERP o SIIFA_ERP_Gestor.
- Para roles
SIIFA_ERP / SIIFA_ERP_Gestor, el NIT del contratante del contrato padre
debe coincidir con el NIT de la empresa del usuario autenticado (claim del token JWT).
Registros creados:
- 1 registro en tabla
CONTRATO_OTROSI.
- 1 registro en tabla
CONTRATO_OTROSI_ESTADO con estado inicial 102001.
Sample request:
POST /api/ContratoOtrosi
{
"idContrato": 42,
"nombre": "Otrosí N°1 - Adición de valor",
"valor": 50000000,
"fechaFinalizacion": "2025-12-31",
"tipoAdicion": true,
"tipoModificacion": false,
"tipoProrroga": false
}
Consumes
This API call consumes the following media types via the request header:
application/json
text/json
application/*+json
Request body
Return type
Example data
Content-Type: application/json
{
"idContrato" : 6,
"idContratoOtroSi" : 0
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
Otrosí creado exitosamente. Retorna el ID del nuevo otrosí.
Minsalud_SIIFA_API_Features_ContratoOtrosi_Commands_AddContratoOtrosi_Result
400
Datos inválidos o permisos insuficientes. El detalle incluye los errores de validación de FluentValidation.
Microsoft_AspNetCore_Mvc_ProblemDetails
401
No autorizado. El token de autenticación es inválido, expiró o no se proporcionó.
Microsoft_AspNetCore_Mvc_ProblemDetails
500
Error interno del servidor al registrar el otrosí.
Microsoft_AspNetCore_Mvc_ProblemDetails
Up
put /api/ContratoOtrosi
Actualiza la información de un otrosí existente. (apiContratoOtrosiPut)
Permite modificar los datos de un otrosí previamente registrado. Solo es posible actualizar
otrosí que se encuentren en estado En creación (102001).
Campos actualizables:
- Nombre: Nombre o descripción del otrosí.
- Valor: Valor económico del otrosí.
- FechaFinalizacion: Fecha de fin de vigencia.
- TipoAdicion, TipoModificacion, TipoProrroga: Indicadores de tipo de otrosí.
Validaciones:
- IdContratoOtrosi debe existir en la base de datos.
- El otrosí debe estar en estado 102001 (En creación) para poder ser modificado.
Sample request:
PUT /api/ContratoOtrosi
{
"idContratoOtrosi": 15,
"idContrato": 42,
"nombre": "Otrosí N°1 - Adición de valor actualizado",
"valor": 75000000,
"fechaFinalizacion": "2026-06-30",
"tipoAdicion": true,
"tipoModificacion": true,
"tipoProrroga": false
}
Consumes
This API call consumes the following media types via the request header:
application/json
text/json
application/*+json
Request body
Return type
Example data
Content-Type: application/json
{
"tipoAdicion" : true,
"tipoProrroga" : true,
"tipoModificacion" : true,
"valor" : 1.4658129805029452,
"idContrato" : 6,
"nombre" : "nombre",
"idContratoOtrosi" : 0,
"fechaFinalizacion" : "2000-01-23T04:56:07.000+00:00"
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Otrosí actualizado exitosamente.
Minsalud_SIIFA_API_Features_ContratoOtrosi_Commands_UpdateContratoOtrosi_Result
400
Datos inválidos o validaciones fallidas.
Microsoft_AspNetCore_Mvc_ProblemDetails
401
No autorizado. El token de autenticación es inválido, expiró o no se proporcionó.
Microsoft_AspNetCore_Mvc_ProblemDetails
404
Otrosí no encontrado. No existe un otrosí con el ID especificado.
Microsoft_AspNetCore_Mvc_ProblemDetails
409
Conflicto. El otrosí no puede ser editado porque no está en estado "En creación" (102001).
Microsoft_AspNetCore_Mvc_ProblemDetails
500
Error interno del servidor al actualizar el otrosí.
Microsoft_AspNetCore_Mvc_ProblemDetails
Up
get /api/ContratoOtrosiCums/ByIdContratoOtrosi/{IdContratoOtrosi}
Obtiene la lista de CUMS asociados a un otrosí específico. (apiContratoOtrosiCumsByIdContratoOtrosiIdContratoOtrosiGet)
Este endpoint permite consultar todos los CUMS registrados para un otrosí, filtrando por el identificador del otrosí.
Path parameters
IdContratoOtrosi (required)
Path Parameter — default: null format: int64
Return type
Example data
Content-Type: application/json
{
"idContratoCums" : 1,
"fechaRegistro" : "2000-01-23T04:56:07.000+00:00",
"cums" : {
"descripcion" : "descripcion",
"codigoAtc" : "codigoAtc",
"expedienteCum" : 7,
"registroSanitario" : "registroSanitario",
"incluidoPbs" : true,
"idCums" : 2,
"nombre" : "nombre"
},
"cantidad" : 5,
"idContratoOtrosiCums" : 0,
"idCums" : 5,
"idContratoOtrosi" : 6
}
Example data
Content-Type: text/json
Custom MIME type example not yet supported: text/json
Example data
Content-Type: text/plain
Custom MIME type example not yet supported: text/plain
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
text/plain
application/json
text/json
Responses
200
Lista de CUMS obtenida exitosamente.
Minsalud_SIIFA_API_Features_ContratoOtrosiCums_Queries_ListContratoOtrosiCumsByIdContratoOtrosi_Result
404
No se encontraron CUMS para el otrosí especificado.
Up
delete /api/ContratoOtrosiCums/{IdContratoOtrosiCums}
Elimina un CUMS de otrosí de contrato por su identificador. (apiContratoOtrosiCumsIdContratoOtrosiCumsDelete)
Este endpoint permite eliminar un CUMS de otrosí de contrato existente, identificándolo por su ID único.
Path parameters
IdContratoOtrosiCums (required)
Path Parameter — default: null format: int64
Return type
Example data
Content-Type: application/json
{
"idContratoOtrosiCums" : 0
}
Example data
Content-Type: text/json
Custom MIME type example not yet supported: text/json
Example data
Content-Type: text/plain
Custom MIME type example not yet supported: text/plain
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
text/plain
application/json
text/json
Responses
200
CUMS eliminado exitosamente.
Minsalud_SIIFA_API_Features_ContratoOtrosiCums_Commands_DeleteContratoOtrosiCums_Result
404
No se encontró el CUMS a eliminar.
Up
get /api/ContratoOtrosiCums/{IdContratoOtrosiCums}
Obtiene el detalle de un CUMS de otrosí de contrato por su identificador. (apiContratoOtrosiCumsIdContratoOtrosiCumsGet)
Este endpoint devuelve la información detallada de un CUMS de otrosí de contrato específico, incluyendo datos de medicamento o insumo.
Path parameters
IdContratoOtrosiCums (required)
Path Parameter — default: null format: int64
Return type
Example data
Content-Type: application/json
{
"idContratoCums" : 1,
"fechaRegistro" : "2000-01-23T04:56:07.000+00:00",
"cums" : {
"descripcion" : "descripcion",
"codigoAtc" : "codigoAtc",
"expedienteCum" : 7,
"registroSanitario" : "registroSanitario",
"incluidoPbs" : true,
"idCums" : 2,
"nombre" : "nombre"
},
"cantidad" : 5,
"idContratoOtrosiCums" : 0,
"idCums" : 5,
"idContratoOtrosi" : 6
}
Example data
Content-Type: text/json
Custom MIME type example not yet supported: text/json
Example data
Content-Type: text/plain
Custom MIME type example not yet supported: text/plain
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
text/plain
application/json
text/json
Responses
200
Detalle del CUMS obtenido exitosamente.
Minsalud_SIIFA_API_Features_ContratoOtrosiCums_Queries_DetailContratoOtrosiCums_Result
404
No se encontró el CUMS solicitado.
Up
post /api/ContratoOtrosiCums
Registra un nuevo CUMS para un otrosí de contrato. (apiContratoOtrosiCumsPost)
Este endpoint permite crear un nuevo registro de CUMS asociado a un otrosí de contrato, especificando los datos requeridos.
Consumes
This API call consumes the following media types via the request header:
application/json
text/json
application/*+json
Request body
Return type
Example data
Content-Type: application/json
{
"idContratoOtroSiCums" : 0,
"idContratoOtroSi" : 6
}
Example data
Content-Type: text/json
Custom MIME type example not yet supported: text/json
Example data
Content-Type: text/plain
Custom MIME type example not yet supported: text/plain
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
text/plain
application/json
text/json
Responses
200
CUMS registrado exitosamente.
Minsalud_SIIFA_API_Features_ContratoOtrosiCums_Commands_AddContratoOtrosiCums_Result
400
Datos inválidos o faltantes en la solicitud.
Up
put /api/ContratoOtrosiCums
Actualiza la información de un CUMS de otrosí de contrato existente. (apiContratoOtrosiCumsPut)
Este endpoint permite modificar los datos de un CUMS previamente registrado para un otrosí de contrato.
Consumes
This API call consumes the following media types via the request header:
application/json
text/json
application/*+json
Request body
Return type
Example data
Content-Type: application/json
{
"idContratoOtrosiCums" : 0,
"idContratoOtrosi" : 6
}
Example data
Content-Type: text/json
Custom MIME type example not yet supported: text/json
Example data
Content-Type: text/plain
Custom MIME type example not yet supported: text/plain
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
text/plain
application/json
text/json
Responses
200
CUMS actualizado exitosamente.
Minsalud_SIIFA_API_Features_ContratoOtrosiCums_Commands_UpdateContratoOtrosiCums_Result
404
No se encontró el CUMS a actualizar.
400
Datos inválidos en la solicitud.
Up
get /api/ContratoOtrosiEstado/ByIdContratoOtrosi/{IdContratoOtrosi}
Obtiene el historial completo de estados de un otrosí específico. (apiContratoOtrosiEstadoByIdContratoOtrosiIdContratoOtrosiGet)
Retorna todos los registros de transición de estado del otrosí indicado, ordenados
cronológicamente por FechaRegistro. Cada elemento incluye el código de estado,
su descripción obtenida desde CodigoReferencia mediante navegación EF Core,
y las fechas de estado y registro.
Estados del ciclo de vida del otrosí:
| Código | Descripción |
|--------|-------------|
| 102001 | En creación |
| 102002 | En verificación contratista |
| 102003 | Rechazado |
| 102004 | Aprobado |
| 102005 | Liquidado |
Validaciones:
- IdContratoOtrosi debe ser un número entero positivo mayor a 0.
Seguridad y roles:
- Requiere autenticación JWT válida. Cualquier rol autenticado puede consultar el historial.
Sample request:
GET /api/ContratoOtrosiEstado/ByIdContratoOtrosi/15
Path parameters
IdContratoOtrosi (required)
Path Parameter — default: null format: int64
Return type
Example data
Content-Type: application/json
[ {
"idContratoOtrosiEstado" : 0,
"nombreEstado" : "nombreEstado",
"fechaRegistro" : "2000-01-23T04:56:07.000+00:00",
"codigoEstado" : 1,
"fechaEstado" : "2000-01-23T04:56:07.000+00:00",
"observacion" : "observacion",
"idContratoOtrosi" : 6
}, {
"idContratoOtrosiEstado" : 0,
"nombreEstado" : "nombreEstado",
"fechaRegistro" : "2000-01-23T04:56:07.000+00:00",
"codigoEstado" : 1,
"fechaEstado" : "2000-01-23T04:56:07.000+00:00",
"observacion" : "observacion",
"idContratoOtrosi" : 6
} ]
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Historial de estados obtenido exitosamente.
400
IdContratoOtrosi inválido. Debe ser un número positivo mayor a 0.
Microsoft_AspNetCore_Mvc_ProblemDetails
401
No autorizado. El token de autenticación es inválido, expiró o no se proporcionó.
Microsoft_AspNetCore_Mvc_ProblemDetails
500
Error interno del servidor al procesar la consulta.
Microsoft_AspNetCore_Mvc_ProblemDetails
Up
post /api/ContratoOtrosiEstado
Registra una nueva transición de estado para un otrosí. (apiContratoOtrosiEstadoPost)
Aplica un cambio de estado al otrosí indicado siguiendo la máquina de estados definida.
El sistema valida que la transición sea permitida desde el estado actual y que el usuario
cuente con el rol requerido para ejecutarla.
Máquina de estados y transiciones permitidas:
| Estado actual | Estado destino | Roles permitidos |
|---------------|---------------|------------------|
| 102001 - En creación | 102002 - En verificación contratista | SIIFA_ERP, SIIFA_ERP_Gestor, SIIFA_Admin |
| 102002 - En verificación contratista | 102003 - Rechazado | SIIFA_IPS, SIIFA_IPS_Gestor, SIIFA_FITS, SIIFA_FITS_Gestor, SIIFA_Admin |
| 102002 - En verificación contratista | 102004 - Aprobado | SIIFA_IPS, SIIFA_IPS_Gestor, SIIFA_FITS, SIIFA_FITS_Gestor, SIIFA_Admin |
| 102003 - Rechazado | 102002 - En verificación contratista | SIIFA_ERP, SIIFA_ERP_Gestor, SIIFA_Admin |
| 102004 - Aprobado | 102005 - Liquidado | SIIFA_ERP, SIIFA_ERP_Gestor, SIIFA_FITS, SIIFA_FITS_Gestor, SIIFA_Admin |
| 102005 - Liquidado | (ninguno) | Estado final, no permite más transiciones |
Validaciones adicionales al pasar a 102002 (En verificación contratista):
- Para roles
SIIFA_ERP / SIIFA_ERP_Gestor, el NIT del contratante del contrato padre
debe coincidir con el NIT de la empresa del usuario autenticado (claim del token JWT).
- Si el contrato padre es de tipo 104001, debe tener al menos un registro en
la tabla
CONTRATO_OPERACION (información de población cubierta).
Validaciones adicionales al pasar a 102003 o 102004:
- Para roles
SIIFA_IPS / SIIFA_IPS_Gestor / SIIFA_FITS / SIIFA_FITS_Gestor,
el NIT del contratista del contrato padre debe coincidir con el NIT del usuario.
Datos requeridos:
- IdContratoOtrosi: Identificador del otrosí al que se aplica el cambio.
- CodigoEstado: Código del estado destino según la tabla de transiciones.
Sample request:
POST /api/ContratoOtrosiEstado
{
"idContratoOtrosi": 15,
"codigoEstado": 102002
}
Consumes
This API call consumes the following media types via the request header:
application/json
text/json
application/*+json
Request body
Return type
Example data
Content-Type: application/json
{
"idContratoOtrosiEstado" : 0,
"idContratoOtrosi" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Transición de estado registrada exitosamente.
Minsalud_SIIFA_API_Features_ContratoOtrosiEstado_Commands_AddContratoOtrosiEstado_Result
400
Transición no permitida, permisos insuficientes o datos inválidos. El detalle incluye el motivo específico del rechazo.
Microsoft_AspNetCore_Mvc_ProblemDetails
401
No autorizado. El token de autenticación es inválido, expiró o no se proporcionó.
Microsoft_AspNetCore_Mvc_ProblemDetails
500
Error interno del servidor al registrar el cambio de estado.
Microsoft_AspNetCore_Mvc_ProblemDetails
Up
get /api/ContratoOtrosiPrestadorServicio/ByIdContratoOtrosi/{IdContratoOtrosi}
Obtiene la lista de prestadores de servicio asociados a un otrosí específico. (apiContratoOtrosiPrestadorServicioByIdContratoOtrosiIdContratoOtrosiGet)
Este endpoint permite consultar todos los prestadores de servicio registrados para un otrosí, filtrando por el identificador del otrosí.
Path parameters
IdContratoOtrosi (required)
Path Parameter — default: null format: int32
Return type
Example data
Content-Type: application/json
{
"codigoHabilitacion" : "codigoHabilitacion",
"codigoServicio" : 5,
"servicio" : {
"nombreServicio" : "nombreServicio",
"codigoServicio" : 5,
"incluidoPbs" : true
},
"numeroSede" : "numeroSede",
"idContratoPrestadorServicio" : 1,
"idContratoOtrosiPrestadorServicio" : 6,
"idContratoOtrosi" : 0
}
Example data
Content-Type: text/json
Custom MIME type example not yet supported: text/json
Example data
Content-Type: text/plain
Custom MIME type example not yet supported: text/plain
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
text/plain
application/json
text/json
Responses
200
Lista de prestadores de servicio obtenida exitosamente.
Minsalud_SIIFA_API_Features_ContratoOtrosiPrestadorServicio_Queries_ListContratoOtrosiPrestadorServicioByIdContratoOtrosi_Result
404
No se encontraron prestadores de servicio para el otrosí especificado.
Up
delete /api/ContratoOtrosiPrestadorServicio/{IdContratoOtrosiPrestadorServicio}
Elimina un prestador de servicio de otrosí de contrato por su identificador. (apiContratoOtrosiPrestadorServicioIdContratoOtrosiPrestadorServicioDelete)
Este endpoint permite eliminar un prestador de servicio de otrosí de contrato existente, identificándolo por su ID único.
Path parameters
IdContratoOtrosiPrestadorServicio (required)
Path Parameter — default: null format: int32
Return type
Example data
Content-Type: application/json
{
"idContratoOtrosiPrestadorServicio" : 0
}
Example data
Content-Type: text/json
Custom MIME type example not yet supported: text/json
Example data
Content-Type: text/plain
Custom MIME type example not yet supported: text/plain
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
text/plain
application/json
text/json
Responses
200
Prestador de servicio eliminado exitosamente.
Minsalud_SIIFA_API_Features_ContratoOtrosiPrestadorServicio_Commands_DeleteContratoOtrosiPrestadorServicio_Result
404
No se encontró el prestador de servicio a eliminar.
Up
get /api/ContratoOtrosiPrestadorServicio/{IdContratoOtrosiPrestadorServicio}
Obtiene el detalle de un prestador de servicio de otrosí de contrato por su identificador. (apiContratoOtrosiPrestadorServicioIdContratoOtrosiPrestadorServicioGet)
Este endpoint devuelve la información detallada de un prestador de servicio de otrosí de contrato específico, incluyendo datos de la entidad o profesional.
Path parameters
IdContratoOtrosiPrestadorServicio (required)
Path Parameter — default: null format: int32
Return type
Example data
Content-Type: application/json
{
"codigoHabilitacion" : "codigoHabilitacion",
"codigoServicio" : 5,
"servicio" : {
"nombreServicio" : "nombreServicio",
"codigoServicio" : 5,
"incluidoPbs" : true
},
"numeroSede" : "numeroSede",
"idContratoPrestadorServicio" : 1,
"idContratoOtrosiPrestadorServicio" : 6,
"idContratoOtrosi" : 0
}
Example data
Content-Type: text/json
Custom MIME type example not yet supported: text/json
Example data
Content-Type: text/plain
Custom MIME type example not yet supported: text/plain
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
text/plain
application/json
text/json
Responses
200
Detalle del prestador de servicio obtenido exitosamente.
Minsalud_SIIFA_API_Features_ContratoOtrosiPrestadorServicio_Queries_DetailContratoOtrosiPrestadorServicio_Result
404
No se encontró el prestador de servicio solicitado.
Up
post /api/ContratoOtrosiPrestadorServicio
Registra un nuevo prestador de servicio para un otrosí de contrato. (apiContratoOtrosiPrestadorServicioPost)
Este endpoint permite crear un nuevo registro de prestador de servicio asociado a un otrosí de contrato, especificando los datos requeridos.
Consumes
This API call consumes the following media types via the request header:
application/json
text/json
application/*+json
Request body
Return type
Example data
Content-Type: application/json
{
"idContratoOtrosiPrestadorServicio" : 0,
"idContratoOtrosi" : 6
}
Example data
Content-Type: text/json
Custom MIME type example not yet supported: text/json
Example data
Content-Type: text/plain
Custom MIME type example not yet supported: text/plain
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
text/plain
application/json
text/json
Responses
200
Prestador de servicio registrado exitosamente.
Minsalud_SIIFA_API_Features_ContratoOtrosiPrestadorServicio_Commands_AddContratoOtrosiPrestadorServicio_Result
400
Datos inválidos o faltantes en la solicitud.
Up
put /api/ContratoOtrosiPrestadorServicio
Actualiza la información de un prestador de servicio de otrosí de contrato existente. (apiContratoOtrosiPrestadorServicioPut)
Este endpoint permite modificar los datos de un prestador de servicio previamente registrado para un otrosí de contrato.
Consumes
This API call consumes the following media types via the request header:
application/json
text/json
application/*+json
Request body
Return type
Example data
Content-Type: application/json
{
"idContratoOtrosiPrestadorServicio" : 0,
"idContratoOtrosi" : 6
}
Example data
Content-Type: text/json
Custom MIME type example not yet supported: text/json
Example data
Content-Type: text/plain
Custom MIME type example not yet supported: text/plain
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
text/plain
application/json
text/json
Responses
200
Prestador de servicio actualizado exitosamente.
Minsalud_SIIFA_API_Features_ContratoOtrosiPrestadorServicio_Commands_UpdateContratoOtrosiPrestadorServicio_Result
404
No se encontró el prestador de servicio a actualizar.
400
Datos inválidos en la solicitud.
Up
get /api/ContratoPrestadorServicio/ByIdContrato/{IdContrato}
Obtiene la lista de prestadores de servicio asociados a un contrato específico. (apiContratoPrestadorServicioByIdContratoIdContratoGet)
Este endpoint permite consultar todos los prestadores de servicio registrados para un contrato, filtrando por el identificador del contrato.
Path parameters
IdContrato (required)
Path Parameter — default: null format: int32
Return type
Example data
Content-Type: application/json
{
"codigoHabilitacion" : "codigoHabilitacion",
"codigoServicio" : 1,
"modalidadMedia" : true,
"servicio" : {
"nombreServicio" : "nombreServicio",
"codigoServicio" : 5,
"incluidoPbs" : true
},
"fechaRegistro" : "2000-01-23T04:56:07.000+00:00",
"numeroSede" : "numeroSede",
"modalidadAlta" : true,
"modalidadBaja" : true,
"idContratoPrestadorServicio" : 0,
"idContrato" : 6
}
Example data
Content-Type: text/json
Custom MIME type example not yet supported: text/json
Example data
Content-Type: text/plain
Custom MIME type example not yet supported: text/plain
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
text/plain
application/json
text/json
Responses
200
Lista de prestadores de servicio obtenida exitosamente.
Minsalud_SIIFA_API_Features_ContratoPrestadorServicio_Queries_ListContratoPrestadorServicioByIdContrato_Result
404
No se encontraron prestadores de servicio para el contrato especificado.
Up
delete /api/ContratoPrestadorServicio/{IdContratoPrestadorServicio}
Elimina un prestador de servicio de contrato por su identificador. (apiContratoPrestadorServicioIdContratoPrestadorServicioDelete)
Este endpoint permite eliminar un prestador de servicio de contrato existente, identificándolo por su ID único.
Path parameters
IdContratoPrestadorServicio (required)
Path Parameter — default: null format: int32
Return type
Example data
Content-Type: application/json
{
"idContratoPrestadorServicio" : 0
}
Example data
Content-Type: text/json
Custom MIME type example not yet supported: text/json
Example data
Content-Type: text/plain
Custom MIME type example not yet supported: text/plain
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
text/plain
application/json
text/json
Responses
200
Prestador de servicio eliminado exitosamente.
Minsalud_SIIFA_API_Features_ContratoPrestadorServicio_Commands_DeleteContratoPrestadorServicio_Result
404
No se encontró el prestador de servicio a eliminar.
Up
get /api/ContratoPrestadorServicio/{IdContratoPrestadorServicio}
Obtiene el detalle de un prestador de servicio de contrato por su identificador. (apiContratoPrestadorServicioIdContratoPrestadorServicioGet)
Este endpoint devuelve la información detallada de un prestador de servicio de contrato específico, incluyendo datos de la entidad o profesional.
Path parameters
IdContratoPrestadorServicio (required)
Path Parameter — default: null format: int32
Return type
Example data
Content-Type: application/json
{
"codigoHabilitacion" : "codigoHabilitacion",
"codigoServicio" : 1,
"modalidadMedia" : true,
"servicio" : {
"nombreServicio" : "nombreServicio",
"codigoServicio" : 5,
"incluidoPbs" : true
},
"fechaRegistro" : "2000-01-23T04:56:07.000+00:00",
"numeroSede" : "numeroSede",
"modalidadAlta" : true,
"modalidadBaja" : true,
"idContratoPrestadorServicio" : 0,
"idContrato" : 6
}
Example data
Content-Type: text/json
Custom MIME type example not yet supported: text/json
Example data
Content-Type: text/plain
Custom MIME type example not yet supported: text/plain
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
text/plain
application/json
text/json
Responses
200
Detalle del prestador de servicio obtenido exitosamente.
Minsalud_SIIFA_API_Features_ContratoPrestadorServicio_Queries_DetailContratoPrestadorServicio_Result
404
No se encontró el prestador de servicio solicitado.
Up
post /api/ContratoPrestadorServicio
Registra un nuevo prestador de servicio para un contrato. (apiContratoPrestadorServicioPost)
Este endpoint permite crear un nuevo registro de prestador de servicio asociado a un contrato, especificando los datos requeridos.
Consumes
This API call consumes the following media types via the request header:
application/json
text/json
application/*+json
Request body
Return type
Example data
Content-Type: application/json
{
"idContratoPrestadorServicio" : 0,
"idContrato" : 6
}
Example data
Content-Type: text/json
Custom MIME type example not yet supported: text/json
Example data
Content-Type: text/plain
Custom MIME type example not yet supported: text/plain
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
text/plain
application/json
text/json
Responses
200
Prestador de servicio registrado exitosamente.
Minsalud_SIIFA_API_Features_ContratoPrestadorServicio_Commands_AddContratoPrestadorServicio_Result
400
Datos inválidos o faltantes en la solicitud.
Up
put /api/ContratoPrestadorServicio
Actualiza la información de un prestador de servicio de contrato existente. (apiContratoPrestadorServicioPut)
Este endpoint permite modificar los datos de un prestador de servicio previamente registrado para un contrato.
Consumes
This API call consumes the following media types via the request header:
application/json
text/json
application/*+json
Request body
Return type
Example data
Content-Type: application/json
{
"idContratoPrestadorServicio" : 0,
"idContrato" : 6
}
Example data
Content-Type: text/json
Custom MIME type example not yet supported: text/json
Example data
Content-Type: text/plain
Custom MIME type example not yet supported: text/plain
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
text/plain
application/json
text/json
Responses
200
Prestador de servicio actualizado exitosamente.
Minsalud_SIIFA_API_Features_ContratoPrestadorServicio_Commands_UpdateContratoPrestadorServicio_Result
404
No se encontró el prestador de servicio a actualizar.
400
Datos inválidos en la solicitud.
Up
delete /api/ContratoPrestadorServicioModalidadPago/{IdContratoPrestadorServicioModalidadPago}
Elimina una modalidad de pago de prestador de servicio de contrato por su identificador. (apiContratoPrestadorServicioModalidadPagoIdContratoPrestadorServicioModalidadPagoDelete)
Este endpoint permite eliminar una modalidad de pago asociada a un prestador de servicio de contrato, identificándola por su ID único.
Path parameters
IdContratoPrestadorServicioModalidadPago (required)
Path Parameter — default: null format: int32
Return type
Example data
Content-Type: application/json
{
"idContratoPrestadorServicioModalidadPago" : 0
}
Example data
Content-Type: text/json
Custom MIME type example not yet supported: text/json
Example data
Content-Type: text/plain
Custom MIME type example not yet supported: text/plain
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
text/plain
application/json
text/json
Responses
200
Modalidad de pago eliminada exitosamente.
Minsalud_SIIFA_API_Features_ContratoPrestadorServicioModalidadPago_Commands_DeleteContratoPrestadorServicioModalidadPago_Result
404
No se encontró la modalidad de pago a eliminar.
Up
get /api/ContratoPrestadorServicioModalidadPago/{IdContratoPrestadorServicioModalidadPago}
Obtiene el detalle de una modalidad de pago de prestador de servicio de contrato por su identificador. (apiContratoPrestadorServicioModalidadPagoIdContratoPrestadorServicioModalidadPagoGet)
Este endpoint devuelve la información detallada de una modalidad de pago asociada a un prestador de servicio de contrato específico.
Path parameters
IdContratoPrestadorServicioModalidadPago (required)
Path Parameter — default: null format: int64
Return type
Example data
Content-Type: application/json
{
"idContratoModalidadPago" : 1,
"fechaRegistro" : "2000-01-23T04:56:07.000+00:00",
"valor" : 5.962133916683182,
"idContratoPrestadorServicioModalidadPago" : 0,
"idContratoPrestadorServicio" : 6
}
Example data
Content-Type: text/json
Custom MIME type example not yet supported: text/json
Example data
Content-Type: text/plain
Custom MIME type example not yet supported: text/plain
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
text/plain
application/json
text/json
Responses
200
Detalle de la modalidad de pago obtenido exitosamente.
Minsalud_SIIFA_API_Contrato_Features_ContratoPrestadorServicioModalidadPago_Queries_DetailContratoPrestadorServicioModalidadPago_Result
404
No se encontró la modalidad de pago solicitada.
Up
post /api/ContratoPrestadorServicioModalidadPago
Registra una nueva modalidad de pago para un prestador de servicio de contrato. (apiContratoPrestadorServicioModalidadPagoPost)
Este endpoint permite crear un nuevo registro de modalidad de pago asociada a un prestador de servicio de contrato, especificando los datos requeridos.
Consumes
This API call consumes the following media types via the request header:
application/json
text/json
application/*+json
Request body
Return type
Example data
Content-Type: application/json
{
"idContratoPrestadorServicioModalidadPago" : 0
}
Example data
Content-Type: text/json
Custom MIME type example not yet supported: text/json
Example data
Content-Type: text/plain
Custom MIME type example not yet supported: text/plain
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
text/plain
application/json
text/json
Responses
200
Modalidad de pago registrada exitosamente.
Minsalud_SIIFA_API_Features_ContratoPrestadorServicioModalidadPago_Commands_AddContratoPrestadorServicioModalidadPago_Result
400
Datos inválidos o faltantes en la solicitud.
Up
put /api/ContratoPrestadorServicioModalidadPago
Actualiza la información de una modalidad de pago de prestador de servicio de contrato existente. (apiContratoPrestadorServicioModalidadPagoPut)
Este endpoint permite modificar los datos de una modalidad de pago previamente registrada para un prestador de servicio de contrato.
Consumes
This API call consumes the following media types via the request header:
application/json
text/json
application/*+json
Request body
Return type
Example data
Content-Type: application/json
{
"idContratoPrestadorServicioModalidaPago" : 0
}
Example data
Content-Type: text/json
Custom MIME type example not yet supported: text/json
Example data
Content-Type: text/plain
Custom MIME type example not yet supported: text/plain
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
text/plain
application/json
text/json
Responses
200
Modalidad de pago actualizada exitosamente.
Minsalud_SIIFA_API_Features_ContratoPrestadorServicioModalidadPago_Commands_UpdateContratoPrestadorServicioModalidadPago_Result
404
No se encontró la modalidad de pago a actualizar.
400
Datos inválidos en la solicitud.
Up
get /api/ContratoRegimen/ByIdContrato/{IdContrato}
Obtiene la lista de regímenes asociados a un contrato específico. (apiContratoRegimenByIdContratoIdContratoGet)
Este endpoint permite consultar todos los regímenes registrados para un contrato, filtrando por el identificador del contrato.
Path parameters
IdContrato (required)
Path Parameter — default: null format: int32
Return type
Example data
Content-Type: application/json
{
"fechaInicioAplicacion" : "2000-01-23T04:56:07.000+00:00",
"idContratoRegimen" : 0,
"fechaRegistro" : "2000-01-23T04:56:07.000+00:00",
"fechaFinalizacionAplicacion" : "2000-01-23T04:56:07.000+00:00",
"idContrato" : 6,
"regimen" : {
"descripcion" : "descripcion",
"codigoReferencia" : 5
},
"codigoRegimen" : 1
}
Example data
Content-Type: text/json
Custom MIME type example not yet supported: text/json
Example data
Content-Type: text/plain
Custom MIME type example not yet supported: text/plain
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
text/plain
application/json
text/json
Responses
200
Lista de regímenes obtenida exitosamente.
Minsalud_SIIFA_API_Features_ContratoRegimen_Queries_ListContratoRegimenByIdContrato_Result
404
No se encontraron regímenes para el contrato especificado.
Up
delete /api/ContratoRegimen/{IdContratoRegimen}
Elimina un régimen de contrato por su identificador. (apiContratoRegimenIdContratoRegimenDelete)
Este endpoint permite eliminar un régimen de contrato existente, identificándolo por su ID único.
Path parameters
IdContratoRegimen (required)
Path Parameter — default: null format: int64
Return type
Example data
Content-Type: application/json
{
"idContratoRegimen" : 0
}
Example data
Content-Type: text/json
Custom MIME type example not yet supported: text/json
Example data
Content-Type: text/plain
Custom MIME type example not yet supported: text/plain
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
text/plain
application/json
text/json
Responses
200
Régimen eliminado exitosamente.
Minsalud_SIIFA_API_Features_ContratoRegimen_Commands_DeleteContratoRegimen_Result
404
No se encontró el régimen a eliminar.
Up
get /api/ContratoRegimen/{IdContratoRegimen}
Obtiene el detalle de un régimen de contrato por su identificador. (apiContratoRegimenIdContratoRegimenGet)
Este endpoint devuelve la información detallada de un régimen de contrato específico, incluyendo tipo, vigencia y condiciones.
Path parameters
IdContratoRegimen (required)
Path Parameter — default: null format: int32
Return type
Example data
Content-Type: application/json
{
"fechaInicioAplicacion" : "2000-01-23T04:56:07.000+00:00",
"idContratoRegimen" : 0,
"fechaRegistro" : "2000-01-23T04:56:07.000+00:00",
"fechaFinalizacionAplicacion" : "2000-01-23T04:56:07.000+00:00",
"idContrato" : 6,
"regimen" : {
"descripcion" : "descripcion",
"codigoReferencia" : 5
},
"codigoRegimen" : 1
}
Example data
Content-Type: text/json
Custom MIME type example not yet supported: text/json
Example data
Content-Type: text/plain
Custom MIME type example not yet supported: text/plain
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
text/plain
application/json
text/json
Responses
200
Detalle del régimen obtenido exitosamente.
Minsalud_SIIFA_API_Features_ContratoRegimen_Queries_DetailContratoRegimen_Result
404
No se encontró el régimen solicitado.
Up
post /api/ContratoRegimen
Registra un nuevo régimen para un contrato. (apiContratoRegimenPost)
Este endpoint permite crear un nuevo registro de régimen asociado a un contrato, especificando los datos requeridos.
Consumes
This API call consumes the following media types via the request header:
application/json
text/json
application/*+json
Request body
Return type
Example data
Content-Type: application/json
{
"idContratoRegimen" : 0,
"idContrato" : 6
}
Example data
Content-Type: text/json
Custom MIME type example not yet supported: text/json
Example data
Content-Type: text/plain
Custom MIME type example not yet supported: text/plain
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
text/plain
application/json
text/json
Responses
200
Régimen registrado exitosamente.
Minsalud_SIIFA_API_Features_ContratoRegimen_Commands_AddContratoRegimen_Result
400
Datos inválidos o faltantes en la solicitud.
Up
put /api/ContratoRegimen
Actualiza la información de un régimen de contrato existente. (apiContratoRegimenPut)
Este endpoint permite modificar los datos de un régimen previamente registrado para un contrato.
Consumes
This API call consumes the following media types via the request header:
application/json
text/json
application/*+json
Request body
Return type
Example data
Content-Type: application/json
{
"idContratoRegimen" : 0,
"idContrato" : 6
}
Example data
Content-Type: text/json
Custom MIME type example not yet supported: text/json
Example data
Content-Type: text/plain
Custom MIME type example not yet supported: text/plain
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
text/plain
application/json
text/json
Responses
200
Régimen actualizado exitosamente.
Minsalud_SIIFA_API_Features_ContratoRegimen_Commands_UpdateContratoRegimen_Result
404
No se encontró el régimen a actualizar.
400
Datos inválidos en la solicitud.
Crea una nueva empresa en el sistema. (apiEmpresaAddPost)
Este endpoint permite registrar una nueva empresa en el catálogo del sistema SIIFA.
Validaciones aplicadas:
- El NIT debe ser único en el sistema
- El NIT debe ser un número positivo
- La razón social es obligatoria (máximo 250 caracteres)
- El dígito de verificación debe estar entre 0 y 9
- El estado debe ser 0 (Inactiva) o 1 (Activa)
- El código REPS debe ser un número positivo
Datos requeridos:
- Nit: Número de Identificación Tributaria
- RazonSocial: Nombre legal de la empresa
- DigitoVerificacion: Dígito de verificación del NIT (0-9)
- Estado: 0 (Inactiva) o 1 (Activa)
- ClprCodigoReps: Código del Registro Especial de Prestadores de Servicios de Salud
Sample request:
POST /api/Empresa/Add
{
"nit": 800197268,
"razonSocial": "IPS SALUD TOTAL S.A.",
"digitoVerificacion": 5,
"estado": 1,
"clprCodigoReps": 25001234
}
Consumes
This API call consumes the following media types via the request header:
application/json
text/json
application/*+json
Request body
Return type
Example data
Content-Type: application/json
{
"nit" : 0
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Empresa creada exitosamente. Retorna el NIT de la empresa creada.
Minsalud_SIIFA_API_Contrato_Features_Empresa_Commands_AddEmpresa_Result
400
Datos inválidos. Verifique que todos los campos cumplan con las validaciones.
Microsoft_AspNetCore_Mvc_ProblemDetails
401
No autorizado. Token de autenticación inválido o no proporcionado.
Microsoft_AspNetCore_Mvc_ProblemDetails
403
Forbidden
Microsoft_AspNetCore_Mvc_ProblemDetails
500
Error interno del servidor al crear la empresa.
Microsoft_AspNetCore_Mvc_ProblemDetails
Up
delete /api/Empresa/Delete/{nit}
Elimina una empresa del sistema. (apiEmpresaDeleteNitDelete)
Este endpoint permite eliminar una empresa del catálogo del sistema.
Solo se permite la eliminación si la empresa no tiene contratos asociados.
Validaciones aplicadas:
- La empresa debe existir en el sistema
- La empresa no debe tener contratos como contratante
- La empresa no debe tener contratos como contratista
Si la empresa tiene contratos asociados, no podrá ser eliminada y se retornará
un error de validación. En ese caso, considere cambiar el estado a Inactiva (0)
en lugar de eliminarla.
Sample request:
DELETE /api/Empresa/Delete/800197268
Path parameters
nit (required)
Path Parameter — Número de Identificación Tributaria (NIT) de la empresa a eliminar. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"nit" : 0
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Empresa eliminada exitosamente. Retorna el NIT de la empresa eliminada.
Minsalud_SIIFA_API_Contrato_Features_Empresa_Commands_DeleteEmpresa_Result
400
No se puede eliminar la empresa porque tiene contratos asociados o el NIT es inválido.
Microsoft_AspNetCore_Mvc_ProblemDetails
401
No autorizado. Token de autenticación inválido o no proporcionado.
Microsoft_AspNetCore_Mvc_ProblemDetails
403
Forbidden
Microsoft_AspNetCore_Mvc_ProblemDetails
404
No se encontró una empresa con el NIT proporcionado.
Microsoft_AspNetCore_Mvc_ProblemDetails
500
Error interno del servidor al eliminar la empresa.
Microsoft_AspNetCore_Mvc_ProblemDetails
Up
get /api/Empresa/Detail/{nit}
Obtiene el detalle completo de una empresa específica por su NIT. (apiEmpresaDetailNitGet)
Este endpoint permite consultar toda la información de una empresa registrada,
incluyendo estadísticas de contratos asociados.
Información devuelta:
- NIT y dígito de verificación
- Razón social completa
- Estado actual y su descripción (Activa/Inactiva)
- Código REPS
- Usuario que realizó el registro
- Fecha de registro en el sistema
- Cantidad de contratos como contratante
- Cantidad de contratos como contratista
Sample request:
GET /api/Empresa/Detail/800197268
Path parameters
nit (required)
Path Parameter — Número de Identificación Tributaria (NIT) de la empresa. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"clprCodigoReps" : 5,
"cantidadContratosComoContratante" : 5,
"digitoVerificacion" : 6,
"razonSocial" : "razonSocial",
"estado" : 1,
"usuarioRegistro" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"cantidadContratosComoContratista" : 2,
"fechaRegistro" : "2000-01-23T04:56:07.000+00:00",
"nit" : 0,
"estadoDescripcion" : "estadoDescripcion"
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Detalle de la empresa obtenido exitosamente.
Minsalud_SIIFA_API_Contrato_Features_Empresa_Queries_DetailEmpresa_ResultEmpresa
400
NIT inválido o empresa no encontrada.
Microsoft_AspNetCore_Mvc_ProblemDetails
401
No autorizado. Token de autenticación inválido o no proporcionado.
Microsoft_AspNetCore_Mvc_ProblemDetails
403
Forbidden
Microsoft_AspNetCore_Mvc_ProblemDetails
404
No se encontró una empresa con el NIT proporcionado.
Microsoft_AspNetCore_Mvc_ProblemDetails
500
Error interno del servidor al procesar la consulta.
Microsoft_AspNetCore_Mvc_ProblemDetails
Obtiene una lista paginada de empresas con filtros opcionales y ordenamiento personalizable. (apiEmpresaListGet)
Este endpoint permite consultar el catálogo completo de empresas registradas en el sistema
con capacidades avanzadas de filtrado, ordenamiento y paginación mediante IQueryable.
Filtros disponibles:
- Nit: Filtro por número de identificación tributaria exacto
- RazonSocial: Filtro por razón social (búsqueda parcial, case-insensitive)
- Estado: Filtro por estado (0: Inactiva, 1: Activa)
- ClprCodigoReps: Filtro por código REPS
Ordenamiento:
- OrdenarPor: Campo por el cual ordenar (Nit, RazonSocial, FechaRegistro). Default: FechaRegistro
- DireccionOrden: Dirección del orden (asc, desc). Default: desc
Paginación:
- NumeroPagina: Número de página (debe ser mayor a 0, default: 1)
- RegistrosPorPagina: Cantidad de registros por página (debe ser mayor a 0 y menor o igual a 100, default: 10)
Información devuelta por cada empresa:
- NIT y dígito de verificación
- Razón social completa
- Estado actual y su descripción
- Código REPS
- Fecha de registro en el sistema
Los resultados incluyen metadatos de paginación:
- Total de registros encontrados
- Total de páginas disponibles
- Página actual
- Registros por página
Sample request:
GET /api/Empresa/List?NumeroPagina=1&RegistrosPorPagina=10&OrdenarPor=RazonSocial&DireccionOrden=asc
GET /api/Empresa/List?Estado=1&RazonSocial=salud
GET /api/Empresa/List?Nit=800197268
Query parameters
Nit (optional)
Query Parameter — Filtro opcional por NIT de la empresa. default: null format: int32
RazonSocial (optional)
Query Parameter — Filtro opcional por razón social de la empresa (búsqueda parcial). default: null
Estado (optional)
Query Parameter — Filtro opcional por estado de la empresa.
1: Activa, 0: Inactiva. default: null format: int32
ClprCodigoReps (optional)
Query Parameter — Filtro opcional por código REPS. default: null format: int32
OrdenarPor (optional)
Query Parameter — Campo por el cual ordenar los resultados.
Valores permitidos: Nit, RazonSocial, FechaRegistro.
Por defecto: FechaRegistro. default: null
DireccionOrden (optional)
Query Parameter — Dirección del ordenamiento.
Valores permitidos: asc, desc.
Por defecto: desc. default: null
NumeroPagina (optional)
Query Parameter — Número de página para la paginación.
Debe ser mayor a 0. Por defecto: 1. default: null format: int32
RegistrosPorPagina (optional)
Query Parameter — Cantidad de registros por página.
Debe ser mayor a 0 y menor o igual a 100. Por defecto: 10. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"totalRegistros" : 1,
"paginaActual" : 0,
"resultado" : [ {
"clprCodigoReps" : 9,
"digitoVerificacion" : 2,
"razonSocial" : "razonSocial",
"estado" : 7,
"fechaRegistro" : "2000-01-23T04:56:07.000+00:00",
"nit" : 5,
"estadoDescripcion" : "estadoDescripcion"
}, {
"clprCodigoReps" : 9,
"digitoVerificacion" : 2,
"razonSocial" : "razonSocial",
"estado" : 7,
"fechaRegistro" : "2000-01-23T04:56:07.000+00:00",
"nit" : 5,
"estadoDescripcion" : "estadoDescripcion"
} ],
"totalPaginas" : 5,
"registrosPorPagina" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Lista paginada de empresas obtenida exitosamente.
PaginadorGenerico_Minsalud_SIIFA_API_Contrato_Features_Empresa_Queries_ListEmpresa_ResultEmpresa
400
Parámetros de consulta inválidos. Verifique los filtros y parámetros de paginación.
Microsoft_AspNetCore_Mvc_ProblemDetails
401
No autorizado. Token de autenticación inválido o no proporcionado.
Microsoft_AspNetCore_Mvc_ProblemDetails
403
Forbidden
Microsoft_AspNetCore_Mvc_ProblemDetails
500
Error interno del servidor al procesar la consulta.
Microsoft_AspNetCore_Mvc_ProblemDetails
Up
put /api/Empresa/Update
Actualiza la información de una empresa existente. (apiEmpresaUpdatePut)
Este endpoint permite modificar los datos de una empresa previamente registrada en el sistema.
El NIT no puede ser modificado ya que es el identificador único de la empresa.
Validaciones aplicadas:
- La empresa debe existir en el sistema
- La razón social es obligatoria (máximo 250 caracteres)
- El dígito de verificación debe estar entre 0 y 9
- El estado debe ser 0 (Inactiva) o 1 (Activa)
- El código REPS debe ser un número positivo
Datos requeridos:
- Nit: Identificador de la empresa (no modificable)
- RazonSocial: Nueva razón social
- DigitoVerificacion: Nuevo dígito de verificación (0-9)
- Estado: Nuevo estado (0 o 1)
- ClprCodigoReps: Nuevo código REPS
Sample request:
PUT /api/Empresa/Update
{
"nit": 800197268,
"razonSocial": "IPS SALUD TOTAL S.A.S.",
"digitoVerificacion": 5,
"estado": 1,
"clprCodigoReps": 25001234
}
Consumes
This API call consumes the following media types via the request header:
application/json
text/json
application/*+json
Request body
Return type
Example data
Content-Type: application/json
{
"nit" : 0
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Empresa actualizada exitosamente. Retorna el NIT de la empresa actualizada.
Minsalud_SIIFA_API_Contrato_Features_Empresa_Commands_UpdateEmpresa_Result
400
Datos inválidos o empresa no encontrada.
Microsoft_AspNetCore_Mvc_ProblemDetails
401
No autorizado. Token de autenticación inválido o no proporcionado.
Microsoft_AspNetCore_Mvc_ProblemDetails
403
Forbidden
Microsoft_AspNetCore_Mvc_ProblemDetails
404
No se encontró una empresa con el NIT proporcionado.
Microsoft_AspNetCore_Mvc_ProblemDetails
500
Error interno del servidor al actualizar la empresa.
Microsoft_AspNetCore_Mvc_ProblemDetails
Up
get /api/ReferenciaBanco
Obtiene la lista de todos los bancos disponibles en el sistema con paginación. (apiReferenciaBancoGet)
Este endpoint retorna todos los bancos registrados en la tabla REFERENCIA_BANCO.
Soporta filtros por código, estado y nombre, además de paginación.
Parámetros de consulta:
- CodigoBanrep (opcional): Filtrar por código específico del banco
- Estado (opcional): Filtrar por estado (ACTIVO, INACTIVO)
- Nombre (opcional): Buscar bancos que contengan el texto especificado en el nombre
- NumeroPagina (opcional): Número de página (por defecto: 1)
- RegistrosPorPagina (opcional): Cantidad de registros por página (por defecto: 10, máximo: 100)
Información retornada:
- Lista paginada ordenada alfabéticamente por nombre
- Incluye código Banrep, código Superfinanciera, NIT, razón social, convenio ADRES
- Fechas de registro, actualización y convenio ADRES
- Metadatos de paginación: total de registros, página actual, registros por página
Casos de uso:
- Llenar catálogos/listas desplegables de bancos en el frontend
- Consultar información de bancos para validaciones
- Obtener información del convenio ADRES de un banco
- Listar bancos con paginación para tablas
Sample requests:
GET /api/ReferenciaBanco
GET /api/ReferenciaBanco?estado=ACTIVO
GET /api/ReferenciaBanco?nombre=Bancolombia
GET /api/ReferenciaBanco?codigoBanrep=1
GET /api/ReferenciaBanco?estado=ACTIVO&numeroPagina=1®istrosPorPagina=20
GET /api/ReferenciaBanco?nombre=Banco&numeroPagina=2®istrosPorPagina=10
Query parameters
CodigoBanrep (optional)
Query Parameter — default: null format: int32
Estado (optional)
Query Parameter — default: null
Nombre (optional)
Query Parameter — default: null
NumeroPagina (optional)
Query Parameter — default: null format: int32
RegistrosPorPagina (optional)
Query Parameter — default: null format: int32
Return type
Example data
Content-Type: application/json
{
"totalRegistros" : 1,
"paginaActual" : 0,
"resultado" : [ {
"codigoBanrep" : 5,
"razonSocial" : "razonSocial",
"estado" : "estado",
"codigoSuperfinanciera" : 2,
"fechaRegistro" : "2000-01-23T04:56:07.000+00:00",
"convenioAdres" : "convenioAdres",
"nit" : "nit",
"fechaActualizacion" : "2000-01-23T04:56:07.000+00:00",
"fechaConvenioAdres" : "2000-01-23T04:56:07.000+00:00",
"nombre" : "nombre",
"tipoEntidad" : "tipoEntidad"
}, {
"codigoBanrep" : 5,
"razonSocial" : "razonSocial",
"estado" : "estado",
"codigoSuperfinanciera" : 2,
"fechaRegistro" : "2000-01-23T04:56:07.000+00:00",
"convenioAdres" : "convenioAdres",
"nit" : "nit",
"fechaActualizacion" : "2000-01-23T04:56:07.000+00:00",
"fechaConvenioAdres" : "2000-01-23T04:56:07.000+00:00",
"nombre" : "nombre",
"tipoEntidad" : "tipoEntidad"
} ],
"totalPaginas" : 5,
"registrosPorPagina" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Example data
Content-Type: application/json
{
"instance" : "instance",
"detail" : "detail",
"type" : "type",
"title" : "title",
"status" : 6
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Lista de bancos obtenida exitosamente.
PaginadorGenerico_Minsalud_SIIFA_API_Contrato_Features_ReferenciaBanco_ListReferenciaBanco_Result
400
Parámetros inválidos.
Microsoft_AspNetCore_Mvc_ProblemDetails
401
No autorizado.
Microsoft_AspNetCore_Mvc_ProblemDetails
500
Error interno del servidor.
Microsoft_AspNetCore_Mvc_ProblemDetails
Up
get /api/ReferenciaCums/ByIdCums/{IdCums}
Obtiene el detalle de una referencia CUMS por su identificador único. (apiReferenciaCumsByIdCumsIdCumsGet)
Este endpoint permite consultar toda la información asociada a una referencia CUMS específica, identificada por su IdCums.
Path parameters
IdCums (required)
Path Parameter — default: null format: int32
Return type
Example data
Content-Type: application/json
{
"descripcion" : "descripcion",
"codigoAtc" : "codigoAtc",
"expedienteCum" : 6,
"consecutivoCum" : 1,
"incluidoPbs" : true,
"idCums" : 0,
"nombre" : "nombre"
}
Example data
Content-Type: text/json
Custom MIME type example not yet supported: text/json
Example data
Content-Type: text/plain
Custom MIME type example not yet supported: text/plain
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
text/plain
application/json
text/json
Responses
200
Detalle de la referencia CUMS obtenido exitosamente.
Minsalud_SIIFA_API_Features_ReferenciaCums_Queries_GetByIdCums_Result
404
No se encontró la referencia CUMS con el identificador proporcionado.
Up
get /api/ReferenciaCums
Obtiene una lista de referencias CUMS filtradas por los parámetros de búsqueda proporcionados. (apiReferenciaCumsGet)
Este endpoint permite buscar referencias CUMS utilizando texto libre, expediente CUM o código ATC.
El resultado incluye información relevante como el nombre, descripción, código ATC y si está incluido en el PBS.
Query parameters
TextoConsulta (optional)
Query Parameter — default: null
NumeroRegistros (optional)
Query Parameter — default: null format: int32
Return type
Example data
Content-Type: application/json
[ {
"descripcion" : "descripcion",
"codigoAtc" : "codigoAtc",
"expedienteCum" : 6,
"consecutivoCum" : 1,
"incluidoPbs" : true,
"idCums" : 0,
"nombre" : "nombre"
}, {
"descripcion" : "descripcion",
"codigoAtc" : "codigoAtc",
"expedienteCum" : 6,
"consecutivoCum" : 1,
"incluidoPbs" : true,
"idCums" : 0,
"nombre" : "nombre"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
text/plain
application/json
text/json
Responses
200
Lista de referencias CUMS obtenida exitosamente.
400
Parámetros de búsqueda inválidos.
Up
get /api/ReferenciaCups/ByIdCups/{IdCups}
Obtiene el detalle de una referencia CUPS a partir de su identificador único. (apiReferenciaCupsByIdCupsIdCupsGet)
Este endpoint permite consultar toda la información relevante de un procedimiento específico, identificado por su IdCups.
Es útil para validación, auditoría y análisis detallado de procedimientos en el sistema.
Path parameters
IdCups (required)
Path Parameter — default: null
Return type
Example data
Content-Type: application/json
{
"codigoCupsSispro" : "codigoCupsSispro",
"codigoCupsNumerico" : 0,
"incluidoPbs" : true,
"nombre" : "nombre"
}
Example data
Content-Type: text/json
Custom MIME type example not yet supported: text/json
Example data
Content-Type: text/plain
Custom MIME type example not yet supported: text/plain
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
text/plain
application/json
text/json
Responses
200
Consulta exitosa. Se devuelve el detalle de la referencia CUPS.
Minsalud_SIIFA_API_Features_ReferenciaCups_Queries_GetByIdCups_Result
404
No se encontró ninguna referencia CUPS con el identificador proporcionado.
Up
get /api/ReferenciaCups
Obtiene la lista de referencias CUPS según los parámetros de consulta. (apiReferenciaCupsGet)
Este endpoint permite consultar todas las referencias CUPS disponibles, filtrando según los criterios definidos en el parámetro de consulta.
Es útil para procesos de integración, auditoría y soporte a la toma de decisiones clínicas y administrativas.
Query parameters
TextoConsulta (optional)
Query Parameter — default: null
NumeroRegistros (optional)
Query Parameter — default: null format: int32
Return type
Example data
Content-Type: application/json
[ {
"codigoCupsSispro" : "codigoCupsSispro",
"codigoCupsNumerico" : 0,
"incluidoPbs" : true,
"nombre" : "nombre"
}, {
"codigoCupsSispro" : "codigoCupsSispro",
"codigoCupsNumerico" : 0,
"incluidoPbs" : true,
"nombre" : "nombre"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
text/plain
application/json
text/json
Responses
200
Lista de referencias CUPS obtenida exitosamente.
Up
get /api/ReferenciaMunicipio
Obtiene la lista de municipios de referencia según los parámetros de consulta. (apiReferenciaMunicipioGet)
Este endpoint permite consultar todos los municipios de referencia disponibles, filtrando según los criterios definidos en el parámetro de consulta.
El resultado incluye información del municipio y su departamento asociado.
Query parameters
query (optional)
Query Parameter — Parámetro que contiene los criterios de búsqueda para los municipios de referencia. default: null
Return type
Example data
Content-Type: application/json
[ {
"codigoDepartamento" : "codigoDepartamento",
"nombreDepartamento" : "nombreDepartamento",
"nombreMunicipio" : "nombreMunicipio",
"codigoMunicipio" : "codigoMunicipio"
}, {
"codigoDepartamento" : "codigoDepartamento",
"nombreDepartamento" : "nombreDepartamento",
"nombreMunicipio" : "nombreMunicipio",
"codigoMunicipio" : "codigoMunicipio"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
text/plain
application/json
text/json
Responses
200
Lista de municipios de referencia obtenida exitosamente.
Up
get /api/ReferenciaReps/ByNitPrestador/{Nit}
Obtiene la lista de referencias REPS asociadas a un prestador según su NIT. (apiReferenciaRepsByNitPrestadorNitGet)
Este endpoint permite consultar todas las referencias REPS disponibles para un prestador de servicios de salud, filtrando por el NIT del prestador.
Path parameters
Nit (required)
Path Parameter — default: null
Return type
Example data
Content-Type: application/json
[ {
"codigoHabilitacion" : "codigoHabilitacion",
"nombreServicio" : "nombreServicio",
"codigoServicio" : 0,
"modalidadMedia" : true,
"nombreDepartamento" : "nombreDepartamento",
"nombreMunicipio" : "nombreMunicipio",
"numeroSede" : "numeroSede",
"modalidadAlta" : true,
"modalidadBaja" : true,
"id" : 6
}, {
"codigoHabilitacion" : "codigoHabilitacion",
"nombreServicio" : "nombreServicio",
"codigoServicio" : 0,
"modalidadMedia" : true,
"nombreDepartamento" : "nombreDepartamento",
"nombreMunicipio" : "nombreMunicipio",
"numeroSede" : "numeroSede",
"modalidadAlta" : true,
"modalidadBaja" : true,
"id" : 6
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
text/plain
application/json
text/json
Responses
200
Lista de referencias REPS obtenida exitosamente.
(getWeatherForecast)
Return type
Example data
Content-Type: application/json
[ {
"date" : "2000-01-23",
"summary" : "summary",
"temperatureC" : 0,
"temperatureF" : 6
}, {
"date" : "2000-01-23",
"summary" : "summary",
"temperatureC" : 0,
"temperatureF" : 6
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
text/plain
application/json
text/json
Responses
200
OK
[ Jump to Methods ]
Table of Contents
Microsoft_AspNetCore_Mvc_ProblemDetails -
Minsalud_SIIFA_API_Contrato_Features_ContratoAnticipo_Commands_AddContratoAnticipo_Command -
Minsalud_SIIFA_API_Contrato_Features_ContratoAnticipo_Commands_AddContratoAnticipo_Result -
Minsalud_SIIFA_API_Contrato_Features_ContratoAnticipo_Commands_DeleteContratoAnticipo_Result -
Minsalud_SIIFA_API_Contrato_Features_ContratoAnticipo_Commands_UpdateContratoAnticipo_Command -
Minsalud_SIIFA_API_Contrato_Features_ContratoAnticipo_Commands_UpdateContratoAnticipo_Result -
Minsalud_SIIFA_API_Contrato_Features_ContratoAnticipo_Queries_DetailContratoAnticipo_Result -
Minsalud_SIIFA_API_Contrato_Features_ContratoAnticipo_Queries_ListContratoAnticipoByIdContrato_Result -
Minsalud_SIIFA_API_Contrato_Features_ContratoCumsModalidadPago_Queries_DetailContratoCumsModalidadPago_Result -
Minsalud_SIIFA_API_Contrato_Features_ContratoCupsModalidadPago_Queries_DetailContratoCupsModalidadPago_Result -
Minsalud_SIIFA_API_Contrato_Features_ContratoModalidadPago_Commands_AddContratoModalidadPago_Command -
Minsalud_SIIFA_API_Contrato_Features_ContratoModalidadPago_Commands_AddContratoModalidadPago_Result -
Minsalud_SIIFA_API_Contrato_Features_ContratoModalidadPago_Commands_DeleteContratoModalidadPago_Result -
Minsalud_SIIFA_API_Contrato_Features_ContratoModalidadPago_Commands_UpdateContratoModalidadPago_Command -
Minsalud_SIIFA_API_Contrato_Features_ContratoModalidadPago_Commands_UpdateContratoModalidadPago_Result -
Minsalud_SIIFA_API_Contrato_Features_ContratoModalidadPago_Queries_DetailContratoModalidadPago_Result -
Minsalud_SIIFA_API_Contrato_Features_ContratoModalidadPago_Queries_ListContratoModalidadPagoByIdContrato_Result -
Minsalud_SIIFA_API_Contrato_Features_ContratoOperacion_Commands_AddContratoOperacion_Command -
Minsalud_SIIFA_API_Contrato_Features_ContratoOperacion_Commands_AddContratoOperacion_Result -
Minsalud_SIIFA_API_Contrato_Features_ContratoOperacion_Commands_DeleteContratoOperacion_Result -
Minsalud_SIIFA_API_Contrato_Features_ContratoOperacion_Commands_UpdateContratoOperacion_Command -
Minsalud_SIIFA_API_Contrato_Features_ContratoOperacion_Commands_UpdateContratoOperacion_Result -
Minsalud_SIIFA_API_Contrato_Features_ContratoOperacion_Queries_DetailContratoOperacion_Result -
Minsalud_SIIFA_API_Contrato_Features_ContratoOperacion_Queries_DetailContratoOperacion_ResultCodigoReferencia -
Minsalud_SIIFA_API_Contrato_Features_ContratoOperacion_Queries_ListContratoOperacionByIdContrato_ResultCodigoReferencia -
Minsalud_SIIFA_API_Contrato_Features_ContratoOperacion_Queries_ListContratoOperacionByIdContrato_ResultContratoOperacion -
Minsalud_SIIFA_API_Contrato_Features_ContratoPrestadorServicioModalidadPago_Queries_DetailContratoPrestadorServicioModalidadPago_Result -
Minsalud_SIIFA_API_Contrato_Features_Empresa_Commands_AddEmpresa_Command -
Minsalud_SIIFA_API_Contrato_Features_Empresa_Commands_AddEmpresa_Result -
Minsalud_SIIFA_API_Contrato_Features_Empresa_Commands_DeleteEmpresa_Result -
Minsalud_SIIFA_API_Contrato_Features_Empresa_Commands_UpdateEmpresa_Command -
Minsalud_SIIFA_API_Contrato_Features_Empresa_Commands_UpdateEmpresa_Result -
Minsalud_SIIFA_API_Contrato_Features_Empresa_Queries_DetailEmpresa_ResultEmpresa -
Minsalud_SIIFA_API_Contrato_Features_Empresa_Queries_ListEmpresa_ResultEmpresa -
Minsalud_SIIFA_API_Contrato_Features_ReferenciaBanco_ListReferenciaBanco_Result -
Minsalud_SIIFA_API_Features_CodigoReferenciaDominio_Queries_ListCodigoReferenciaDominio_Result -
Minsalud_SIIFA_API_Features_CodigoReferencia_Queries_ListCodigoReferenciaByIdDominio_Result -
Minsalud_SIIFA_API_Features_CodigoReferencia_Queries_ListCodigoReferenciaByNombreDominio_Result -
Minsalud_SIIFA_API_Features_ContratoCumsModalidadPago_Commands_AddContratoCumsModalidadPago_Command -
Minsalud_SIIFA_API_Features_ContratoCumsModalidadPago_Commands_AddContratoCumsModalidadPago_Result -
Minsalud_SIIFA_API_Features_ContratoCumsModalidadPago_Commands_DeleteContratoCumsModalidadPago_Result -
Minsalud_SIIFA_API_Features_ContratoCumsModalidadPago_Commands_UpdateContratoCumsModalidadPago_Command -
Minsalud_SIIFA_API_Features_ContratoCumsModalidadPago_Commands_UpdateContratoCumsModalidadPago_Result -
Minsalud_SIIFA_API_Features_ContratoCupsModalidadPago_Commands_AddContratoCupsModalidadPago_Command -
Minsalud_SIIFA_API_Features_ContratoCupsModalidadPago_Commands_AddContratoCupsModalidadPago_Result -
Minsalud_SIIFA_API_Features_ContratoCupsModalidadPago_Commands_DeleteContratoCupsModalidadPago_Result -
Minsalud_SIIFA_API_Features_ContratoCupsModalidadPago_Commands_UpdateContratoCupsModalidadPago_Command -
Minsalud_SIIFA_API_Features_ContratoCupsModalidadPago_Commands_UpdateContratoCupsModalidadPago_Result -
Minsalud_SIIFA_API_Features_ContratoCups_Commands_AddContratoCups_Command -
Minsalud_SIIFA_API_Features_ContratoCups_Commands_AddContratoCups_Result -
Minsalud_SIIFA_API_Features_ContratoCups_Commands_DeleteContratoCups_Result -
Minsalud_SIIFA_API_Features_ContratoCups_Commands_UpdateContratoCups_Command -
Minsalud_SIIFA_API_Features_ContratoCups_Commands_UpdateContratoCups_Result -
Minsalud_SIIFA_API_Features_ContratoCups_Queries_DetailContratoCups_Result -
Minsalud_SIIFA_API_Features_ContratoCups_Queries_DetailContratoCups_ResultReferenciaCups -
Minsalud_SIIFA_API_Features_ContratoCups_Queries_ListContratoCupsByIdContrato_Result -
Minsalud_SIIFA_API_Features_ContratoCups_Queries_ListContratoCupsByIdContrato_ResultReferenciaCups -
Minsalud_SIIFA_API_Features_ContratoEstado_Commands_AddContratoEstado_Command -
Minsalud_SIIFA_API_Features_ContratoEstado_Commands_AddContratoEstado_Result -
Minsalud_SIIFA_API_Features_ContratoEstado_Queries_ListContratoEstadoByIdContrato_Result -
Minsalud_SIIFA_API_Features_ContratoLiquidacion_Commands_AddContratoLiquidacion_Command -
Minsalud_SIIFA_API_Features_ContratoLiquidacion_Commands_AddContratoLiquidacion_Result -
Minsalud_SIIFA_API_Features_ContratoLiquidacion_Commands_DeleteContratoLiquidacion_Result -
Minsalud_SIIFA_API_Features_ContratoLiquidacion_Commands_UpdateContratoLiquidacion_Command -
Minsalud_SIIFA_API_Features_ContratoLiquidacion_Commands_UpdateContratoLiquidacion_Result -
Minsalud_SIIFA_API_Features_ContratoLiquidacion_Queries_DetailContratoLiquidacion_Result -
Minsalud_SIIFA_API_Features_ContratoLiquidacion_Queries_DetailContratoLiquidacion_ResultReferenciaCausalLiquidacion -
Minsalud_SIIFA_API_Features_ContratoLiquidacion_Queries_ListContratoLiquidacionByIdContrato_Result -
Minsalud_SIIFA_API_Features_ContratoLiquidacion_Queries_ListContratoLiquidacionByIdContrato_ResultReferenciaCausalLiquidacion -
Minsalud_SIIFA_API_Features_ContratoOtrosiCums_Commands_AddContratoOtrosiCums_Command -
Minsalud_SIIFA_API_Features_ContratoOtrosiCums_Commands_AddContratoOtrosiCums_Result -
Minsalud_SIIFA_API_Features_ContratoOtrosiCums_Commands_DeleteContratoOtrosiCums_Result -
Minsalud_SIIFA_API_Features_ContratoOtrosiCums_Commands_UpdateContratoOtrosiCums_Command -
Minsalud_SIIFA_API_Features_ContratoOtrosiCums_Commands_UpdateContratoOtrosiCums_Result -
Minsalud_SIIFA_API_Features_ContratoOtrosiCums_Queries_DetailContratoOtrosiCums_Result -
Minsalud_SIIFA_API_Features_ContratoOtrosiCums_Queries_DetailContratoOtrosiCums_ResultReferenciaCums -
Minsalud_SIIFA_API_Features_ContratoOtrosiCums_Queries_ListContratoOtrosiCumsByIdContratoOtrosi_Result -
Minsalud_SIIFA_API_Features_ContratoOtrosiCums_Queries_ListContratoOtrosiCumsByIdContratoOtrosi_ResultReferenciaCums -
Minsalud_SIIFA_API_Features_ContratoOtrosiEstado_Commands_AddContratoOtrosiEstado_Command -
Minsalud_SIIFA_API_Features_ContratoOtrosiEstado_Commands_AddContratoOtrosiEstado_Result -
Minsalud_SIIFA_API_Features_ContratoOtrosiEstado_Queries_ListContratoOtrosiEstadoByIdContratoOtrosi_Result -
Minsalud_SIIFA_API_Features_ContratoOtrosiPrestadorServicio_Commands_AddContratoOtrosiPrestadorServicio_Command -
Minsalud_SIIFA_API_Features_ContratoOtrosiPrestadorServicio_Commands_AddContratoOtrosiPrestadorServicio_Result -
Minsalud_SIIFA_API_Features_ContratoOtrosiPrestadorServicio_Commands_DeleteContratoOtrosiPrestadorServicio_Result -
Minsalud_SIIFA_API_Features_ContratoOtrosiPrestadorServicio_Commands_UpdateContratoOtrosiPrestadorServicio_Command -
Minsalud_SIIFA_API_Features_ContratoOtrosiPrestadorServicio_Commands_UpdateContratoOtrosiPrestadorServicio_Result -
Minsalud_SIIFA_API_Features_ContratoOtrosiPrestadorServicio_Queries_DetailContratoOtrosiPrestadorServicio_Result -
Minsalud_SIIFA_API_Features_ContratoOtrosiPrestadorServicio_Queries_DetailContratoOtrosiPrestadorServicio_ResultReferenciaServicio -
Minsalud_SIIFA_API_Features_ContratoOtrosiPrestadorServicio_Queries_ListContratoOtrosiPrestadorServicioByIdContratoOtrosi_Result -
Minsalud_SIIFA_API_Features_ContratoOtrosiPrestadorServicio_Queries_ListContratoOtrosiPrestadorServicioByIdContratoOtrosi_ResultReferenciaServicio -
Minsalud_SIIFA_API_Features_ContratoOtrosi_Commands_AddContratoOtrosi_Command -
Minsalud_SIIFA_API_Features_ContratoOtrosi_Commands_AddContratoOtrosi_Result -
Minsalud_SIIFA_API_Features_ContratoOtrosi_Commands_DeleteContratoOtrosi_Result -
Minsalud_SIIFA_API_Features_ContratoOtrosi_Commands_UpdateContratoOtrosi_Command -
Minsalud_SIIFA_API_Features_ContratoOtrosi_Commands_UpdateContratoOtrosi_Result -
Minsalud_SIIFA_API_Features_ContratoOtrosi_Queries_DetailContratoOtrosi_Result -
Minsalud_SIIFA_API_Features_ContratoOtrosi_Queries_DetailContratoOtrosi_ResultContrato -
Minsalud_SIIFA_API_Features_ContratoOtrosi_Queries_DetailContratoOtrosi_ResultContratoRegimen -
Minsalud_SIIFA_API_Features_ContratoOtrosi_Queries_DetailContratoOtrosi_ResultEmpresa -
Minsalud_SIIFA_API_Features_ContratoOtrosi_Queries_ListContratoOtrosiByIdContrato_Result -
Minsalud_SIIFA_API_Features_ContratoOtrosi_Queries_ListContratoOtrosi_Result -
Minsalud_SIIFA_API_Features_ContratoPrestadorServicioModalidadPago_Commands_AddContratoPrestadorServicioModalidadPago_Command -
Minsalud_SIIFA_API_Features_ContratoPrestadorServicioModalidadPago_Commands_AddContratoPrestadorServicioModalidadPago_Result -
Minsalud_SIIFA_API_Features_ContratoPrestadorServicioModalidadPago_Commands_DeleteContratoPrestadorServicioModalidadPago_Result -
Minsalud_SIIFA_API_Features_ContratoPrestadorServicioModalidadPago_Commands_UpdateContratoPrestadorServicioModalidadPago_Command -
Minsalud_SIIFA_API_Features_ContratoPrestadorServicioModalidadPago_Commands_UpdateContratoPrestadorServicioModalidadPago_Result -
Minsalud_SIIFA_API_Features_ContratoPrestadorServicio_Commands_AddContratoPrestadorServicio_Command -
Minsalud_SIIFA_API_Features_ContratoPrestadorServicio_Commands_AddContratoPrestadorServicio_Result -
Minsalud_SIIFA_API_Features_ContratoPrestadorServicio_Commands_DeleteContratoPrestadorServicio_Result -
Minsalud_SIIFA_API_Features_ContratoPrestadorServicio_Commands_UpdateContratoPrestadorServicio_Command -
Minsalud_SIIFA_API_Features_ContratoPrestadorServicio_Commands_UpdateContratoPrestadorServicio_Result -
Minsalud_SIIFA_API_Features_ContratoPrestadorServicio_Queries_DetailContratoPrestadorServicio_Result -
Minsalud_SIIFA_API_Features_ContratoPrestadorServicio_Queries_DetailContratoPrestadorServicio_ResultReferenciaServicio -
Minsalud_SIIFA_API_Features_ContratoPrestadorServicio_Queries_ListContratoPrestadorServicioByIdContrato_Result -
Minsalud_SIIFA_API_Features_ContratoPrestadorServicio_Queries_ListContratoPrestadorServicioByIdContrato_ResultReferenciaServicio -
Minsalud_SIIFA_API_Features_ContratoRegimen_Commands_AddContratoRegimen_Command -
Minsalud_SIIFA_API_Features_ContratoRegimen_Commands_AddContratoRegimen_Result -
Minsalud_SIIFA_API_Features_ContratoRegimen_Commands_DeleteContratoRegimen_Result -
Minsalud_SIIFA_API_Features_ContratoRegimen_Commands_UpdateContratoRegimen_Command -
Minsalud_SIIFA_API_Features_ContratoRegimen_Commands_UpdateContratoRegimen_Result -
Minsalud_SIIFA_API_Features_ContratoRegimen_Queries_DetailContratoRegimen_Result -
Minsalud_SIIFA_API_Features_ContratoRegimen_Queries_DetailContratoRegimen_ResultReferenciaRegimen -
Minsalud_SIIFA_API_Features_ContratoRegimen_Queries_ListContratoRegimenByIdContrato_Result -
Minsalud_SIIFA_API_Features_ContratoRegimen_Queries_ListContratoRegimenByIdContrato_ResultReferenciaRegimen -
Minsalud_SIIFA_API_Features_Contrato_Commands_AddContratoCums_Command -
Minsalud_SIIFA_API_Features_Contrato_Commands_AddContratoCums_Result -
Minsalud_SIIFA_API_Features_Contrato_Commands_AddContrato_Command -
Minsalud_SIIFA_API_Features_Contrato_Commands_AddContrato_Result -
Minsalud_SIIFA_API_Features_Contrato_Commands_DeleteContratoCums_Result -
Minsalud_SIIFA_API_Features_Contrato_Commands_DeleteContrato_Result -
Minsalud_SIIFA_API_Features_Contrato_Commands_UpdateContratoCums_Command -
Minsalud_SIIFA_API_Features_Contrato_Commands_UpdateContratoCums_Result -
Minsalud_SIIFA_API_Features_Contrato_Commands_UpdateContrato_Command -
Minsalud_SIIFA_API_Features_Contrato_Commands_UpdateContrato_Result -
Minsalud_SIIFA_API_Features_Contrato_Queries_DetailContratoCums_Result -
Minsalud_SIIFA_API_Features_Contrato_Queries_DetailContratoCums_ResultReferenciaCums -
Minsalud_SIIFA_API_Features_Contrato_Queries_DetailContrato_Result -
Minsalud_SIIFA_API_Features_Contrato_Queries_DetailContrato_ResultCodigoReferenciaTipoContrato -
Minsalud_SIIFA_API_Features_Contrato_Queries_DetailContrato_ResultContratoAgrupador -
Minsalud_SIIFA_API_Features_Contrato_Queries_DetailContrato_ResultContratoModalidadPago -
Minsalud_SIIFA_API_Features_Contrato_Queries_DetailContrato_ResultContratoRegimen -
Minsalud_SIIFA_API_Features_Contrato_Queries_DetailContrato_ResultEmpresa -
Minsalud_SIIFA_API_Features_Contrato_Queries_DetailContrato_ResultOtroSi -
Minsalud_SIIFA_API_Features_Contrato_Queries_ListContratoCumsByIdContrato_Result -
Minsalud_SIIFA_API_Features_Contrato_Queries_ListContratoCumsByIdContrato_ResultReferenciaCums -
Minsalud_SIIFA_API_Features_Contrato_Queries_ListContrato_Result -
Minsalud_SIIFA_API_Features_Contrato_Queries_ListContrato_ResultContratoRegimen -
Minsalud_SIIFA_API_Features_Contrato_Queries_ListContrato_ResultEmpresa -
Minsalud_SIIFA_API_Features_ReferenciaCums_Queries_GetByIdCums_Result -
Minsalud_SIIFA_API_Features_ReferenciaCums_Queries_ListReferenciaCums_Result -
Minsalud_SIIFA_API_Features_ReferenciaCums_Queries_ListReferenciaCups_Result -
Minsalud_SIIFA_API_Features_ReferenciaCups_Queries_GetByIdCups_Result -
Minsalud_SIIFA_API_Features_ReferenciaMunicipio_Queries_ListReferenciaMunicipio_Result -
Minsalud_SIIFA_API_Features_ReferenciaReps_Queries_ListReferenciaRepsByNit_Result -
Minsalud_SIIFA_API_WeatherForecast -
PaginadorGenerico_Minsalud_SIIFA_API_Contrato_Features_ContratoOperacion_Queries_ListContratoOperacionByIdContrato_ResultContratoOperacion - PaginadorGenerico_ResultContratoOperacion
PaginadorGenerico_Minsalud_SIIFA_API_Contrato_Features_Empresa_Queries_ListEmpresa_ResultEmpresa - PaginadorGenerico_ResultEmpresa
PaginadorGenerico_Minsalud_SIIFA_API_Contrato_Features_ReferenciaBanco_ListReferenciaBanco_Result - PaginadorGenerico_Result
PaginadorGenerico_Minsalud_SIIFA_API_Features_Contrato_Queries_ListContrato_Result - PaginadorGenerico_Result
type (optional)
title (optional)
status (optional)
detail (optional)
instance (optional)
idContrato (optional)
codigoFuente (optional)
referencia (optional)
valorAnticipo (optional)
fechaAnticipo (optional)
idContratoAnticipo (optional)
idContratoAnticipo (optional)
idContratoAnticipo (optional)
codigoFuente (optional)
referencia (optional)
valorAnticipo (optional)
fechaAnticipo (optional)
idContratoAnticipo (optional)
idContratoAnticipo (optional)
idContrato (optional)
codigoFuente (optional)
referencia (optional)
valorAnticipo (optional)
fechaAnticipo (optional)
fechaRegistro (optional)
idContratoAnticipo (optional)
idContrato (optional)
codigoFuente (optional)
referencia (optional)
valorAnticipo (optional)
fechaAnticipo (optional)
fechaRegistro (optional)
idContratoCumsModalidadPago (optional)
idContratoCums (optional)
idContratoModalidadPago (optional)
valor (optional)
fechaRegistro (optional)
idContratoCupsModalidadPago (optional)
idContratoCups (optional)
idContratoModalidadPago (optional)
valor (optional)
fechaRegistro (optional)
idContrato (optional)
codigoModalidad
idContratoModalidadPago (optional)
idContrato (optional)
idContratoModalidadPago (optional)
idContratoModalidadPago (optional)
codigoModalidad (optional)
idContratoModalidadPago (optional)
idContrato (optional)
idContratoModalidadPago (optional)
idContrato (optional)
codigoModalidad
fechaRegistro (optional)
idContratoModalidadPago (optional)
idContrato (optional)
codigoModalidad
fechaRegistro (optional)
idContrato (optional)
codigoAlcance (optional)
codigoDepartamento (optional)
codigoMunicipio (optional)
poblacionCubierta (optional)
idContratoOperacion (optional)
idContrato (optional)
idContratoOperacion (optional)
idContratoOperacion (optional)
codigoAlcance (optional)
codigoDepartamento (optional)
codigoMunicipio (optional)
poblacionCubierta (optional)
idContratoOperacion (optional)
idContrato (optional)
idContratoOperacion (optional)
idContrato (optional)
codigoAlcance (optional)
alcance (optional)
codigoMunicipio (optional)
nombreMunicipio (optional)
codigoDepartamento (optional)
nombreDepartamento (optional)
poblacionCubierta (optional)
fechaRegistro (optional)
idCondigoReferencia (optional)
descripcion (optional)
idCondigoReferencia (optional)
descripcion (optional)
idContratoOperacion (optional)
idContrato (optional)
codigoAlcance (optional)
alcance (optional)
codigoMunicipio
nombreMunicipio
codigoDepartamento
nombreDepartamento
poblacionCubierta (optional)
fechaRegistro (optional)
idContratoPrestadorServicioModalidadPago (optional)
idContratoPrestadorServicio (optional)
idContratoModalidadPago (optional)
valor (optional)
fechaRegistro (optional)
Comando para agregar una empresa con validaciones de integridad de datos.
nit (optional)
Integer Número de Identificación Tributaria (NIT) de la empresa.
Debe ser único en el sistema y tener entre 6 y 9 dígitos. format: int32
razonSocial (optional)
String Razón social de la empresa.
Es obligatorio y no puede superar los 250 caracteres.
digitoVerificacion (optional)
Integer Dígito de verificación del NIT.
Valor entre 0 y 9 que valida la autenticidad del NIT. format: int32
estado (optional)
Integer Estado de la empresa.
1: Activa, 0: Inactiva. format: int32
clprCodigoReps (optional)
Integer Código REPS (Registro Especial de Prestadores de Servicios de Salud).
Identificador único del prestador en el sistema REPS. format: int32
Resultado que contiene el NIT de la empresa creada.
Resultado que contiene el NIT de la empresa eliminada.
Comando para actualizar los datos de una empresa con validaciones de integridad.
nit (optional)
Integer Número de Identificación Tributaria (NIT) de la empresa a actualizar.
Identifica de forma única la empresa en el sistema. format: int32
razonSocial (optional)
String Nueva razón social de la empresa.
No puede estar vacía ni superar los 250 caracteres.
digitoVerificacion (optional)
Integer Nuevo dígito de verificación del NIT.
Debe estar entre 0 y 9. format: int32
estado (optional)
Integer Nuevo estado de la empresa.
1: Activa, 0: Inactiva. format: int32
clprCodigoReps (optional)
Integer Nuevo código REPS de la empresa.
Identificador del prestador en el Registro Especial de Prestadores de Servicios de Salud. format: int32
Resultado que contiene el NIT de la empresa actualizada.
Objeto de resultado con la información detallada de la empresa.
nit (optional)
Integer Número de Identificación Tributaria (NIT) de la empresa. format: int32
razonSocial (optional)
String Razón social completa de la empresa.
digitoVerificacion (optional)
Integer Dígito de verificación del NIT. format: int32
estado (optional)
Integer Estado actual de la empresa.
1: Activa, 0: Inactiva. format: int32
estadoDescripcion (optional)
String Descripción del estado de la empresa.
clprCodigoReps (optional)
Integer Código REPS (Registro Especial de Prestadores de Servicios de Salud). format: int32
usuarioRegistro (optional)
UUID Identificador del usuario que registró la empresa. format: uuid
fechaRegistro (optional)
Date Fecha y hora de registro de la empresa en el sistema. format: date-time
cantidadContratosComoContratante (optional)
Integer Cantidad de contratos donde la empresa figura como contratante. format: int32
cantidadContratosComoContratista (optional)
Integer Cantidad de contratos donde la empresa figura como contratista. format: int32
Objeto de resultado que contiene la información de una empresa.
nit (optional)
Integer Número de Identificación Tributaria (NIT) de la empresa. format: int32
razonSocial (optional)
String Razón social completa de la empresa.
digitoVerificacion (optional)
Integer Dígito de verificación del NIT. format: int32
estado (optional)
Integer Estado actual de la empresa.
1: Activa, 0: Inactiva. format: int32
estadoDescripcion (optional)
String Descripción del estado de la empresa.
clprCodigoReps (optional)
Integer Código REPS de la empresa. format: int32
fechaRegistro (optional)
Date Fecha y hora de registro de la empresa en el sistema. format: date-time
codigoBanrep (optional)
codigoSuperfinanciera (optional)
nombre (optional)
razonSocial (optional)
nit (optional)
tipoEntidad (optional)
convenioAdres (optional)
estado (optional)
fechaRegistro (optional)
fechaActualizacion (optional)
fechaConvenioAdres (optional)
idCodigoReferenciaDominio (optional)
unidadAnalisis (optional)
nombre (optional)
descripcion (optional)
activo (optional)
idCodigoReferencia (optional)
descripcion (optional)
activo (optional)
idCodigoReferencia (optional)
descripcion (optional)
activo (optional)
idContratoCums (optional)
idContratoModalidadPago (optional)
valor (optional)
idContratoCumsModalidadPago (optional)
idContratoCumsModalidadPago (optional)
idContratoCumsModalidaPago (optional)
idContratoModalidadPago (optional)
valor (optional)
idContratoCumsModalidaPago (optional)
idContratoCups (optional)
idContratoModalidadPago (optional)
valor (optional)
idContratoCupsModalidadPago (optional)
idContratoCupsModalidadPago (optional)
idContratoCupsModalidaPago (optional)
idContratoModalidadPago (optional)
valor (optional)
idContratoCupsModalidaPago (optional)
idContrato (optional)
codigoCupsSispro (optional)
cantidad (optional)
idContratoCups (optional)
idContrato (optional)
idContratoCums (optional)
idContratoCups (optional)
idContrato (optional)
codigoCupsSispro (optional)
cantidad (optional)
idContratoCups (optional)
idContrato (optional)
idContratoCups (optional)
idContrato (optional)
codigoCupsSispro (optional)
cantidad (optional)
fechaRegistro (optional)
cups (optional)
codigoCupsSispro (optional)
codigoCupsNumerico (optional)
nombre (optional)
incluidoPbs (optional)
idContratoCups (optional)
idContrato (optional)
codigoCupsSispro (optional)
cantidad (optional)
fechaRegistro (optional)
cups (optional)
codigoCupsSispro (optional)
codigoCupsNumerico (optional)
nombre (optional)
incluidoPbs (optional)
idContrato (optional)
codigoEstado (optional)
observacion (optional)
idContratoEstado (optional)
idContrato (optional)
idContratoEstado (optional)
idContrato (optional)
codigoEstado (optional)
nombreEstado (optional)
fechaCambio (optional)
fechaRegistro (optional)
observacion (optional)
idContrato (optional)
codigoCausal (optional)
fechaLiquidacion (optional)
valorTotalContrato (optional)
valorTotalEjecutado (optional)
valorTotalPagado (optional)
valorSaldoFavorContratista (optional)
valorSaldoFavorContratatante (optional)
valorIndemnizacion (optional)
valorDeducciones (optional)
valorNetoPagar (optional)
valorMultas (optional)
idContratoLiquidacion (optional)
idContrato (optional)
idContratoLiquidacion (optional)
idContratoLiquidacion (optional)
codigoCausal (optional)
fechaLiquidacion (optional)
valorTotalContrato (optional)
valorTotalEjecutado (optional)
valorTotalPagado (optional)
valorSaldoFavorContratista (optional)
valorSaldoFavorContratatante (optional)
valorIndemnizacion (optional)
valorDeducciones (optional)
valorNetoPagar (optional)
valorMultas (optional)
idContratoLiquidacion (optional)
idContratoLiquidacion (optional)
idContrato (optional)
codigoCausal (optional)
fechaLiquidacion (optional)
valorTotalContrato (optional)
valorTotalEjecutado (optional)
valorTotalPagado (optional)
valorSaldoFavorContratista (optional)
valorSaldoFavorContratante (optional)
valorIndemnizacion (optional)
valorDeducciones (optional)
valorNetoPagar (optional)
valorMultas (optional)
fechaRegistro (optional)
causalLiquidacion (optional)
codigoReferencia (optional)
descripcion (optional)
idContratoLiquidacion (optional)
idContrato (optional)
codigoCausal (optional)
fechaLiquidacion (optional)
valorTotalContrato (optional)
valorTotalEjecutado (optional)
valorTotalPagado (optional)
valorSaldoFavorContratista (optional)
valorSaldoFavorContratante (optional)
valorIndemnizacion (optional)
valorDeducciones (optional)
valorNetoPagar (optional)
valorMultas (optional)
fechaRegistro (optional)
causalLiquidacion (optional)
codigoReferencia (optional)
descripcion (optional)
idContratoOtrosi (optional)
idContratoCums (optional)
idCums (optional)
cantidad (optional)
idContratoOtroSiCums (optional)
idContratoOtroSi (optional)
idContratoOtrosiCums (optional)
idContratoOtrosiCums (optional)
idContratoOtrosi (optional)
idContratoCums (optional)
idCums (optional)
cantidad (optional)
idContratoOtrosiCums (optional)
idContratoOtrosi (optional)
idContratoOtrosiCums (optional)
idContratoOtrosi (optional)
idContratoCums (optional)
idCums (optional)
cantidad (optional)
fechaRegistro (optional)
cums (optional)
idCums (optional)
expedienteCum (optional)
nombre (optional)
descripcion (optional)
codigoAtc (optional)
registroSanitario (optional)
incluidoPbs (optional)
idContratoOtrosiCums (optional)
idContratoOtrosi (optional)
idContratoCums (optional)
idCums (optional)
cantidad (optional)
fechaRegistro (optional)
cums (optional)
idCums (optional)
expedienteCum (optional)
nombre (optional)
descripcion (optional)
codigoAtc (optional)
registroSanitario (optional)
incluidoPbs (optional)
idContratoOtrosi (optional)
codigoEstado (optional)
observacion (optional)
idContratoOtrosiEstado (optional)
idContratoOtrosi (optional)
idContratoOtrosiEstado (optional)
idContratoOtrosi (optional)
codigoEstado (optional)
nombreEstado (optional)
fechaEstado (optional)
fechaRegistro (optional)
observacion (optional)
idContratoOtrosi (optional)
idContratoPrestadorServicio (optional)
codigoServicio (optional)
codigoHabilitacion (optional)
numeroSede (optional)
idContratoOtrosiPrestadorServicio (optional)
idContratoOtrosi (optional)
idContratoOtrosiPrestadorServicio (optional)
idContratoOtrosiPrestadorServicio (optional)
codigoServicio (optional)
codigoHabilitacion (optional)
numeroSede (optional)
modalidadBaja (optional)
modalidadMedia (optional)
modalidadAlta (optional)
idContratoOtrosiPrestadorServicio (optional)
idContratoOtrosi (optional)
idContratoOtrosi (optional)
idContratoOtrosiPrestadorServicio (optional)
idContratoPrestadorServicio (optional)
codigoServicio (optional)
codigoHabilitacion (optional)
numeroSede (optional)
servicio (optional)
codigoServicio (optional)
nombreServicio (optional)
incluidoPbs (optional)
idContratoOtrosi (optional)
idContratoOtrosiPrestadorServicio (optional)
idContratoPrestadorServicio (optional)
codigoServicio (optional)
codigoHabilitacion (optional)
numeroSede (optional)
servicio (optional)
codigoServicio (optional)
nombreServicio (optional)
incluidoPbs (optional)
idContrato (optional)
nombre (optional)
valor (optional)
fechaFinalizacion (optional)
tipoAdicion (optional)
tipoModificacion (optional)
tipoProrroga (optional)
idContratoOtroSi (optional)
idContrato (optional)
idContratoOtroSi (optional)
idContratoOtrosi (optional)
idContrato (optional)
nombre (optional)
valor (optional)
fechaFinalizacion (optional)
tipoAdicion (optional)
tipoModificacion (optional)
tipoProrroga (optional)
idContratoOtrosi (optional)
idContrato (optional)
nombre (optional)
valor (optional)
fechaFinalizacion (optional)
tipoAdicion (optional)
tipoModificacion (optional)
tipoProrroga (optional)
idContratoOtrosi (optional)
idContrato (optional)
nombre (optional)
valor (optional)
fechaFinalizacion (optional)
fechaRegistro (optional)
tipoAdicion (optional)
tipoModificacion (optional)
tipoProrroga (optional)
estado (optional)
codigoEstado (optional)
contrato (optional)
idContrato (optional)
nitContratante (optional)
nitContratista (optional)
nombre (optional)
fechaSuscripcion (optional)
fechaInicio (optional)
fechaFin (optional)
valor (optional)
modalidadPago (optional)
cucon (optional)
empresaContratante (optional)
empresaContratista (optional)
regimenes (optional)
estado (optional)
codigoEstado (optional)
codigoRegimen (optional)
descripcion (optional)
fechaInicioAplicacion (optional)
fechaFinalizacionAplicacion (optional)
nit (optional)
razonSocial (optional)
idContratoOtrosi (optional)
idContrato (optional)
nombre (optional)
valor (optional)
fechaFinalizacion (optional)
fechaRegistro (optional)
tipoAdicion (optional)
tipoModificacion (optional)
tipoProrroga (optional)
estado (optional)
codigoEstado (optional)
idContratoOtrosi (optional)
idContrato (optional)
nombre (optional)
valor (optional)
fechaFinalizacion (optional)
fechaRegistro (optional)
tipoAdicion (optional)
tipoModificacion (optional)
tipoProrroga (optional)
estado (optional)
codigoEstado (optional)
idContratoPrestadorServicio (optional)
idContratoModalidadPago (optional)
valor (optional)
idContratoPrestadorServicioModalidadPago (optional)
idContratoPrestadorServicioModalidadPago (optional)
idContratoPrestadorServicioModalidaPago (optional)
idContratoModalidadPago (optional)
valor (optional)
idContratoPrestadorServicioModalidaPago (optional)
idContrato (optional)
codigoHabilitacion (optional)
numeroSede (optional)
codigoServicio (optional)
idContratoPrestadorServicio (optional)
idContrato (optional)
idContratoPrestadorServicio (optional)
idContratoPrestadorServicio (optional)
codigoServicio (optional)
codigoHabilitacion (optional)
numeroSede (optional)
idContratoPrestadorServicio (optional)
idContrato (optional)
idContratoPrestadorServicio (optional)
idContrato (optional)
codigoServicio (optional)
codigoHabilitacion (optional)
numeroSede (optional)
modalidadBaja (optional)
modalidadMedia (optional)
modalidadAlta (optional)
fechaRegistro (optional)
servicio (optional)
codigoServicio (optional)
nombreServicio (optional)
incluidoPbs (optional)
idContratoPrestadorServicio (optional)
idContrato (optional)
codigoServicio (optional)
codigoHabilitacion (optional)
numeroSede (optional)
modalidadBaja (optional)
modalidadMedia (optional)
modalidadAlta (optional)
fechaRegistro (optional)
servicio (optional)
codigoServicio (optional)
nombreServicio (optional)
incluidoPbs (optional)
idContrato (optional)
codigoRegimen (optional)
fechaInicioAplicacion (optional)
fechaFinalizacionAplicacion (optional)
idContratoRegimen (optional)
idContrato (optional)
idContratoRegimen (optional)
idContratoRegimen (optional)
codigoRegimen (optional)
fechaInicioAplicacion (optional)
fechaFinalizacionAplicacion (optional)
idContratoRegimen (optional)
idContrato (optional)
idContratoRegimen (optional)
idContrato (optional)
codigoRegimen (optional)
fechaInicioAplicacion (optional)
fechaFinalizacionAplicacion (optional)
fechaRegistro (optional)
regimen (optional)
codigoReferencia (optional)
descripcion (optional)
idContratoRegimen (optional)
idContrato (optional)
codigoRegimen (optional)
fechaInicioAplicacion (optional)
fechaFinalizacionAplicacion (optional)
fechaRegistro (optional)
regimen (optional)
codigoReferencia (optional)
descripcion (optional)
idContrato (optional)
idCums (optional)
cantidad (optional)
idContratoCums (optional)
idContrato (optional)
codigoTipoContrato (optional)
nitContratante (optional)
nitContratista (optional)
nombre (optional)
fechaSuscripcion (optional)
fechaInicio (optional)
fechaFin (optional)
valor (optional)
codigoReferenciaModalidadPago (optional)
codigoReferenciaAgrupador (optional)
codigoReferenciaRegimen (optional)
idContratoCums (optional)
idContratoCums (optional)
idContrato (optional)
idCums (optional)
cantidad (optional)
idContratoCums (optional)
idContrato (optional)
idContrato (optional)
codigoTipoContrato (optional)
nitContratante (optional)
nitContratista (optional)
nombre (optional)
fechaSuscripcion (optional)
fechaInicio (optional)
fechaFin (optional)
valor (optional)
codigoReferenciaModalidadPago (optional)
codigoReferenciaAgrupador (optional)
codigoReferenciaRegimen (optional)
idContratoCums (optional)
idContrato (optional)
idCums (optional)
cantidad (optional)
fechaRegistro (optional)
cums (optional)
idCums (optional)
expedienteCum (optional)
nombre (optional)
descripcion (optional)
codigoAtc (optional)
registroSanitario (optional)
incluidoPbs (optional)
idContrato (optional)
codigoTipoContrato (optional)
tipoContrato (optional)
nitContratante (optional)
empresaContratante (optional)
nitContratista (optional)
empresaContratista (optional)
nombre (optional)
fechaSuscripcion (optional)
fechaInicio (optional)
fechaFin (optional)
valor (optional)
cucon (optional)
codigoReferenciaModalidadPago (optional)
contratoModalidadPago (optional)
codigoReferenciaAgrupador (optional)
contratoAgrupador (optional)
codigoReferenciaRegimen (optional)
contratoRegimen (optional)
otrosis (optional)
estado (optional)
codigoEstado (optional)
numeroServicios (optional)
numeroMedicamentos (optional)
numeroProcedimientos (optional)
codigoTipoContrato (optional)
descripcion (optional)
idContratoAgrupador (optional)
codigoAgrupador (optional)
descripcion (optional)
idContratoModalidadPago (optional)
codigoModalidadPago (optional)
descripcion (optional)
idContratoRegimen (optional)
codigoRegimen (optional)
descripcion (optional)
nit (optional)
razonSocial (optional)
idContratoOtrosi (optional)
nombre (optional)
valor (optional)
fechaFinalizacion (optional)
fechaRegistro (optional)
estado (optional)
codigoEstado (optional)
idContratoCums (optional)
idContrato (optional)
idCums (optional)
cantidad (optional)
fechaRegistro (optional)
cums (optional)
idCums (optional)
expedienteCum (optional)
nombre (optional)
descripcion (optional)
codigoAtc (optional)
registroSanitario (optional)
incluidoPbs (optional)
idContrato (optional)
nitContratante (optional)
nitContratista (optional)
nombre (optional)
fechaSuscripcion (optional)
fechaInicio (optional)
fechaFin (optional)
valor (optional)
codigoModalidadPago (optional)
cucon (optional)
vigencia (optional)
empresaContratante (optional)
empresaContratista (optional)
regimenes (optional)
estado (optional)
codigoEstado (optional)
codigoRegimen (optional)
descripcion (optional)
fechaInicioAplicacion (optional)
fechaFinalizacionAplicacion (optional)
nit (optional)
razonSocial (optional)
idCums (optional)
expedienteCum (optional)
consecutivoCum (optional)
nombre (optional)
descripcion (optional)
codigoAtc (optional)
incluidoPbs (optional)
idCums (optional)
expedienteCum (optional)
consecutivoCum (optional)
nombre (optional)
descripcion (optional)
codigoAtc (optional)
incluidoPbs (optional)
codigoCupsSispro (optional)
codigoCupsNumerico (optional)
nombre (optional)
incluidoPbs (optional)
codigoCupsSispro (optional)
codigoCupsNumerico (optional)
nombre (optional)
incluidoPbs (optional)
codigoMunicipio (optional)
codigoDepartamento (optional)
nombreMunicipio (optional)
nombreDepartamento (optional)
nombreDepartamento (optional)
nombreMunicipio (optional)
codigoHabilitacion (optional)
numeroSede (optional)
codigoServicio (optional)
modalidadBaja (optional)
modalidadMedia (optional)
modalidadAlta (optional)
nombreServicio (optional)
id (optional)
date (optional)
temperatureC (optional)
temperatureF (optional)
summary (optional)
paginaActual (optional)
registrosPorPagina (optional)
Integer Número de registros de la página devuelta. format: int32
totalRegistros (optional)
Integer Total de registros de consulta. format: int32
totalPaginas (optional)
Integer Total de páginas de la consulta. format: int32
resultado (optional)
paginaActual (optional)
registrosPorPagina (optional)
Integer Número de registros de la página devuelta. format: int32
totalRegistros (optional)
Integer Total de registros de consulta. format: int32
totalPaginas (optional)
Integer Total de páginas de la consulta. format: int32
resultado (optional)
paginaActual (optional)
registrosPorPagina (optional)
Integer Número de registros de la página devuelta. format: int32
totalRegistros (optional)
Integer Total de registros de consulta. format: int32
totalPaginas (optional)
Integer Total de páginas de la consulta. format: int32
resultado (optional)
paginaActual (optional)
registrosPorPagina (optional)
Integer Número de registros de la página devuelta. format: int32
totalRegistros (optional)
Integer Total de registros de consulta. format: int32
totalPaginas (optional)
Integer Total de páginas de la consulta. format: int32
resultado (optional)