API - Trade Item Lot Totals | Wisefish Manuals

Overview

This is a summary list (query) with totals per

Item No.
Lot
Closing Type
Variant

The API returns the total quantity for the dimensions above.

Endpoint name	`tradeItemLotTotals`
Source table	`WiFi Trade Item Ledger Entry`
Fixed view	The endpoint only lists item that are not in inventory any more, so there is a fixed filter on non-empty Closing Type: `where("Closing Type" = filter(<> ''));`
Requests allowed	GET
Object Type	`Query`

Data

Field List

	Property	Type	Description
1	`itemNo`	string	Item number.
2	`lot`	string	Lot identifier.
3	`closingType`	string	Closing type for the ledger entry.
4	`itemType`	string	Item type.
5	`variantCode`	string	Variant code, if applicable.
6	`quantity`	number	Total quantity.
7	`unitOfMeasure`	string	Unit of measure for the quantity.
8	`tradeItems`	number	Total number of trade items.
9	`tradeItemUnitOfMeasure`	string	Unit of measure for trade items.
10	`weight`	number	Total weight.
11	`itemDescription`	string	Item description.

Example Object

JSON

{
    "itemNo": "100",
    "lot": "L26-001",
    "closingType": "Usage",
    "itemType": "Raw Material",
    "variantCode": "",
    "quantity": 100,
    "unitOfMeasure": "KG",
    "tradeItems": 100,
    "tradeItemUnitOfMeasure": "KG",
    "weight": 100,
    "itemDescription": "Cod (raw material catch)"
}

Usage

Totals for all lots of a selected Item

To get all lots, both in stock and gone, for item 70064 and lot ‘15-04-04’:

JSON

GET ../tradeItemLotTotals?$filter=itemNo eq '70064' and lot eq '15-04-01'

The following response shows that there are 36 boxes still in stock, but 39 were credited and 15 were repacked.

JSON

{
    "@odata.context": "https://containers.wisefish.com/BC/api/wisefish/base/v1.0/$metadata#companies(0c28f579-28b9-f011-af5f-6045bdacc160)/tradeItemLotTotals",
    "value": [
        {
            "itemNo": "70064",
            "lot": "15-04-01",
            "closingType": " ",
            "itemType": "Product",
            "variantCode": "",
            "quantity": 36,
            "unitOfMeasure": "BOKS",
            "tradeItems": 12,
            "tradeItemUnitOfMeasure": "STK",
            "weight": 72,
            "itemDescription": "Salmon Pack of 3 boxes"
        },
        {
            "itemNo": "70064",
            "lot": "15-04-01",
            "closingType": "Credit",
            "itemType": "Product",
            "variantCode": "",
            "quantity": 39,
            "unitOfMeasure": "BOKS",
            "tradeItems": 13,
            "tradeItemUnitOfMeasure": "STK",
            "weight": 78,
            "itemDescription": "Salmon Pack of 3 boxes"
        },
        {
            "itemNo": "70064",
            "lot": "15-04-01",
            "closingType": "Repacking",
            "itemType": "Product",
            "variantCode": "",
            "quantity": 15,
            "unitOfMeasure": "BOKS",
            "tradeItems": 5,
            "tradeItemUnitOfMeasure": "STK",
            "weight": 30,
            "itemDescription": "Salmon Pack of 3 boxes"
        }
    ]
}