Schema URL

Type: object

Schema defining the structure of ABCInventoryModuleData including Principal Data, inventory, and transaction data in ABC-Plan's Inventory Management Module. Version 5.1.0 adds support for Change Attributes transactions.

Properties

$schema string required
Values: "https://www.schemastore.org/abc-inventory-module-data-5.1.0.json"
ABCProducts object required
ABCVendors object required
ABCMaterialCategories object required
ABCMaterialNumbers object required
ABCLocations object required
ABCTags object required
ABCReasonCodes object required
ABCTransactions ABCInventoryTransaction[] required
ABCInventoryEntries object required

Definitions

ABCStatus string
ABCInventoryReceiveTransaction object
uid string required
timestamp number required
transactionType string required
Values: "receive"
transactionData object required
12 nested properties
lotNumber string required
materialNumberID string required
materialCategoryID string required
quantity number required
dateOfExpiry string required
format=date
dateOfManufacture string required
format=date
poNumber string required
statusID string required
Values: "RELEASED" "CONDITIONAL_RELEASED" "QUARANTINE" "IN_TRANSIT" "ON_HOLD" "EXPIRED" "DAMAGED"
locationID string required
tagIDs string[] required
productID string | null required
notes string required
targetLotID string
ABCInventoryBuildTransaction object
uid string required
timestamp number required
transactionType string required
Values: "build"
transactionData object required
20 nested properties
lotNumber string required
materialNumberID string required
materialCategoryID string required
quantity number required
dateOfExpiry string required
format=date
dateOfManufacture string required
format=date
poNumber string required
statusID string required
Values: "RELEASED" "CONDITIONAL_RELEASED" "QUARANTINE" "IN_TRANSIT" "ON_HOLD" "EXPIRED" "DAMAGED"
locationID string required
tagIDs string[] required
upstreams object[] required
upstreamIDs string[] required
upstreamLotNumbers string[] required
upstreamQuantities number[] required
upstreamMaterialNumberIDs string[] required
upstreamMaterialCategoryIDs string[] required
upstreamLocationIDs string[] required
productID string | null required
upstreamProductIDs string | null[] required
notes string required
targetLotID string
ABCInventoryTransferTransaction object
uid string required
timestamp number required
transactionType string required
Values: "transfer"
transactionData object required
9 nested properties
lotID string required
newLocationID string required
quantity number required
lotNumber string required
materialNumberID string required
locationID string required
productID string | null required
materialCategoryID string required
notes string required
targetLotID string
ABCInventoryStatusChangeTransaction object
uid string required
timestamp number required
transactionType string required
Values: "statusChange"
transactionData object required
9 nested properties
lotID string required
newStatusID string required
Values: "RELEASED" "CONDITIONAL_RELEASED" "QUARANTINE" "IN_TRANSIT" "ON_HOLD" "EXPIRED" "DAMAGED"
quantity number required
lotNumber string required
materialNumberID string required
locationID string required
productID string | null required
materialCategoryID string required
notes string required
targetLotID string
ABCInventoryDistributeTransaction object
uid string required
timestamp number required
transactionType string required
Values: "distribute"
transactionData object required
8 nested properties
lotID string required
quantity number required
lotNumber string required
materialNumberID string required
locationID string required
productID string | null required
materialCategoryID string required
notes string required
ABCInventoryDestroyTransaction object
uid string required
timestamp number required
transactionType string required
Values: "destroy"
transactionData object required
7 nested properties
lotID string required
lotNumber string required
materialNumberID string required
locationID string required
productID string | null required
materialCategoryID string required
notes string required
ABCInventorySellTransaction object
uid string required
timestamp number required
transactionType string required
Values: "sell"
transactionData object required
8 nested properties
lotID string required
quantity number required
lotNumber string required
materialNumberID string required
locationID string required
productID string | null required
materialCategoryID string required
notes string required
ABCInventoryAdjustTransaction object
uid string required
timestamp number required
transactionType string required
Values: "adjust"
transactionData object required
9 nested properties
lotID string required
newQuantity number required
reasonCodeID string required
lotNumber string required
materialNumberID string required
locationID string required
productID string | null required
materialCategoryID string required
notes string required
oldQuantity number required
ABCInventoryChangeExpiryTransaction object
uid string required
timestamp number required
transactionType string required
Values: "changeExpiry"
transactionData object required
8 nested properties
lotID string required
newDateOfExpiry string required
lotNumber string required
materialNumberID string required
locationID string required
productID string | null required
materialCategoryID string required
notes string required
ABCInventoryChangeAttributesTransaction object
uid string required
timestamp number required
transactionType string required
Values: "changeAttributes"
transactionData object required
10 nested properties
lotID string required
lotNumber string required
materialNumberID string required
materialCategoryID string required
productID string | null required
locationID string required
dateOfManufacture string
format=date
poNumber string
tagIDs string[]
notes string
ABCInventoryTransaction ABCInventoryReceiveTransaction | ABCInventoryBuildTransaction | ABCInventoryTransferTransaction | ABCInventoryStatusChangeTransaction | ABCInventoryDistributeTransaction | ABCInventoryDestroyTransaction | ABCInventorySellTransaction | ABCInventoryAdjustTransaction | ABCInventoryChangeExpiryTransaction | ABCInventoryChangeAttributesTransaction
ABCInventoryEntryWithoutUpstreams object
lotNumber string required
materialNumberID string required
materialCategoryID string required
productID string | null required
quantity number required
dateOfExpiry string required
format=date
dateOfManufacture string required
format=date
poNumber string required
statusID string required
Values: "RELEASED" "CONDITIONAL_RELEASED" "QUARANTINE" "IN_TRANSIT" "ON_HOLD" "EXPIRED" "DAMAGED"
locationID string required
tagIDs string[] required
hasUpstreams boolean required
Values: false
transactionNotes string[] required
lotNumberLowercase string required
ABCInventoryEntryWithUpstreams object
lotNumber string required
materialNumberID string required
materialCategoryID string required
productID string | null required
quantity number required
dateOfExpiry string required
format=date
dateOfManufacture string required
format=date
poNumber string required
statusID string required
Values: "RELEASED" "CONDITIONAL_RELEASED" "QUARANTINE" "IN_TRANSIT" "ON_HOLD" "EXPIRED" "DAMAGED"
locationID string required
tagIDs string[] required
hasUpstreams boolean required
Values: true
upstreamIDs string[] required
upstreamQuantities number[] required
upstreamLotNumbers string[] required
transactionNotes string[] required
lotNumberLowercase string required
ABCInventoryEntry ABCInventoryEntryWithoutUpstreams | ABCInventoryEntryWithUpstreams