Search Inventory Decreases

POST /inventory/inventory-decreases/search

Group: Inventory › Inventory Decreases · Operation ID: searchInventoryDecreases

Returns the inventory decreases that match the given filters, each with its lines.

This returns the inventory decreases that match, with their full header and lines, the same item schema GET inventory/inventory-decreases/:id returns. It is the read endpoint that returns lines, since the collection is header-only. itemId matches documents that have a line for that item, which the collection cannot answer. Every criterion is an exact match or a range, never a substring, and criteria combine with AND. An empty filters object returns everything, page by page. No match is an empty items array, not an error.

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.

Request body

Required, application/json: searchInventoryDecreasesInput.

Field Type Required Description
filters object yes The search criteria, combined with AND. An empty object returns every inventory decrease, page by page.
filters.documentNumber string no Limits results to the inventory decrease with this document number, for example 'DEC-42'. The match is exact.
filters.documentStatus string no Limits results to inventory decreases with this status. Possible values: 'DRAFT', 'COMMITTED', 'CANCELLED'. The match is exact.
filters.entityId string no Limits results to inventory decreases for this legal entity. See id on GET base/entities.
filters.locationId string no Limits results to inventory decreases at this warehouse location. See id on GET inventory/warehouses/:id.
filters.reasonCodeId string no Limits results to inventory decreases with this reason code. See id on GET inventory/reason-codes/:id.
filters.itemId string no Limits results to inventory decreases that have a line for this item. The collection cannot filter by item, because lines are not on it. See id on GET inventory/items/:id.
filters.fromDate string (date) no Limits results to documentDate on or after this date. Omit for an open-ended start. Use format YYYY-MM-DD.
filters.toDate string (date) no Limits results to documentDate on or before this date. Omit for an open-ended end. Use format YYYY-MM-DD.
filters.modifiedSince string (date-time) no Limits results to inventory decreases changed at or after this time, in UTC. This is separate from the documentDate window. Use format YYYY-MM-DDTHH:mm:ss.sssZ.
page object no The pagination controls. Omit for the first page.
page.cursor string no The cursor from the previous response's pagination.nextCursor. Omit on the first request.
page.size number no The number of inventory decreases per page. Defaults to 50. A value above 200 is treated as 200.

Example:

{
  "filters": {
    "documentStatus": "DRAFT",
    "locationId": "e1d84c07-5b39-4a26-9f70-2c8b613ad495"
  },
  "page": {
    "cursor": "<cursor>",
    "size": 0
  }
}

Response

200 Success

Under data (searchInventoryDecreasesOutput):

Field Type Required Description
items array of object yes The inventory decreases that match, oldest first, each with its lines. An empty array when nothing matches.
items[].id string yes The unique identifier for the inventory decrease.
items[].documentNumber string no The inventory decrease's document number, for example 'DEC-42'. Absent while none has been assigned.
items[].documentStatus string yes The status of the inventory decrease. Possible values: 'DRAFT', 'COMMITTED', 'CANCELLED'.
items[].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.
items[].entityId string yes The unique identifier for the legal entity the document belongs to. See id on GET base/entities.
items[].entityName string no The display name of that legal entity.
items[].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.
items[].locationCode string no The short code of that warehouse location.
items[].locationName string no The display name of that warehouse location.
items[].reasonCodeId string no The unique identifier for the reason code, when one was given. See id on GET inventory/reason-codes/:id.
items[].reasonCode string no The short code of that reason code.
items[].reasonCodeDescription string no The description of that reason code.
items[].currency string no The currency the inventory decrease is valued in, the legal entity's functional currency. Format ISO 4217, for example 'EUR'.
items[].notes string no Free text on the inventory decrease.
items[].createdDate string (date-time) no The date and time the inventory decrease was created, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.
items[].lastModifiedDate string (date-time) no The date and time the inventory decrease record last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.
items[].lines array of object yes The lines of the inventory decrease. An inventory decrease always has at least one.
items[].lines[].id string yes The unique identifier for the inventory decrease line.
items[].lines[].itemId string yes The unique identifier for the item whose stock this line removes. See id on GET inventory/items/:id.
items[].lines[].itemCode string no The short code of that item.
items[].lines[].itemName string no The display name of that item.
items[].lines[].unitId string yes The unique identifier for the unit the quantity is counted in. See id on GET inventory/unit-of-measures/:id.
items[].lines[].unitCode string no The short code of that unit, for example 'BOX'.
items[].lines[].quantity string (decimal) yes The quantity removed, in the line's unit. A positive number.
items[].lines[].inventoryQuantity string (decimal) no The same quantity in the item's stocking unit.
items[].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.
items[].lines[].notes string no Free text on the line.
items[].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.
items[].lines[].batches[].batchNumberId string no The unique identifier for the batch record.
items[].lines[].batches[].batchNumber string yes The batch number as printed, for example 'LOT-2026-08-14'.
items[].lines[].batches[].manufacturerBatchNumber string no The maker's own number for the same batch, when one was recorded.
items[].lines[].batches[].expirationDate string (date) no The expiration date of the batch. Format YYYY-MM-DD.
items[].lines[].batches[].quantity string (decimal) yes The quantity of this batch removed by the line, in the line's unit.
items[].lines[].batches[].inventoryQuantity string (decimal) no The same quantity in the item's stocking unit.
items[].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.
items[].lines[].serials[].serialNumberId string no The unique identifier for the serial record.
items[].lines[].serials[].serialNumber string yes The serial number stamped on the unit.
items[].lines[].serials[].manufacturerSerialNumber string no The maker's own number for the same unit, when one was recorded.
items[].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.
items[].lines[].binLocations[].binLocationId string yes The unique identifier for the bin the quantity came out of. See id on GET inventory/bins/:id.
items[].lines[].binLocations[].binLocationCode string no The short code of that bin.
items[].lines[].binLocations[].quantity string (decimal) yes The quantity taken from this bin, in the line's unit.
items[].lines[].binLocations[].inventoryQuantity string (decimal) no The same quantity in the item's stocking unit.
items[].lines[].binLocations[].batchNumber string no The batch this bin entry belongs to, when it belongs to one of the line's batches.
items[].lines[].binLocations[].serialNumber string no The serialized unit this bin entry belongs to, when it belongs to one of the line's units.
pagination object yes The pagination cursor for this page.
pagination.nextCursor string no The cursor for the next page. Pass it as page.cursor. Absent on the last page.
pagination.hasMore boolean yes Whether more results remain beyond this page.

Statuses