Obtiene la lista de financieras existentes en el sistema ISOLUCIÓN.
HTTP GET: https://[service_address]/api/financiera/
[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. |
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 Financieras 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 Financieras registrados en el sistema. En el caso de respuesta no exitosa el valor es nulo. |
Sample Ok Response:
{ "StatusCode": 200, "Message": "Lista de financieras obtenida exitosamente.", "Entity": "[{\"NomEquipo\":\"Pantalla de trabajo 19\",\"MarcaDeEquipo\":null,\"Modelo\":\"\",\"Descripcion\":\"\",\"Cuidados\":\"\",\"Serial\":\"\",\"Placa\":\"EQ-2098\",\"Localizacion\":\"\",\"Oficina\":null,\"Usuario\":null,\"FechaCompra\":\"1900-01-01T00:00:00\",\"CantidadCalibracion\":0,\"CantidadMantenimiento\":0,\"Activo\":1},{\"NomEquipo\":\"Pantalla de trabajo\",\"MarcaDeEquipo\":null,\"Modelo\":\"Serie5\",\"Descripcion\":\"LCD 42 pulgadas\",\"Cuidados\":\"\",\"Serial\":\"\",\"Placa\":\"EQ-2098\",\"Localizacion\":\"\",\"Oficina\":null,\"Usuario\":null,\"FechaCompra\":\"1900-01-01T00:00:00\",\"CantidadCalibracion\":0,\"CantidadMantenimiento\":0,\"Activo\":1},{\"NomEquipo\":\"Pantalla\",\"MarcaDeEquipo\":null,\"Modelo\":\"Serie5\",\"Descripcion\":\"LCD 42 pulgadas\",\"Cuidados\":\"\",\"Serial\":\"\",\"Placa\":\"EQ-2098\",\"Localizacion\":\"\",\"Oficina\":null,\"Usuario\":null,\"FechaCompra\":\"1900-01-01T00:00:00\",\"CantidadCalibracion\":0,\"CantidadMantenimiento\":0,\"Activo\":1}]" }
Sample ERROR Response:
{ "StatusCode": 401, "Message": "Unauthorized : *DESCRIPCION ERROR NO AUTORIZADO*.", "Entity": null }
{ "StatusCode": 500, "Message": "InternalServerError : La solicitud no fue procesada.", "Entity": null }
Obtiene una financiera por Id existente en el sistema ISOLUCIÓN.
HTTP GET: https://[service_address]/api/financiera/Id/[Id]
[service_address]: Dirección disponible para conectividad con el API, debe validarse con su proveedor de ISOLUCIÓN.
[Id]: Id del cual se quiere traer la informacion de la financiera.
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":"Financiera obtenida exitosamente.." | Descripción de la respuesta exitosa o mensaje de error enviado por el servidor. |
Entity | "Entity": [{data1}] | Formato JSON con el la Financiera registrado en el sistema. En el caso de respuesta no exitosa el valor es nulo. |
Sample Ok Response:
{ "StatusCode": 200, "Message": "Financiera obtenida exitosamente.", "Entity": "{\"Id_SlfTFinanciera\":786463,\"TipoIdentificacion\":\"Cédula\",\"Identificacion\":\"1019089957\",\"TipoTFinanciera\":\"Debito\",\"Monto\":100.00,\"Iva\":0.00,\"Ica\":0.00,\"Ipc\":0.00,\"CodDivisa\":1,\"Efectivo\":false,\"NotificacionEnvidada\":false,\"Alertar\":false,\"CodAccion\":7,\"PesoAcumulado\":0,\"PesoTotal\":0,\"CalificacionRiesgo\":100.00,\"Procesada\":false,\"Manual\":false,\"Borrada\":false,\"Sospechosa\":true,\"Segura\":false,\"CodigoUnico\":\"J\",\"FechaEmision\":\"2023-12-01T00:00:00\",\"FechaRecepcion\":\"2006-12-23T00:00:00\",\"MensajeAlerta\":\"\"}" }
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 }
Crea una financiera en el sistema ISOLUCIÓN a través de esta opción.
HTTP POST: https://[service_address]/api/financiera/
[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(20) | Tipo de identificacion de la financiera. | Si. |
Identificacion | Texto | varchar(20) | Identificación de la financiera. | Si. |
TipoTFinanciera | Texto | varchar(20) | Tipo de financiera. | Si. |
Monto | Numérico | Decimal(9) | Monto de la financiera. | Si. |
Iva | Numérico | Decimal(9) | Iva de la financiera. | Si. |
Ica | Numérico | Decimal(9) | Ica de la financiera. | Si. |
Ipc | Numérico | Decimal(9) | Icpc de la financiera. | Si. |
CodDivisa | Numérico | int | Código de la moneda de la financiera. | Si. |
Efectivo | Booleano [1,0] | Efectivo:1, No efectivo:0. Indica si el pago es en efectivo o no. | Si. | |
NotificacionEnvidada | Booleano [1,0] | Enviada:1, No enviada:0. Indica si se envio la notificación o no. | Si. | |
CodAccion | Numérico | int | Código de la accion a la que esta relacionada la financiera. | No. |
Alertar | Booleano [1,0] | Alertar:1, No alertar:0. Indica si se envia alerta de la financiera o no. | Si. | |
MensajeAlerta | Texto | varchar(16) | Mensaje de alerta de la financiera. | No. |
PesoAcumulado | Numérico | int | Peso acumulado de la financiera. | Si. |
PesoTotal | Numérico | int | Peso total de la financiera. | Si. |
CalificacionRiesgo | Numérico | Decimal(9) | Calificación del riesgo de la financiera. | Si. |
Procesada | Booleano [1,0] | Procesada:1, No procesada:0. Indica si se proceso o no. | Si. | |
Borrada | Booleano [1,0] | Borrada:1, No borrada:0. Indica si fue borrada o no. | Si. | |
Sospechosa | Booleano [1,0] | Sospechosa:1, No sospechosa:0. Indica si es sospechosa o no. | Si. | |
Segura | Booleano [1,0] | Segura:1, No segura:0. Indica si es segura o no. | Si. | |
CodigoUnico | Texto | varchar(200) | Código único de la financiera. | No. |
FechaEmision | Fecha | Date | La fecha de emision de la financiera, valor por defecto la fecha actual, formatos admitidos, yyyy/MM/dd HH:mm:ss ó yyyy/MM/dd. | No. |
FechaRecepcion | Fecha | Date | La fecha de emision de la financiera, valor por defecto la fecha actual, formatos admitidos, yyyy/MM/dd HH:mm:ss ó yyyy/MM/dd. | No. |
Manual | Booleano [1,0] | Manual:1, No manual:0. Indica si es manual o no. | Si. |
Sample:
{"TipoIdentificacion":"Cédula","Identificacion":"1019089957","TipoTFinanciera":"Debito","Monto":100,"Iva":0,"Ica":0,"Ipc":0,"CodDivisa":1,"Efectivo":0,"NotificacionEnvidada":0,"CodAccion":0,"Alertar":0,"MensajeAlerta":"","PesoAcumulado":0,"PesoTotal":0,"CalificacionRiesgo":100,"Procesada":0,"Borrada":0,"Sospechosa":1,"Segura":0,"CodigoUnico":"","FechaEmision":null,"FechaRecepcion":null,"Manual":0}
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":"La Financiera ha sido creada 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": "La financiera ha sido creada exitosamente.", "Entity": "{\"TipoIdentificacion\":\"Cédula\",\"Identificacion\":\"1019089957\",\"TipoTFinanciera\":\"Debito\",\"Monto\":100.0,\"Iva\":0.0,\"Ica\":0.0,\"Ipc\":0.0,\"CodDivisa\":1,\"Efectivo\":false,\"NotificacionEnvidada\":false,\"Alertar\":false,\"CodAccion\":7,\"PesoAcumulado\":0,\"PesoTotal\":0,\"CalificacionRiesgo\":100.0,\"Procesada\":false,\"Manual\":false,\"Borrada\":false,\"Sospechosa\":true,\"Segura\":false,\"CodigoUnico\":\"J\",\"FechaEmision\":\"2023-12-01T00:00:00\",\"FechaRecepcion\":\"2006-12-23T00:00:00\",\"MensajeAlerta\":\"\"}" }
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 una financiera en el sistema ISOLUCIÓN a través de esta opción.
HTTP PUT: https://[service_address]/api/financiera/
[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 |
---|---|---|---|---|
Id_SlfTFinanciera | Numérico | int | Id de la financiera. | Si. |
TipoIdentificacion | Texto | varchar(20) | Tipo de identificacion de la financiera. | Si. |
Identificacion | Texto | varchar(20) | Identificación de la financiera. | Si. |
TipoTFinanciera | Texto | varchar(20) | Tipo de financiera. | Si. |
Monto | Numérico | Decimal(9) | Monto de la financiera. | Si. |
Iva | Numérico | Decimal(9) | Iva de la financiera. | Si. |
Ica | Numérico | Decimal(9) | Ica de la financiera. | Si. |
Ipc | Numérico | Decimal(9) | Icpc de la financiera. | Si. |
CodDivisa | Numérico | int | Código de la moneda de la financiera. | Si. |
Efectivo | Booleano [1,0] | Efectivo:1, No efectivo:0. Indica si el pago es en efectivo o no. | Si. | |
NotificacionEnvidada | Booleano [1,0] | Enviada:1, No enviada:0. Indica si se envio la notificación o no. | Si. | |
CodAccion | Numérico | int | Código de la accion a la que esta relacionada la financiera. | No. |
Alertar | Booleano [1,0] | Alertar:1, No alertar:0. Indica si se envia alerta de la financiera o no. | Si. | |
MensajeAlerta | Texto | varchar(16) | Mensaje de alerta de la financiera. | No. |
PesoAcumulado | Numérico | int | Peso acumulado de la financiera. | Si. |
PesoTotal | Numérico | int | Peso total de la financiera. | Si. |
CalificacionRiesgo | Numérico | Decimal(9) | Calificación del riesgo de la financiera. | Si. |
Procesada | Booleano [1,0] | Procesada:1, No procesada:0. Indica si se proceso o no. | Si. | |
Borrada | Booleano [1,0] | Borrada:1, No borrada:0. Indica si fue borrada o no. | Si. | |
Sospechosa | Booleano [1,0] | Sospechosa:1, No sospechosa:0. Indica si es sospechosa o no. | Si. | |
Segura | Booleano [1,0] | Segura:1, No segura:0. Indica si es segura o no. | Si. | |
CodigoUnico | Texto | varchar(200) | Código único de la financiera. | No. |
FechaEmision | Fecha | Date | La fecha de emision de la financiera, valor por defecto la fecha actual, formatos admitidos, yyyy/MM/dd HH:mm:ss ó yyyy/MM/dd. | No. |
FechaRecepcion | Fecha | Date | La fecha de emision de la financiera, valor por defecto la fecha actual, formatos admitidos, yyyy/MM/dd HH:mm:ss ó yyyy/MM/dd. | No. |
Manual | Booleano [1,0] | Manual:1, No manual:0. Indica si es manual o no. | Si. |
Sample:
{"Id_SlfTFinanciera":7,"TipoIdentificacion":"Cédula","Identificacion":"1019089957","TipoTFinanciera":"Debito","Monto":100,"Iva":0,"Ica":0,"Ipc":0,"CodDivisa":1,"Efectivo":0,"NotificacionEnvidada":0,"CodAccion":0,"Alertar":0,"MensajeAlerta":"","PesoAcumulado":0,"PesoTotal":0,"CalificacionRiesgo":100,"Procesada":0,"Borrada":0,"Sospechosa":1,"Segura":0,"CodigoUnico":"","FechaEmision":null,"FechaRecepcion":null,"Manual":0}
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":"La Financiera ha sido actualizada 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": "La Financiera ha sido actualizada exitosamente.", "Entity": "{\"Id_SlfTFinanciera\":786463,\"TipoIdentificacion\":\"Cédula\",\"Identificacion\":\"1019089957\",\"TipoTFinanciera\":\"Debito\",\"Monto\":100.0,\"Iva\":0.0,\"Ica\":0.0,\"Ipc\":0.0,\"CodDivisa\":1,\"Efectivo\":false,\"NotificacionEnvidada\":false,\"Alertar\":false,\"CodAccion\":7,\"PesoAcumulado\":0,\"PesoTotal\":0,\"CalificacionRiesgo\":100.0,\"Procesada\":false,\"Manual\":false,\"Borrada\":false,\"Sospechosa\":true,\"Segura\":false,\"CodigoUnico\":\"J\",\"FechaEmision\":\"2023-12-01T00:00:00\",\"FechaRecepcion\":\"2006-12-23T00:00:00\",\"MensajeAlerta\":\"\"}" }
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 }