Breadcrumbs

Wisefish Base APIs

This chapter is about the APIs in the Wisefish APIs addon in Wisefish.

It contains endpoints for reading the most general setup of Wisefish, reading and modifying the main master data as well as running the most general procedures on agreements (RA, DA, PA). Finally it allows doing some simple inventory methods.

This API add-on has various methods for reading and updating Wisefish:

  1. Reading setup data, for example User Profiles, Locations and Stock Centers

  2. Reading and modifying master data, for example Items, Customers and Vendors

  3. Reading inventory status and doing some general methods, like adjusting inventory and transferring stock between locations

  4. Working with buying and selling, i.e. reading and inserting new agreements. Procedures for the most general actions, such as releasing, creating a posting document and posting the inventory change. For the logistics related to sales, there are endpoints for Scheduled Trips and Transport Units as well as for the most important actions.

  5. Finally, there are endpoints for working with the standard warehouse since these are not available in standard Business Central APIs.

Identification for this Wisefish API:

Publisher : wisefish
API Group : base
Version: v1.0




Contents

On page Base APIs - Endpoint Overview there is a detailed list of all the endpoints with a link to a documentation for each of them, but here is a short list of the main data tables included.

APIS

Main Endpoints / data

Notes

Setup

  1. User Profiles

  2. Locations and stock centers

  3. Inventory setup tables: Item categories, lot groups, raw material size groups etc.

  4. Fishing setup tables: Areas, harbors, equipment and landing types

Stock Centers and Lot Groups can be updated.

Master data

  1. Customers

  2. Vendors

  3. Vessels

  4. Items

All these can be updated.

Inventory

  1. Inventory

  2. Lots

  3. Trade Items

  4. Pallets

To get the list of inventory, either per item or trade item.

Lots can be updated.

Pallets can be created, and then ready to get trade items via inventory posting.

Trading

  1. Purchase Agreements

  2. Sales Agreements

  3. Scheduled Trips

  4. Transport Units

Unposted agreements can be modified

and most important methods can be run, such as release, create posting document

Production

  1. Production Lots

  2. Production Agreements

Production Lots can be created.

Warehouse (standard documents)

  1. Warehouse Receipts (for POs)

  2. Warehouse Shipments (for SOs)

These document cannot be modified, but the API is to post the received or shipped items.

Fishing

  1. Fishing Trips

  2. Product Lines

These endpoints are only available if the Fishing module is installed.




APIS

Main Endpoints / data

Notes

Change Log




Installation

Wisefish API

By installing this app, this becomes available:

  • most of the data endpoints

  • the change log

  • endpoint overview within BC

Fishing & Quota

By installing this, the endpoints in group “Fishing” are added. They have the same base url: wisefish/base