{ "openapi": "3.0.0", "servers": [ { "description": "Calidad", "url": "https://colsubsidio-test.apigee.net/api" }, { "description": "Producción", "url": "https://colsubsidio-prod.apigee.net/api" } ], "info": { "description": "Información de los servicios de afiliaciones y afiliados.", "version": "1.0.0", "title": "Afiliaciones afiliado", "termsOfService": "http://172.16.95.36/wiki/index.php/T%C3%A9rminos_de_servicio_Swagger", "contact": { "email": "operacionesti@colsubsidio.com" }, "license": { "name": "Colsubsidio", "url": "http://172.16.95.36/wiki/index.php/T%C3%A9rminos_de_servicio_Swagger" } }, "tags": [ { "name": "cols-afiliaciones-afiliado", "description": "Consulta de los servicios de afiliaciones." }, { "name": "cols-afiliaciones-validador", "description": "Consulta de afiliaciones a través del validador." }, { "name": "cols-afiliaciones-validadorempresas", "description": "Consulta de afiliaciones para validar empresas." } ], "paths": { "/v1/afiliaciones/afiliado": { "get": { "tags": [ "cols-afiliaciones-afiliado" ], "summary": "Consulta de afiliado como trabajador dependiente.", "description": "Obtener informacion de una persona afiliada y sus beneficiarios.", "operationId": "obtenerAfiliadoDep", "parameters": [ { "name": "tipoIdEmp", "in": "query", "description": "
Tipos de identificación
TipoID Descripción
CO1C Cédula
CO1N Nit
CO1E Cédula de extranjería
CO1T Tarjeta de identidad
CO1L Registro Civil
CO1P Pasaporte
CO1D Carnet Diplomático
CO1S Sin identificación del exterior
CO1V Permiso Especial de Permanencia
CO1X Tarjeta de extranjería
", "required": true, "schema": { "type": "string" } }, { "name": "numIdEmp", "in": "query", "description": "Numero de documento del empleador, ejemplo: 860523408.", "required": true, "schema": { "type": "string" } }, { "name": "digVerifica", "in": "query", "description": "Digito de verificacion, ejemplo: 6", "required": true, "schema": { "type": "string" } }, { "name": "tipoId", "in": "query", "description": "
Tipos de identificación
TipoID Descripción
CO1C Cédula
CO1N Nit
CO1E Cédula de extranjería
CO1T Tarjeta de identidad
CO1L Registro Civil
CO1P Pasaporte
CO1D Carnet Diplomático
CO1S Sin identificación del exterior
CO1V Permiso Especial de Permanencia
CO1X Tarjeta de extranjería
", "required": true, "schema": { "type": "string" } }, { "name": "numId", "in": "query", "description": "Numero de documento.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Operación exitosa", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/obtenerAfiliadoResponse" } } } }, "400": { "description": "Estado inválido" } }, "security": [ { "apigee_auth": [ "write:apigee", "read:apigee" ] } ] }, "post": { "tags": [ "cols-afiliaciones-afiliado" ], "summary": "Crear afiliado como trabajador dependiente.", "description": "Afiliar a trabajador dependiente y sus beneficiarios.", "operationId": "crearAfiliadoDep", "responses": { "200": { "description": "Operación exitosa", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/crearAfiliadoResponse" } } } }, "400": { "description": "Estado inválido" } }, "security": [ { "apigee_auth": [ "write:apigee", "read:apigee" ] } ], "requestBody": { "$ref": "#/components/requestBodies/crearAfiliadoRequestBody" } } }, "/v1/afiliaciones/afiliado/retiro": { "get": { "tags": [ "cols-afiliaciones-afiliado" ], "summary": "Consulta del afiliado retirado.", "description": "Obtener informacion de un afiliado retirado.", "operationId": "retiroAfiliadoDep", "parameters": [ { "name": "tipoIdEmp", "in": "query", "description": "
Tipos de identificación
TipoID Descripción
CO1C Cédula
CO1N Nit
CO1E Cédula de extranjería
CO1T Tarjeta de identidad
CO1L Registro Civil
CO1P Pasaporte
CO1D Carnet Diplomático
CO1S Sin identificación del exterior
CO1V Permiso Especial de Permanencia
CO1X Tarjeta de extranjería
", "required": true, "schema": { "type": "string" } }, { "name": "numIdEmp", "in": "query", "description": "Numero de documento del empleador, ejemplo: 860523408.", "required": true, "schema": { "type": "string" } }, { "name": "digVerifica", "in": "query", "description": "Digito de verificacion, ejemplo: 6", "required": true, "schema": { "type": "string" } }, { "name": "tipoId", "in": "query", "description": "
Tipos de identificación
TipoID Descripción
CO1C Cédula
CO1N Nit
CO1E Cédula de extranjería
CO1T Tarjeta de identidad
CO1L Registro Civil
CO1P Pasaporte
CO1D Carnet Diplomático
CO1S Sin identificación del exterior
CO1V Permiso Especial de Permanencia
CO1X Tarjeta de extranjería
", "required": true, "schema": { "type": "string" } }, { "name": "numId", "in": "query", "description": "Numero de documento.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Operación exitosa", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retiroAfiliadoDepResponse" } } } }, "400": { "description": "Estado inválido" } }, "security": [ { "apigee_auth": [ "write:apigee", "read:apigee" ] } ] }, "delete": { "tags": [ "cols-afiliaciones-afiliado" ], "summary": "Retiro de afiliado.", "description": "Retirar afiliado.", "operationId": "retirarAfiliadoDep", "parameters": [ { "name": "tipoIdEmp", "in": "query", "description": "
Tipos de identificación
TipoID Descripción
CO1C Cédula
CO1N Nit
CO1E Cédula de extranjería
CO1T Tarjeta de identidad
CO1L Registro Civil
CO1P Pasaporte
CO1D Carnet Diplomático
CO1S Sin identificación del exterior
CO1V Permiso Especial de Permanencia
CO1X Tarjeta de extranjería
", "required": true, "schema": { "type": "string" } }, { "name": "numIdEmp", "in": "query", "description": "Numero de documento del empleador, ejemplo: 860523408.", "required": true, "schema": { "type": "string" } }, { "name": "digVerifica", "in": "query", "description": "Digito de verificacion, ejemplo: 6", "required": true, "schema": { "type": "string" } }, { "name": "tipoId", "in": "query", "description": "
Tipos de identificación
TipoID Descripción
CO1C Cédula
CO1N Nit
CO1E Cédula de extranjería
CO1T Tarjeta de identidad
CO1L Registro Civil
CO1P Pasaporte
CO1D Carnet Diplomático
CO1S Sin identificación del exterior
CO1V Permiso Especial de Permanencia
CO1X Tarjeta de extranjería
", "required": true, "schema": { "type": "string" } }, { "name": "numId", "in": "query", "description": "Numero de identificacion del documento.", "required": true, "schema": { "type": "string" } }, { "name": "fechaRet", "in": "query", "description": "Fecha de retiro del afiliado en formato ISO 8601 sin guiones. AAAAMMDD.", "required": true, "schema": { "type": "string" } }, { "name": "motivoRet", "in": "query", "description": "Motivo de retiro del afiliado.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Operación exitosa", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retirarAfiliadoDepResponse" } } } }, "400": { "description": "Estado inválido" } }, "security": [ { "apigee_auth": [ "write:apigee", "read:apigee" ] } ] } }, "/v2/afiliacion/validador": { "get": { "tags": [ "cols-afiliaciones-validador" ], "summary": "Información del afiliado ", "description": "Retorna la información detallada de un afiliado a la caja.", "operationId": "validadorAfiliado", "parameters": [ { "name": "tipoId", "in": "query", "description": "
Tipos de identificación
TipoID Descripción
CO1C Cédula
CO1N Nit
CO1E Cédula de extranjería
CO1T Tarjeta de identidad
CO1L Registro Civil
CO1P Pasaporte
CO1D Carnet Diplomático
CO1S Sin identificación del exterior
CO1V Permiso Especial de Permanencia
CO1X Tarjeta de extranjería
", "required": true, "schema": { "type": "string" } }, { "name": "numeroId", "in": "query", "description": "Numero de documento.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Operación exitosa", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/validadorResponse" } } } }, "400": { "description": "Estado inválido" } }, "security": [ { "apigee_auth": [ "write:apigee", "read:apigee" ] } ] } }, "/v2/afiliacion/validador/personas/basico": { "get": { "tags": [ "cols-afiliaciones-validador" ], "summary": "Información basica del afiliado ", "description": "Retorna la información detallada de un afiliado a la caja.", "operationId": "validadorAfiliadoPersonaBasico", "parameters": [ { "name": "tipoId", "in": "query", "description": "
Tipos de identificación
TipoID Descripción
CO1C Cédula
CO1N Nit
CO1E Cédula de extranjería
CO1T Tarjeta de identidad
CO1L Registro Civil
CO1P Pasaporte
CO1D Carnet Diplomático
CO1S Sin identificación del exterior
CO1V Permiso Especial de Permanencia
CO1X Tarjeta de extranjería
", "required": true, "schema": { "type": "string" } }, { "name": "numeroId", "in": "query", "description": "Numero de documento.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Operación exitosa", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/validadorBasicoResponse" } } } }, "400": { "description": "Estado inválido" } }, "security": [ { "apigee_auth": [ "write:apigee", "read:apigee" ] } ] } }, "/v2/afiliacion/validador/personas/pacs": { "get": { "tags": [ "cols-afiliaciones-validador" ], "summary": "Información basica del afiliado Y Pacs ", "description": "Retorna la información detallada de un afiliado a la caja.", "operationId": "validadorAfiliadoPersonaPacs", "parameters": [ { "name": "tipoId", "in": "query", "description": "
Tipos de identificación
TipoID Descripción
CO1C Cédula
CO1N Nit
CO1E Cédula de extranjería
CO1T Tarjeta de identidad
CO1L Registro Civil
CO1P Pasaporte
CO1D Carnet Diplomático
CO1S Sin identificación del exterior
CO1V Permiso Especial de Permanencia
CO1X Tarjeta de extranjería
", "required": true, "schema": { "type": "string" } }, { "name": "numeroId", "in": "query", "description": "Numero de documento.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Operación exitosa", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/validadorPacsResponse" } } } }, "400": { "description": "Estado inválido" } }, "security": [ { "apigee_auth": [ "write:apigee", "read:apigee" ] } ] } }, "/v2/afiliacion/validador/personas/empleador": { "get": { "tags": [ "cols-afiliaciones-validador" ], "summary": "Información basica del afiliado y empleador", "description": "Retorna la información de un afiliado a la caja y el empleador.", "operationId": "validadorAfiliadoPersonaEmpleador", "parameters": [ { "name": "tipoId", "in": "query", "description": "
Tipos de identificación
TipoID Descripción
CO1C Cédula
CO1N Nit
CO1E Cédula de extranjería
CO1T Tarjeta de identidad
CO1L Registro Civil
CO1P Pasaporte
CO1D Carnet Diplomático
CO1S Sin identificación del exterior
CO1V Permiso Especial de Permanencia
CO1X Tarjeta de extranjería
", "required": true, "schema": { "type": "string" } }, { "name": "numeroId", "in": "query", "description": "Numero de documento.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Operación exitosa", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/validadorEmpleadorResponse" } } } }, "400": { "description": "Estado inválido" } }, "security": [ { "apigee_auth": [ "write:apigee", "read:apigee" ] } ] } }, "/v2/afiliaciones/validadorempresas": { "get": { "tags": [ "cols-afiliaciones-validadorempresas" ], "summary": "Información del afiliado ", "description": "Retorna la información detallada de una empresa.", "operationId": "validadorEmpresas.v2", "parameters": [ { "name": "tipoId", "in": "query", "description": "
Tipos de identificación
TipoID Descripción
CO1C Cédula
CO1N Nit
CO1E Cédula de extranjería
CO1T Tarjeta de identidad
CO1L Registro Civil
CO1P Pasaporte
CO1D Carnet Diplomático
CO1S Sin identificación del exterior
CO1V Permiso Especial de Permanencia
CO1X Tarjeta de extranjería
", "required": true, "schema": { "type": "string" } }, { "name": "numeroId", "in": "query", "description": "Numero de documento.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Operación exitosa", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/validadorEmpresaResponse" } } } }, "400": { "description": "Estado inválido" } }, "security": [ { "apigee_auth": [ "write:apigee", "read:apigee" ] } ] } }, "/v1/afiliaciones/validadorempresas": { "get": { "tags": [ "cols-afiliaciones-validadorempresas" ], "summary": "Información del afiliado ", "description": "Retorna la información detallada de una empresa.", "operationId": "validadorEmpresas.v1", "parameters": [ { "name": "x-api-key", "in": "header", "description": "Client key", "required": true, "schema": { "type": "string" } }, { "name": "tipoId", "in": "query", "description": "
Tipos de identificación
TipoID Descripción
CO1C Cédula
CO1N Nit
CO1E Cédula de extranjería
CO1T Tarjeta de identidad
CO1L Registro Civil
CO1P Pasaporte
CO1D Carnet Diplomático
CO1S Sin identificación del exterior
CO1V Permiso Especial de Permanencia
CO1X Tarjeta de extranjería
", "required": true, "schema": { "type": "string" } }, { "name": "numeroId", "in": "query", "description": "Numero de documento.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Operación exitosa", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/validadorEmpresaResponse" } } } }, "400": { "description": "Estado inválido" } }, "security": [ { "apigee_auth": [ "write:apigee", "read:apigee" ] } ] } } }, "externalDocs": { "description": "Encontrar más información en EnterpriseArchitect", "url": "http://172.16.95.36/wiki/index.php/Enterprise_Architect" }, "components": { "schemas": { "validadorEmpresaResponse": { "type": "object", "required": [ "resultado" ], "properties": { "estado":{ "type":"string", "description":"Estado del servicio" }, "mensaje":{ "type":"string", "description":"Mensaje del servicio" }, "data": { "type": "array", "items":{ "$ref": "#/components/schemas/afiliadoValidadorEmpresa" } } } }, "afiliadoValidadorEmpresa": { "type": "object", "properties": { "contribuyente": { "$ref": "#/components/schemas/validadorEmpresa" } } }, "telefonoValidadorEmpresa": { "type": "object", "properties": { "fijo":{ "type":"string", "description":"Telefono fijo" }, "celular":{ "type":"string", "description":"Telefono celular" }, } }, "direccionValidadorEmpresa": { "type": "object", "properties": { "pais":{ "type":"object", "properties":{ "id":{ "type":"string", "description":"Numero de identificacion del pais" }, "nombre":{ "type":"string", "description":"Nombre del pais" }, } }, "departamento":{ "type":"object", "properties":{ "id":{ "type":"string", "description":"Numero de identificacion del departamento" }, "nombre":{ "type":"string", "description":"Nombre del departamento" }, } }, "ciudad":{ "type":"object", "properties":{ "id":{ "type":"string", "description":"Numero de identificacion de la ciudad" }, "nombre":{ "type":"string", "description":"Nombre de la ciudad" }, } }, "localidad":{ "type":"object", "properties":{ "id":{ "type":"string", "description":"Numero de identificacion de la localidad" }, "nombre":{ "type":"string", "description":"Nombre de la localidad" }, } }, "direccionPrincipal":{ "type":"string", "description":"Direccion principal" }, "barrio":{ "type":"string", "description":"Barrio" }, "direccionSecundaria":{ "type":"string", "description":"Direccion secundaria" }, } }, "representanteLegal":{ "type":"object", "properties":{ "id":{ "type":"string", "description":"Numero de identificacion" }, "tipoDocumento":{ "type":"string", "description":"Tipo de documento del representanteLegal" }, "numeroDocumento":{ "type":"string", "description":"Numero de documento del representanteLegal" }, "nombre":{ "type":"string", "description":"Nombre del representanteLegal" }, "primerNombre":{ "type":"string", "description":"Primer nombre del representanteLegal" }, "segundoNombre":{ "type":"string", "description":"Segundo nombre del representanteLegal" }, "primerApellido":{ "type":"string", "description":"Primer apellido del representanteLegal" }, "segundoApellido":{ "type":"string", "description":"Segundo apellido del representanteLegal" }, "idPosicion":{ "type":"string", "description":"Numero de identificacion de la posicion del representanteLegal" }, } }, "contactoAdministrador":{ "type":"object", "properties":{ "tipoDocumento":{ "type":"string", "description":"Tipo de documento del contacto administrador" }, "numeroDocumento":{ "type":"string", "description":"Numero de documento del contacto administrador" }, "nombre":{ "type":"string", "description":"Nombre del contacto administrador" }, } }, "actividadEconomica":{ "type":"object", "properties":{ "codigo":{ "type":"string", "description":"Codigo de actividad economica" }, "descripcion":{ "type":"string", "description":"Descripcion de actividad economica" }, "agrupacion":{ "type":"string", "description":"Agrupacion de actividad economica" }, } }, "claseValidadorEmpresa":{ "type":"object", "properties":{ "id":{ "type":"string", "description":"Numero de identificacion de clase" }, "descripcion":{ "type":"string", "description":"Descripcion de clase" } } }, "detalleAportantes":{ "type":"object", "properties":{ "tipoContrato":{ "type":"string", "description":"Tipo de contrato" }, "descripcionContrato":{ "type":"string", "description":"Descripcion del contrato" }, "claseInterlocutor":{ "type":"string", "description":"Clase de interlocutor" }, "descripcionInterlocutor":{ "type":"string", "description":"Descripcion de interlocutor" }, "estado":{ "type":"object", "properties":{ "estadoId":{ "type":"string", "description":"Estado id" }, "fechaInicio":{ "type":"string", "description":"Fecha de inicio" }, "fechaFin":{ "type":"string", "description":"Fecha de fin" }, } }, "numeroCotizantes":{ "type":"string", "description":"Numero de cotizantes" }, "numeroConyuges":{ "type":"string", "description":"Numero de conyugues" }, "numeroPacs":{ "type":"string", "description":"Numero de pacs" }, "retiro":{ "type":"object", "properties":{ "motivo":{ "type":"string", "description":"Motivo de retiro" }, "descripcion":{ "type":"string", "description":"Descripcion de retiro" } } }, "modalidad":{ "type":"object", "properties":{ "nombre":{ "type":"string", "description":"Nombre de modalidad" }, "descripcion":{ "type":"string", "description":"Descripcion de modalidad" } } }, "pago":{ "type":"object", "properties":{ "via":{ "type":"string", "description":"Via de pago" }, "descripcion":{ "type":"string", "description":"Descripcion de pago" } } }, "ultimoCicloPagado":{ "type":"string", "description":"Ultimo ciclo pagado" }, "fechaInicioAporte":{ "type":"string", "description":"Fecha de inicio aporte" }, "distribucionId":{ "type":"string", "description":"Distribucion Id" }, "pagoAportesId":{ "type":"string", "description":"Id de pago de aportes" } } }, "validadorEmpresa": { "type": "object", "properties": { "nombre":{ "type":"string", "description":"Nombre del contribuyente" }, "numeroDocumento":{ "type":"string", "description":"Número de documento del contribuyente" }, "tipoDocumento":{ "type":"string", "description":"Tipo de documento del contribuyente" }, "telefono":{ "$ref": "#/components/schemas/telefonoValidadorEmpresa" }, "direccion":{ "$ref": "#/components/schemas/direccionValidadorEmpresa" }, "correoElectronico":{ "type":"string", "description":"Correo electronico del contribuyente" }, "sitioWebEmpresa":{ "type":"string", "description":"Pagina web del contribuyente" }, "representanteLegal":{ "$ref": "#/components/schemas/representanteLegal" }, "contactoAdministrador":{ "$ref": "#/components/schemas/contactoAdministrador" }, "nombreSujetoDerecho":{ "type":"string", "description":"Nombre sujeto derecho" }, "formaJuridica":{ "type":"string", "description":"Forma juridica" }, "actividadEconomica":{ "$ref": "#/components/schemas/actividadEconomica" }, "clase":{ "$ref": "#/components/schemas/claseValidadorEmpresa" }, "leyMiPyme":{ "type":"string", "description":"leyMiPyme" }, "fechaAfiliacion":{ "type":"string", "description":"Fecha de afiliacion" }, "idAlcaldia":{ "type":"string", "description":"Numero de identificacion de alcaldia" }, "idOficinaColsubsidio":{ "type":"string", "description":"Numero de identificacion de oficina Colsubsidio" }, "localidad":{ "type":"string", "description":"Localidad" }, "tipoPersona":{ "type":"string", "description":"Tipo de persona" }, "tipoContribuyente":{ "type":"string", "description":"Tipo de contribuyente" }, "fechaInicio":{ "type":"string", "description":"Fecha de inicio" }, "detalleAportantes": { "type": "array", "items":{ "$ref": "#/components/schemas/detalleAportantes" } } } }, "validadorEmpleadorResponse": { "type": "object", "required": [ "resultado" ], "properties": { "estado":{ "type":"string", "description":"Estado del servicio" }, "mensaje":{ "type":"string", "description":"Mensaje del servicio" }, "data": { "type": "array", "items":{ "$ref": "#/components/schemas/afiliadoEmpleadorValidador" } } } }, "afiliadoEmpleadorValidador": { "type": "object", "properties": { "afiliado": { "$ref": "#/components/schemas/validadorEmpleador" }, "empleadores":{ "$ref": "#/components/schemas/empleadorValidacion" } } }, "validadorEmpleador": { "type": "object", "properties": { "numeroDocumento":{ "type":"string", "description":"Número de documento del afiliado" }, "tipoDocumento":{ "type":"string", "description":"Número de documento del afiliado" }, "primerNombre":{ "type":"string", "description":"primer nombre del afiliado" }, "segundoNombre":{ "type":"string", "description":"segundo nombre del afiliado" }, "primerApellido":{ "type":"string", "description":"primer apellido del afiliado" }, "segundoApellido":{ "type":"string", "description":"Segundo apellido del afiliado" }, "fechaNacimiento":{ "type":"string", "format": "date-time", "description":"Fecha de nacimiento del afiliado" }, "genero":{ "type":"string", "description":"Código de género del afiliado" }, "estadoCivil":{ "type":"string", "description":"Código de estado civil" }, "estado":{ "type":"string", "description":"Estado del Afiliado" }, "afiliacion":{ "$ref": "#/components/schemas/afiliacion" } } }, "validadorPacsResponse": { "type": "object", "required": [ "resultado" ], "properties": { "estado":{ "type":"string", "description":"Estado del servicio" }, "mensaje":{ "type":"string", "description":"Mensaje del servicio" }, "data": { "type": "array", "items":{ "$ref": "#/components/schemas/afiliadoPacsValidador" } } } }, "afiliadoPacsValidador": { "type": "object", "properties": { "afiliado": { "$ref": "#/components/schemas/validadorBasico" }, "pacs":{ "type": "array", "items":{ "$ref": "#/components/schemas/pacs" } } } }, "validadorBasicoResponse": { "type": "object", "required": [ "resultado" ], "properties": { "estado":{ "type":"string", "description":"Estado del servicio" }, "mensaje":{ "type":"string", "description":"Mensaje del servicio" }, "data": { "type": "array", "items":{ "$ref": "#/components/schemas/afiliadoBasicoValidador" } } } }, "afiliadoBasicoValidador": { "type": "object", "properties": { "afiliado": { "$ref": "#/components/schemas/validadorBasico" } } }, "validadorBasico": { "type": "object", "properties": { "numeroDocumento":{ "type":"string", "description":"Número de documento del afiliado" }, "tipoDocumento":{ "type":"string", "description":"Número de documento del afiliado" }, "primerNombre":{ "type":"string", "description":"primer nombre del afiliado" }, "segundoNombre":{ "type":"string", "description":"segundo nombre del afiliado" }, "primerApellido":{ "type":"string", "description":"primer apellido del afiliado" }, "segundoApellido":{ "type":"string", "description":"Segundo apellido del afiliado" }, "fechaNacimiento":{ "type":"string", "description":"Fecha de nacimiento del afiliado" }, "genero":{ "type":"string", "description":"Código de género del afiliado" }, "estadoCivil":{ "type":"string", "description":"Código de estado civil" }, "estado":{ "type":"string", "description":"Estado del Afiliado" }, "afiliacion":{ "$ref": "#/components/schemas/afiliacionBasico" } } }, "afiliacionBasico": { "type": "object", "properties": { "fechaAfiliacion": { "type":"string", "description":"fecha de afiliación" }, "categoria": { "type":"string", "description":"Categoría" } }, "xml": { "name": "afiliado" } }, "resultado": { "type": "object", "properties": { "codigo": { "type": "string", "description": "Código del resultado" }, "descripcion": { "type": "string", "description": "Descripción del resultado" } }, "xml": { "name": "resultado" } }, "documento": { "type": "object", "properties": { "tipo": { "type": "string", "description": "Tipo de documento de identificacion." }, "numero": { "type": "string", "description": "Numero de documento de identificacion." } }, "xml": { "name": "documento" } }, "nombre": { "type": "object", "properties": { "primero": { "type": "string", "description": "Primer nombre." }, "segundo": { "type": "string", "description": "Segundo nombre." }, "primerApellido": { "type": "string", "description": "Primer apellido." }, "segundoApellido": { "type": "string", "description": "Segundo apellido." } }, "xml": { "name": "nombre" } }, "nacimiento": { "type": "object", "properties": { "fecha": { "type": "string", "format": "date-time", "description": "Fecha de nacimiento." } }, "xml": { "name": "nacimiento" } }, "genero": { "type": "object", "properties": { "codigo": { "type": "string", "description": "Codigo del genero." } }, "xml": { "name": "nacimiento" } }, "contrato": { "type": "object", "properties": { "tipo": { "type": "string", "description": "Tipo de contrato." }, "horasDiaria": { "type": "string", "description": "Horas diarias del empleo." }, "horasMes": { "type": "string", "description": "Horas mensuales del empleo." }, "fechaIngreso": { "type": "string", "format": "date-time", "description": "Fecha de ingreso al empleo." } }, "xml": { "name": "contrato" } }, "salario": { "type": "object", "properties": { "tipo": { "type": "string", "description": "Tipo de salario." }, "basico": { "type": "string", "description": "Salario basico." } }, "xml": { "name": "salario" } }, "ingresos": { "type": "object", "properties": { "salario": { "$ref": "#/components/schemas/salario" } }, "xml": { "name": "ingresos" } }, "empleo": { "type": "object", "properties": { "tipo": { "type": "string", "description": "Tipo de actividad." }, "ingresos": { "$ref": "#/components/schemas/ingresos" }, "contrato": { "$ref": "#/components/schemas/contrato" } }, "xml": { "name": "empleo" } }, "empleador": { "type": "object", "properties": { "documento": { "$ref": "#/components/schemas/documento" }, "digitoVerificacion": { "type": "string", "description": "Digito de verificacion." }, "agrupacion": { "type": "string", "description": "Agrupacion." } }, "xml": { "name": "empleador" } }, "companias":{ "type":"object", "properties":{ "bp":{ "type":"integer", "description":"Código de SAP" }, "tipoDocumento":{ "type":"string", "description":"Tipo de documento" }, "numberoDocumento":{ "type":"integer", "description":"Tipo de documento" }, "nombre":{ "type":"string", "description":"Razón social de la empresa" }, "tipoAportante":{ "type":"string", "description":"Descripcion del Tipo de contribuyente DIAN. Ejemplo:Gran Contribuyente " }, "claserAportante":{ "type":"string", "description":"Código que determina la clase de aporte" }, "fechaInicioActividad":{ "type":"string", "description":"Fecha de ingreso de actividades" }, "estado":{ "type":"string", "description":"Código que determina el estado de la actividad" }, "fechaIngresoAfiliado":{ "type":"string", "description":"Fecha de ingreso del afiliado a la empresa" }, "fechaInicioVigencia":{ "type":"string", "description":"Fecha de afiliación de la empresa a la caja" }, "fechaFinVigencia":{ "type":"string", "description":"Fecha de fin de la vigencia de la empresa para casos donde su estado sea retirado." }, "salario":{ "type":"string", "description":"Salario que está devengando en la empresa especifica." }, "sucursal":{ "type":"string", "description":"Sucursal de la compañia." }, "localidad":{ "type":"string", "description":"Localidad de la compañia." }, "empresaPrincipal":{ "type":"string", "description":"Marca con la cual se identifica si la empresa es el principal empleador del afiliado" }, } }, "empleadorValidacion": { "type": "object", "properties": { "empleadoresConcurrentes": { "type":"integer", "description":"Número de empleadores" }, "companias": { "type": "array", "items":{ "$ref": "#/components/schemas/companias" } }, }, "xml": { "name": "empleador" } }, "beneficiario": { "type": "object", "properties": { "tipo": { "type": "string", "description": "Tipo de beneficiario. Valores posibles: conyugue, hijo." }, "documento": { "$ref": "#/components/schemas/documento" }, "nombre": { "$ref": "#/components/schemas/nombre" }, "nacimiento": { "$ref": "#/components/schemas/nacimiento" }, "genero": { "$ref": "#/components/schemas/genero" }, "estadoCivil": { "type": "string", "description": "Estado civil de conyugue." }, "convivencia": { "type": "string", "description": "Convivencia." }, "ocupacion": { "type": "string", "description": "Ocupacion de conyugue." }, "parentesco": { "type": "string", "description": "Parentesco." }, "subsidio": { "type": "string", "description": "Subsidio." }, "discapacidad": { "type": "string", "description": "Discapacidad." } }, "xml": { "name": "beneficiario" } }, "pacs": { "type": "object", "properties": { "bp": { "type": "string", "description":"Identificador único en SAP de un Afiliado,Beneficiario, Empresa o Entidad." }, "tipoDocumento": { "type":"string", "description":"Tipo de documento" }, "numeroDocumento": { "type":"integer", "description":"Número de documento de la persona a cargo del Afiliado" }, "primerNombre": { "type":"string", "description":"Primer Nombre de la persona a cargo del Afiliado" }, "segundoNombre": { "type":"string", "description":"Segundo Nombre de la persona a cargo del Afiliado" }, "apellido": { "type":"string", "description":"Primer Apellido de la persona a cargo del Afiliado" }, "segundoApellido": { "type":"string", "description":"Segundo Apellido de la persona a cargo del Afiliado" }, "edad": { "type":"integer", "description":"Edad de la persona a cargo del afiliado" }, "genero": { "type":"integer", "description":"Edad de la persona a cargo del afiliado" }, "fechaNacimiento": { "type":"integer", "description":"Fecha de nacimiento" }, "relacion": { "type":"object", "properties":{ "codigo":{ "type":"string", "description":"codigo" }, "descripcion":{ "type":"string", "description":"descripción" }, } }, "fechaInicioVigencia":{ "type":"string", "description":"Fecha de inicio de la vigencia de la empresa para casos donde su estado sea retirado." }, "fechaFinVigencia":{ "type":"string", "description":"Fecha de fin de la vigencia de la empresa para casos donde su estado sea retirado." }, "fechaRegistroRetiro":{ "type":"string", "description":" en el que se registra el retiro" }, "discapacidad":{ "type":"integer", "description":"Código de discapacidad" }, "fechaLimiteComprobanteNutricional":{ "type":"integer", "description":"Fecha límite" }, "documentacion":{ "type":"object", "properties":{ "motivoBloqueo":{ "type":"string", "description":"tipo de bloqueo" }, "descripcionBloqueo":{ "type":"string", "description":"Descripción del bloqueo" } } }, "tarjeta":{ "type":"object", "properties":{ "numero":{ "type":"string", "description":"Número de Tarjeta Amparada " }, "estado":{ "type":"string", "description":"ACTIVA o INACTIVA" }, "lote":{ "type":"string", "description":"Lote de la tarjeta" } } }, "cuotaMonetaria":{ "type":"object", "properties":{ "motivoBloqueo":{ "type":"string", "description":"Motivo del salario" }, "salario":{ "type":"string", "description":"Salario" } } }, "nivelEducativo":{ "type":"string", "description":"Nivel educativo de la persona" }, "estado":{ "type":"string", "description":"Estado" } }, "xml": { "name": "beneficiario" } }, "afiliadoRequest": { "type": "object", "properties": { "empleador": { "$ref": "#/components/schemas/empleador" }, "nombre": { "$ref": "#/components/schemas/nombre" }, "documento": { "$ref": "#/components/schemas/documento" }, "nacimiento": { "$ref": "#/components/schemas/nacimiento" }, "genero": { "$ref": "#/components/schemas/genero" }, "direccion": { "$ref": "#/components/schemas/direccion" }, "empleo": { "$ref": "#/components/schemas/empleo" }, "estadoCivil": { "type": "string", "description": "Estado civil del afiliado." }, "telefono": { "type": "string", "description": "Telefono fijo del afiliado." }, "celular": { "type": "string", "description": "Celular del afiliado." }, "correoElectronico": { "type": "string", "description": "Correo electronico del afiliado." }, "nacionalidad": { "type": "string", "description": "Nacionalidad del afiliado." }, "fechaAfiliacion": { "type": "string", "format": "date-time", "description": "Fecha de afiliacion." }, "beneficiario": { "type": "array", "items": { "$ref": "#/components/schemas/beneficiario" } } }, "xml": { "name": "afiliado" } }, "afiliado": { "type": "object", "properties": { "empleador": { "$ref": "#/components/schemas/empleador" }, "nombre": { "$ref": "#/components/schemas/nombre" }, "documento": { "$ref": "#/components/schemas/documento" }, "nacimiento": { "$ref": "#/components/schemas/nacimiento" }, "genero": { "$ref": "#/components/schemas/genero" }, "direccion": { "$ref": "#/components/schemas/direccion" }, "estadoCivil": { "type": "string", "description": "Estado civil del afiliado." }, "telefono": { "type": "string", "description": "Telefono fijo del afiliado." }, "celular": { "type": "string", "description": "Celular del afiliado." }, "correoElectronico": { "type": "string", "description": "Correo electronico del afiliado." }, "nacionalidad": { "type": "string", "description": "Nacionalidad del afiliado." }, "beneficiario": { "type": "array", "items": { "$ref": "#/components/schemas/beneficiario" } }, "pacs":{ "type":"array", "items":{ "$ref": "#/components/schemas/pacs" } } }, "xml": { "name": "afiliado" } }, "departamento": { "type": "object", "properties": { "codigo": { "type": "string", "description": "Codigo del departamento." } }, "xml": { "name": "departamento" } }, "ciudad": { "type": "object", "properties": { "codigo": { "type": "string", "description": "Codigo de la ciudad." } }, "xml": { "name": "ciudad" } }, "direccionValidador": { "type": "object", "properties": { "pais":{ "type": "object", "properties": { "id": { "type": "string", "description": "Id del pais." }, "nombre": { "type": "string", "description": "Nombre del pais." } } }, "departamento":{ "type": "object", "properties": { "id": { "type": "string", "description": "Id del departamento." }, "nombre": { "type": "string", "description": "Nombre del departamento." } } }, "ciudad":{ "type": "object", "properties": { "id": { "type": "string", "description": "Id de la ciudad." }, "nombre": { "type": "string", "description": "Nombre de la ciudad." } } }, "localidad":{ "type": "object", "properties": { "id": { "type": "string", "description": "Id de la localidad." }, "nombre": { "type": "string", "description": "Nombre de la localidad." } } }, "direccionPrincipal": { "type": "string", "description": "direccion principal del afiliado." }, "direccionSecundaria": { "type": "string", "description": "direccion secundaria del afiliado." } }, "xml": { "name": "direccion" } }, "direccion": { "type": "object", "properties": { "departamento": { "$ref": "#/components/schemas/departamento" }, "ciudad": { "$ref": "#/components/schemas/ciudad" }, "direccionPrincipal": { "type": "string", "description": "direccion principal del afiliado." } }, "xml": { "name": "direccion" } }, "obtenerAfiliadoDep": { "type": "object", "properties": { "afiliado": { "$ref": "#/components/schemas/afiliado" } }, "xml": { "name": "obtenerAfiliado" } }, "obtenerAfiliadoResponse": { "type": "object", "required": [ "resultado" ], "properties": { "resultado": { "type": "array", "xml": { "name": "resultado" }, "items": { "$ref": "#/components/schemas/resultado" } }, "obtenerAfiliado": { "type": "array", "items": { "$ref": "#/components/schemas/obtenerAfiliadoDep" } } } }, "natural": { "type": "object", "properties": { "nombre": { "$ref": "#/components/schemas/nombre" } }, "xml": { "name": "natural" } }, "empleadorRetiro": { "type": "object", "properties": { "natural": { "$ref": "#/components/schemas/natural" }, "documento": { "$ref": "#/components/schemas/documento" }, "digitoVerificacion": { "type": "string", "description": "Digito de verificacion." }, "razonSocial": { "type": "string", "description": "Razon social de la empresa." }, "nombre": { "type": "string", "description": "Nombre de la empresa." } }, "xml": { "name": "empleadorRetiro" } }, "afiliadoRetiro": { "type": "object", "properties": { "empleadorRetiro": { "$ref": "#/components/schemas/empleadorRetiro" }, "documento": { "$ref": "#/components/schemas/documento" }, "nombre": { "$ref": "#/components/schemas/nombre" }, "fechaRetiro": { "type": "string", "format": "date-time", "description": "Fecha de retiro de afiliado." }, "motivoRetiro": { "type": "string", "description": "Motivo de retiro de afiliado." } }, "xml": { "name": "afiliado" } }, "afiliacion": { "type": "object", "properties": { "fechaAfiliacion": { "type":"string", "description":"fecha de afiliación" }, "categoria": { "type":"string", "description":"Categoría" }, "grupo": { "type":"string", "description":"Grupo" }, "tipoSalario": { "type":"string", "description":"Tipo de salario" }, "salario": { "type":"string", "description":"salario" }, "salarioOtros": { "type":"string", "description":"salario" }, "fechaRetiro": { "type":"string", "description":"Fecha del retiro" }, "tipoCargo": { "type":"string", "description":"Tipo de cargo" }, "horasLaboradas": { "type":"string", "description":"Horas laboradas" }, "tipoTrabajador": { "type":"string", "description":"Tipo de trabajador" } }, "xml": { "name": "afiliado" } }, "cuotaMonetaria": { "type": "object", "properties": { "tieneCuotaMonetaria": { "type":"string", "description":"fecha de afiliación" }, "lugarEntrega": { "type":"string", "description":"Categoría" }, "valorUltimoSubsidio": { "type":"string", "description":"Grupo" }, "monto": { "type":"string", "description":"Tipo de salario" } }, "xml": { "name": "afiliado" } }, "tarjetaMultiservicios": { "type": "object", "properties": { "lote": { "type":"string", "description":"fecha de afiliación" }, "numeroTarjeta": { "type":"string", "description":"Categoría" }, "serialProximidad": { "type":"string", "description":"Grupo" }, "gp": { "type":"integer", "description":"gp" }, "estado": { "type":"integer", "description":"estado" }, "fechaEntrega": { "type":"string", "format": "date-time", "description":"Fecha entrega" }, "estadoEntrega": { "type":"string", "description":"Estado entrega" }, "fechaExpedicion": { "type":"string", "format": "date-time", "description":"Fecha de expedicion" }, "causaCambio": { "type":"integer", "description":"Causa de cambio" }, "ultimoMesPagado": { "type":"integer", "description":"Ultimo mes pagado" }, "motivoBloqueo": { "type":"integer", "description":"Motivo de bloqueo" }, "metodoPago": { "type":"object", "properties":{ "id":{ "type":"integer", "description":"id del método de pago" }, "nombre":{ "type":"string", "description":"Nombre del método de pago" } } } }, "xml": { "name": "afiliado" } }, "retiroAfiliadoDep": { "type": "object", "properties": { "afiliado": { "$ref": "#/components/schemas/afiliadoRetiro" } }, "xml": { "name": "retiroAfiliadoDep" } }, "crearAfiliadoRequest": { "type": "object", "properties": { "afiliado": { "$ref": "#/components/schemas/afiliadoRequest" } } }, "crearAfiliadoResponse": { "type": "object", "required": [ "resultado" ], "properties": { "resultado": { "type": "array", "xml": { "name": "resultado" }, "items": { "$ref": "#/components/schemas/resultado" } } } }, "retirarAfiliadoDepResponse": { "type": "object", "required": [ "resultado" ], "properties": { "resultado": { "type": "array", "xml": { "name": "resultado" }, "items": { "$ref": "#/components/schemas/resultado" } } } }, "retiroAfiliadoDepResponse": { "type": "object", "required": [ "resultado" ], "properties": { "resultado": { "type": "array", "xml": { "name": "resultado" }, "items": { "$ref": "#/components/schemas/resultado" } }, "obtenerAfiliado": { "type": "array", "items": { "$ref": "#/components/schemas/retiroAfiliadoDep" } } } }, "validadorResponse": { "type": "object", "required": [ "resultado" ], "properties": { "estado":{ "type":"string", "description":"Estado del servicio" }, "mensaje":{ "type":"string", "description":"Mensaje del servicio" }, "data": { "type": "array", "items":{ "$ref": "#/components/schemas/afiliadoValidador" } } } }, "afiliadoValidador": { "type": "object", "properties": { "afiliado": { "$ref": "#/components/schemas/validador" }, "empleadores":{ "$ref": "#/components/schemas/empleadorValidacion" }, "pacs":{ "type": "array", "items":{ "$ref": "#/components/schemas/pacs" } } } }, "validador": { "type": "object", "properties": { "bp":{ "type":"integer", "description":"Identificador único del SAP" }, "numeroDocumento":{ "type":"integer", "description":"Número de documento del afiliado" }, "tipoDocumento":{ "type":"integer", "description":"Número de documento del afiliado" }, "primerNombre":{ "type":"string", "description":"primer nombre del afiliado" }, "segundoNombre":{ "type":"string", "description":"segundo nombre del afiliado" }, "primerApellido":{ "type":"string", "description":"primer apellido del afiliado" }, "segundoApellido":{ "type":"string", "description":"Segundo apellido del afiliado" }, "fechaNacimiento":{ "type":"string", "description":"Fecha de nacimiento del afiliado" }, "edad":{ "type":"integer", "description":"Fecha de nacimiento del afiliado" }, "genero":{ "type":"integer", "description":"Código de género del afiliado" }, "estadoCivil":{ "type":"integer", "description":"Código de estado civil" }, "personasACargo":{ "type":"integer", "description":"Número de personas a cargo" }, "nivelEducativo":{ "type":"string", "description":"Nivel educativo de la persona" }, "telefono":{ "type":"integer", "description":"Teléfono de la persona" }, "motivoRetiro":{ "type":"string", "description":"Descripción del motivo de Retiro" }, "direccion":{ "$ref": "#/components/schemas/direccionValidador" }, "estado":{ "type":"string", "description":"Estado del Afiliado" }, "afiliacion":{ "$ref": "#/components/schemas/afiliacion" }, "cuotaMonetaria":{ "$ref": "#/components/schemas/cuotaMonetaria" }, "tarjetaMultiservicios":{ "$ref": "#/components/schemas/tarjetaMultiservicios" } } }, }, "requestBodies": { "crearAfiliadoRequestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/crearAfiliadoRequest" } } }, "description": "Request para la creacion de un afiliado dependiente.", "required": true } }, "securitySchemes": { "apigee_auth": { "type": "oauth2", "flows": { "clientCredentials": { "tokenUrl": "https://colsubsidio-test.apigee.net/oauth/client_credential/accesstoken?grant_type=client_credentials", "scopes": { "write:apigee": "Permisos de escritura", "read:apigee": "Permisos de lectura" } } } } } } }