List inventory revaluations
Operation ID: inventoryRevaluations
Group: Inventory › Inventory Revaluations
Open in the interactive reference
GET /inventory/inventory-revaluations
Read-only: Reads and returns; changes nothing.
Lists inventory revaluations, without their lines. Each revaluation comes back with lineCount and totalRevaluationAmount instead of its lines. To read the lines, use GET inventory/inventory-revaluations/:id or POST inventory/inventory-revaluations/search.
To filter by item or warehouse, use POST inventory/inventory-revaluations/search.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
Api-Version |
header | string · 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, likedocumentNumber— filter by eq, ne, gt, gte, lt, lte, in, notIn, between, likedocumentStatus— filter by eq, ne, gt, gte, lt, lte, in, notIn, between, likedocumentDate— filter by eq, ne, gt, gte, lt, lte, in, notIn, betweenentityId— filter by eq, ne, gt, gte, lt, lte, in, notIn, between, likecostingValuationType— filter by eq, ne, gt, gte, lt, lte, in, notIn, between, likereasonCodeId— filter by eq, ne, gt, gte, lt, lte, in, notIn, between, likeactive— filter by eq, ne, gt, gte, lt, lte, in, notIn, betweenlastModifiedDate— filter by eq, ne, gt, gte, lt, lte, in, notIn, between- 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
page[size]— Page sizepage[cursor]— Opaque continuation cursor
Response
200 Success
Under data, an array of inventoryRevaluationsRow:
| Field | Type | Required | Filter | Sort | Description |
|---|---|---|---|---|---|
id |
string | no | Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) |
yes | The unique identifier for the revaluation. Example: "8e4b17c0-5d92-4a63-b0f7-1c8e35a029d4". |
documentNumber |
string | null | no | Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) |
yes | The revaluation's document number, for example 'REV-1187'. Example: "REV-1187". |
documentStatus |
string | no | Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) |
yes | The status of the revaluation. Possible values: 'DRAFT', 'COMMITTED', 'CANCELLED'. Example: "COMMITTED". |
documentDate |
date | null | no | Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn) |
yes | The date the revaluation is dated. Format YYYY-MM-DD. Example: "2026-08-18". |
entityId |
string | null | no | Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) |
no | The unique identifier for the legal entity whose books this moves. See id on GET base/entities. Example: "1a9c4e70-38b5-4d26-9f01-7c2e5b8a6d43". |
entityName |
string | null | no | no | no | The display name of that legal entity. Example: "Acme Netherlands B.V.". |
costingValuationType |
string | null | no | Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) |
yes | 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. Example: "revaluation". |
capitalisationExpenseAccountId |
string | null | no | no | no | The unique identifier for the general ledger 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 | null | no | no | no | The unique identifier for the costing element type the cost breakdown rows are recorded against. Required to commit. |
reasonCodeId |
string | null | no | Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) |
no | The unique identifier for the reason code, when one was given. See id on GET inventory/reason-codes/:id. |
reasonCode |
string | null | no | no | no | The code of that reason code. |
reasonCodeDescription |
string | null | no | no | no | The description of that reason code. |
currency |
string | null | no | no | no | The currency of every amount on the revaluation, the legal entity's functional currency. Format ISO 4217, for example 'EUR'. Example: "EUR". |
totalRevaluationAmount |
decimal | null | no | no | yes | The sum of every line's revaluationAmount, in the revaluation's currency. This is what the document moves on the balance sheet. Example: "-450". |
active |
boolean | null | no | Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn) |
no | Whether the document is active. Example: true. |
notes |
string | null | no | no | no | Free text on the revaluation. |
lineCount |
number | null | no | no | no | How many lines the revaluation has. Example: 1. |
createdDate |
date-time | null | no | no | yes | The date and time the revaluation was created, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ. Example: "2026-08-18T09:14:22.104Z". |
lastModifiedDate |
date-time | null | no | Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn) |
yes | The date and time the revaluation record last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ. Example: "2026-08-18T09:14:22.517Z". |
{
"data": [
{
"id": "8e4b17c0-5d92-4a63-b0f7-1c8e35a029d4",
"documentNumber": "REV-1187",
"documentStatus": "COMMITTED",
"documentDate": "2026-08-18",
"entityId": "1a9c4e70-38b5-4d26-9f01-7c2e5b8a6d43",
"entityName": "Acme Netherlands B.V.",
"costingValuationType": "revaluation",
"capitalisationExpenseAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"costingElementTypeId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"reasonCodeId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"reasonCode": "<reasonCode>",
"reasonCodeDescription": "<reasonCodeDescription>",
"currency": "EUR",
"totalRevaluationAmount": "-450",
"active": true,
"notes": "<notes>",
"lineCount": 1,
"createdDate": "2026-08-18T09:14:22.104Z",
"lastModifiedDate": "2026-08-18T09:14:22.517Z"
}
],
"pagination": {
"hasMore": true,
"nextCursor": "<nextCursor>"
}
}
Statuses
400— Invalid request or business failure401— The request carries no valid access token.403— Not authorized404— Not found429— Too many requests from this client address. The response has no body and noRetry-Afterheader.500— Internal server error