Get Inventory Decrease

GET /inventory/inventory-decreases/{id}

Group: Inventory › Inventory Decreases · Operation ID: getInventoryDecrease

Returns the inventory decrease with the given identifier, with its lines.

This returns the inventory decrease with its lines and their batch, serial and bin detail. The same item schema is returned by POST inventory/inventory-decreases/search. The collection GET inventory/inventory-decreases returns the header only, without the lines. documentStatus says what you may do next: a draft can be edited, committed or deleted, a committed document can only be canceled, and a canceled one can only be deleted.

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 decrease to return.

Response

200 Success

Under data (getInventoryDecreaseOutput):

Field Type Required Description
id string yes The unique identifier for the inventory decrease.
documentNumber string no The inventory decrease's document number, for example 'DEC-42'. Absent while none has been assigned.
documentStatus string yes The status of the inventory decrease. Possible values: 'DRAFT', 'COMMITTED', 'CANCELLED'.
documentDate string (date) yes The date the adjustment is dated. It drives the posting period, so it is not the same as when the record was created. Format YYYY-MM-DD.
entityId string yes The unique identifier for the legal entity the document belongs to. See id on GET base/entities.
entityName string no The display name of that legal entity.
locationId string no The unique identifier for the warehouse location. One location for the whole document, and every line uses it. Absent only on a document with no lines. See id on GET inventory/warehouses/:id.
locationCode string no The short code of that warehouse location.
locationName string no The display name of that warehouse location.
reasonCodeId string no The unique identifier for the reason code, when one was given. See id on GET inventory/reason-codes/:id.
reasonCode string no The short code of that reason code.
reasonCodeDescription string no The description of that reason code.
currency string no The currency the inventory decrease is valued in, the legal entity's functional currency. Format ISO 4217, for example 'EUR'.
notes string no Free text on the inventory decrease.
createdDate string (date-time) no The date and time the inventory decrease was created, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.
lastModifiedDate string (date-time) no The date and time the inventory decrease record last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.
lines array of object yes The lines of the inventory decrease. An inventory decrease always has at least one.
lines[].id string yes The unique identifier for the inventory decrease line.
lines[].itemId string yes The unique identifier for the item whose stock this line removes. See id on GET inventory/items/:id.
lines[].itemCode string no The short code of that item.
lines[].itemName string no The display name of that item.
lines[].unitId string yes The unique identifier for the unit the quantity is counted in. See id on GET inventory/unit-of-measures/:id.
lines[].unitCode string no The short code of that unit, for example 'BOX'.
lines[].quantity string (decimal) yes The quantity removed, in the line's unit. A positive number.
lines[].inventoryQuantity string (decimal) no The same quantity in the item's stocking unit.
lines[].unitPrice string (decimal) no The value of one unit, in the inventory decrease's currency, when one was recorded. Usually absent, since stock leaving is valued at the cost it already has.
lines[].notes string no Free text on the line.
lines[].batches array of object no The batches making up this line's quantity, for a batch-tracked item. Absent when the item is not batch-tracked.
lines[].batches[].batchNumberId string no The unique identifier for the batch record.
lines[].batches[].batchNumber string yes The batch number as printed, for example 'LOT-2026-08-14'.
lines[].batches[].manufacturerBatchNumber string no The maker's own number for the same batch, when one was recorded.
lines[].batches[].expirationDate string (date) no The expiration date of the batch. Format YYYY-MM-DD.
lines[].batches[].quantity string (decimal) yes The quantity of this batch removed by the line, in the line's unit.
lines[].batches[].inventoryQuantity string (decimal) no The same quantity in the item's stocking unit.
lines[].serials array of object no The serialized units making up this line's quantity, one entry per unit. Absent when the item is not serialized.
lines[].serials[].serialNumberId string no The unique identifier for the serial record.
lines[].serials[].serialNumber string yes The serial number stamped on the unit.
lines[].serials[].manufacturerSerialNumber string no The maker's own number for the same unit, when one was recorded.
lines[].binLocations array of object no The bins the quantity came out of, in a bin-tracked warehouse. Each entry that names a batchNumber or serialNumber belongs to that batch or unit, and one that names neither belongs to the line.
lines[].binLocations[].binLocationId string yes The unique identifier for the bin the quantity came out of. See id on GET inventory/bins/:id.
lines[].binLocations[].binLocationCode string no The short code of that bin.
lines[].binLocations[].quantity string (decimal) yes The quantity taken from this bin, in the line's unit.
lines[].binLocations[].inventoryQuantity string (decimal) no The same quantity in the item's stocking unit.
lines[].binLocations[].batchNumber string no The batch this bin entry belongs to, when it belongs to one of the line's batches.
lines[].binLocations[].serialNumber string no The serialized unit this bin entry belongs to, when it belongs to one of the line's units.

Errors

Code Status
NOT_FOUND 400

Statuses