Supply Chain · Reachable by link
Item · Costing
The cost method, the elements that make up the standard, and where it posts. The elements must add up to the standard — the platform refuses a row where they do not.
/api/scm/item-costingPublished as /api/v1/item-costingOverview
| 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 › Item · Costing 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.item_costing · kept per company (and organisational unit where it has one) |
| Record | Created, changed and (where the screen allows) deleted; 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/item-costingList item · costing
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",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"cost_method": "standard",
"currency": "USD",
"material_cost": "1250.00",
"labor_cost": "1250.00",
"overhead_cost": "1250.00",
"subcontract_cost": "1250.00",
"freight_cost": "1250.00",
"standard_cost": "1250.00",
"average_cost": "1250.00",
"last_cost": "1250.00",
"inventory_account_no": "INV-000001"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/scm/item-costing?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/scm/item-costing/{id}Read one item costing
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",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"cost_method": "standard",
"currency": "USD",
"material_cost": "1250.00",
"labor_cost": "1250.00",
"overhead_cost": "1250.00",
"subcontract_cost": "1250.00",
"freight_cost": "1250.00",
"standard_cost": "1250.00",
"average_cost": "1250.00",
"last_cost": "1250.00",
"inventory_account_no": "INV-000001"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/scm/item-costing/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/item-costingCreate a item costing
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
item_id | uuid | Yes | Item |
org_unit_id | uuid | No | Applies in — Leave empty and it applies company-wide. Choose a business unit and it overrides the company-wide row there — which is how one item behaves differently in two plants. |
cost_method | text | No | Cost method Allowed: standard average fifo lifo specific actual |
currency | text | No | Currency |
material_cost | numeric | No | Material |
labor_cost | numeric | No | Labor |
overhead_cost | numeric | No | Overhead |
subcontract_cost | numeric | No | Subcontract |
freight_cost | numeric | No | Freight |
standard_cost | numeric | No | Standard cost — Must equal the elements above when any of them are given. |
average_cost | numeric | No | Average cost |
last_cost | numeric | No | Last cost |
inventory_account_no | text | No | Inventory account |
cogs_account_no | text | No | Cost of sales account |
variance_account_no | text | No | Variance account |
revenue_account_no | text | No | Revenue account |
cost_center_id | uuid | No | Cost center |
profit_center_id | uuid | No | Profit center id |
is_inventory_asset | boolean | No | Carried as an inventory asset |
is_capitalizable | boolean | No | Capitalizable — Ticked, every goods receipt of this item drafts fixed assets for finance to capitalise (Accounting › Assets to Capitalise). A requisition in the Capital equipment category does the same for whatever it orders. |
asset_category | text | No | Asset category |
useful_life_months | integer | No | Useful life (months) |
tax_category_id | uuid | No | Tax category id |
tax_code | text | No | Tax code |
is_tax_exempt | boolean | No | Tax exempt |
transfer_price | numeric | No | Transfer price |
transfer_price_basis | text | No | Transfer price basis Allowed: cost cost_plus market negotiated |
effective_from | date | No | In force from — The date this version of the row takes effect. Leave it as today unless you are dating a change ahead. |
effective_to | date | No | Until — Leave empty for open-ended. Setting it ends this version rather than deleting it. |
asset_class_id | uuid | No | Asset class — The class its assets go into: their accounts, and how long they are depreciated over. Left empty, the receipt still drafts them and finance chooses the class when capitalising. |
asset_per_unit | boolean | No | One asset per unit received — Cleared, a receipt line becomes one asset for its whole quantity. Serial-numbered units are always one asset each. |
Sample body
{
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"cost_method": "standard",
"currency": "USD",
"material_cost": "1250.00"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"cost_method": "standard",
"currency": "USD",
"material_cost": "1250.00",
"labor_cost": "1250.00",
"overhead_cost": "1250.00",
"subcontract_cost": "1250.00",
"freight_cost": "1250.00",
"standard_cost": "1250.00",
"average_cost": "1250.00",
"last_cost": "1250.00",
"inventory_account_no": "INV-000001"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/scm/item-costing" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"item_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","org_unit_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","cost_method":"standard","currency":"USD","material_cost":"1250.00"}'PUT/api/scm/item-costing/{id}Change a item costing
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
Only the fields to change; fields left out keep their value.
| Field | Type | Required | Description |
|---|---|---|---|
item_id | uuid | Yes | Item |
org_unit_id | uuid | No | Applies in — Leave empty and it applies company-wide. Choose a business unit and it overrides the company-wide row there — which is how one item behaves differently in two plants. |
cost_method | text | No | Cost method Allowed: standard average fifo lifo specific actual |
currency | text | No | Currency |
material_cost | numeric | No | Material |
labor_cost | numeric | No | Labor |
overhead_cost | numeric | No | Overhead |
subcontract_cost | numeric | No | Subcontract |
freight_cost | numeric | No | Freight |
standard_cost | numeric | No | Standard cost — Must equal the elements above when any of them are given. |
average_cost | numeric | No | Average cost |
last_cost | numeric | No | Last cost |
inventory_account_no | text | No | Inventory account |
cogs_account_no | text | No | Cost of sales account |
variance_account_no | text | No | Variance account |
revenue_account_no | text | No | Revenue account |
cost_center_id | uuid | No | Cost center |
profit_center_id | uuid | No | Profit center id |
is_inventory_asset | boolean | No | Carried as an inventory asset |
is_capitalizable | boolean | No | Capitalizable — Ticked, every goods receipt of this item drafts fixed assets for finance to capitalise (Accounting › Assets to Capitalise). A requisition in the Capital equipment category does the same for whatever it orders. |
asset_category | text | No | Asset category |
useful_life_months | integer | No | Useful life (months) |
tax_category_id | uuid | No | Tax category id |
tax_code | text | No | Tax code |
is_tax_exempt | boolean | No | Tax exempt |
transfer_price | numeric | No | Transfer price |
transfer_price_basis | text | No | Transfer price basis Allowed: cost cost_plus market negotiated |
effective_from | date | No | In force from — The date this version of the row takes effect. Leave it as today unless you are dating a change ahead. |
effective_to | date | No | Until — Leave empty for open-ended. Setting it ends this version rather than deleting it. |
asset_class_id | uuid | No | Asset class — The class its assets go into: their accounts, and how long they are depreciated over. Left empty, the receipt still drafts them and finance chooses the class when capitalising. |
asset_per_unit | boolean | No | One asset per unit received — Cleared, a receipt line becomes one asset for its whole quantity. Serial-numbered units are always one asset each. |
Sample body
{
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"cost_method": "standard",
"currency": "USD",
"material_cost": "1250.00",
"labor_cost": "1250.00",
"overhead_cost": "1250.00",
"subcontract_cost": "1250.00",
"freight_cost": "1250.00",
"standard_cost": "1250.00",
"average_cost": "1250.00",
"last_cost": "1250.00",
"inventory_account_no": "INV-000001"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/scm/item-costing/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"item_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","org_unit_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'DELETE/api/scm/item-costing/{id}Delete a item costing
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{ "deleted": true }Many documents are cancelled or reversed instead; the API refuses a delete the screen would refuse.
Sample request
curl -X DELETE "https://demo.tranxact.ai/api/scm/item-costing/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/item-costing/{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/item-costing/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'Data model
Every field of a item costing, 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, write | Item |
org_unit_id | uuid | read, write | Applies in — Leave empty and it applies company-wide. Choose a business unit and it overrides the company-wide row there — which is how one item behaves differently in two plants. |
cost_method | text | read, write | Cost method Allowed: standard average fifo lifo specific actual |
currency | text | read, write | Currency |
material_cost | numeric | read, write | Material |
labor_cost | numeric | read, write | Labor |
overhead_cost | numeric | read, write | Overhead |
subcontract_cost | numeric | read, write | Subcontract |
freight_cost | numeric | read, write | Freight |
standard_cost | numeric | read, write | Standard cost — Must equal the elements above when any of them are given. |
average_cost | numeric | read, write | Average cost |
last_cost | numeric | read, write | Last cost |
inventory_account_no | text | read, write | Inventory account |
cogs_account_no | text | read, write | Cost of sales account |
variance_account_no | text | read, write | Variance account |
revenue_account_no | text | read, write | Revenue account |
cost_center_id | uuid | read, write | Cost center |
profit_center_id | uuid | read, write | Profit center id |
is_inventory_asset | boolean | read, write | Carried as an inventory asset |
is_capitalizable | boolean | read, write | Capitalizable — Ticked, every goods receipt of this item drafts fixed assets for finance to capitalise (Accounting › Assets to Capitalise). A requisition in the Capital equipment category does the same for whatever it orders. |
asset_category | text | read, write | Asset category |
useful_life_months | integer | read, write | Useful life (months) |
tax_category_id | uuid | read, write | Tax category id |
tax_code | text | read, write | Tax code |
is_tax_exempt | boolean | read, write | Tax exempt |
transfer_price | numeric | read, write | Transfer price |
transfer_price_basis | text | read, write | Transfer price basis Allowed: cost cost_plus market negotiated |
created_at | timestamp with time zone | read only | Created at |
effective_from | date | read, write | In force from — The date this version of the row takes effect. Leave it as today unless you are dating a change ahead. |
effective_to | date | read, write | Until — Leave empty for open-ended. Setting it ends this version rather than deleting it. |
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 |
created_by | uuid | read only | Created by |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
asset_class_id | uuid | read, write | Asset class — The class its assets go into: their accounts, and how long they are depreciated over. Left empty, the receipt still drafts them and finance chooses the class when capitalising. |
asset_per_unit | boolean | read, write | One asset per unit received — Cleared, a receipt line becomes one asset for its whole quantity. Serial-numbered units are always one asset each. |
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 › Item · Costing 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.