TRANXACT.AI Help

Supply Chain · Units & Packaging

Units of Measure

A unit belongs to a dimension and carries a factor to that dimension’s base unit, so any two units of one dimension convert without anybody declaring anything.

Type REST6 operationsBase path /api/scm/units-of-measurePublished as /api/v1/units-of-measure

Download specification (OpenAPI 3.1) Screen: Units of Measure

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 › Units of Measure 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.uoms · 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/units-of-measureList units of measure

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",
      "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "code": "COD-000001",
      "name": "Example",
      "plural_name": "Example",
      "symbol": "text",
      "dimension": "text",
      "factor_to_base": "1250.00",
      "is_base": true,
      "decimals": 10,
      "rounding": "half_up",
      "iso_code": "ISO-000001",
      "unece_code": "UNE-000001",
      "is_packaging": true
    }
  ],
  "count": 1
}

Sample request

curl "https://demo.tranxact.ai/api/scm/units-of-measure?limit=20" \
  -H "Authorization: Bearer $TOKEN"
GET/api/scm/units-of-measure/{id}Read one unit of measure

Path parameters

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "plural_name": "Example",
  "symbol": "text",
  "dimension": "text",
  "factor_to_base": "1250.00",
  "is_base": true,
  "decimals": 10,
  "rounding": "half_up",
  "iso_code": "ISO-000001",
  "unece_code": "UNE-000001",
  "is_packaging": true
}

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

Sample request

curl "https://demo.tranxact.ai/api/scm/units-of-measure/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/units-of-measureCreate a unit of measure

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
codetextYesCode — What appears on a line: EA, KG, PLT.
nametextYesName
plural_nametextNoPlural
symboltextNoSymbol — What is printed on a label.
dimensiontextYesMeasures — Two units of the same dimension convert by arithmetic. Two of different dimensions convert only per item, because that is a fact about the thing.
factor_to_basenumericNoWorth this many base units — A pound is 0.45359237 kilograms. The base unit itself is 1.
is_basebooleanNoThis is the base unit for its dimension — Exactly one per dimension. Two makes every conversion through it ambiguous.
decimalsintegerNoDecimal places — Ordering 2.5 pallets is a data entry error; 2.5 metres of cable is not. This is the only thing that knows the difference.
roundingtextNoRounding
Allowed: half_up half_even up down none
iso_codetextNoUN/CEFACT code — KGM, MTR, LTR. What a customs entry wants.
unece_codetextNoUNECE code
is_packagingbooleanNoIs also a container
allow_purchasebooleanNoMay be bought in
allow_salesbooleanNoMay be sold in
allow_stockbooleanNoMay be stocked in
allow_productionbooleanNoMay be produced in
sort_orderintegerNoSort order
is_activebooleanNoActive
notestextNoNotes

Sample body

{
  "code": "COD-000001",
  "name": "Example",
  "dimension": "text",
  "plural_name": "Example",
  "symbol": "text",
  "factor_to_base": "1250.00",
  "is_base": true
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "plural_name": "Example",
  "symbol": "text",
  "dimension": "text",
  "factor_to_base": "1250.00",
  "is_base": true,
  "decimals": 10,
  "rounding": "half_up",
  "iso_code": "ISO-000001",
  "unece_code": "UNE-000001",
  "is_packaging": true
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/scm/units-of-measure" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"code":"COD-000001","name":"Example","dimension":"text","plural_name":"Example","symbol":"text","factor_to_base":"1250.00","is_base":true}'
PUT/api/scm/units-of-measure/{id}Change a unit of measure

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
codetextYesCode — What appears on a line: EA, KG, PLT.
nametextYesName
plural_nametextNoPlural
symboltextNoSymbol — What is printed on a label.
dimensiontextYesMeasures — Two units of the same dimension convert by arithmetic. Two of different dimensions convert only per item, because that is a fact about the thing.
factor_to_basenumericNoWorth this many base units — A pound is 0.45359237 kilograms. The base unit itself is 1.
is_basebooleanNoThis is the base unit for its dimension — Exactly one per dimension. Two makes every conversion through it ambiguous.
decimalsintegerNoDecimal places — Ordering 2.5 pallets is a data entry error; 2.5 metres of cable is not. This is the only thing that knows the difference.
roundingtextNoRounding
Allowed: half_up half_even up down none
iso_codetextNoUN/CEFACT code — KGM, MTR, LTR. What a customs entry wants.
unece_codetextNoUNECE code
is_packagingbooleanNoIs also a container
allow_purchasebooleanNoMay be bought in
allow_salesbooleanNoMay be sold in
allow_stockbooleanNoMay be stocked in
allow_productionbooleanNoMay be produced in
sort_orderintegerNoSort order
is_activebooleanNoActive
notestextNoNotes

Sample body

{
  "code": "COD-000001",
  "name": "Example"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "plural_name": "Example",
  "symbol": "text",
  "dimension": "text",
  "factor_to_base": "1250.00",
  "is_base": true,
  "decimals": 10,
  "rounding": "half_up",
  "iso_code": "ISO-000001",
  "unece_code": "UNE-000001",
  "is_packaging": true
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/scm/units-of-measure/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"code":"COD-000001","name":"Example"}'
DELETE/api/scm/units-of-measure/{id}Delete a unit of measure

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/units-of-measure/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/units-of-measure/{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/units-of-measure/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 unit of measure, 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
org_unit_iduuidread onlyOrg unit id
codetextread, writeCode — What appears on a line: EA, KG, PLT.
nametextread, writeName
plural_nametextread, writePlural
symboltextread, writeSymbol — What is printed on a label.
dimensiontextread, writeMeasures — Two units of the same dimension convert by arithmetic. Two of different dimensions convert only per item, because that is a fact about the thing.
factor_to_basenumericread, writeWorth this many base units — A pound is 0.45359237 kilograms. The base unit itself is 1.
is_basebooleanread, writeThis is the base unit for its dimension — Exactly one per dimension. Two makes every conversion through it ambiguous.
decimalsintegerread, writeDecimal places — Ordering 2.5 pallets is a data entry error; 2.5 metres of cable is not. This is the only thing that knows the difference.
roundingtextread, writeRounding
Allowed: half_up half_even up down none
iso_codetextread, writeUN/CEFACT code — KGM, MTR, LTR. What a customs entry wants.
unece_codetextread, writeUNECE code
is_packagingbooleanread, writeIs also a container
allow_purchasebooleanread, writeMay be bought in
allow_salesbooleanread, writeMay be sold in
allow_stockbooleanread, writeMay be stocked in
allow_productionbooleanread, writeMay be produced in
sort_orderintegerread, writeSort order
is_activebooleanread, writeActive
notestextread, writeNotes
created_attimestamp with time zoneread onlyCreated at
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

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 › Units of Measure 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.