Obtiene la lista de proveedores existentes en el sistema ISOLUCIÓN.
HTTP GET: https://[service_address]/api/Proveedores/
[service_address]: Dirección disponible para conectividad con el API, debe validarse con su proveedor de ISOLUCIÓN.
Header | Ejemplo | Descripción |
---|---|---|
Authorization | Basic Tm9tYnJlVXN1YXJpbzpDb250cmFzZcOxYQ== |
Para la autorización sobre el API es necesario un usuario y contraseña, este usuario debe ser creado en el modulo de Usuarios de Isolucion, se recomienda crear un usuario único para la integración. Una vez creado el usuario se debe cifrar en base64 de la siguiente manera NombreUsuario:Contraseña el resultado debe ser algo parecido a Tm9tYnJlVXN1YXJpbzpDb250cmFzZcOxYQ== Cuando se tenga este dato se debe enviar en el encabezado de la petición de la siguiente manera Basic Tm9tYnJlVXN1YXJpbzpDb250cmFzZcOxYQ==
Referencias |
apiKey | YWJjZDEyMzQYWJjZDEyMzQYWJjZDEyMzQ-localhost | Llave otorgada para el uso del API. |
Content-Type | application/json | Tipo de contenido enviado en la solicitud. |
Si requiere paginar los registros se deben enviar estos parametros por query string.
HTTP GET: https://[service_address]/api/[metodo]?RegistroActual=0&TamanoPagina=20
[service_address]: Dirección disponible para conectividad con el API, debe validarse con su proveedor de ISOLUCIÓN.
[metodo]: Hace referencia al objeto de isolucion que queremos consultar (Funcionarios, Mediciones, Cargos, etc).
Nombre del campo | Formato | Tamaño | Descripción | Obligatorio |
---|---|---|---|---|
RegistroActual | Númerico | Indice del registro en el cual se encuentra la consulta. Indice inicial debe ser 0. | Si. | |
TamanoPagina | Númerico | Cantidad total de registros que se quiere traer. Si el tamaño es 0 se consultaran todos los datos | Si. |
Respuesta en Formato JSON a la solicitud de obtener los datos registrados en el sistema.
Campo | Ejemplo | Descripción |
---|---|---|
StatusCode | "StatusCode":200 | Códigos HTTP de respuesta indicando si fue exitoso o no el request realizado. [200,500] Exito,Error. |
Message | "Message":"Lista de Proveedores obtenida exitosamente." | Descripción de la respuesta exitosa o mensaje de error enviado por el servidor. |
Entity | "Entity": [[{data1},{data2}...],null] | Formato JSON con el listado de Proveedores registrados en el sistema. En el caso de respuesta no exitosa el valor es nulo. |
Sample Ok Response:
{ "StatusCode": 200, "Message": "Lista de proveedores obtenida exitosamente.", "Entity": "[{\"IdProveedor\":1,\"NomProveedor\":\"Proveedores qa09092019\",\"CodTipoIdentificacion\":2,\"NumeroIdentificacion\":null,\"Contacto\":null,\"Telefono\":null,\"Email\":\"oscar.roncancio@isolucion.com.co\",\"Fax\":null,\"Direccion\":null,\"CodPais\":null,\"CodigoInternoProveedor\":\"\",\"BienesServicios\":\"\",\"CodObjetoSocial\":null,\"VigenciaSociedad\":\"\",\"CodNivelRiesgo\":null,\"CodTamanoCompania\":null,\"CatalogosDisponibles\":\"\",\"CodMarca\":null,\"CodProducto\":null,\"Telefono2\":\"\",\"Telefono3\":\"\",\"LovSexo\":\"\",\"CodClasificacionTributaria\":null,\"CodCiudad\":null,\"PeriodoPago\":null,\"ActividadEconomica\":null,\"FormaPago\":null,\"CodTipoPersona\":null,\"Declarante\":null,\"AgenteRetenedor\":null,\"Autorretenedor\":null,\"CodigoBanco\":null,\"NombreBanco\":null,\"CodTipoCuenta\":null,\"NumeroCuenta\":null,\"ValorMaximoPago\":null,\"Activo\":1,\"EsNivelGlobal\":0,\"EmailAdicional\":\"\",\"ScoringSarlaft\":2,\"CodOrigenRecursos\":null,\"CodActividaEconomica\":null,\"CodSLFCanal\":null,\"CodCiudad\":null,\"FechaScoring\":null,\"Sucursales\":\"1,3\"EsPEP\":false}]" }
Sample ERROR Response:
{ "StatusCode": 401, "Message": "Unauthorized : *DESCRIPCION ERROR NO AUTORIZADO*.", "Entity": null }
{ "StatusCode": 500, "Message": "InternalServerError : La solicitud no fue procesada.", "Entity": null }
Crea un proveedor en el sistema ISOLUCIÓN a través de esta opción.
HTTP POST: https://[service_address]/api/Proveedores/
[service_address]: Dirección disponible para conectividad con el API, debe validarse con su proveedor de ISOLUCIÓN.
Header | Ejemplo | Descripción |
---|---|---|
Authorization | Basic Tm9tYnJlVXN1YXJpbzpDb250cmFzZcOxYQ== |
Para la autorización sobre el API es necesario un usuario y contraseña, este usuario debe ser creado en el modulo de Usuarios de Isolucion, se recomienda crear un usuario único para la integración. Una vez creado el usuario se debe cifrar en base64 de la siguiente manera NombreUsuario:Contraseña el resultado debe ser algo parecido a Tm9tYnJlVXN1YXJpbzpDb250cmFzZcOxYQ== Cuando se tenga este dato se debe enviar en el encabezado de la petición de la siguiente manera Basic Tm9tYnJlVXN1YXJpbzpDb250cmFzZcOxYQ==
Referencias |
apiKey | YWJjZDEyMzQYWJjZDEyMzQYWJjZDEyMzQ-localhost | Llave otorgada para el uso del API. |
Content-Type | application/json | Tipo de contenido enviado en la solicitud. |
Nombre del campo | Formato | Tamaño | Descripción | Obligatorio |
---|---|---|---|---|
TipoIdentificacion | Texto | varchar(255) | Nombre del tipo documento, sino existe se crea con el valor enviado. | Si. |
NumeroIdentificacion | Texto | varchar(20) | Número de identificación. | Si. |
Nombre | Texto | varchar(255) | Nombre completo del proveedor. | Si. |
Contacto | Texto | varchar(80) | Correo electronico. | No. |
Telefono | varchar(30) | Telefono. | No. | |
Texto | varchar(250) | Email. | No. | |
Fax | Texto | varchar(30) | Fax. | No. |
Direccion | Texto | varchar(255) | Direccion. | No. |
Pais | Texto | varchar(100) | Pais de trabajo del proveedor, sino existe se crea con el valor enviado. | Si. |
Activo | Booleano [1,0] | Activo:1 , Inactivo:0. Indica si el proveedor se encuentra activo o no. | No. | |
CodActividadEconomica | Entero | int | Codigo de la actividad economica a la que se dedica el proveedor. Debe existir previamente. | No. |
CodOrigenRecursos | Entero | int | Codigo delorigen de los recursos del proveedor. Debe existir previamente. | No. |
CodSLFCanal | Entero | int | Codigo del canal por el que el cliente conocio la empresa. Debe existir previamente | No. |
CodCiudad | Entero | int | Codigo de la Ciudad, debe existir en Isolucion (Ver Objeto ciudad) | No. |
EsNivelGlobal | Entero | int | Indica si el cliente es de nivel global (1) o pertenece a alguna sucursal (0) | Si (Para empresas con multicompañia) |
Sucursales | Texto | varchar(255) | Lista de sucursales a las que pertenece el cliente | Si (Para empresas con multicompañia) |
Sample:
{ "TipoIdentificacion": "Pasaporte", "NumeroIdentificacion": "14231", "Nombre": "sample string 8", "Contacto": "sample string 5", "Telefono": "sample string 7", "Email": "sample string 8", "Fax": "sample string 9", "Direccion": "sample string 10", "Pais": "Colombia", "Activo": "1", "CodActividadEconomica":2, "CodOrigenRecursos":2, "CodSLFCanal":17, "CodCiudad" : 1, "EsNivelGlobal":0, "Sucursales":"1,3" }
Respuesta en Formato JSON a la solicitud de creación en el sistema.
Campo | Ejemplo | Descripción |
---|---|---|
StatusCode | "StatusCode":200 | Códigos HTTP de respuesta indicando si fue exitoso o no el request realizado. [200,400,500] Exito,Error. |
Message | "Message":"El proveedor ha sido creado exitosamente." | Descripción de la respuesta exitosa o mensaje de error enviado por el servidor. |
Entity | "Entity": [[{data1},{data2}...],null] | Formato JSON con los datos creados en el sistema. En el caso de respuesta no exitosa el valor es nulo. |
Sample OK Response:
{ "StatusCode": 200, "Message": "Proveedor creado", "Entity": "{\"IdProveedor\":558,\"TipoIdentificacion\":\"Pasaporte\",\"NumeroIdentificacion\":\"14231\",\"Nombre\":\"sample string 8\",\"Contacto\":\"sample string 5\",\"Telefono\":\"sample string 7\",\"Email\":\"sample string 8\",\"Fax\":\"sample string 9\",\"Direccion\":\"sample string 10\",\"Pais\":\"Colombia\",\"Activo\":\"1\",\"CodActividadEconomica\":2,\"CodOrigenRecursos\":2,\"CodSLFCanal\":17,\"EsNivelGlobal\":0,\"Sucursales\":\"3\"}" }
Sample ERROR Response:
{ "StatusCode": 400, "Message": "Bad Request : *DESCRIPCION DEL ERROR PARAMETRO ENTRADA ERRADO*.", "Entity": null }
{ "StatusCode": 401, "Message": "Unauthorized : *DESCRIPCION ERROR NO AUTORIZADO*.", "Entity": null }
{ "StatusCode": 500, "Message": "InternalServerError : La solicitud no fue procesada.", "Entity": null }
Actualiza un proveedor en el sistema ISOLUCIÓN a través de esta opción.
HTTP PUT: https://[service_address]/api/proveedores/
[service_address]: Dirección disponible para conectividad con el API, debe validarse con su proveedor de ISOLUCIÓN.
Header | Ejemplo | Descripción |
---|---|---|
Authorization | Basic Tm9tYnJlVXN1YXJpbzpDb250cmFzZcOxYQ== |
Para la autorización sobre el API es necesario un usuario y contraseña, este usuario debe ser creado en el modulo de Usuarios de Isolucion, se recomienda crear un usuario único para la integración. Una vez creado el usuario se debe cifrar en base64 de la siguiente manera NombreUsuario:Contraseña el resultado debe ser algo parecido a Tm9tYnJlVXN1YXJpbzpDb250cmFzZcOxYQ== Cuando se tenga este dato se debe enviar en el encabezado de la petición de la siguiente manera Basic Tm9tYnJlVXN1YXJpbzpDb250cmFzZcOxYQ==
Referencias |
apiKey | YWJjZDEyMzQYWJjZDEyMzQYWJjZDEyMzQ-localhost | Llave otorgada para el uso del API. |
Content-Type | application/json | Tipo de contenido enviado en la solicitud. |
Nombre del campo | Formato | Tamaño | Descripción | Obligatorio |
---|---|---|---|---|
TipoIdentificacion | Texto | varchar(255) | Nombre del tipo documento, sino existe se crea con el valor enviado. | Si. |
NumeroIdentificacion | Texto | varchar(20) | Número de identificación. | Si. |
Nombre | Texto | varchar(255) | Nombre completo del proveedor. | Si. |
Contacto | Texto | varchar(80) | Correo electronico. | No. |
Telefono | varchar(30) | Telefono. | No. | |
Texto | varchar(250) | Email. | No. | |
Fax | Texto | varchar(30) | Fax. | No. |
Direccion | Texto | varchar(255) | Direccion. | No. |
Pais | Texto | varchar(100) | Pais de trabajo del proveedor, sino existe se crea con el valor enviado. | Si. |
Activo | Booleano [1,0] | Activo:1 , Inactivo:0. Indica si el proveedor se encuentra activo o no. | No. | |
CodActividadEconomica | Entero | int | Codigo de la actividad economica a la que se dedica el proveedor. Debe existir previamente. | No. |
CodOrigenRecursos | Entero | int | Codigo delorigen de los recursos del proveedor. Debe existir previamente. | No. |
CodSLFCanal | Entero | int | Codigo del canal por el que el cliente conocio la empresa. Debe existir previamente | No. |
CodCiudad | Entero | int | Codigo de la Ciudad, debe existir en Isolucion (Ver Objeto ciudad) | No. |
EsNivelGlobal | Entero | int | Indica si el cliente es de nivel global (1) o pertenece a alguna sucursal (0) | Si (Para empresas con multicompañia) |
Sucursales | Texto | varchar(255) | Lista de sucursales a las que pertenece el cliente | Si (Para empresas con multicompañia) |
Sample:
{ "TipoIdentificacion": "Pasaporte", "NumeroIdentificacion": "1423", "Nombre": "sample string 4", "Contacto": "sample string 5", "Telefono": "sample string 7", "Email": "sample string 8", "Fax": "sample string 9", "Direccion": "sample string 10", "Pais": "Colombia", "Activo": "1", "CodActividadEconomica":2, "CodOrigenRecursos":2, "CodSLFCanal":17, "CodCiudad": 1, "EsNivelGlobal":0, "Sucursales":"3,1" }
Respuesta en Formato JSON a la solicitud de actualización en el sistema.
Campo | Ejemplo | Descripción |
---|---|---|
StatusCode | "StatusCode":200 | Códigos HTTP de respuesta indicando si fue exitoso o no el request realizado. [200,400,404,500] Exito,Error. |
Message | "Message":"El Proveedor ha sido actualizado exitosamente." | Descripción de la respuesta exitosa o mensaje de error enviado por el servidor. |
Entity | "Entity": [[{data1},{data2}...],null] | Formato JSON con los datos actualizados en el sistema. En el caso de respuesta no exitosa el valor es nulo. |
Sample OK Response:
{ "StatusCode": 200, "Message": "Proveedor actualizado.", "Entity": "{\"IdProveedor\":0,\"TipoIdentificacion\":\"Pasaporte\",\"NumeroIdentificacion\":\"1423\",\"Nombre\":\"sample string 4\",\"Contacto\":\"sample string 5\",\"Telefono\":\"sample string 7\",\"Email\":\"sample string 8\",\"Fax\":\"sample string 9\",\"Direccion\":\"sample string 10\",\"Pais\":\"Colombia\",\"Activo\":\"1\",\"CodActividadEconomica\":2,\"CodOrigenRecursos\":2,\"CodSLFCanal\":17,\"EsNivelGlobal\":0,\"Sucursales\":\"3,1\"}" }
Sample ERROR Response:
{ "StatusCode": 400, "Message": "Bad Request : *DESCRIPCION DEL ERROR PARAMETRO ENTRADA ERRADO*.", "Entity": null }
{ "StatusCode": 401, "Message": "Unauthorized : *DESCRIPCION ERROR NO AUTORIZADO*.", "Entity": null }
{ "StatusCode": 404, "Message": "Not Found : *DESCRIPCION ERROR ELEMENTO NO EXISTE*.", "Entity": null }
{ "StatusCode": 500, "Message": "InternalServerError : La solicitud no fue procesada.", "Entity": null }
Obtiene un proveedor por documento y tipo de documento existentes en el sistema ISOLUCIÓN.
HTTP GET: https://[service_address]/api/Proveedores/tipodocumento/[codTipoDocumento]/documento/[numeroDocumento]
[service_address]: Dirección disponible para conectividad con el API, debe validarse con su proveedor de ISOLUCIÓN.
[codTipoDocumento]: Identificador del Tipo de documento del cual se quiere traer la informacion del proveedor.
[numeroDocumento]: Número de documento del cual se quiere traer la informacion del proveedor.
Header | Ejemplo | Descripción |
---|---|---|
Authorization | Basic Tm9tYnJlVXN1YXJpbzpDb250cmFzZcOxYQ== |
Para la autorización sobre el API es necesario un usuario y contraseña, este usuario debe ser creado en el modulo de Usuarios de Isolucion, se recomienda crear un usuario único para la integración. Una vez creado el usuario se debe cifrar en base64 de la siguiente manera NombreUsuario:Contraseña el resultado debe ser algo parecido a Tm9tYnJlVXN1YXJpbzpDb250cmFzZcOxYQ== Cuando se tenga este dato se debe enviar en el encabezado de la petición de la siguiente manera Basic Tm9tYnJlVXN1YXJpbzpDb250cmFzZcOxYQ==
Referencias |
apiKey | YWJjZDEyMzQYWJjZDEyMzQYWJjZDEyMzQ-localhost | Llave otorgada para el uso del API. |
Content-Type | application/json | Tipo de contenido enviado en la solicitud. |
Respuesta en Formato JSON a la solicitud de obtener los datos registrados en el sistema.
Campo | Ejemplo | Descripción |
---|---|---|
StatusCode | "StatusCode":200 | Códigos HTTP de respuesta indicando si fue exitoso o no el request realizado. [200,400,404,500] Exito,Error. |
Message | "Message":"Prooveedor obtenido exitosamente.." | Descripción de la respuesta exitosa o mensaje de error enviado por el servidor. |
Entity | "Entity": [{data1}] | Formato JSON con el Proveedor registrado en el sistema. En el caso de respuesta no exitosa el valor es nulo. |
Sample Ok Response:
{ "StatusCode": 200, "Message": "Prooveedores obtenido exitosamente.", "Entity": "{\"Id_Tercero\":9,\"NomTercero\":\"NELSON ROKEFELLER\",\"CodTipoidentificacion\":4,\"NumDocumento\":\"12345678\",\"Telefono\":null,\"Email\":null,\"CodTipoDeRelacion\":1,\"CodTipoPersona\":2,\"Porcentaje\":4,\"Activo\":1}" }
Sample ERROR Response:
{ "StatusCode": 400, "Message": "Bad Request : *DESCRIPCION DEL ERROR PARAMETRO ENTRADA ERRADO*.", "Entity": null }
{ "StatusCode": 401, "Message": "Unauthorized : *DESCRIPCION ERROR NO AUTORIZADO*.", "Entity": null }
{ "StatusCode": 404, "Message": "Not Found : *DESCRIPCION ERROR ELEMENTO NO EXISTE*.", "Entity": null }
{ "StatusCode": 500, "Message": "InternalServerError : La solicitud no fue procesada.", "Entity": null }
Relaciona un tercero existente a un provedor en el sistema ISOLUCIÓN.
HTTP POST: https://[service_address]/api/Proveedores/[idProveedor]/Tercero
[service_address]: Dirección disponible para conectividad con el API, debe validarse con su proveedor de ISOLUCIÓN.
[idProveedor]: Identificador único de proveedor (id) en isolucion (Ver Objeto proveedor)..
Header | Ejemplo | Descripción |
---|---|---|
Authorization | Basic Tm9tYnJlVXN1YXJpbzpDb250cmFzZcOxYQ== |
Para la autorización sobre el API es necesario un usuario y contraseña, este usuario debe ser creado en el modulo de Usuarios de Isolucion, se recomienda crear un usuario único para la integración. Una vez creado el usuario se debe cifrar en base64 de la siguiente manera NombreUsuario:Contraseña el resultado debe ser algo parecido a Tm9tYnJlVXN1YXJpbzpDb250cmFzZcOxYQ== Cuando se tenga este dato se debe enviar en el encabezado de la petición de la siguiente manera Basic Tm9tYnJlVXN1YXJpbzpDb250cmFzZcOxYQ==
Referencias |
apiKey | YWJjZDEyMzQYWJjZDEyMzQYWJjZDEyMzQ-localhost | Llave otorgada para el uso del API. |
Content-Type | application/json | Tipo de contenido enviado en la solicitud. |
Nombre del campo | Formato | Tamaño | Descripción | Obligatorio |
---|---|---|---|---|
IdTercero | Entero | int | Identificador único de tercero (id) en isolucion (Ver Objeto tercero). | Si. |
Porcentaje | Entero | Int) | Participacion de tercero en la relación con su contraparte | No. |
TipoRelacion | Entero | Int | Identificador único de tipo de relacion (id) en isolucion (Ver Objeto tipo relación) . | Si. |
Sample:
{ "IdTercero": 12, "Porcentaje": 30, "TipoRelacion": 3 }
Respuesta en Formato JSON a la solicitud de obtener los datos registrados en el sistema.
Campo | Ejemplo | Descripción |
---|---|---|
StatusCode | "StatusCode":200 | Códigos HTTP de respuesta indicando si fue exitoso o no el request realizado. [200,400,500] Exito,Error. |
Message | "Message":"Tercero relacionado agregado correctamente" | Descripción de la respuesta exitosa o mensaje de error enviado por el servidor. |
Entity | "Entity": [{data1}] | Formato JSON con el Tercero registrado en el sistema. En el caso de respuesta no exitosa el valor es nulo. |
Sample Ok Response:
{ "StatusCode": 200, "Message": "Tercero relacionado agregado correctamente.", "Entity": "{\"Id_Tercero\":9,\"Porcentaje\":22,\"IdContraparte\":2,\"TipoRelacion\":4,\"TipoContraparte\":1}" }
Sample ERROR Response:
{ "StatusCode": 400, "Message": "Bad Request : *DESCRIPCION DEL ERROR PARAMETRO ENTRADA ERRADO*.", "Entity": null }
{ "StatusCode": 401, "Message": "Unauthorized : *DESCRIPCION ERROR NO AUTORIZADO*.", "Entity": null }
{ "StatusCode": 500, "Message": "InternalServerError : La solicitud no fue procesada.", "Entity": null }
Elimina relación de un tercero existente a un provedor en el sistema ISOLUCIÓN.
HTTP DELETE: https://[service_address]/api/Proveedores/[idProveedor]/Tercero/[idTercero]/TipoRelacion/[idTipoRelacion]
[service_address]: Dirección disponible para conectividad con el API, debe validarse con su proveedor de ISOLUCIÓN.
[idProveedor]: Identificador único de proveedor (id) en isolucion (Ver Objeto proveedor).
[idTercero]: Identificador único de tercero (id) en isolucion (Ver Objeto tercero).
[idTipoRelacion]: Identificador único de tipo de relacion en isolucion (Ver Objeto tipo relación) .
Header | Ejemplo | Descripción |
---|---|---|
Authorization | Basic Tm9tYnJlVXN1YXJpbzpDb250cmFzZcOxYQ== |
Para la autorización sobre el API es necesario un usuario y contraseña, este usuario debe ser creado en el modulo de Usuarios de Isolucion, se recomienda crear un usuario único para la integración. Una vez creado el usuario se debe cifrar en base64 de la siguiente manera NombreUsuario:Contraseña el resultado debe ser algo parecido a Tm9tYnJlVXN1YXJpbzpDb250cmFzZcOxYQ== Cuando se tenga este dato se debe enviar en el encabezado de la petición de la siguiente manera Basic Tm9tYnJlVXN1YXJpbzpDb250cmFzZcOxYQ==
Referencias |
apiKey | YWJjZDEyMzQYWJjZDEyMzQYWJjZDEyMzQ-localhost | Llave otorgada para el uso del API. |
Content-Type | application/json | Tipo de contenido enviado en la solicitud. |
Respuesta en Formato JSON a la solicitud de obtener los datos registrados en el sistema.
Campo | Ejemplo | Descripción |
---|---|---|
StatusCode | "StatusCode":200 | Códigos HTTP de respuesta indicando si fue exitoso o no el request realizado. [200,400,500] Exito,Error. |
Message | "Message":"Tercero relacionado agregado correctamente" | Descripción de la respuesta exitosa o mensaje de error enviado por el servidor. |
Entity | "Entity": [{data1}] | Formato JSON con el Tercero registrado en el sistema. En el caso de respuesta no exitosa el valor es nulo. |
Sample Ok Response:
{ "StatusCode": 200, "Message": "Tercero relacionado eliminado correctamente", "Entity": "{\"Id_Tercero\":9,\"NomTercero\":\"NELSON ROKEFELLER\",\"CodTipoidentificacion\":4,\"NumDocumento\":\"12345678\",\"Telefono\":null,\"Email\":null,\"CodTipoDeRelacion\":1,\"CodTipoPersona\":2,\"Porcentaje\":4,\"Activo\":1}" }
Sample ERROR Response:
{ "StatusCode": 400, "Message": "Bad Request : *DESCRIPCION DEL ERROR PARAMETRO ENTRADA ERRADO*.", "Entity": null }
{ "StatusCode": 401, "Message": "Unauthorized : *DESCRIPCION ERROR NO AUTORIZADO*.", "Entity": null }
{ "StatusCode": 404, "Message": "Not Found : *DESCRIPCION ERROR ELEMENTO NO EXISTE*.", "Entity": null }
{ "StatusCode": 500, "Message": "InternalServerError : La solicitud no fue procesada.", "Entity": null }