TRANXACT.AI Help

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.

Type REST6 operationsBase path /api/scm/item-costingPublished as /api/v1/item-costing

Download specification (OpenAPI 3.1) Screen: Item · Costing

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 › 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.
Tablescm.item_costing · kept per company (and organisational unit where it has one)
RecordCreated, changed and (where the screen allows) deleted; key 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/item-costingList item · costing

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": [
    {
      "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

NameTypeDescription
idstring (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.

FieldTypeRequiredDescription
item_iduuidYesItem
org_unit_iduuidNoApplies 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_methodtextNoCost method
Allowed: standard average fifo lifo specific actual
currencytextNoCurrency
material_costnumericNoMaterial
labor_costnumericNoLabor
overhead_costnumericNoOverhead
subcontract_costnumericNoSubcontract
freight_costnumericNoFreight
standard_costnumericNoStandard cost — Must equal the elements above when any of them are given.
average_costnumericNoAverage cost
last_costnumericNoLast cost
inventory_account_notextNoInventory account
cogs_account_notextNoCost of sales account
variance_account_notextNoVariance account
revenue_account_notextNoRevenue account
cost_center_iduuidNoCost center
profit_center_iduuidNoProfit center id
is_inventory_assetbooleanNoCarried as an inventory asset
is_capitalizablebooleanNoCapitalizable — 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_categorytextNoAsset category
useful_life_monthsintegerNoUseful life (months)
tax_category_iduuidNoTax category id
tax_codetextNoTax code
is_tax_exemptbooleanNoTax exempt
transfer_pricenumericNoTransfer price
transfer_price_basistextNoTransfer price basis
Allowed: cost cost_plus market negotiated
effective_fromdateNoIn force from — The date this version of the row takes effect. Leave it as today unless you are dating a change ahead.
effective_todateNoUntil — Leave empty for open-ended. Setting it ends this version rather than deleting it.
asset_class_iduuidNoAsset 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_unitbooleanNoOne 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

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

Only the fields to change; fields left out keep their value.

FieldTypeRequiredDescription
item_iduuidYesItem
org_unit_iduuidNoApplies 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_methodtextNoCost method
Allowed: standard average fifo lifo specific actual
currencytextNoCurrency
material_costnumericNoMaterial
labor_costnumericNoLabor
overhead_costnumericNoOverhead
subcontract_costnumericNoSubcontract
freight_costnumericNoFreight
standard_costnumericNoStandard cost — Must equal the elements above when any of them are given.
average_costnumericNoAverage cost
last_costnumericNoLast cost
inventory_account_notextNoInventory account
cogs_account_notextNoCost of sales account
variance_account_notextNoVariance account
revenue_account_notextNoRevenue account
cost_center_iduuidNoCost center
profit_center_iduuidNoProfit center id
is_inventory_assetbooleanNoCarried as an inventory asset
is_capitalizablebooleanNoCapitalizable — 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_categorytextNoAsset category
useful_life_monthsintegerNoUseful life (months)
tax_category_iduuidNoTax category id
tax_codetextNoTax code
is_tax_exemptbooleanNoTax exempt
transfer_pricenumericNoTransfer price
transfer_price_basistextNoTransfer price basis
Allowed: cost cost_plus market negotiated
effective_fromdateNoIn force from — The date this version of the row takes effect. Leave it as today unless you are dating a change ahead.
effective_todateNoUntil — Leave empty for open-ended. Setting it ends this version rather than deleting it.
asset_class_iduuidNoAsset 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_unitbooleanNoOne 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

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

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/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.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
item_iduuidread, writeItem
org_unit_iduuidread, writeApplies 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_methodtextread, writeCost method
Allowed: standard average fifo lifo specific actual
currencytextread, writeCurrency
material_costnumericread, writeMaterial
labor_costnumericread, writeLabor
overhead_costnumericread, writeOverhead
subcontract_costnumericread, writeSubcontract
freight_costnumericread, writeFreight
standard_costnumericread, writeStandard cost — Must equal the elements above when any of them are given.
average_costnumericread, writeAverage cost
last_costnumericread, writeLast cost
inventory_account_notextread, writeInventory account
cogs_account_notextread, writeCost of sales account
variance_account_notextread, writeVariance account
revenue_account_notextread, writeRevenue account
cost_center_iduuidread, writeCost center
profit_center_iduuidread, writeProfit center id
is_inventory_assetbooleanread, writeCarried as an inventory asset
is_capitalizablebooleanread, writeCapitalizable — 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_categorytextread, writeAsset category
useful_life_monthsintegerread, writeUseful life (months)
tax_category_iduuidread, writeTax category id
tax_codetextread, writeTax code
is_tax_exemptbooleanread, writeTax exempt
transfer_pricenumericread, writeTransfer price
transfer_price_basistextread, writeTransfer price basis
Allowed: cost cost_plus market negotiated
created_attimestamp with time zoneread onlyCreated at
effective_fromdateread, writeIn force from — The date this version of the row takes effect. Leave it as today unless you are dating a change ahead.
effective_todateread, writeUntil — Leave empty for open-ended. Setting it ends this version rather than deleting it.
xf_text_1textread onlyXf text 1
xf_text_2textread onlyXf text 2
xf_text_3textread onlyXf text 3
xf_text_4textread onlyXf text 4
xf_text_5textread onlyXf text 5
xf_num_1numericread onlyXf num 1
xf_num_2numericread onlyXf num 2
xf_num_3numericread onlyXf num 3
xf_date_1dateread onlyXf date 1
xf_date_2dateread onlyXf date 2
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
asset_class_iduuidread, writeAsset 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_unitbooleanread, writeOne asset per unit received — Cleared, a receipt line becomes one asset for its whole quantity. Serial-numbered units are always one asset each.

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 › Item · Costing 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.