Breadcrumbs

Wisefish Base APIs

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

This solution contains

  • API endpoints needed to work with the main part of the Wisefish system. These are on the base url wisefish/base and allow the user to…

    • read and modify the most general setup of Wisefish

    • read and modify the main master data

    • create agreements (RA, DA, PA) and run the most common procedures on them

    • receive and ship through warehouse documents

    • do some simple inventory methods through journals

  • Change Log feature

    • The user can read the change log in order to monitor which data has been changed, for example master data, and then use the corresponding endpoints to retrieve that data - and mark the change log when data has been read.

  • Field List feature

Identification for this Wisefish API:

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





    Endpoint Groups

    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.

    Endpoint Group

    Contents

    Main Endpoints / examples

    Setup

    Reading the main setup for Wisefish. Stock Centers and Lot Groups can be updated.

    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

    Master data

    Reading and modifying master data. All masterdata records can be updated.

    for example

    1. Customers

    2. Vendors

    3. Vessels

    4. Items

    Inventory

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

    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.

    Example of endpoints:

    1. Inventory

    2. Lots

    3. Trade Items

    4. Pallets

    Trading

    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.

    1. Purchase Agreements

    2. Sales Agreements

    3. Scheduled Trips

    4. Transport Units

    Production

    Production Lots can be created.

    1. Production Lots

    2. Production Agreements

    Warehouse (standard documents)

    For working with the standard warehouse since these are not available in standard Business Central APIs. These documents cannot be modified, but the API is to post the received or shipped items.

    1. Warehouse Receipts (for POs)

    2. Warehouse Shipments (for SOs)

    Fishing

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

    1. Fishing Trips

    2. Product Lines





    Endpoint Overview

    A list of all endpoints in the system

    Wisefish API Endpoint Overview


    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