Returns the inventory transaction with the given identifier.

GET /inventory/inventory-transactions/{id}

Group: Inventory › Inventory Transactions · Operation ID: getInventoryTransaction

Returns the same fields as GET inventory/inventory-transactions and POST inventory/inventory-transactions/search. A ledger row cannot be changed once written, so a NOT_FOUND means the identifier was never one, not that the row was removed.

Open in the interactive reference

Parameters

Name In Type Required Description
Api-Version header "v1" yes The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version v1.
id path string yes The unique identifier for the inventory transaction to return.

Response

200 Success

Under data (getInventoryTransactionOutput):

Field Type Required Description
id string yes The unique identifier for the ledger row.
itemId string yes The unique identifier for the item that moved. See id on GET inventory/items/:id.
itemCode string no The code of that item.
itemName string no The display name of that item.
locationId string yes The unique identifier for the location the movement happened at. See id on GET inventory/warehouses/:id.
locationCode string no The code of that location.
locationName string no The display name of that location.
unitId string no The unique identifier for the unit the movement was recorded in. See id on GET inventory/unit-of-measures/:id.
unitCode string no The code of that unit, for example 'BOX'.
unitName string no The display name of that unit.
transactionDate string (date) yes The date the movement was posted. Format YYYY-MM-DD.
inQuantity string (decimal) yes The quantity that moved into stock, in the item's stocking unit. Zero on an outbound movement.
outQuantity string (decimal) no The quantity that moved out of stock, in the item's stocking unit. Zero on an inbound movement.
unitInQuantity string (decimal) no The same inbound movement in the unit the document used, which unitId names. It differs from inQuantity when the document used a unit other than the item's stocking unit.
unitOutQuantity string (decimal) no The same outbound movement in the unit the document used, which unitId names.
unitCost string (decimal) no The unit cost at the time of the movement, in the currency named by currency.
totalCost string (decimal) no The total cost of the movement, in the currency named by currency.
salesAmount string (decimal) no The sales amount of the movement, where it has one, in the currency named by currency.
currency string no The currency that unitCost, totalCost and salesAmount are stated in. Format ISO 4217, for example 'USD'.
sourceDocumentLineType string, one of "IMInventorySalesOrderLine", "IMInventorySalesDeliveryLine", "IMSalesOrderLine", "IMInventoryPurchaseReturnLine", "IMInventorySalesReturnLine", "IMWarehouseTransferLine", "IMInventoryDecreaseLine", "IMInventoryIncreaseLine", "IMInventoryRevaluationLine", "IMInventoryTransferLine", "IMInventoryAdjustmentLine", "IMInventoryCountLine", "IMInventoryPutAwayTask", "IMInventoryPurchaseReturnReversal", "PurchaseOrderLine", "IMLandedCostAllocationLine", "SalesOrderProductItem", "IMWarehouseTransferOrderLine", "VendorBillItemBase", "InvPurchaseDeliveryLine" no The kind of document line that produced this movement.
isReturn boolean no Whether the movement is a return.
isPriceDiff boolean no Whether the movement is a price-difference adjustment rather than a physical movement of goods.
lastModifiedDate string (date-time) no The date and time the ledger row last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.

Errors

Code Status
NOT_FOUND 400

Statuses