Supply Chain · Inventory Costing
Cost Revaluations
Re-prices an item’s stock and, if you wish, changes its costing method. Open layers are closed, stock restarts under the new method at the unit cost you give, and the difference is posted to inventory against the inventory adjustment account.
/api/scm/cost-revaluationsPublished as /api/v1/cost-revaluationsDownload specification (OpenAPI 3.1) Screen: Cost Revaluations
Overview
| Package | Supply Chain |
|---|---|
| Authentication | Bearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key |
| Authorization | The caller's roles must hold Supply Chain › Cost Revaluations on the Roles screen: display for GET, add for POST, change for PUT, delete for DELETE; an action needs the grant of the button that runs it on the screen. |
| Table | scm.cost_revaluations · kept per company (and organisational unit where it has one) |
| Record | Read only; key id |
| Rules | The same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail. |
API reference
6 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/scm/cost-revaluationsList cost revaluations
Query parameters
| Name | Description | Example |
|---|---|---|
limit | Rows per page (50 by default, at most 200) | limit=100 |
offset | Rows to skip | offset=200 |
q | Free-text search over the search columns | q=acme |
sort | column:asc or column:desc, several separated by commas | sort=created_at:desc |
filter | A JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sorted | filter={"col":"status","op":"eq","value":"open"} |
<field>=<value> | Shorthand for "field is value" |
Response 200
{
"rows": [
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"reval_no": "REV-000001",
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"old_method": "text",
"new_method": "text",
"new_unit_cost": "1250.00",
"on_hand_qty": "12.0000",
"old_value": "1250.00",
"new_value": "1250.00",
"difference": "1250.00",
"reason": "text",
"status": "draft",
"journal_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"layers_closed": 10
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/scm/cost-revaluations?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/scm/cost-revaluations/{id}Read one cost revaluation
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"reval_no": "REV-000001",
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"old_method": "text",
"new_method": "text",
"new_unit_cost": "1250.00",
"on_hand_qty": "12.0000",
"old_value": "1250.00",
"new_value": "1250.00",
"difference": "1250.00",
"reason": "text",
"status": "draft",
"journal_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"layers_closed": 10
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/scm/cost-revaluations/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/cost-revaluationsPost cost revaluations
Request body
The keys this action reads (* = required; "one of" lists the only values):
itemId*, item_id, newMethod, new_method, newUnitCost, new_unit_cost, reasonResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/scm/cost-revaluations" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"itemId":"value","item_id":"value","newMethod":"value","new_method":"value","newUnitCost":"value","new_unit_cost":"value"}'POST/api/scm/cost-revaluations/{id}/copyCopy
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
overrides, preview, withLinesResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/scm/cost-revaluations/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'PUT/api/scm/cost-revaluations/{id}Put cost revaluations
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X PUT "https://demo.tranxact.ai/api/scm/cost-revaluations/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/scm/cost-revaluations/{id}Delete cost revaluations
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X DELETE "https://demo.tranxact.ai/api/scm/cost-revaluations/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"Data model
Every field of a cost revaluation, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.
| Field | Type | Access | Description |
|---|---|---|---|
id | uuid | read only | Id |
org_id | uuid | read only | Org id |
reval_no | text | read only | Reval no |
item_id | uuid | read only | Item id |
old_method | text | read only | Old method |
new_method | text | read only | New method |
new_unit_cost | numeric | read only | New unit cost |
on_hand_qty | numeric | read only | On hand qty |
old_value | numeric | read only | Old value |
new_value | numeric | read only | New value |
difference | numeric | read only | Difference |
reason | text | read only | Reason |
status | text | read only | Status |
journal_id | uuid | read only | Journal id |
layers_closed | integer | read only | Layers closed |
posted_by | uuid | read only | Posted by |
posted_at | timestamp with time zone | read only | Posted at |
created_at | timestamp with time zone | read only | Created at |
created_by | uuid | read only | Created by |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
xf_text_1 | text | read only | Xf text 1 |
xf_text_2 | text | read only | Xf text 2 |
xf_text_3 | text | read only | Xf text 3 |
xf_text_4 | text | read only | Xf text 4 |
xf_text_5 | text | read only | Xf text 5 |
xf_num_1 | numeric | read only | Xf num 1 |
xf_num_2 | numeric | read only | Xf num 2 |
xf_num_3 | numeric | read only | Xf num 3 |
xf_date_1 | date | read only | Xf date 1 |
xf_date_2 | date | read only | Xf date 2 |
Errors
| Status | Meaning |
|---|---|
| 400 | The request could not be read: a filter that is not JSON, a bad parameter |
| 401 | No credential, or it is wrong, revoked or expired |
| 403 | The caller's roles do not hold Supply Chain › Cost Revaluations for this verb, or the address or origin is not allowed |
| 404 | No record with that id is visible to the caller |
| 409 | A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else |
| 422 | Refused by the same validation as the screen; the error names the field and why |
Every error is JSON: {"error": "a sentence saying what was wrong"}, with field where it applies.