Obtiene la lista de clientes existentes en el sistema ISOLUCIÓN.
HTTP GET: https://[service_address]/api/clientes
[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 clientes 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 Clientes registrados en el sistema. En el caso de respuesta no exitosa el valor es nulo. |
Sample OK Response:
{
"StatusCode": 200,
"Message": "Lista de clientes obtenida exitosamente.",
"Entity": "[{\"Nombredelcliente\":\"SAMSUNG COMPANY\",\"Activo\":1,\"Celular\":null,\"ActividadEconomica\":\"COMERCIO POR MENOR\",\"Ciudad\":\"BOGOTA D.C.\",\"Sector\":\"Privado\",\"Tipocliente\":null,\"TipoDocIdentidad\":\"NIT\",\"Contacto\":\"Carolina Gomez\",\"Direccion\":null,\"Documento\":\"830987654\",\"Email\":\"cliente@cliente.com\",\"Fax\":null,\"FechaActualizacion\":null,\"Fechacreación\":null,\"Telefono\":null,\"URL\":null,\"OrigenRecursos\":null,\"CodOrigenRecursos\":2,\"SLFCanal\":null,\"CodSLFCanal\":17,\"CodActividadEconomica\":null,\"ScoringSarlaft\":null,\"EsNivelGlobal\":0,\"Sucursales\":\"1,3\"}]"
}
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 cliente en el sistema ISOLUCIÓN a través de esta opción.
HTTP POST: https://[service_address]/api/clientes/
[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 |
|---|---|---|---|---|
| Nombredelcliente | Texto | varchar(100) | Nombre del cliente. Debe ser único, no puede existir otro cliente con el mismo nombre. | Si. |
| TipoDocIdentidad | Texto | varchar(50) | Tipo de documento de identificación. Lista de valores, sino existe se crea. | Si. |
| Documento | Texto | varchar(20) | Número de documento de identificación. El tipo de documento y el número de documento no deben existir previamente. | Si. |
| Contacto | Texto | varchar(100) | Nombre del contacto en el cliente. | No. |
| Activo | Booleano [1,0] | Activo:1 , Inactivo:0. Indica si el cliente se encuentra activo o no. Valor por defecto: [0]. | No. | |
| Departamento | Texto | varchar(150) | Nombre del departamento. *Solo se usa para elegir la ciudad cuando hay varias con el mismo nombre. | No. |
| Ciudad | Texto | varchar(150) | Ciudad o municipio del Cliente. Debe existir previamente. | No. |
| Texto | varchar(120) | Email del Cliente. Se espera un formato válido. | No. | |
| Sector | Texto | varchar(50) | Sector del cliente (público o privado).Lista de valores, sino existe se crea. | No. |
| Dirección | Texto | varchar(255) | Dirección del cliente. | No. |
| Tipodecliente | Texto | varchar(50) | Tipo de cliente. Lista de valores, sino existe se crea | No. |
| Celular | Texto | varchar(30) | Teléfono celular del cliente. | No. |
| Telefono | Texto | varchar(30) | Número de teléfono del cliente. | No. |
| Fax | Texto | varchar(30) | Fax del cliente. | No. |
| URL | Texto | varchar(255) | Dirección URL del cliente. | No. |
| CodActividadEconomica | Entero | int | Codigo de la actividad economica a la que se dedica el funcionario. Debe existir previamente. | No. |
| CodOrigenRecursos | Entero | int | Codigo del origen de los recursos del cliente. Debe existir previamente. | No. |
| CodSLFCanal | Entero | int | Codigo del canal por el que el cliente conocio la empresa. Debe existir previamente | No. |
| FechaCreacion | Fecha | Date | La fecha de creación del cliente, valor por defecto la fecha actual, formatos admitidos, yyyy/MM/dd HH:mm:ss ó yyyy/MM/dd | 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:
{
"Nombredelcliente":"SAMSUNG COMPANY 2",
"Activo":1,"Celular":null,
"Ciudad":"BOGOTÁ D.C.",
"Sector":"Privado",
"TipoCliente":null,
"TipoDocIdentidad":"NIT",
"Contacto":"Carolina Gomez",
"Direccion":null,
"Documento":"8309876544",
"Email":"cliente@cliente.com",
"Fax":null,
"Telefono":null,
"URL":null,
"CodActividadEconomica":1,
"CodOrigenRecursos":1,
"CodSLFCanal":1,
"FechaCreacion":"2020/05/12",
"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 Cliente 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": " El Cliente ha sido creado exitosamente.",
"Entity": "{\"Nombredelcliente\":\"SAMSUNG COMPANY 2\",\"Activo\":1,\"Celular\":null,\"ActividadEconomica\":\"COMERCIO POR MAYOR\",\"Ciudad\":\"BOGOTÁ D.C.\",\"Sector\":\"Privado\",\"Tipocliente\":null,\"TipoDocIdentidad\":\"NIT\",\"Contacto\":\"Carolina Gomez\",\"Direccion\":null,\"Documento\":\"8309876544\",\"Email\":\"cliente@cliente.com\",\"Fax\":null,\"FechaActualizacion\":null,\"Fechacreación\":\"2021-03-08T07:35:35\",\"Telefono\":null,\"URL\":null,\"OrigenRecursos\":null,\"CodOrigenRecursos\":2,\"SLFCanal\":null,\"CodSLFCanal\":17,\"CodActividadEconomica\":null,\"ScoringSarlaft\":null,\"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 cliente en el sistema ISOLUCIÓN a través de esta opción.
HTTP PUT: https://[service_address]/api/clientes/
[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 |
|---|---|---|---|---|
| Nombredelcliente | Texto | varchar(100) | Nombre del cliente. Debe ser único, no puede existir otro cliente con el mismo nombre. | Si. |
| TipoDocIdentidad | Texto | varchar(50) | Tipo de documento de identificación. Lista de valores, sino existe se crea. No puede ser modificado. | Si. |
| Documento | Texto | varchar(20) | Número de documento de identificación del cliente. En conjunto con el tipo de documento, se utilizan para identificar al cliente el cual debe existir previamente. No puede ser modificado. | Si. |
| Contacto | Texto | varchar(100) | Nombre del contacto en el cliente. | No. |
| Activo | Booleano [1,0] | Activo:1 , Inactivo:0. Indica si el cliente se encuentra activo o no. Valor por defecto: [0]. | No. | |
| Departamento | Texto | varchar(150) | Nombre del departamento. *Solo se usa para elegir la ciudad cuando hay varias con el mismo nombre. | No. |
| Ciudad | Texto | varchar(150) | Ciudad o municipio del Cliente. Debe existir previamente. | No. |
| Texto | varchar(120) | Email del Cliente. Se espera un formato válido. | No. | |
| Sector | Texto | varchar(50) | Sector del cliente (público o privado).Lista de valores, sino existe se crea. | No. |
| Dirección | Texto | varchar(255) | Dirección del cliente. | No. |
| Tipodecliente | Texto | varchar(50) | Tipo de cliente. Lista de valores, sino existe se crea | No. |
| Celular | Texto | varchar(30) | Teléfono celular del cliente. | No. |
| Telefono | Texto | varchar(30) | Número de teléfono del cliente. | No. |
| Fax | Texto | varchar(30) | Fax del cliente. | No. |
| URL | Texto | varchar(255) | Dirección URL del cliente. | No. |
| CodActividadEconomica | Entero | int | Codigo de la actividad economica a la que se dedica el funcionario. Debe existir previamente. | No. |
| CodOrigenRecursos | Entero | int | Codigo del origen de los recursos del cliente. Debe existir previamente. | No. |
| CodSLFCanal | Entero | int | Codigo del canal por el que el cliente conocio la empresa. Debe existir previamente | No. |
| FechaCreacion | Fecha | Date | La fecha de creación del cliente, valor por defecto la fecha actual, formatos admitidos, yyyy/MM/dd HH:mm:ss ó yyyy/MM/dd | No. |
| FechaActualizacion | Fecha | Date | La fecha de actualización de los datos del cliente, valor por defecto la fecha actual, formatos admitidos, yyyy/MM/dd HH:mm:ss ó yyyy/MM/dd | 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:
{
"Nombredelcliente":"SAMSUNG COMPANY 2",
"Activo":1,"Celular":null,
"Ciudad":"BOGOTÁ D.C.",
"Sector":"Privado",
"TipoCliente":null,
"TipoDocIdentidad":"NIT",
"Contacto":"Carolina Gomez",
"Direccion":null,
"Documento":"8309876544",
"Email":"cliente@cliente.com",
"Fax":null,
"Telefono":null,
"URL":null,
"CodActividadEconomica":1,
"CodOrigenRecursos":2,
"CodSLFCanal":17,
"FechaActualizacion":"2020/05/12 17:17:04",
"FechaCreacion":"2020/05/12",
"ScoringSarlaft":null,
"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 Cliente 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": " El Cliente ha sido actualizado exitosamente.",
"Entity": "{\"Nombredelcliente\":\"SAMSUNG COMPANY 2\",\"Activo\":1,\"Celular\":null,\"ActividadEconomica\":\"COMERCIO POR MAYOR\",\"Ciudad\":\"BOGOTÁ D.C.\",\"Sector\":\"Privado\",\"Tipocliente\":null,\"TipoDocIdentidad\":\"NIT\",\"Contacto\":\"Carolina Gomez\",\"Direccion\":null,\"Documento\":\"8309876544\",\"Email\":\"cliente@cliente.com\",\"Fax\":null,\"FechaActualizacion\":\"2021-03-08T09:40:12\",\"Fechacreación\":\"2021-03-08T07:36:00\",\"Telefono\":null,\"URL\":null,\"OrigenRecursos\":null,\"CodOrigenRecursos\":2,\"SLFCanal\":null,\"CodSLFCanal\":17,\"ScoringSarlaft\":null,\"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 cliente por documento y tipo de documento existentes en el sistema ISOLUCIÓN.
HTTP GET: https://[service_address]/api/Clientes/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 cliente.
[numeroDocumento]: Número de documento del cual se quiere traer la informacion del cliente.
| 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":"Cliente obtenido exitosamente.." | Descripción de la respuesta exitosa o mensaje de error enviado por el servidor. |
| Entity | "Entity": [{data1}] | Formato JSON con el Cliente registrado en el sistema. En el caso de respuesta no exitosa el valor es nulo. |
Sample Ok Response:
{
"StatusCode": 200,
"Message": "Cliente obtenido exitosamente.",
"Entity": "{\"Nombredelcliente\":\"SAMSUNG COMPANY 2\",\"Activo\":1,\"Celular\":null,\"ActividadEconomica\":\"COMERCIO POR MAYOR\",\"Ciudad\":\"BOGOTÁ D.C.\",\"Sector\":\"Privado\",\"Tipocliente\":null,\"TipoDocIdentidad\":\"NIT\",\"Contacto\":\"Carolina Gomez\",\"Direccion\":null,\"Documento\":\"8309876544\",\"Email\":\"cliente@cliente.com\",\"Fax\":null,\"FechaActualizacion\":\"2021-03-08T09:40:12\",\"Fechacreación\":\"2021-03-08T07:36:00\",\"Telefono\":null,\"URL\":null,\"OrigenRecursos\":null,\"CodOrigenRecursos\":2,\"SLFCanal\":null,\"CodSLFCanal\":17,\"ScoringSarlaft\":null,\"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
}
Relaciona un tercero existente a un cliente en el sistema ISOLUCIÓN.
HTTP POST: https://[service_address]/api/clientes/[idCliente]/Tercero
[service_address]: Dirección disponible para conectividad con el API, debe validarse con su proveedor de ISOLUCIÓN.
[idCliente]: Identificador único de cliente (id) en isolucion (Ver Objeto cliente)..
| 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 cliente en el sistema ISOLUCIÓN.
HTTP DELETE: https://[service_address]/api/clientes/[idCliente]/Tercero/[idTercero]/TipoRelacion/[idTipoRelacion]
[service_address]: Dirección disponible para conectividad con el API, debe validarse con su proveedor de ISOLUCIÓN.
[idCliente]: Identificador único de cliente (id) en isolucion (Ver Objeto cliente).
[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 agregado 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": 500,
"Message": "InternalServerError : La solicitud no fue procesada.",
"Entity": null
}
Obtiene la lista de clientes existentes en el sistema ISOLUCIÓN.
Similar a Obtener, incluye la propiedad InfoPortalContrapartes que contiene la información diligenciada en el/los formulario(s) de Contrapartes.
HTTP GET: https://[service_address]/api/clientes/ext
[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]/ext?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 clientes 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 Clientes registrados en el sistema. En el caso de respuesta no exitosa el valor es nulo. |
Sample OK Response:
{
"StatusCode": 200,
"Message": "Lista de clientes obtenida exitosamente.",
"Entity": "[...
{
"IdCliente": 17,
"Nombredelcliente": "Pedro Pablo Moreno",
"Activo": 1,
"Celular": null,
"ActividadEconomica": null,
"Ciudad": null,
"Departamento": null,
"Sector": null,
"Tipocliente": "empleado",
"TipoDocIdentidad": "Cédula de ciudadanía",
"Contacto": "123",
"Direccion": null,
"Documento": "123456789",
"Email": "Pedro.Pablo.Moreno@isolucion.com",
"Fax": null,
"FechaActualizacion": "Sep 21 2023 12:00AM",
"FechaCreacion": "",
"Telefono": null,
"URL": null,
"OrigenRecursos": null,
"CodOrigenRecursos": null,
"SLFCanal": null,
"CodSLFCanal": null,
"CodActividadEconomica": null,
"ScoringSarlaft": 3,
"EsNivelGlobal": 1,
"Sucursales": null,
"InfoPortalContrapartes": [
{
"camposSimples": {
"Datos generales": {
"Tipo Identificación": "3",
"Identificación": "123456789",
"Tipo Persona": "1",
"Nombre o Razón social": "Pedro Pablo Moreno",
"Teléfono": "",
"Fax": "",
"Email": "kjhgbv@sharklasers.com",
"Sitio web": "",
"Dirección": "",
"Ciudad / Departamento / País": "1965",
"Código postal": "",
"Tamaño de la empresa": null,
"Número de empleados": "",
"Canal": "23"
},
"Representante legal": {
"Nombre": "Pablo Marmol",
"Tipo Identificación": "6",
"Identificación": "123456789",
"Lugar de expedición": "",
"Teléfono": "",
"Email": "kjhgbv@sharklasers.com",
"Ciudad / Departamento / País": "",
"Dirección": "",
"Código postal": "",
"¿Por su cargo o actividad maneja recursos públicos?": false,
"¿Por su cargo o actividad ejerce algún grado de poder público?": false,
"¿Por su actividad u oficio goza usted de reconocimiento público general?": false,
"¿Existe algún vínculo entre usted y una persona considerada públicamente expuesta?": false,
"¿Usted o la persona jurídica que representa ha celebrado contratos con entidades estatales?": false,
"¿Usted o la persona jurídica que representa tiene algún asociado o accionista considerado persona expuesta políticamente?": false,
"¿Está obligado a tributar en un país diferente al que vive?": false,
"Explicaciones preguntas": ""
},
"Representante legal suplente": {
"Nombre": "",
"Tipo Identificación": null,
"Identificación": "",
"Lugar de expedición": "",
"Teléfono": "",
"Email": "",
"Ciudad / Departamento / País": "",
"Dirección": "",
"Código postal": "",
"¿Por su cargo o actividad maneja recursos públicos?": "",
"¿Por su cargo o actividad ejerce algún grado de poder público?": "",
"¿Por su actividad u oficio goza usted de reconocimiento público general?": "",
"¿Existe algún vínculo entre usted y una persona considerada públicamente expuesta?": "",
"¿Usted o la persona jurídica que representa ha celebrado contratos con entidades estatales?": "",
"¿Usted o la persona jurídica que representa tiene algún asociado o accionista considerado persona expuesta políticamente?": "",
"¿Está obligado a tributar en un país diferente al que vive?": "",
"Explicaciones preguntas": ""
},
"Contacto e información comercial": {
"Nombre del contacto": "",
"Cargo": "",
"Tipo Identificación": null,
"Identificación": "",
"Lugar de expedición": "",
"Teléfono": "",
"Email": "",
"Dirección": "",
"Ciudad / Departamento / País": "",
"Código postal": "",
"Condiciones de pago": null
},
"Composición accionaria": {
},
"Terceros relacionados": {
},
"Información tributaria": {
"Actividad económica CIIU a 4 dígitos": "853",
"Email facturación electrónica": "kjhgbv@sharklasers.com",
"Agente retenedor de IVA": false,
"Autorretenedor de Impuesto de Renta": false,
"Entidad sin ánimo de lucro": false,
"Resolución entidad sin ánimo de lucro": "",
"Gran contribuyente": false,
"Resolución Gran contribuyente": "",
"Retenedor o Agente retenedor ICA": false,
"Maneja topes de retención en la fuente": false,
"Responsable de IVA": false,
"Régimen especial ZOMAC": false,
"Régimen especial ZESE": false,
"Régimen especial CI": false
},
"Información financiera": {
"Fecha Información financiera": "",
"Fecha Actualización": "",
"Fecha Creación": "",
"Activo Corriente": "",
"Activo No Corriente": "",
"Pasivo Corriente": "",
"Pasivo No Corriente": "",
"Total Patrimonio": "",
"Utilidad Neta": "",
"Ingresos Mensuales": "",
"Egresos Mensuales": "",
"Otros Ingresos Mensuales": ""
},
"Personas autorizadas para solicitar servicios (Proveedores)": {
},
"Información de pagos": {
"Días de pago": "",
"Condiciones de pago": null
},
"Operaciones internacionales y activos virtuales": {
"¿Realiza transacciones en moneda extranjera?": "",
"Tipo de operaciones en moneda extranjera": "Exportación",
"Observaciones operaciones en moneda extranjera": "Dolares",
"¿La empresa realiza o realizó alguna actividad u operación con activos virtuales?": "",
"¿Con cuáles activos virtuales?": "Bitcoin"
},
"Referencias comerciales": {
},
"Declaración de origen de fondos": {
"Declaración de origen de fondos": true,
"Actividad de origen de fondos": "4"
},
"Autorización de manejo de información": {
"Autorización de manejo de información": true
},
"Autorización de tratamiento de datos personales": {
"Autorización de tratamiento de datos personales": true
},
"Políticas de control de riesgos": {
"Políticas de control de riesgos": true
}
},
"camposGrupo": {
"Operaciones internacionales y activos virtuales::¿Posee productos financieros en el exterior?": [
{
"¿Posee productos financieros en el exterior?::Tipo de Producto": "Cuenta corriente",
"¿Posee productos financieros en el exterior?::Número de identificación del producto": "123456789",
"¿Posee productos financieros en el exterior?::Entidad": "Davivienda Panama",
"¿Posee productos financieros en el exterior?::Monto": "$12.500.000,00",
"¿Posee productos financieros en el exterior?::Ciudad": "Panama",
"¿Posee productos financieros en el exterior?::País": "156",
"¿Posee productos financieros en el exterior?::Moneda": "COP"
}
]
}
}
]
},
...]"
}
Sample ERROR Response:
{
"StatusCode": 401,
"Message": "Unauthorized : *DESCRIPCION ERROR NO AUTORIZADO*.",
"Entity": null
}
{
"StatusCode": 500,
"Message": "InternalServerError : La solicitud no fue procesada.",
"Entity": null
}