This is an overview of the available endpoints. For each base path, there is a sub-page with more information.
-
Some data is non-editable because the data must always be set up within BC.
-
In some cases, new entries can only be created with a specific procedures, for example Lots.
-
Even if there is a POST, PATCH, DELETE option, the data is only editable, as long as it is still editable within Wisefish. For example, if a status does of an entry does not allow changes in BC, the functionality is the same when trying to modify with an API.
API groups
Identification for the Wisefish core APIs:
Publisher : wisefish
API Group : base
Version: v1.0
|
Endpoint |
Description |
Link to Documentation |
Requests available |
Procedures available |
|||
1. Setup
|
|
|
|
|
|
|
|
|
|
Wisefish User Profiles
|
|
|
|
|
|
|
|
|
Locations
|
|
|
|
|
|
|
|
|
Stock Centers with Certification Program Registers. |
|
|
|
|
For creating lots and pallets. |
|
|
|
Processing Stages |
|
|
|
|
|
|
|
|
Item Categories |
|
|
|
|
|
|
|
|
Fishing Areas |
|
|
|
|
|
|
|
|
Landing Types |
|
|
|
|
|
|
|
|
Raw Material Size Quality Grades |
|
|
|
|
|
|
2. Master data
|
|
|
|
|
|
|
|
|
|
Customers, the most important fields. |
|
|
|
|
For adding notes. |
|
|
|
Ship-to Addresses for Customers |
|
|
|
|
|
|
|
|
Vendors |
|
|
|
|
For adding notes. |
|
|
|
Vessels |
|
|
|
|
|
|
|
|
Items, a simple list with the description of the item, unit of measure and prices.
|
|
|
|
|
For adding notes. |
|
|
|
Items with units and variants and the most important fields. |
|
|
|
|
|
|
|
|
Item units.
|
|
|
|
|
|
|
|
|
Item variants. Attached as child-entries on |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
The Certification Program Register.
|
|
|
|
|
|
|
|
|
Comments, used as child entries on other endpoints. |
|
|
|
|
|
|
3. Inventory
|
|
|
|
|
|
|
|
|
|
Lots with catch origin and certifications. Origin lots from fishing will have info like vessel, landing date and fishing equipment. |
|
|
|
|
For adding notes. |
|
|
|
Certification Programs for a Lot |
|
|
|
|
|
|
|
|
Lot Groups. These are groups to be added on Lots. |
|
|
|
|
|
|
|
|
List of inventory items with quantity in stock. The table behind this is “Item” so there will always be just one entry per item number. |
|
|
|
|
To transfer inventory between locations. |
|
|
|
These are Trade Items available in stock. The entries from table “Open Trade Item“. This can have multiple entries per item number and lot. |
|
|
|
|
For palletizing and splitting trade items. |
|
|
|
These are all Trade Items, that have been removed from stock. They might have been sold, consumed or credited (scrapped).
(The entries are from table “Trade Item Ledger Entry“ with a filter on Closing Type not blank.) |
|
|
|
|
|
|
|
|
Totals per item, lot and closing type. |
|
|
|
|
|
|
|
|
Pallets, with items. |
|
|
|
|
To reserve, load and add/remove trade items. |
|
|
|
An endpoint to create a new pallet with a given barcode. |
|
|
|
|
|
|
4. Trading (Purchase & Sales)
|
|
|
|
|
|
|
|
Purchases
|
|
|
|||||
|
|
Purchase Agreements that have not been posted, with type = Receipt/Blanket |
|
|
|
|
To change status, create posting document and post the receipt. |
|
|
|
Purchase Agreement Lines, with type = Receipt/Blanket. |
|
|
|
|
|
|
|
|
Closed Purchase Agreements, with type = Receipt/Blanket
|
|
|
|
|
|
|
Sales
|
|
|
|||||
|
|
Delivery Agreements + Blankets, no matter of the Status. These are all entries in the table and therefore the endpoint does not allow insert, modify and delete. But procedures are available but will return an error if not allowed.
|
|
|
|
|
To change status, create posting document and post the shipment.
|
|
|
|
Delivery Agreements + Blankets, but only the open agreements that can be modified. |
|
|
|
|
Same as on |
|
|
|
Delivery Agreements + Blankets which are closed, i.e. with Status = Posting|Closed |
|
|
|
|
|
|
|
|
The lines on Delivery Agreements + Blankets Contains various endpoint procedures to simplify modifications and reserve items to sell.
|
|
|
|
|
To update certain fields and handle reservation of trade items/pallets. |
|
|
|
Extended texts can be added on agreements. |
|
|
|
|
|
|
Logistics
|
|
|
|||||
|
|
Scheduled trips. |
|
|
|
|
|
|
|
|
Transport Units. |
|
|
|
|
|
|
5. Production & Tracing
|
|
|
|
|
|
|
|
|
|
Origin lots.
|
|
|
|
|
|
|
|
|
Production lots.
|
|
|
|
|
To create item journals for output and consumption. Note: Use |
|
|
|
List of origin, which can be used as a child object on productionLots |
|
|
|
|
|
|
|
|
Trade Item Output Journal. Here the produced items are inserted.
|
|
|
|
|
|
|
|
|
Trade Item Consumption Journal. Here the consumed items are inserted. |
|
|
|
|
|
|
|
|
Posted consumption |
|
|
|
|
|
|
|
|
Posted consumption |
|
|
|
|
|
|
6. Warehouse
|
|
|
|
|
|
|
|
Standard
|
|
|
|
|
|
|
|
|
|
Receiving items on purchase orders, without using Warehouse Receipts |
|
|
|
|
To post the receipt |
|
|
|
The lines for |
|
|
|
|
To update quantity to receive and Bin. To create item tracking. |
|
|
|
Warehouse Receipts, usually related to purchase orders |
|
|
|
|
To receive items, with or without a Bin. |
|
|
|
The lines for |
See |
|
|
|
|
|
7. Fishing & Quota
|
|
|
|
|
|
|
|
|
|
Fishing Trips |
|
|
|
|
|
|
|
|
Raw material lines on fishing trips |
|
|
|
|
|
|
|
|
Product lines on fishing trips |
|
|
|
|
|
|
|
|
Production lines on fishing trips |
|
|
|
|
|
|
8. Change Log + more
|
|
|
|
|
|
|
|
|
|
The module logs changes on the main tables |
|
|
|
|
|
To mark entry as read. |
|
|
Add notes on any record. |
|
|
|
|
|
|