# Inventory Revaluations

`GET /inventory/inventory-revaluations`

Group: Inventory › Inventory Revaluations · Operation ID: `inventoryRevaluations`

Returns a list of inventory revaluations, headers only. To filter by item or warehouse, use POST inventory/inventory-revaluations/search.

The inventory revaluation collection returns headers only. It does not return lines, so it publishes lineCount and totalRevaluationAmount in their place. totalRevaluationAmount is what the document moves, which is usually what a list of them is read for, and it can be ordered, so the largest write-downs in a period are one call.

Filtering by item or warehouse needs the lines, so both live on POST inventory/inventory-revaluations/search. entityId can be filtered, so a collection can be scoped to one legal entity, and lastModifiedDate can be filtered and ordered, which makes it a sync cursor.

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

## 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
- `costingValuationType` — 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
- `active` — 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, costingValuationType, totalRevaluationAmount, createdDate, lastModifiedDate
- Selectable: id, documentNumber, documentStatus, documentDate, entityId, entityName, costingValuationType, capitalisationExpenseAccountId, costingElementTypeId, reasonCodeId, reasonCode, reasonCodeDescription, currency, totalRevaluationAmount, active, notes, lineCount, createdDate, lastModifiedDate

## Response

`200` Success

Under `data`, an array of inventoryRevaluationsRow:

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | no | The unique identifier for the revaluation. |
| `documentNumber` | string or null | no | The revaluation's document number, for example 'REV-1187'. |
| `documentStatus` | string | no | The status of the revaluation. Possible values: 'DRAFT', 'COMMITTED', 'CANCELLED'. |
| `documentDate` | string (date) or null | no | The date the revaluation is dated. Format YYYY-MM-DD. |
| `entityId` | string or null | no | The unique identifier for the legal entity whose books this moves. See id on GET base/entities. |
| `entityName` | string or null | no | The display name of that legal entity. |
| `costingValuationType` | string or null | no | How the value change is recorded. Possible values: 'revaluation', 'directCostCapitalisation'. 'revaluation' restates the cost outright, and 'directCostCapitalisation' adds a cost that was expensed elsewhere onto the stock. |
| `capitalisationExpenseAccountId` | string or null | no | The unique identifier for the GL account a direct cost capitalization takes the expense off. Absent on an ordinary revaluation. See id on GET accounting/chart-of-accounts/:id. |
| `costingElementTypeId` | string or null | no | The unique identifier for the costing element type the cost breakdown rows are recorded against. Required to commit. |
| `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 code of that reason code. |
| `reasonCodeDescription` | string or null | no | The description of that reason code. |
| `currency` | string or null | no | The currency of every amount on the revaluation, the legal entity's functional currency. Format ISO 4217, for example 'EUR'. |
| `totalRevaluationAmount` | string (decimal) or null | no | The sum of every line's revaluationAmount, in the revaluation's currency. This is what the document moves on the balance sheet. |
| `active` | boolean or null | no | Whether the document is active. |
| `notes` | string or null | no | Free text on the revaluation. |
| `lineCount` | number or null | no | How many lines the revaluation has. |
| `createdDate` | string (date-time) or null | no | The date and time the revaluation was created, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ. |
| `lastModifiedDate` | string (date-time) or null | no | The date and time the revaluation 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
