Returns the inventory revaluation with the given identifier.

GET /inventory/inventory-revaluations/{id}

Group: Inventory › Inventory Revaluations · Operation ID: getInventoryRevaluation

Returns one inventory revaluation with its lines. Each line's revaluationAmount is what that line moves, and totalRevaluationAmount what the whole document moves: (newUnitCost - currentUnitCost) x quantity, in the legal entity's functional currency. A negative total is a write-down.

The warehouse is on the line, not the header, so one revaluation can restate the same item in several warehouses. This is the same schema as the collection endpoint, plus the lines the collection endpoint does not carry.

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.
id path string yes The unique identifier for the revaluation to return.

Response

200 Success

Under data (getInventoryRevaluationOutput):

Field Type Required Description
id string yes The unique identifier for the revaluation.
documentNumber string no The revaluation's document number, for example 'REV-1187'.
documentStatus string yes The status of the revaluation. Possible values: 'DRAFT', 'COMMITTED', 'CANCELLED'.
documentDate string (date) no The date the revaluation is dated. Format YYYY-MM-DD.
entityId string no The unique identifier for the legal entity whose books this moves. See id on GET base/entities.
entityName string no The display name of that legal entity.
costingValuationType string 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 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 no The unique identifier for the costing element type the cost breakdown rows are recorded against. Required to commit.
reasonCodeId string no The unique identifier for the reason code, when one was given. See id on GET inventory/reason-codes/:id.
reasonCode string no The code of that reason code.
reasonCodeDescription string no The description of that reason code.
currency string no The currency of every amount on the revaluation, the legal entity's functional currency. Format ISO 4217, for example 'EUR'.
totalRevaluationAmount string (decimal) 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 no Whether the document is active.
notes string no Free text on the revaluation.
lineCount number no How many lines the revaluation has.
createdDate string (date-time) no The date and time the revaluation was created, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.
lastModifiedDate string (date-time) no The date and time the revaluation record last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.
lines array of object no The lines of the revaluation. Absent from the collection endpoint, which publishes lineCount instead.
lines[].id string yes The unique identifier for the revaluation line. Pass it in updateLines or deleteLines on PATCH inventory/inventory-revaluations/:id to change or remove the line.
lines[].itemId string no The unique identifier for the item being revalued. See id on GET inventory/items/:id.
lines[].itemCode string no The code of that item.
lines[].itemName string no The display name of that item.
lines[].locationId string no The unique identifier for the warehouse whose stock this line restates. The same item may be carried at a different cost in each warehouse. See id on GET inventory/warehouses/:id.
lines[].locationCode string no The code of that warehouse.
lines[].locationName string no The display name of that warehouse.
lines[].unitId string no The unique identifier for the unit the quantity is in. See id on GET inventory/unit-of-measures/:id.
lines[].unitCode string no The code of that unit.
lines[].quantity string (decimal) no How much stock this line restates the cost of, in the line's unit.
lines[].inventoryQuantity string (decimal) no The same amount in the item's stocking unit.
lines[].currentUnitCost string (decimal) no What the stock is carried at today, in the revaluation's currency. You supply it and the platform checks it rather than deriving it. Read it from GET inventory/inventory-levels.
lines[].newUnitCost string (decimal) no What it should be carried at after this posts, in the revaluation's currency.
lines[].previousAfterSaleCost string (decimal) no The accrued after-sale cost before this document, in the revaluation's currency. Moving-average direct cost capitalization only.
lines[].newAfterSaleCost string (decimal) no The after-sale cost to capitalize, in the revaluation's currency. Moving-average direct cost capitalization only.
lines[].revaluationAmount string (decimal) no The value this line moves on the balance sheet, in the revaluation's currency: (newUnitCost - currentUnitCost) x quantity.
lines[].status string no Where the line sits in the platform's own process. This is free text with no fixed set of values.
lines[].notes string no Free text on the line.
lines[].batches array of object no The batches being restated. Their quantities must add up to the line's quantity.
lines[].batches[].batchNumberId string no The unique identifier for the batch number.
lines[].batches[].batchNumber string no The batch number itself.
lines[].batches[].quantity string (decimal) no How much of the line this batch accounts for.
lines[].batches[].currentUnitCost string (decimal) no What this batch is carried at today, in the revaluation's currency.
lines[].batches[].newUnitCost string (decimal) no What it should be carried at.
lines[].serials array of object no The serialized units being restated, one entry per unit, so there must be exactly as many as the quantity says.
lines[].serials[].serialNumberId string no The unique identifier for the serial number.
lines[].serials[].serialNumber string no The serial number itself.
lines[].serials[].currentUnitCost string (decimal) no What this unit is carried at today, in the revaluation's currency.
lines[].serials[].newUnitCost string (decimal) no What it should be carried at.
lines[].serials[].previousAfterSaleCost string (decimal) no The unit's accrued after-sale cost before this document. Direct cost capitalization on a sold serial only.
lines[].serials[].newAfterSaleCost string (decimal) no The after-sale cost to capitalize on it.

Errors

Code Status
NOT_FOUND 400

Statuses