esofitec. CoreDocs

esofitec. CoreDocs

Workers y dispatchers / API estándar para a3ERP

Catálogo de operaciones

El módulo estándar ofrece dos tipos de funcionalidad:

  • Consultas (lectura) — las resuelve la API directamente a partir de las vistas y procedimientos que el módulo instala en el diccionario de extensibilidad de a3ERP. Son síncronas: devuelven los datos en el momento.
  • Operaciones de escritura (crear, modificar, eliminar) — las ejecuta el worker contra a3ERP. Son asíncronas: la aplicación encola la petición y luego consulta el resultado (ver Uso).

Consultas (vistas y procedimientos del diccionario)#

El módulo instala en el diccionario de extensibilidad de a3ERP, para cada entidad, una vista (SIT_API_<ENTIDAD>, devuelve todos los registros) y un procedimiento parametrizado (SIT_API_<ENTIDAD>_Parametrized, permite filtrar por identificador; sin filtro, devuelve todos). La API los expone como extremos de consulta de solo lectura. La forma de darlos de alta es la misma que cualquier extremo de vista o procedimiento (ver Configuración de endpoints).

Entidades disponibles:

Maestros y tablas auxiliares#

  • Clientes
  • Proveedores
  • Personas
  • Artículos
  • Familias
  • Almacenes
  • Bancos
  • Series
  • Formas de pago
  • Documentos de pago
  • Tipos de IVA
  • Descuentos
  • Precios especiales
  • Tarifas
  • Tarifas de venta
  • Cartera
  • Representantes

Documentos (cabecera y líneas)#

  • Pedidos de venta
  • Pedidos de compra
  • Albaranes de venta
  • Albaranes de compra
  • Facturas de venta
  • Facturas de compra

El conjunto depende de la versión del diccionario

Las vistas y procedimientos disponibles los aporta la versión del diccionario que tengas instalada. Si echas en falta una entidad o un campo, revisa la versión del diccionario frente a la de la entrega del módulo (ver Puesta en marcha).

Operaciones de escritura (worker)#

Cada operación es un extremo de tipo custom que se da de alta en la pantalla de Configuración de la API indicando el dispatcher (la familia) y el nombre de la operación de estas tablas, además de los permisos del usuario. Cómo se configuran está en Configuración de endpoints.

Clientes#

Dispatcher Clientes.

Operación Qué hace
AltaCliente Crea un cliente
ModificaCliente Modifica un cliente existente
EliminaCliente Elimina un cliente
AltaDireccion Añade una dirección a un cliente
ModificaDireccion Modifica una dirección
EliminaDireccion Elimina una dirección
AltaContactoCliente Añade un contacto a un cliente
ModificaContactoCliente Modifica un contacto
EliminaContactoCliente Elimina un contacto

Proveedores#

Dispatcher Proveedores.

Operación Qué hace
AltaProveedor Crea un proveedor
ModificaProveedor Modifica un proveedor existente
EliminaProveedor Elimina un proveedor

Personas#

Dispatcher Personas.

Operación Qué hace
AltaPersona Crea una persona
ModificaPersona Modifica una persona existente
EliminaPersona Elimina una persona

Artículos#

Dispatcher Articulos.

Operación Qué hace
AltaArticulo Crea un artículo
ModificaArticulo Modifica un artículo existente
EliminaArticulo Elimina un artículo

Pedidos#

Dispatcher Pedidos.

Operación Qué hace
AltaPedidoVenta Crea un pedido de venta
ModificaPedidoVenta Modifica un pedido de venta
EliminaPedidoVenta Elimina un pedido de venta
AltaPedidoCompra Crea un pedido de compra
ModificaPedidoCompra Modifica un pedido de compra
EliminaPedidoCompra Elimina un pedido de compra

Albaranes#

Dispatcher Albaranes.

Operación Qué hace
AltaAlbaranVenta Crea un albarán de venta
ModificaAlbaranVenta Modifica un albarán de venta
FacturaAlbaranVenta Factura un albarán de venta (genera su factura)
EliminaAlbaranVenta Elimina un albarán de venta
AltaAlbaranCompra Crea un albarán de compra
ModificaAlbaranCompra Modifica un albarán de compra
EliminaAlbaranCompra Elimina un albarán de compra

Facturas#

Dispatcher Facturas.

Operación Qué hace
AltaFacturaVenta Crea una factura de venta
ModificaFacturaVenta Modifica una factura de venta
EliminaFacturaVenta Elimina una factura de venta
AltaFacturaCompra Crea una factura de compra
ModificaFacturaCompra Modifica una factura de compra
EliminaFacturaCompra Elimina una factura de compra
ImprimeFacturaVenta Genera el PDF de una factura de venta
ImprimeFacturaCompra Genera el PDF de una factura de compra

Auxiliares#

Dispatcher Auxiliares.

Operación Qué hace
AltaSerie Crea una serie
AltaCentroCoste Crea un centro de coste analítico

El nombre del dispatcher importa

Al configurar un extremo custom, el dispatcher del extremo debe coincidir exactamente con la familia de estas tablas (Clientes, Proveedores, Articulos…) y el nombre con el de la operación. Si no casan, el worker no recoge la petición y se queda encolada. Ver Solución de problemas.