API Bancos y Financieras

Esta API permite gestionar bancos y entidades financieras utilizados por la empresa, incluyendo consulta, alta, modificación y eliminación de registros.

La funcionalidad asociada en el sistema se encuentra en Configuración > Caja y Bancos > Bancos y Financieras.

Endpoint del servicio

Método Query

Permite obtener un listado de bancos y entidades financieras aplicando filtros.

Parámetros de entrada

Parámetro Tipo Descripción
CodigoDesde T(3) Código inicial.
CodigoHasta T(3) Código final.
NombreContiene T(20) Filtro por nombre.
Page N(2) Paginación (obligatorio).

Estructura del response

Codigo
Nombre
Abreviacion
Tipo
Notas

Método Load

Permite obtener un banco o entidad financiera específica.

Parámetro de entrada

  • Codigo – Obligatorio.

Resultado

Codigo
Nombre
Abreviacion
Tipo
Notas

Método Save

Permite crear o actualizar un banco o entidad financiera.

Al actualizar, los campos que no se envían en el payload no conservan automáticamente su valor anterior.

El sistema toma como referencia únicamente la información recibida. Por este motivo, los campos que no se incluyen en  la solicitud quedan sin valor.

Por lo tanto, al realizar una actualización, es necesario enviar también los datos que se desean conservar.

Parámetros de entrada

Datos obligatorios

Campo Descripción
Codigo Código único del banco o entidad financiera.
Nombre Nombre del banco o entidad financiera.
Abreviacion Nombre abreviado del banco o entidad financiera.
Tipo Tipo de entidad: "B" = Banco o "E" = Entidad financiera.

Datos opcionales

Campo Descripción
Notas Información adicional sobre el banco o entidad financiera.

Resultado

Succeed
Error
Mensaje

Observación

El campo Tipo solo puede definirse al crear un registro nuevo.

Método Delete

Permite eliminar un banco o entidad financiera.

Parámetro de entrada

  • Codigo – Obligatorio.

Restricción

No es posible eliminar un banco o entidad financiera si está asociado a cuentas bancarias o tarjetas.

Resultado

Succeed
Error
Mensaje

Observaciones

  • El método Query permite consultas masivas.
  • El método Load es recomendado para consultas puntuales.
  • El método Save permite tanto alta como modificación.
  • El método Delete está condicionado por dependencias en el sistema.

Consideraciones de integración

  • Utilizar paginación en consultas.
  • Validar dependencias antes de eliminar registros.
  • Persistir bancos y financieras en sistemas externos si se requiere integración.
Compartir

API Bancos y Financieras

O copia el enlace

CONTENIDO