API - Production Lots

Overview

This API is for the lot table but with a fixed filter on Production Lots. New production lots can be created and there are procedures to create journal lines for both the produced items and the consumption.

Instead of the procedures below, the endpoints outputJournalLines (produced items) and consumptionJournalLines (consumption) can be used to create the journal lines.

Creating, changing and deleting production lots

New production lots are created with a POST request on the endpoint (see the example Create a Production Lot under Examples). Production lots can also be changed with PATCH and deleted with DELETE.

The procedures produceItem and consumeItem only create journal lines. The journal lines must be posted afterwards in Wisefish.

Data

Field List

Object Example

{
    "systemId": "06df22ff-2dd0-f011-8542-000d3a679afe",
    "code": "LOT251203-1",
    "description": "Production 3nd Dec - Lot 1",
    "lotGroup": "BOILING",
    "postingStatus": "Open",
    "stockCenterCode": "AA",
    "itemCategoryCode": "",
    "activeInProduction": true,
    "productionType": "Production",
    "startingDate": "2025-12-03",
    "startingTime": "00:00:00",
    "startingDateTime": "2025-12-03T00:00:00Z",
    "endingDate": "2025-12-03",
    "endingTime": "00:00:00",
    "endingDateTime": "2025-12-03T23:59:59.997Z",
    "processingStage": "",
    "allowedRawMaterial": "",
    "landingDate": "2025-12-03",
    "vesselCode": "",
    "fishingTripNo": "",
    "certificationProcess": "No",
    "certification": "",
    "systemRowVersion": 2581734,
    "lastModified": "2025-12-03T09:54:03.287Z",
    "modifiedByUser": ""
}

Lot Certification

The child object lotCertification (array certifications) lists the certification programs registered on the lot. It is read with $expand=certifications.

Procedures

Procedures are called on a specific production lot: POST productionLots('<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 names start with a lower-case letter (produceItem, consumeItem).

Journal Lines

Produce Item

This is an endpoint to easily add a line to the Trade Item Output Journal.

POST .../productionLots([lotNumber])/Microsoft.NAV.produceItem

Body:
{
    "itemNumber": "[Item.No.]",
    "quantity": [Quantity],
    "unitOfMeasure": [Unit of measure],
    "location": "[Location Code]"
}

Possible errors:

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

• The output of a production lot needs to be a Trade Item! (when the item is not a trade item)

• Lot is not a production lot!

• The lot has no Processing Stage (standard Business Central error, Processing Stage must have a value).

• No Output journal template or batch exists (standard Business Central error, record not found).

• The location, item, quantity or unit of measure is not valid for the journal line (standard Business Central validation errors).

Behaviour notes:

• The line is created in the first non-recurring journal template of type Output and its first non-recurring batch.

• Posting Date and Production Date of the line are set to today's date, and the stage of the line is the Processing Stage of the lot.

• The line is only created, not posted.

Consume Item

This is an endpoint to easily add a line to the Trade Item Consumption Journal.

POST .../productionLots([lotNumber])/Microsoft.NAV.consumeItem

Body:
{
    "itemNumber": "[Item.No.]",
    "quantity": [Quantity],
    "unitOfMeasure": [Unit of measure],
    "location": "[Location Code]"
}

Possible errors:

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

• TODO - HOW TO consume a standard item !?! (when the item is not a trade item)

• Location must be given to find trade item to consume!

• Unit of Measure must be given to find trade item to consume. This can be either the base unit of the trade item unit!

• Lot is not a production lot!

• The lot has no Processing Stage (standard Business Central error, Processing Stage must have a value).

• The API user has no User Setup, no WiFi User Profile Code, or the User Profile has no Stock Center Code (standard Business Central errors).

• Trade Item not found that matches the parameters! %1 (%1 is the filters used in the search)

• No Consumption journal template or batch exists (standard Business Central error, record not found).

Behaviour notes:

• The search is for a trade item of the item in the stock center of the User Profile of the API user, with status posted, not reserved on an agreement and not unavailable, where the trade item unit is unitOfMeasure. The first trade item found is used.

• quantity and location are not used in the search. The quantity, location, stage and unit of the journal line are taken from the trade item found.

• The line is consumed to the production lot and its Processing Stage, with Posting Date today's date.

• The line is created in the first non-recurring journal template of type Consumption and its first non-recurring batch. The line is only created, not posted.

Examples

The URLs below are relative to .../api/wisefish/base/v1.0/companies([company-id])/.

Read production lots

Read all production lots

Reads all production lots (lots where productionType is not blank). The response is a list of objects, as shown in Object Example.

GET .../productionLots

Read one production lot

The record id is the lot number itself:

GET .../productionLots('LOT251203-1')

Read open production lots in a processing stage

For example, all open production lots in processing stage SOÐIÐ:

GET .../productionLots?$filter=postingStatus eq 'Open' and processingStage eq 'SOÐIÐ'

Read selected properties of production lots

Reads only the lot number, description and dates of the lots that are active in production:

GET .../productionLots?$filter=activeInProduction eq true&$select=code,description,startingDate,endingDate

Read a production lot with its certifications

Adds the certification programs of the lot to the response as the array certifications:

GET .../productionLots('LOT251203-1')?$expand=certifications

Response:

{
    "@odata.context": "https://containers.wisefish.com/BC/api/wisefish/base/v1.0/$metadata#companies(cf9f7b85-dd11-ef11-9f8b-6045bde9cc61)/productionLots(certifications())/$entity",
    "@odata.etag": "W/\"JzE5OzEyMzQ1Njc4OTAxMjM0NTY3ODkwOzAwOyc=\"",
    "systemId": "06df22ff-2dd0-f011-8542-000d3a679afe",
    "code": "LOT251203-1",
    "description": "Production 3nd Dec - Lot 1",
    "lotGroup": "BOILING",
    "postingStatus": "Open",
    "stockCenterCode": "AA",
    "itemCategoryCode": "",
    "activeInProduction": true,
    "productionType": "Production",
    "startingDate": "2025-12-03",
    "startingTime": "00:00:00",
    "startingDateTime": "2025-12-03T00:00:00Z",
    "endingDate": "2025-12-03",
    "endingTime": "00:00:00",
    "endingDateTime": "2025-12-03T23:59:59.997Z",
    "processingStage": "",
    "allowedRawMaterial": "",
    "landingDate": "2025-12-03",
    "vesselCode": "",
    "fishingTripNo": "",
    "certificationProcess": "Yes",
    "certification": "Certified",
    "systemRowVersion": 2581734,
    "lastModified": "2025-12-03T09:54:03.287Z",
    "modifiedByUser": "",
    "certifications": [
        {
            "@odata.etag": "W/\"JzE4OzU1NTY2Nzc4ODk5MDAxMTIyMzswMDsn\"",
            "systemId": "1a2b3c4d-2dd0-f011-8542-000d3a679afe",
            "lot": "LOT251203-1",
            "entryId": 1052,
            "cpCode": "MSC",
            "certificationType": "Certified",
            "description": "MSC certified",
            "type": "MSC",
            "systemRowVersion": 2581740,
            "lastModified": "2025-12-03T10:02:11.120Z"
        }
    ]
}

Create, change and delete production lots

Create a Production Lot

To create a production lot with a specific number:

POST .../productionLots

{
    "code": "LOT251222-A",
    "processingStage" : "SOÐIÐ",
    "startingDate": "2025-12-22",
    "description": "Production A - Dec 22"
}

Change a production lot

Sets the processing stage of lot LOT251203-1. A PATCH request needs the If-Match header with the @odata.etag of the record (or *).

Request:

PATCH .../productionLots('LOT251203-1')
If-Match: *

Body:
{
    "processingStage": "SOÐIÐ"
}

Response:

{
    "@odata.context": "https://containers.wisefish.com/BC/api/wisefish/base/v1.0/$metadata#companies(cf9f7b85-dd11-ef11-9f8b-6045bde9cc61)/productionLots/$entity",
    "@odata.etag": "W/\"JzE5OzQ0NTE2Mzc4OTAxMjM0NTY3ODkwOzAwOyc=\"",
    "systemId": "06df22ff-2dd0-f011-8542-000d3a679afe",
    "code": "LOT251203-1",
    "description": "Production 3nd Dec - Lot 1",
    "lotGroup": "BOILING",
    "postingStatus": "Open",
    "stockCenterCode": "AA",
    "itemCategoryCode": "",
    "activeInProduction": true,
    "productionType": "Production",
    "startingDate": "2025-12-03",
    "startingTime": "00:00:00",
    "startingDateTime": "2025-12-03T00:00:00Z",
    "endingDate": "2025-12-03",
    "endingTime": "00:00:00",
    "endingDateTime": "2025-12-03T23:59:59.997Z",
    "processingStage": "SOÐIÐ",
    "allowedRawMaterial": "",
    "landingDate": "2025-12-03",
    "vesselCode": "",
    "fishingTripNo": "",
    "certificationProcess": "No",
    "certification": "",
    "systemRowVersion": 2581802,
    "lastModified": "2025-12-03T10:15:42.517Z",
    "modifiedByUser": ""
}

Delete a production lot

Deletes lot LOT251222-A. On success the response is empty (HTTP status 204 No Content).

DELETE .../productionLots('LOT251222-A')

Create journal lines

Add a produced trade item to the output journal

Creates an output journal line for 3 KASSI of item 80216-T on lot PROD-LOT-007 with produceItem.

POST .../productionLots('PROD-LOT-007')/Microsoft.NAV.produceItem

Body:
{
    "itemNumber": "80216-T",
    "quantity": 3,
    "unitOfMeasure": "KASSI",
    "location": "FACTORY"
}

Response:

{
    "@odata.context": "https://containers.wisefish.com/BC/api/wisefish/base/v1.0/$metadata#Edm.String",
    "value": "Line created in journal OUTPUT DEFAULT"
}

Add a consumed trade item to the consumption journal

Finds an available trade item of item 80216-T with unit KASSI and creates a consumption journal line for it on lot PROD-LOT-007 with consumeItem.

POST .../productionLots('PROD-LOT-007')/Microsoft.NAV.consumeItem

Body:
{
    "itemNumber": "80216-T",
    "quantity": 1,
    "unitOfMeasure": "KASSI",
    "location": "FACTORY"
}

Response:

{
    "@odata.context": "https://containers.wisefish.com/BC/api/wisefish/base/v1.0/$metadata#Edm.String",
    "value": "Line created in journal CONSUMP DEFAULT"
}

Consume an item without a location

Calls consumeItem with an empty location; the call fails and no line is created.

Request:

POST .../productionLots('PROD-LOT-007')/Microsoft.NAV.consumeItem

Body:
{
    "itemNumber": "80216-T",
    "quantity": 1,
    "unitOfMeasure": "KASSI",
    "location": ""
}

Response:

{
    "error": {
        "code": "Application_DialogException",
        "message": "Location must be given to find trade item to consume!"
    }
}