Name | Description | Type | Additional information |
---|---|---|---|
ProductInventoryID |
The internal identifier for this inventory transaction e.g. 347997977270547474 |
integer |
Optional |
OrganisationID |
The internal identifier of this organisation in Tradevine e.g. 3451460443781171981 |
integer |
Optional |
ProductID |
The internal identifier for this product this transaction is for e.g. 3479979772705247895 |
integer |
Optional |
IsCurrent |
This will always be true to indicate this is the current inventory record |
boolean |
Optional |
EntryDate |
The date and time (in UTC) the transaction was made |
date |
Optional |
InventoryType |
The inventory entry type lookup value |
integer |
Optional |
QuantityChange |
The net quantity change that occurred as a result of this transaction |
decimal number |
Optional |
ProductCostPrice |
The unit cost price of each piece of inventory if this transaction was an addition |
decimal number |
Optional |
QuantityInStockSnapshot |
The current total Stock on Hand (SOH) value for this product |
decimal number |
Optional |
AverageFIFOCost |
The weight-average-cost (WAC) of each piece of inventory as it stands after this transaction |
decimal number |
Optional |
AvailableBalance |
This is the quantity remaining of this batch of inventory (to be consumed on a FIFO basis) |
decimal number |
Optional |
TotalInventoryValueSnapshot |
This is the rolled up total inventory value (summing all available balances multiplied by their respective cost prices) |
decimal number |
Optional |
Currency |
The transaction currency lookup value |
integer |
Optional |
Reference |
A reference to a shipment or receipt if the current transaction was caused by such a document |
string |
Optional |
PurchaseOrderID |
The internal identifier to the purchase order causing this inventory transaction (will be null if used through this API call) |
integer |
Optional |
SalesOrderID |
The internal identifier to the sales order causing this inventory transaction (will be null if used through this API call) |
integer |
Optional |
PackListID |
The internal identifier to the shipment causing this inventory transaction (will be null if used through this API call) |
integer |
Optional |
Notes |
Any notes saved against this transaction (from the input) |
string |
Optional |
CreatedDate |
The date and time (in UTC) that the inventory adjustment was created |
date |
Optional |
CreatedBy |
The internal Tradevine ID of the user that created the inventory adjustment |
integer |
Optional |
ModifiedDate |
The date and time (in UTC) that the inventory adjustment was last modified |
date |
Optional |
ModifiedBy |
The internal Tradevine ID of the user that last modified the inventory adjustment |
integer |
Optional |
GoodsReceiptID |
The internal identifier to the goods receipt causing this inventory transaction (will be null if used through this API call) |
integer |
Optional |
AccountingJournalID |
If Xero is integrated, this will be the guid for the manual journal created by Tradevine in Xero for this transaction |
string |
Optional |
WarehouseID |
The ID of the warehouse this adjustment relates to - if not supplied, the warehouse will be assumed to be your primary warehouse |
integer |
Optional |
ProductCode |
The external SKU for this product is for e.g. PR-43254 |
string |
Optional |
WarehouseCode |
The user defined code of the warehouse this adjustment is for (if not supplied, the transaction will default to the primary warehouse) e.g. WH3 |
string |
Optional |