Base APIs - Endpoint Overview

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.

Endpoint	Description	Requests available				Procedures
1. Setup
`userProfiles`	Wisefish User Profiles	`GET`		`PATCH`
`locations`	Locations	`GET`
`stockCenters`	Stock Centers with Certification Program Registers.	`GET`	`POST`	`PATCH`	`DELETE`	`POST /createOriginLot` `POST /createProductionLot`
`fishingAreas`	Fishing Areas	`GET`	`POST`	`PATCH`	`DELETE`
`landingTypes`	Landing Types	`GET`	`POST`	`PATCH`	`DELETE`
`itemCategories`	Item categories.	`GET`	`POST`	`PATCH`	`DELETE`
`processingStages`	Processing Stages	`GET`	`POST`	`PATCH`	`DELETE`
`rawMaterialSQGrades`	Raw Material Size Quality Grades	`GET`	`POST`	`PATCH`	`DELETE`
2. Master data
`customers`	Customers, the most important fields.	`GET`	`POST`	`PATCH`	`DELETE`
`vendors`	Vendors	`GET`	`POST`	`PATCH`	`DELETE`
`vessels`	Vessels	`GET`	`POST`	`PATCH`	`DELETE`
`items`	Items, a simple list.	`GET`
`itemDetails`	Items with units and variants and the most important fields.	`GET`	`POST`	`PATCH`	`POST`
`itemUnits`	Item units. Used as child-entries on `itemDetails`	`GET`	`POST`	`PATCH`	`DELETE`
`itemVariants`	Item variants. Used as child-entries on `itemDetails`	`GET`	`POST`	`PATCH`	`DELETE`
`certificationPrograms`	The Certification Program Register. Used as child-entries on other endpoints.	`GET`	`POST`	`PATCH`	`DELETE`
3. Inventory
`inventoryItems`	List of inventory items with quantity in stock API - Item Inventory	`GET`				`POST /transferQtyToLocation` `POST /transferQtyToLocationAndBin`
`lots`	Lots with catch origin and certifications.	`GET`	`n/a`	`PATCH`	`DELETE`	See procedure on `stockCenters` to create
`lotCertifications`	Certification Programs for a Lot	`GET`	`POST`	`PATCH`	`DELETE`
`lotGroups`	Lot Groups. These are groups to be added on Lots.	`GET`	`POST`	`PATCH`	`DELETE`
`openTradeItems`	Trade Items available in the warehouse.	`GET`
`pallets`	Pallets	`GET`
4. Purchase & Sales
`purchaseAgreements`	Purchase Agreements that have not been posted, with type = Receipt API - Purchase Agreements	`GET`	`POST`	`PATCH`	`DELETE`	Procedures are available to do the most general actions: `POST /release` `POST /reopen` `POST /createPostingDocument` `POST /receiveItems`
`purchaseAgreementLines`	Purchase Agreement Lines, with type = Receipt. API - Purchase Agreement Lines	`GET`	`POST`	`PATCH`	`DELETE`
`closedPurchaseAgreements`	Closed Purchase Agreements, with type = Receipt Lines are shown with `$expand=purchaseAgreementLines`	`GET`
`salesAgreements`	Sales Agreements, with type = Delivery Lines are shown with `$expand=salesAgreementLines`	`GET`	`POST`	`PATCH`	`DELETE`	`POST /release` `POST /reopen` `POST /createAndPostSalesDocument` `POST /suggTIsReservIntoAgr` `POST /syncToReserved` TO-DO: methods came from Lava, TEST! do we want to post as well? have 2 options?
`salesAgreementLines`	Sales Agreement Lines, with type = Delivery	`GET`	`POST`	`PATCH`	`DELETE`	Methods are given for easier usage (instead of PATCH): `POST /updateQuantity` `POST /updateUnitPrice` `POST /updateQuantityAndUnitPrice`
`closedSalesAgreements`	Closed Sales Agreements, with type = Delivery	`GET`
`extendedTexts`	Extended texts can be added on agreements.	`GET`	`POST`	`PATCH`	`n/a`
`scheduledTrips`	Scheduled trips.	`GET`				This could be modified to allow changes.
`transportUnits`	Transport Units.	`GET`				This could be modified to allow changes.
5. Production
`productionLots`	Production lots.	`GET`	`POST`	`PATCH`	`DELETE`	`POST /consumeItem` `POST /procudeItem` There is also a procedure on `stockCenters` to create a new lot.
`productionAgreements`	TO DO
6. Warehouse (std)
`warehouseReceipts`	Warehouse Receipts, i.e. the standard documents created for standard Purchase Orders API - Warehouse Receipts	`GET`				`POST /receiveItem` `POST /receiveItemToBin`
`warehouseShipments`	Warehouse Shipments, i.e. the standard documents created for standard Sales Orders	`GET`				`POST /shipItem` `POST /shipItemFromBin`
7. Change Log
`changeLogEntries`	The module logs changes on the main tables	`GET`				`POST /markAsRead`

1. Setup

2. Master data

3. Inventory

4. Purchase & Sales

5. Production

6. Warehouse (std)

7. Change Log