Index
api/v1/stock
Path: api/v1/stock
This API is JSON:API compliant.
This endpoint supports the following methods:
GET
The resource type for this endpoint is Stock
The identifier is stockno
The Stock resource type attributes are as follows:
{
"code":string
"description":string
"type":string
"serialNo":string
"active":boolean
"gLGroupCode":string
"labourContent":number
optional
"manufacturingCost":number
"buy":{
"taxCode":string
"decimalPlaces":integer
}
"sell":{
"taxCode":string
"decimalPlaces":integer
}
"listPriceExcl":number
"listPriceIncl":number
"dimensions":{
"weight":number
"width":number
"height":number
"depth":number
}
"procurement":{
"minQtyPerLocationMethod":string
"dailyAvgSoldPerDayBasedOn":string
"dailyAvgSoldPerDayBasedOnDays":
"addExtraPercent":
"reorderQty":number
}
"measure": [{
"unit":string
"qty":number
"unitDesc":string
"barcode":string
}]
"qtyDecimalPlaces":integer
"warrantyMonths":
"manufacturingType":string
"serviceStock":boolean
"macroDesc":string
"hideOnInvoice":boolean
"excludeAttributesInProcurement":boolean
"publishPriceTo":string
"roundPriceUpToNearestCents":integer
optional
"rateMultiplier":number
"summaryKit":boolean
"floorCostMarkup":number
"manufacturePartNumber":string
"gTINumber":string
"shortDesc":string
"detailedDesc":string
"warrantyDesc":string
"allowPriceOverride":boolean
"discountIsPercentageOfPrice":boolean
"dangerousGoods":boolean
"comissions":{
optional
"exclude":boolean
optional
"floor":number
optional
"percent":number
optional
"extra":number
}
"lastCost":number
"lastCOGS":number
"maxCOGS":number
"avgCost":number
"avgCOGS":number
"lastPOCOGS":number
"avgPOCOGS":number
"groups": [{
"type":string
"id":integer
"name":string
}]
Example GET (Return all)
Path: api/v1/stock?filter[SerialOnSell]=True&filter[GLGroupNo][-eq]10&filter[LastModified][-gt]2025-01-12T00%3A00%3A00%2B00%3A00
Supported Filters:
| Alive | Bool | AttributesNotRequired | Bool | AttributesOnPurchase | Bool | AttributesOnSell | Bool |
| BarCode | Text | Bin | Lookup | BuyStock | Bool | DangerousGoods | Bool | DateIn | DateRange |
| DateInEnd | Date | DateInStart | Date | Dates | DateRange | GLGroupNo | Lookup | Groups | Group |
| kIncDetailedDesc | Bool | LabourContent | Text | LastModified | DateRange | Location | Lookup | ManfStock | Bool |
| mWeight | Text | ParentStockNo | Lookup | PriceTempl | Lookup | Promo | Lookup | PublishPrice | Lookup |
| QtyInLocation | Lookup | SellStock | Bool | SerialNotRequired | Bool | SerialOnPurchase | Bool | SerialOnSell | Bool |
| ServStock | Bool | StockCode | Lookup | StockDesc | Text | StockLG | Lookup | Supplier | Lookup |
| SupplierStockCode | Text |
Operators:
| = | Equals |
| [-gte] | GreaterThanOrEqual |
| [-lte] | LessThanOrEqual |
| [-ne] | NotEqual |
| [-lt] | LessThan |
| [-gt] | GreaterThan |
| [-eq] | Equal |
| [-like] | Like |
Response: