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
POST /api_v1/deudas/
Obtener lista de deudas por interlocutor o subcuenta.
- Petición
- FiltroTesoreria
- Respuesta
- lista de Deuda
GET /api_v1/diario/<fecha_hasta>
Obtener el diario contable del ejercicio hasta la fecha indicada. Indica la fecha en el formato YYYYMMDD. Los asientos confirmados se quedan bloqueados en la contabilidad de winfra.
Utilice app_id (/diario/fecha_hasta/app_id) si NO desea bloquear la contabilidad.
Utilice /api_v1/diario/confirmar/<peticion_id> para confirmar la obtención de los asientos. En la próxima llamada obtendrá solo asientos nuevos o modificados.
Ejemplo: /api_v1/diario/20200615.
- Respuesta
- Diario
GET /api_v1/diario/<fecha_hasta>/<app_id>
Obtener el diario contable del ejercicio hasta la fecha indicada para una aplicación determinada. Indica la fecha en el formato YYYYMMDD.
Indica el código de la aplicación que recibe datos: Una cadena de hasta 50 caracteres.
Utilice /api_v1/diario/confirmar/<peticion_id> para confirmar la obtención de los asientos. En la próxima llamada obtendrá solo asientos nuevos o modificados.
Al confirmar los asientos se quedan marcados como transmitidos solo para la aplicación indicada.
Ejemplo: /api_v1/diario/20200615/BI.
- Respuesta
- Diario
GET /api_v1/diario/confirmar/<peticion_id>
Confirmar la recepción del diario contable. Tiene que confirmar el diario después de cada llamada, solo se puede confirmar la ultima llamada a /diario/.
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:
POST /api_v1/actualizar_cliente/
Dar de alta o actualizar clientes.
- Petición
- lista de ActualizacionCliente
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
GET /api_v1/ficha_completa/<cliente_id>
Obtener la lista de fichas de formatos que el cliente suele comprar.
- Respuesta
- lista de ArticuloFicha
GET /api_v1/modelo347/<ejercicio>/<idfiscal>
Obtiene información para la declaración del modelo 347 para el ejercicio e identificación fiscal. Ejemplo /api_v1/modelo347/2021/3d61abd3-d485-2342-7896-50ff691d044c.
- Respuesta
- lista de Modelo347
GET /api_v1/modelo347_validar/<id>
Validar las cantidades a declarar. Permite al cliente dar la conformidad con las cantidades a declarar. Indica el id del registro del modelo 347 que quiere confirmar. Ejemplo /api_v1/modelo347_validar/7205e4eb-4606-11ec-a736-fa163e6ae230.
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_simular/
Permite hacer una valoración del pedido desde el sistema CRM sin subirlo a Winfra. A diferencia de /pedidocrm_valorar/ no crea un transaccion_id y solo sirve para obtener la valoración. Para grabar el pedido tiene que llamar a /pedidocrm_valorar/ y /pedidocrm_confirmar/ o guardar pedido directamente con /pedidocrm/ según la configuración de la tienda de winfra.
POST /api_v1/pedidocrm_valorar/
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/articulos_lotes_cliente/<cliente_id>
Obtener los lotes vigentes para el cliente identificado por su cliente_id.
- Respuesta
- lista de ArticuloLote
GET /api_v1/articulos_lotes_cliente/<cliente_id>/imagenes
Obtener los lotes vigentes para el cliente identificado por su cliente_id. La respuesta incluye las imágenes de los lotes.
- Respuesta
- lista de ArticuloLote
GET /api_v1/cliente_tipos/
Obtener la lista de tipos de clientes.
- Respuesta
- lista de TipoCliente
POST /api_v1/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/compras/<fecha_desde>/<fecha_hasta>
Obtener el histórico de compras entre fechas indicadas (de 0:00 hasta 24:00). Ejemplo /api_v1/compras/20210101/20210131/3d61abd3-d01d-42d8-ab39-50ff691d044c
- Respuesta
- lista de CompraResumen
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
POST /api_v1/descuentos/
Obtener la lista de descuentos de precios de los artículos según el filtro indicado.
- Petición
- FiltroDescuentos
- Respuesta
- lista de Descuento
GET /api_v1/factura_imprimir/<vcid>
Obtener impresión (documento PDF) de una factura por su id. Ejemplo /api_v1/factura_imprimir/7283c2e3-4306-11ed-9bd7-fa163ee51b9d.
GET /api_v1/informe_grupos/
Obtener la estructura de la agrupación para informe asociado a la tienda.
- Respuesta
- lista de InformeGrupo
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
GET /api_v1/movimientos/<fecha_desde>/<fecha_hasta>
Devuelve todos los movimientos de almacen entre dos fechas indicadas. Ejemplo /api_v1/movimientos/20210101/20211231
- Respuesta
- lista de MovimientoAlmacen
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>
GET /api_v1/stock/<formato_id>/<cliente_id>
Devuelve el stock actual del Formato indicado por su formato_id. El cliente_id es opcional, si esta indicado el stock es de almacen al que pertenece el cliente.
Ejemplo: /api_v1/stock_actual/3b3ab89d-427f-7563-9863-87644d89e8bd o /api_v1/stock_actual/3b3ab89d-427f-7563-9863-87644d89e8bd/3d61abd3-d01d-42d8-ab39-50ff691d044c
- Respuesta
- decimal
GET /api_v1/stock_actual/<formato_id>
GET /api_v1/stock_actual/<formato_id>/<cliente_id>
Devuelve el stock actual del Formato indicado por su formato_id El cliente_id es opcional, si esta indicado el stock es de almacen al que pertenece el cliente.
Ejemplo: /api_v1/stock_actual/3b3ab89d-427f-7563-9863-87644d89e8bd o /api_v1/stock_actual/3b3ab89d-427f-7563-9863-87644d89e8bd/3d61abd3-d01d-42d8-ab39-50ff691d044c
- Respuesta
- FormatoStock
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/tarifas/
Obtener lista de tarifas de precios según el filtro indicado. La tarifa corresponde al interlocutor de tipo cliente indicado en el filtro.
- Petición
- FiltroTarifas
- Respuesta
- lista de Tarifa
POST /api_v1/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/venta_imprimir/<venta_id>
Obtener impresión (documento PDF) de una venta por su id. Ejemplo /api_v1/venta_imprimir/3d61abd3-d485-2342-7896-50ff691d044c
- Respuesta
- binary stream PDF file
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
GET /api_v1/ventas_facturas/<fecha_desde>/<fecha_hasta>
Obtener el histórico de facturas de venta entre fechas indicadas (de 0:00 hasta 24:00). Ejemplo /api_v1/ventas_facturas/20210101/20210131
- Respuesta
- lista de VentaFactura
GET /api_v1/ventas_facturas/<fecha_desde>/<fecha_hasta>/<cliente_id>
Obtener el histórico de facturas de venta entre fechas indicadas (de 0:00 hasta 24:00) y para el cliente indicado. Ejemplo /api_v1/ventas_facturas/20210101/20210131/3d61abd3-d01d-42d8-ab39-50ff691d044c
- Respuesta
- lista de VentaFactura
GET /api_v1/ventas_todo/<fecha>
Obtener el histórico de ventas de cualquier tipo de documento y cualquier estado para la fecha indicada. Ejemplo /api_v1/ventas/20210615
- Respuesta
- lista de VentaResumen
GET /api_v1/ventas_todo/<fecha_desde>/<fecha_hasta>
Obtener el histórico de ventas de cualquier tipo de documento y cualquier estado 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_todo/<fecha_desde>/<fecha_hasta>/<cliente_id>
Obtener el histórico de ventas de cualquier tipo de documento y cualquier estado 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
Publicaciones
Indica el nombre de api publicaciones para acceder a los siguientes servicios:
GET /api_v1/publicacion/<fecha_publicacion>/
Obtener la lista de precios de artículos publicados en la fecha indicada. Ejemplo /api_v1/publicaciones/020231001/
- Respuesta
- lista de ArticuloPublicacion
GET /api_v1/publicaciones/
Obtener las distintas fechas en que ha habido publicaciones del catálogo predeterminado. Ejemplo /api_v1/publicaciones/
- Respuesta
- lista de datetime
Xxl
Para mas información haz click en descarga de datos masiva.
Indica el nombre de api xxl para acceder a los siguientes servicios:
GET /api_v1/datos_xxl/<peticion_id>/<dataset>
GET /api_v1/datos_xxl/<peticion_id>/<dataset>/<offset>/<limit>
Obtener datos masivo generados, el tipo de datos depende del dataset indicado. Opcionalmente puede indicar offset (posición desde la que va a obtener registros, 0 para el primer registro) y limit (número de registros obtenidos). Comprueba el estado de la petición para saber el numero total de los registros.
GET /api_v1/estado_xxl
Obtener lista de estados de todas las peticiones de generación de los conjuntos de datos. La lista esta ordenada por fecha y hora, la última petición esta primera. Las peticiones se eliminan después de 12 horas.
- Respuesta
- lista de EstadoGenerarXXL
GET /api_v1/estado_xxl/<peticion_id>
Obtener estado de la petición de generación de los conjuntos de datos según su peticion_id.
- Respuesta
- EstadoGenerarXXL
POST /api_v1/generar_xxl
Añadir a la cola una generación de descarga masiva de los datos.Puede indicar una lista de conjuntos de datos con sus parámetros para generar.
- Petición
- lista de PeticionGenerarXXL
- Respuesta
- EstadoGenerarXXL