Servicios disponibles

Los servicios disponibles para acceder a datos de winfra.

API genérico

Los servicios son disponibles en todos los APIs.

GET /api_v1/info/

Devuelve informacion sobre el API, como versión, fecha actual de servidor etc..

Respuesta
lista de ServerInfo

Contabilidad

Indica el nombre de api contabilidad para acceder a los siguientes servicios:

GET /api_v1/centros_coste/

Obtiene todos los centros de coste.

Respuesta
lista de CentroCoste

GET /api_v1/diario/<fecha_hasta>

Obtener el diario contable del ejercicio hasta la fecha indicada. Indica la fecha en el formato YYYYMMDD. Ejemplo: /api_v1/diario/20200615.

Respuesta
Diario

GET /api_v1/diario/confirmar/<peticion_id>

Confirmar la recepción del diario contable.


GET /api_v1/empleados/

Obtener los empleados.

Respuesta
lista de Empleado

GET /api_v1/subcuentas/

Obtener las subcuentas contables.

Respuesta
lista de Subcuenta

GET /api_v1/vehiculos/

Obtener los vehículos.

Respuesta
lista de Vehiculo

Crm

Indica el nombre de api crm para acceder a los siguientes servicios:

GET /api_v1/carga_descargar/<carga_id>

Obtiene la carga para los móviles. Utiliza /api_v1/carga_disponible/ para obtener un actual carga_id La petición devuelve el fichero ZIP con la base de datos en el formato SQLITE comprimida. Nombre de la base de datos (dentro de zip) es siempre carga.sqlite

Respuesta
binary stream zip file

GET /api_v1/carga_disponible/<version>

Obtiene la información sobre la carga para los móviles. En la versión indica la versión de la estructura según la documentación que desea obtener. Ejemplo: /api_v1/carga_disponible/45.

Respuesta
CargaMovil

GET /api_v1/ficha/<cliente_id>

Obtener la lista de formatos que el cliente suele comprar. La ficha esta basada en el historial de ventas y se actualiza a diario.

Respuesta
lista de Formato

POST /api_v1/pedidocrm/

Permite subir un pedido a Winfra desde el sistema de CRM. A diferencia de Pedido el PedidoCrm necesita indicar el cliente de Winfra (InterlocutorComercial). El pedido se graba en winfra tal como se ha subido sin necesidad de confirmarlo. Identificador de la transacción devuelto es solo informativo, puede utilizarlo para comprobar la situación del pedido con /api_v1/pedido_transaccion/

Petición
PedidoCRM
Respuesta
PedidoTransaccion

GET /api_v1/pedidocrm_confirmar/<transaccion_id>

Confirma el pedido que ha sido valorado previamente para subirlo a Windra desde el sistema CRM.Requiere la valoración previa desde /api_v1/pedidocrm_valorar/Indica transaccion_id del pedido. Ej: /api_v1/pedidocrm_confirmar/90002091-dd89-11ea-a983-54e1ade9de7d

Respuesta
PedidoTransaccion

POST /api_v1/pedidocrm_valorar/

Permite hacer una valoración del pedido desde el sistema CRM sin subirlo a Winfra. Requiere confirmación posterior para ser subido.Para confirmarlo utilizar /api_v1/pedidocrm_confirmar/

Petición
PedidoCRM
Respuesta
lista de Venta,

Maestros

Indica el nombre de api maestros para acceder a los siguientes servicios:

GET /api_v1/articulo_grupos/

Obtener la lista de grupos de artículos.

Respuesta
lista de ArticuloGrupo

GET /api_v1/articulo_grupos/<grupo_id>

Obtener la lista de artículos dentro de grupo indicado.

Respuesta
lista de ArticuloResumen

GET /api_v1/articulos/

Obtener la lista de todos los artículos.

Respuesta
lista de ArticuloResumen

GET /api_v1/articulos/<id>

Obtener un articulo por su id.

Respuesta
Articulo

GET /api_v1/articulos_cargo/

Obtener lista de artículos de cargo logístico. Para obtener los precios utiliza /precio/<formato_id>/<fecha>.

Respuesta
lista de Articulo

GET /api_v1/cliente_tipos/

Obtener la lista de tipos de clientes.

Respuesta
lista de TipoCliente

POST /api_v1/compra/

Obtener compra por sus ids. La petición tiene que contener la lista de ids de compra y esta limitada a 1000 ids.

Petición
lista de string
Respuesta
lista de Compra

GET /api_v1/compra/<compra_id>

Obtener una compra por su id. Ejemplo /api_v1/compra/3d61abd3-d485-2342-7896-50ff691d044c

Respuesta
Compra

GET /api_v1/descuentos/

Obtener la lista de descuentos de precios de los artículos para hoy y los próximos 7 días.

Respuesta
lista de Descuento

GET /api_v1/interlocutores/

Obtener la lista de todos los interlocutores comerciales (clientes, proveedores y acreedores).

Respuesta
lista de InterlocutorComercialResumen

GET /api_v1/interlocutores/<id>

Obtener un interlocutor por su id.

Respuesta
InterlocutorComercial

POST /api_v1/pedido/

Permite subir un pedido a winfra. La respuesta contiene el código de la transacción para confirmarla. En caso de error de la validación el resultado esta devuelto como error.

Petición
Pedido
Respuesta
PedidoTransaccion

POST /api_v1/pedido_cobro/

Permite subir cobros a winfra. En caso de error de la validación el resultado esta devuelto como error.

Petición
lista de PedidoCobro

POST /api_v1/pedido_confirmar/

Confirma los pedidos subidos anteriormente en una transacción.

Petición
PedidoConfirmacion

GET /api_v1/pedido_imprimir/<id>

Obtener el documento PDF de la impresión del documento creado con /pedido/ o con /pedidocrm/. Indica transaccion_id. Ejemplo: /api_v1/pedido_imprimir/90002091-dd89-11ea-a983-54e1ade9de7d

Respuesta
binary stream PDF file

GET /api_v1/pedido_transaccion/<id>

Obtener información sobre la transacción iniciada con /pedido/ o con /pedidocrm/. Indica transaccion_id. Ejemplo: /api_v1/pedido_transaccion/90002091-dd89-11ea-a983-54e1ade9de7d

Respuesta
PedidoTransaccion

GET /api_v1/precio/<formato_id>/<fecha>

Obtener el precio del formato en la fecha indicada. Indica la fecha en el formato YYYYMMDD. Ejemplo: /api_v1/tarifas/3b3ab89d-427f-7563-9863-87644d89e8bd/20200615.

Respuesta
decimal

GET /api_v1/stock/<formato_id>

Devuelve el stock actual del Formato indicado por su id

Respuesta
decimal

GET /api_v1/stocks/

Devuelve todos los formatos con el stock calculado.

Respuesta
lista de FormatoStock

GET /api_v1/tarifas

Obtener la lista de tarifas de precios de los artículos.

Respuesta
lista de Tarifa

POST /api_v1/venta/

Obtener venta por sus ids. La petición tiene que contener la lista de ids de venta y esta limitada a 1000 ids.

Petición
lista de string
Respuesta
lista de Venta

GET /api_v1/venta/<venta_id>

Obtener una venta por su id. Ejemplo /api_v1/venta/3d61abd3-d485-2342-7896-50ff691d044c

Respuesta
Venta

GET /api_v1/ventas/<fecha>

Obtener el histórico de ventas para la fecha indicada. Ejemplo /api_v1/ventas/20210615

Respuesta
lista de VentaResumen

GET /api_v1/ventas/<fecha_desde>/<fecha_hasta>

Obtener el histórico de ventas entre las fechas indicadas. El intervalo esta limitado a un año. Ejemplo /api_v1/ventas/20210101/20211231

Respuesta
lista de VentaResumen

GET /api_v1/ventas/<fecha_desde>/<fecha_hasta>/<cliente_id>

Obtener el histórico de ventas entre fechas indicadas (de 0:00 hasta 24:00) para un cliente según su id. Ejemplo /api_v1/ventas/20210101/20210131/3d61abd3-d01d-42d8-ab39-50ff691d044c

Respuesta
lista de VentaResumen