Returns the serial transaction line with the given identifier.

GET /inventory/serial-transactions/{id}

Group: Inventory › Serial Transactions · Operation ID: getSerialTransaction

Returns the same item schema as GET inventory/serial-transactions and POST inventory/serial-transactions/search. The id you pass is the serial line's identifier, not the ledger row's (transactionId) or the unit's (serialNumberId).

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 serial transaction line to return. It is the serial line's identifier, not the ledger row's (transactionId) or the unit's (serialNumberId).

Response

200 Success

Under data (getSerialTransactionOutput):

Field Type Required Description
id string yes The unique identifier for the serial transaction line. This is a different record from the ledger row (transactionId) and the unit (serialNumberId).
serialNumberId string yes The unique identifier for the serial number that moved. See id on GET inventory/serial-numbers/:id.
serialNumber string no The serial number stamped on the unit, for example 'SN-000412'.
manufacturerSerialNumber string no The manufacturer's own serial number for the unit, where one is recorded.
expirationDate string (date) no The date the unit expires, from the serial record. Format YYYY-MM-DD.
entryDate string (date) no The date the unit entered inventory, from the serial record. Format YYYY-MM-DD.
isSold boolean no Whether the unit has since been sold. This is a current property of the unit, not of this movement, so a receipt line shows true once the unit is later sold.
transactionId string no The unique identifier for the ledger row this serial line belongs to. See id on GET inventory/inventory-transactions/:id.
itemId string no The unique identifier for the item that moved, from the ledger row, not the unit's current item. 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 no The unique identifier for the location the movement was posted at, from the ledger row, not where the unit is now. See id on GET inventory/warehouses/:id.
locationCode string no The code of that location.
locationName string no The display name of that location.
transactionDate string (date) no The date the movement was posted. Format YYYY-MM-DD.
inQuantity string (decimal) no The quantity into stock for this movement. It is 1 when the movement received the unit and 0 otherwise.
outQuantity string (decimal) no The quantity out of stock for this movement. It is 1 when the movement issued the unit and 0 otherwise.
cost string (decimal) no The cost of the unit at this movement, in the currency named by currency.
currency string no The currency the cost is 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 the movement, from the ledger row.
lastModifiedDate string (date-time) no The date and time the serial line last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.

Errors

Code Status
NOT_FOUND 400

Statuses