EP API - Inbound Entries
Endpoint name |
|
Source table in Wisefish |
|
Fixed view | No filter. |
Editable | This API will only insert new entries. |
Procedures | There are no procedures on this endpoint, POST request is used to insert data. (Modify not allowed). |
Primary key of table | Line no. (auto increment integer). Handled internally, sender of data doesn’t have to do anything about it. |
Process
Manufacturing system uses the API to send in data for consumed items and produced materials.
The contents of the request must contain properties from the the Field List below.
Note: Only some of the properties are required, see practical example below regarding production.The entries will be inserted into page Inbound from Innova, where they are visible to users if they have a read permission.
The Job Queue in Wisefish with Batch job "WiFi Innova Flush from Inbound" is running. It performs the posting into Wisefish.
After a successful posting, inventory has been updated. This includes update of the following tables, depending on the contents and type of the request:
Item Ledger Entries
Trade Items
Pallets
If the batch job posting was not successful, the error can be seen in page Inbound from Innova.
The reason for an error might be posting setup missing. When the problem has been fixed, the batch job will re-run the posting.
Data
Field List
Property | Table Field | Type | Notes |
packetId | PacketID | Integer | field that allows external production system to send in a reference to the records sent to wisefish. Can be used for backwards traceability. |
producerId | ProducerID | Text[20] | |
weight | Weight | Decimal | |
quantity | Quantity | Integer | |
quantityUnit | QuantityUnit | Code[10] | |
lotId | LotID | Code[20] | |
itemId | ItemID | Code[20] | (accepts value upto Code[30], but will be truncated to 20 before validating) |
palletNo | PalletNo | Code[20] | |
palletStatus | "Pallet Status" | Option |
|
warehouseId | WarehouseID | Code[20] | |
productionDate | ProductionDate | DateTime | |
orderNo | OrderNo | Code[20] | |
orderLineNo | OrderLineNo | Integer | |
material | Material | Code[20] | |
supplier | Supplier | Code[20] | |
po | Po | Code[20] | (accepts value upto Code[30], but will be truncated to 20 before validating) |
usageDate | UsageDate | Date | |
lotFrom | LotFrom | Code[20] | |
lotTo | LotTo | Code[20] | |
nominal | Nominal | Decimal | Represents “the sales weight” from ext. prod. system. Is optional. |
registrationDate | RegistrationDate | DateTime | |
handledPacketDate | HandledPacketDate | DateTime | |
handledPalletDate | HandledPalletDate | DateTime | |
soapPacketNo | SoapPacketNo | Integer | Obsoleted field |
soapPalletNo | SoapPalletNo | Integer | Obsoleted field |
lotDescription | LotDescription | Text[30] | |
weightUnit | WeightUnit | Code[10] | |
masters | Masters | Decimal | Decimal places 2:5 (minimum 2, maximum 5). |
soapID | SoapID | Text[10] |
|
sscc | SSCC | Code[20] | Pallet number in SSCC format. |
processed | Processed | Boolean | Represents if wisefish has processed (posted) the entry. Irrelevant, because the record is moved to an archive table at the time of posting. |
transactionTable | "Transaction Table" | Option |
|
wPConnectionPK | "WP Connection PK" | BigInteger | Irrelevant, for internal use (WiseFish maps together records containing same basic parameters, in order to consolidate them into fewer entries containing more quantity per entry at the time of posting). |
tripNo | TripNo | Code[20] | Fishing Trip No. |
portNo | PortNo | Code[10] | Number of Harbor that fish was landed into. |
landingType | LandingType | Code[10] | Parameter to determine if fishing trip line is supposed to have normal affect on inventory, salary and quota, or some exceptional affect (such as landed as damaged, thus inventory = 0). |
startDate | "Fishing Trip Start Date" | Date | first date of fishing trip |
endDate | "Fishing Trip End Date" | Date | last date of fishing trip |
aveWeightOfFish | "Average Weight of Fish" | Decimal | Used to populate corresponding field in a fishing trip line, when importing received qty into a fishing trip. (receiving “a landing note” into a fishing trip. |
landingDate | LandingDate | DateTime | the landing date of fishing trip (can be the same as ending date of fishing trip, but not before that). |
catchArea | CatchArea | Code[10] | The formal area where the catch of fishing trip line belongs to. Can be used to affect quota deduction. |
container | Container | Code[20] | Represents a fishing trip (raw material) tub number. |
sizeGrade | SizeGrade | Code[10] | Raw material size grade |
qualityGrade | QualityGrade | Code[10] | raw material quality grade |
reserveToAgreementType | ReserveToAgreementType | Option |
|
reserveToAgreementNo | ReserveToAgreementNo | Code[20] | Document No. |
reserveToAgreementLineNo | ReserveToAgreementLineNo | Integer | Document Line No. |
delAgreeNo | DelAgreeNo | Code[20] | Document No. of sales order (delivery agreement) that this record belongs to. Often used when produced to order. |
delAgreeLnNo | DelAgreeLnNo | Integer | Document Line No. of sales order (delivery agreement). Often used when produced to order. |
shippingRefNo | "Shipping Reference No." | Code[20] | Ability for external prod. system to send this info to wisefish. It is inherited to delivery agreement header in wisefish. |
extDocumentNo | "External Document No." | Code[35] |
|
validateCert | "Validate Incoming Cert" | Option |
|
customer | Customer | Code[20] | Code of customer (relates to sales document) |
currency | Currency | Code[10] | Stands for currency of sales document, codes such as EUR, USD expected. |
salesDate | SalesDate | Date | The date of the sales document. |
salesPrice | SalesPrice | Decimal | The price in a line of a sales document. If the document is in USD, then this price represents USD. |
sealNoexport | "Seal No. (Export)" | Code[20] | Seal number on container. Can be used in sales documents. |
containerNoExport | "Container No. (Export)" | Code[20] | The fixed number of the container in a sales document. |
shippingAgentCode | "Shipping Agent Code" | Code[10] | The shipping company specified in a sales document |
certificationProgram | CertificationProgram | Code[10] | Expected values such as MSC. Used in pelagic factories, as they decide the certification on the fly in the production system. |
originalRecordedWeight | "Original Recorded Weight" | Decimal | The weight originally sent from the production system. Kept for reference. |
processingOption | "Processing Option" | Option | Not relevant, only for internal use of wisefish |
errorMsg | ErrorMsg | Text[200] | internal use in wisefish. If wisefish can not post the record, it will throw an error in this field, stating what is missing/wrong in order for the record to post. |
warning | Warning | Text[50] | Same as errorMsg. |
bestBeforeDate | BestBeforeDate) | Date | the bestBeforeDate |
workCenter | "Work Center" | Code[20] | Becomes a “stage” in posted trade item. |
processingRouteCode | "Processing Route Code" | Code[20] | rarely used. |
palletStartDateTime | "Pallet Start DateTime" | DateTime | Start date/time of pallet. |
palletEndDateTime | "Pallet End DateTime" | DateTime | End date/time of pallet. |
tareWeight | "Tare Weight" | Decimal | Tare weight of pallet. Rarely used. |
Examples
Produced Trade Item
Example of how to send in a produced pack into WiseFish.
After a successful posting by the batch job, inventory has been created and
a new Trade Item exists.
a new Pallet exists
{
"soapID": "107",
"packetId":5145,
"producerId": "A373" ,
"masters": 1,
"weight": 25,
"nominal": 25,
"quantity": 1,
"quantityunit": "PACK",
"itemId": "112600",
"palletNo": "S099000",
"sscc": "00137300000002332307",
"lotid": "2025-12-12",
"warehouseId": "SALT",
"productionDate": "2025-12-12T00:00:00Z",
"registrationDate": "2023-12-12T00:00:00Z"
}
Credit a Produced Trade Item
Example of credit-produced pack coming into to WiseFish.
After a successful posting, inventory has been reduced and
the Trade Item has been deleted.
the Pallet has been deleted
{
"soapID": "123",
"packetId":5145,
"producerId": "A373" ,
"masters": 1,
"weight": 25,
"nominal": 25,
"quantity": 1,
"quantityunit": "PACK",
"itemId": "112600",
"palletNo": "S099000",
"sscc": "00137300000002332307",
"lotid": "2025-12-12",
"warehouseId": "SALT",
"productionDate": "2025-12-12T00:00:00Z",
"registrationDate": "2023-01-02T00:00:00Z"
}
Receiving
Example of fishing trip line coming into to WiseFish.
tripno refers to the number of the fishing trip in WiseFish.
the line in the example is showing one record for cod, 1200 kg landed into warehouse “RawMaterial”, average weight of fish 3.45 kg, vessel no. 2625.
{
"soapID": "108",
"aveWeightOfFish": 3.45,
"endDate": "2024-04-05",
"itemId": "1",
"landingDate": "2024-04-16T00:00:00Z",
"masters": 1,
"productionDate": "2023-08-17T00:00:00Z",
"registrationDate": "2024-04-15T20:10:00Z",
"salesPrice": 982,
"startDate": "2024-04-04",
"supplier": "2625",
"tripno": "900061",
"warehouseId": "RawMaterial",
"weight": 1200
}
Make to order (produce to reserved sale)
Example of production that is “make to order” comming into WiseFish.
soapID 120 is the code used to represent that this is a delivery agreement line.
delAgreeNo and delAgreeLnNo refer to the document number and the line number of the document.
{
"soapID": "120",
"packetId": 14784,
"producerId": "A412",
"masters": 480.0,
"quantity": 1,
"quantityunit": "PACK",
"itemId": "088040",
"lotid": "2414",
"productionDate": "2024-04-04T00:00:00Z",
"registrationDate": "2024-04-04T14:16:00Z",
"warehouseId": "FROST",
"customer": "4310120140",
"delAgreeNo": "pror005292",
"delAgreeLnNo": 14784,
"salesPrice": 7.3,
"currency": "EUR"
//"shippingRefNo": "467234",
//"extDocumentNo": "240404 Novo Food CF2942"
}
$body
Consumption
Example of consumption transaction comming into WiseFish.
soapID 122 is the code used to represent that this is a consumption record.
The example shown on the right side is a consumption record. This works both when consuming products to other products (repacking), and it also works for consumption of raw material.
{
"soapID": "122", // fixed integer. Wisefish will understand that this is regular consumption (to the repacking lot).
"packetId":164895, // prod.systems packet ID. It is optional if this comes along.
"producerId": "MCS" , // If there were more than 1 factory, this would vary.
"masters": 1, // Can be used to indicate how many boxes prod. system is producing, but as motorcity setup has everything defined in LB, then this is just "one production record representing X many LB".
"weight": 24.61, // doesn't apply if dealing with fixed weight (then weight is calculated from the item card's definition).
"quantity": 1, // quantity should be 1. Masters are no. of boxes (outers).
"itemId": "ATL-VER01", // "012416",
"warehouseId": "HIGHLND PK", // inventory (location).
"productionDate": "2025-02-19T00:00:00Z",
"registrationDate": "2025-02-19T23:59:00Z", // have this as date, time. use this as an indication of "when did the EPS (external prod system) send wf this record".
"usageDate": "2025-12-31", // the date of the usage.
"lotFrom": "2504000175", // the lot that has the inventory being used (consumption)
"lotTo": "L1" // the production lot that this is being consumed to.
}