Supply Chain · Inventory Costing
Cost Layers
Each receipt of a FIFO or LIFO item, what is left of it and what a unit of it costs now (landed cost included).
/api/scm/cost-layersPublished as /api/v1/cost-layersOverview
| 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 Layers 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_layer_board · 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-layersList cost layers
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",
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"item_no": "ITE-000001",
"item_name": "Example",
"cost_method": "text",
"layer_seq": "1250.00",
"received_on": "2026-10-30T09:00:00Z",
"reference_module": "text",
"reference_no": "REF-000001",
"lot_no": "LOT-000001",
"qty_in": "12.0000",
"qty_remaining": "12.0000",
"unit_cost": "1250.00",
"landed_per_unit": "1250.00"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/scm/cost-layers?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/scm/cost-layers/{id}Read one cost layer
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",
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"item_no": "ITE-000001",
"item_name": "Example",
"cost_method": "text",
"layer_seq": "1250.00",
"received_on": "2026-10-30T09:00:00Z",
"reference_module": "text",
"reference_no": "REF-000001",
"lot_no": "LOT-000001",
"qty_in": "12.0000",
"qty_remaining": "12.0000",
"unit_cost": "1250.00",
"landed_per_unit": "1250.00"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/scm/cost-layers/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/cost-layersPost cost layers
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/cost-layers" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/cost-layers/{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-layers/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-layers/{id}Put cost layers
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-layers/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/scm/cost-layers/{id}Delete cost layers
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-layers/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"Data model
Every field of a cost layer, 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 |
item_id | uuid | read only | Item id |
item_no | text | read only | Item no |
item_name | text | read only | Item name |
cost_method | text | read only | Cost method |
layer_seq | bigint | read only | Layer seq |
received_on | timestamp with time zone | read only | Received on |
reference_module | text | read only | Reference module |
reference_no | text | read only | Reference no |
lot_no | text | read only | Lot no |
qty_in | numeric | read only | Qty in |
qty_remaining | numeric | read only | Qty remaining |
unit_cost | numeric | read only | Unit cost |
landed_per_unit | numeric | read only | Landed per unit |
remaining_value | numeric | read only | Remaining value |
is_opening | boolean | read only | Is opening |
closed_reason | text | read only | Closed reason |
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 Layers 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.