External Production API - User Documentation

This documentation is about the APIs in the External Production addon in Wisefish.

Main Features of this API Extension

Reading master files from Wisefish, such as:

Reading Sales Agreements
Reading Production Agreements
Read Items,
Read Lots, both origin lots and production lots

Writing transactions in real time (post) into Wisefish, such as:

Receiving raw material (into fishing trip or Receipt Agreement).
Recording consumption (of raw material or WIP products)
Production transactions (by far the most used feature of this API). This can be production to stock; with or without an order (production or sales order).

Most of these endpoints only read data from the Business Central Wisefish system, but do not allow any data modifications.

Identification for the Wisefish API:

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

Table of Contents

Endpoint Overview

Endpoint	Description	Details	Methods	Read / Insert / Modify / Delete
`companyInformations`	Company Information	EP API - Company Information	`GET`	READONLY
`rmOfficialReportings`	Raw Material official reporting codes.	EP API - RM Official Reporting Codes	`GET`	READONLY
`items`	Items with units and variants and the most important Wisefish fields.	EP API - Items	`GET`	READONLY
`itemUnitOfMeasures`	Item units.	EP API - Item Units of Measure	`GET`	READONLY
`itemTranslations`	Translations for the item table.	EP API - Item Translations	`GET`	READONLY
`externalItems`	External item numbers.	EP API - External Items	`GET`	READONLY
`extItemLabelSelections`	External item label selection. The list is filtered on "Type of Ext. Party" = Customer.	EP API - External Item Label Selection	`GET`	READONLY
`lots`	Origin lots.	EP API - Lots	`GET`	READONLY
`productionLots`	Lots with Production Type = Production.	EP API - Production Lots	`GET`	READONLY
`processingMethods`	Processing methods	EP API - Processing Methods
`salesAgreementHeaders`	Sales Agreements, with type = Delivery Lines are returned as child objects with `$expand=salesAgreementLines`	EP API - Sales Agreements	`GET`	READONLY
`salesAgreementLines`	Sales Agreement Lines, with type = Delivery Existing lines, can be modified, but insert and delete is not allowed.	EP API - SalesAgreementLines	`GET`	RM
`productionAgreements`	Production Agreements. Lines are returned as child objects with `$expand=productionAgreementLines`	EP API - Production Agreements	`GET`	READONLY
`productionAgreementLines`	Production Agreement Lines.	EP API - Production Agreement Lines	`GET`	READONLY
`inboundInnovaEntries`	This endpoint is used to import data into Wisefish in order to post items either as consumed or produced.	EP API - Inbound Entries	`POST`	RI

Example Usage

Request

JSON

GET
[server]/api/wisefish/wiFiEP/v1.0/companies([CompanyGUID])/[endpoint]

Example:
To get the origin Lots:

CODE

https://containers.wisefish.com/BC24BjarteyW1CU1rest/api/wisefish/wiFiEP/v1.0/companies(cf9f7b85-dd11-ef11-9f8b-6045bde9cc61)/lots

Filtering

A filter is added with $filter. An example of how a filter is added:

NONE

https://containers.wisefish.com/BC24BjarteyW1CU1rest/api/wisefish/wiFiEP/v1.0/companies(cf9f7b85-dd11-ef11-9f8b-6045bde9cc61)/itemUnitOfMeasures?$filter=itemNo eq '70070'

Response

The data is returned as JSON.

JSON

$body