Returns a list of inventory transactions.

GET /inventory/inventory-transactions

Group: Inventory › Inventory Transactions · Operation ID: inventoryTransactions

Returns the same fields as GET inventory/inventory-transactions/:id and POST inventory/inventory-transactions/search. A ledger is unbounded, so filter by a transactionDate window, on its own or with itemId or locationId, to turn it into a report.

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`.

Query surface

id — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
itemId — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
itemCode — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
locationId — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
locationCode — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
transactionDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
sourceDocumentLineType — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
isReturn — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
isPriceDiff — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
lastModifiedDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
Orderable: id, transactionDate, inQuantity, outQuantity, totalCost, itemCode, locationCode, lastModifiedDate
Selectable: id, itemId, itemCode, itemName, locationId, locationCode, locationName, unitId, unitCode, unitName, transactionDate, inQuantity, outQuantity, unitInQuantity, unitOutQuantity, unitCost, totalCost, salesAmount, currency, sourceDocumentLineType, isReturn, isPriceDiff, lastModifiedDate

Response

200 Success

Under data, an array of inventoryTransactionsRow:

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

Statuses

400 — Invalid request or business failure
401 — Missing or invalid access token
403 — Not authorized
404 — Not found
429 — Too many requests
500 — Internal server error