# Inventory Increases

`GET /inventory/inventory-increases`

Group: Inventory › Inventory Increases · Operation ID: `inventoryIncreases`

Returns a list of inventory increases. Each row is a header with lineCount. To get the lines, or to filter by item or date, use POST inventory/inventory-increases/search.

Returns the inventory increase collection. It returns headers only, without the lines. GET inventory/inventory-increases/:id and POST inventory/inventory-increases/search return the lines, and search takes the same filters, so listing documents with their lines means searching. lineCount stands in for the rows, saying whether a document is one correction or forty. Filtering by item is not possible here, because items are on the lines. POST inventory/inventory-increases/search takes itemId and answers it.

[Open in the interactive reference](https://docs.api.lensing.ai/?op=inventoryIncreases)

## 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 inventoryIncreasesRow:

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | no | The unique identifier for the inventory increase. |
| `documentNumber` | string or null | no | The inventory increase's document number, for example 'INC-42'. Absent while none has been assigned. |
| `documentStatus` | string | no | The status of the inventory increase. Possible values: 'DRAFT', 'COMMITTED', 'CANCELLED'. |
| `documentDate` | string (date) | no | The date the inventory increase is dated. It sets the posting period. Format YYYY-MM-DD. |
| `entityId` | string | no | The unique identifier for the legal entity. 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 the stock is added to. See id on GET inventory/warehouses/:id. |
| `locationCode` | string or null | no | The short code of that warehouse. |
| `locationName` | string or null | no | The display name of that warehouse. |
| `reasonCodeId` | string or null | no | The unique identifier for the reason code. 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 increase is valued in. Format ISO 4217, for example 'EUR'. |
| `lineCount` | number or null | no | The number of lines the inventory increase has. The collection does not return the lines themselves. |
| `notes` | string or null | no | Free text on the inventory increase. |
| `createdDate` | string (date-time) or null | no | The date and time the inventory increase was created, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ. |
| `lastModifiedDate` | string (date-time) or null | no | The date and time the inventory increase 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