API - Lots

Overview

This API is for the lot table.

Every item entry in Wisefish must be linked to a Lot, because in fact, the Lot makes it possible to “track” items of Wisefish.

It is important to understand that lots are mainly of 2 types:

1. Origin Lots. These are used for stock that comes into the system either with purchase, landing or positive adjustments.

2. Production Lots. These are used for posting the produced items into stock or removing the consumed items out of stock.

Creating, changing and deleting lots

New lots are created with a POST request on the endpoint (see the example Create a new Lot under Examples). Lots can also be changed with PATCH.

The endpoint is not closed for deleting, but Wisefish will not allow the deletion if any trade items have been created on the Lot.

Data

Field List

Object Example

{
    "systemId": "0f8f305a-09dc-f011-b02a-8bca792786d1",
    "code": "COD-LIVER-18-12",
    "description": "Þorsklifur móttekin 18. des",
    "postingStatus": "Open",
    "stockCenterCode": "FROSTI",
    "vesselCode": "",
    "fishingAreaCode": "",
    "fishingTripNo": "",
    "productionType": "Production",
    "startingDate": "2025-12-18",
    "endingDate": "2025-12-18",
    "itemCategoryCode": "",
    "certificationProcess": "Yes",
    "certification": "Certified",
    "systemRowVersion": 2581734,
    "lastModified": "2025-12-18T12:01:58.453Z",
    "modifiedByUser": ""
}

Procedures

Procedures are called on a specific lot: POST lots('<code>')/Microsoft.NAV.<procedureName> with a JSON body of parameters. Each procedure returns a text message in the value property of the response on success. On failure it returns an error with a readable message.

Parameter names are case-sensitive, and the procedure name starts with a capital letter (AddNote).

Notes

Add Note

The procedure AddNote adds a note to the lot. The note is a Business Central Note record link with the description “Sent through API”, and it is registered as from the API user (the user making the call).

POST
.../lots([record-id])/Microsoft.NAV.AddNote

Body:
{
    "noteText": [the text of the note]
}

Possible errors:

• The lot does not exist (standard Business Central error, record not found).

• noteText is longer than 250 characters (standard Business Central error, the text exceeds the parameter length).

Behaviour notes:

• The note text is not validated: an empty noteText is not rejected, an empty note is added.

• The note is a Note type record link with the description “Sent through API”, created with the current date and time.

Notes can be read with the Record Notes API, see API - Record Notes in this space.

Add Note from a User

The procedure AddNoteFromUser works the same way as AddNote, but the note is registered as from the given Business Central user instead of the API user.

POST
.../lots([record-id])/Microsoft.NAV.AddNoteFromUser

Body:
{
    "noteText": [the text of the note],
    "fromUser": [the BC user ID the note is registered from]
}

Possible errors:

• The lot does not exist (standard Business Central error, record not found).

• A parameter is longer than its maximum length (standard Business Central error, the text exceeds the parameter length).

• User with ID <fromUser> does not exist (when fromUser is not found in User Setup)

Behaviour notes:

• fromUser is a code parameter, so the value is converted to upper case: "john" is registered and returned as JOHN.

• If fromUser is empty, no user check is made and the note is registered as from the API user (same as AddNote), but the response text then ends with an empty user ID: Note successfully added and registered from user .

• The note text is not validated: an empty noteText is not rejected.

Examples

Read lots

Read all lots

Reads all lots, both origin lots and production lots. The response is a list of lot objects, as shown in Object Example.

GET .../lots

Read one lot

The record id is the lot number itself, so one entry is read with a GET request on the following format:

GET .../lots('COD-LIVER-18-12')

Read open lots in a stock center

For example, to read all open lots in stock center FROSTI:

GET .../lots?$filter=postingStatus eq 'Open' and stockCenterCode eq 'FROSTI'

Read a lot with its certifications

Adds the certification programs of the lot to the response as the array certifications with $expand=certifications.

GET .../lots('COD-LIVER-18-12')?$expand=certifications

Create, change and delete lots

Create a new Lot

Creates a new lot with a code, description and dates. The code is given in lower case but is stored in upper case.

Request:

POST .../lots

Body:
{
    "code": "cod-liver-21-12",
    "description": "Þorsklifur móttekin 21. des",
    "startingDate": "2025-12-21",
    "endingDate": "2025-12-21"
}

Response:

{
    "@odata.context": "https://containers.wisefish.com/BC/api/wisefish/base/v1.0/$metadata#companies(cf9f7b85-dd11-ef11-9f8b-6045bde9cc61)/lots/$entity",
    "@odata.etag": "W/\"JzE5OzU4MTgwODMxMjM5NTU1NTM5MjAxOzAwOyc=\"",
    "code": "COD-LIVER-21-12",
    "systemId": "4d9188eb-17dc-f011-b02a-8bca792786d1",
    "description": "Þorsklifur móttekin 21. des",
    "postingStatus": "Open",
    "stockCenterCode": "FROSTI",
    "vesselCode": "",
    "fishingAreaCode": "",
    "fishingTripNo": "",
    "itemCategoryCode": "",
    "productionType": " ",
    "startingDate": "2025-12-21",
    "endingDate": "2025-12-21",
    "certificationProcess": "Yes",
    "certification": "",
    "systemRowVersion": 2581802,
    "lastModified": "2025-12-18T13:46:15.247Z",
    "modifiedByUser": ""
}

Change a lot

Changes the ending date of lot COD-LIVER-21-12. A PATCH request needs the If-Match header with the @odata.etag of the record (or *).

Request:

PATCH .../lots('COD-LIVER-21-12')
If-Match: *

Body:
{
    "endingDate": "2025-12-22"
}

Response:

{
    "@odata.context": "https://containers.wisefish.com/BC/api/wisefish/base/v1.0/$metadata#companies(cf9f7b85-dd11-ef11-9f8b-6045bde9cc61)/lots/$entity",
    "@odata.etag": "W/\"JzE5OzQ0NTE2Mzc4OTAxMjM0NTY3ODkwOzAwOyc=\"",
    "systemId": "4d9188eb-17dc-f011-b02a-8bca792786d1",
    "code": "COD-LIVER-21-12",
    "description": "Þorsklifur móttekin 21. des",
    "postingStatus": "Open",
    "stockCenterCode": "FROSTI",
    "vesselCode": "",
    "fishingAreaCode": "",
    "fishingTripNo": "",
    "productionType": " ",
    "startingDate": "2025-12-21",
    "endingDate": "2025-12-22",
    "itemCategoryCode": "",
    "certificationProcess": "Yes",
    "certification": "",
    "systemRowVersion": 2581845,
    "lastModified": "2025-12-18T14:05:31.870Z",
    "modifiedByUser": ""
}

Delete a lot

Deletes lot COD-LIVER-21-12, which has no trade items. On success the response is empty (HTTP status 204 No Content).

DELETE .../lots('COD-LIVER-21-12')

Add notes

Add a Note to a Lot

Adds the note “Quality check completed” to lot LOT0206 with AddNote; the note is registered as from the API user.

POST .../lots('LOT0206')/Microsoft.NAV.AddNote
{
    "noteText": "Quality check completed"
}

Response:
{
    "@odata.context": "https://containers.wisefish.com/BC/api/wisefish/base/v1.0/$metadata#Edm.String",
    "value": "Note successfully added"
}

Add a Note to a Lot from a specific User

Adds the same note to lot LOT0206 with AddNoteFromUser, registered as from user JOHN.

POST .../lots('LOT0206')/Microsoft.NAV.AddNoteFromUser
{
    "noteText": "Quality check completed",
    "fromUser": "JOHN"
}

Response:
{
    "@odata.context": "https://containers.wisefish.com/BC/api/wisefish/base/v1.0/$metadata#Edm.String",
    "value": "Note successfully added and registered from user JOHN"
}

Add a note from a user that does not exist

Calls AddNoteFromUser with a user ID that is not in User Setup; the call fails and no note is added (the error message is shortened).

Request:

POST .../lots('LOT0206')/Microsoft.NAV.AddNoteFromUser
{
    "noteText": "Quality check completed",
    "fromUser": "NOBODY"
}

Response:

{
    "error": {
        "code": "Application_DialogException",
        "message": "User with ID NOBODY does not exist"
    }
}