Inventory Decreases

GET /inventory/inventory-decreases

Group: Inventory › Inventory Decreases · Operation ID: inventoryDecreases

Returns a list of inventory decreases. Each row is a header, with lineCount in place of the lines. To filter by item or return the lines, use POST inventory/inventory-decreases/search.

This returns inventory decreases as header rows, without their lines: a collection field cannot contain a nested array, so the row publishes lineCount in place of the lines. GET inventory/inventory-decreases/:id and POST inventory/inventory-decreases/search return the full document. To filter by item, or to list documents with their lines, use the search endpoint, which takes itemId and the same filters.

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
documentNumber — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
documentStatus — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
documentDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
entityId — 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
reasonCodeId — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
reasonCode — 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, documentNumber, documentDate, documentStatus, createdDate, lastModifiedDate
Selectable: id, documentNumber, documentStatus, documentDate, entityId, entityName, locationId, locationCode, locationName, reasonCodeId, reasonCode, reasonCodeDescription, currency, lineCount, notes, createdDate, lastModifiedDate

Response

200 Success

Under data, an array of inventoryDecreasesRow:

Field	Type	Required	Description
`id`	string	no	The unique identifier for the inventory decrease.
`documentNumber`	string or null	no	The inventory decrease's document number, for example 'DEC-42'. Absent while none has been assigned.
`documentStatus`	string	no	The status of the inventory decrease. Possible values: 'DRAFT', 'COMMITTED', 'CANCELLED'.
`documentDate`	string (date)	no	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	no	The unique identifier for the legal entity the document belongs to. See id on GET base/entities.
`entityName`	string or null	no	The display name of that legal entity.
`locationId`	string or null	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 or null	no	The short code of that warehouse location.
`locationName`	string or null	no	The display name of that warehouse location.
`reasonCodeId`	string or null	no	The unique identifier for the reason code, when one was given. See id on GET inventory/reason-codes/:id.
`reasonCode`	string or null	no	The short code of that reason code.
`reasonCodeDescription`	string or null	no	The description of that reason code.
`currency`	string or null	no	The currency the inventory decrease is valued in, the legal entity's functional currency. Format ISO 4217, for example 'EUR'.
`lineCount`	number or null	no	The number of lines the inventory decrease has. The collection returns it because the lines themselves are not on the collection.
`notes`	string or null	no	Free text on the inventory decrease.
`createdDate`	string (date-time) or null	no	The date and time the inventory decrease was created, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.
`lastModifiedDate`	string (date-time) or null	no	The date and time the inventory decrease record 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