TRANXACT.AI Help

Supply Chain · Inventory Costing

Inventory Valuation

What stock is worth, item by item, by the costing method each item is costed with — beside what it would be worth at standard cost.

Type REST6 operationsBase path /api/scm/inventory-valuationPublished as /api/v1/inventory-valuation

Download specification (OpenAPI 3.1) Screen: Inventory Valuation

Overview

PackageSupply Chain
AuthenticationBearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key
AuthorizationThe caller's roles must hold Supply Chain › Inventory Valuation 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.
Tablescm.inventory_valuation · kept per company (and organisational unit where it has one)
RecordRead only; key item_id
RulesThe 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/inventory-valuationList inventory valuation

Query parameters

NameDescriptionExample
limitRows per page (50 by default, at most 200)limit=100
offsetRows to skipoffset=200
qFree-text search over the search columnsq=acme
sortcolumn:asc or column:desc, several separated by commassort=created_at:desc
filterA JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sortedfilter={"col":"status","op":"eq","value":"open"}
<field>=<value>Shorthand for "field is value" 

Response 200

{
  "rows": [
    {
      "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "item_no": "ITE-000001",
      "item_name": "Example",
      "uom": "text",
      "cost_method": "text",
      "on_hand": "1250.00",
      "standard_cost": "1250.00",
      "unit_value": "1250.00",
      "stock_value": "1250.00",
      "value_at_standard": "1250.00",
      "open_layers": 10
    }
  ],
  "count": 1
}

Sample request

curl "https://demo.tranxact.ai/api/scm/inventory-valuation?limit=20" \
  -H "Authorization: Bearer $TOKEN"
GET/api/scm/inventory-valuation/{item_id}Read one valuation line

Path parameters

NameTypeDescription
item_idstring (uuid)The record's item_id, as a list returns it.

Response 200

{
  "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "item_no": "ITE-000001",
  "item_name": "Example",
  "uom": "text",
  "cost_method": "text",
  "on_hand": "1250.00",
  "standard_cost": "1250.00",
  "unit_value": "1250.00",
  "stock_value": "1250.00",
  "value_at_standard": "1250.00",
  "open_layers": 10
}

404 when no record with that id is visible to the caller.

Sample request

curl "https://demo.tranxact.ai/api/scm/inventory-valuation/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/inventory-valuationPost inventory valuation

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 POST "https://demo.tranxact.ai/api/scm/inventory-valuation" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/inventory-valuation/{id}/copyCopy

Path parameters

NameTypeDescription
idstring (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, withLines

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 POST "https://demo.tranxact.ai/api/scm/inventory-valuation/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/inventory-valuation/{id}Put inventory valuation

Path parameters

NameTypeDescription
idstring (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/inventory-valuation/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
DELETE/api/scm/inventory-valuation/{id}Delete inventory valuation

Path parameters

NameTypeDescription
idstring (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/inventory-valuation/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"

Data model

Every field of a valuation line, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.

FieldTypeAccessDescription
org_iduuidread onlyOrg id
item_iduuidread onlyItem id
item_notextread onlyItem no
item_nametextread onlyItem name
uomtextread onlyUom
cost_methodtextread onlyCost method
on_handnumericread onlyOn hand
standard_costnumericread onlyStandard cost
unit_valuenumericread onlyUnit value
stock_valuenumericread onlyStock value
value_at_standardnumericread onlyValue at standard
open_layersintegerread onlyOpen layers

Errors

StatusMeaning
400The request could not be read: a filter that is not JSON, a bad parameter
401No credential, or it is wrong, revoked or expired
403The caller's roles do not hold Supply Chain › Inventory Valuation for this verb, or the address or origin is not allowed
404No record with that id is visible to the caller
409A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else
422Refused 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.