TRANXACT.AI Help

Supply Chain · Units & Packaging

Unit Conversions

The conversions arithmetic cannot derive. A rule with no item is a company rule; a rule with one belongs to that item and beats it.

Type REST6 operationsBase path /api/scm/uom-conversionsPublished as /api/v1/uom-conversions

Download specification (OpenAPI 3.1) Screen: Unit Conversions

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 › Unit Conversions 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.uom_conversions · 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/uom-conversionsList unit conversions

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",
      "from_uom_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "to_uom_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "numerator": "1250.00",
      "denominator": "1250.00",
      "is_reversible": true,
      "valid_from": "2026-10-30",
      "valid_to": "2026-10-30",
      "notes": "text",
      "created_at": "2026-10-30T09:00:00Z",
      "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "xf_text_1": "text",
      "xf_text_2": "text"
    }
  ],
  "count": 1
}

Sample request

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

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",
  "from_uom_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "to_uom_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "numerator": "1250.00",
  "denominator": "1250.00",
  "is_reversible": true,
  "valid_from": "2026-10-30",
  "valid_to": "2026-10-30",
  "notes": "text",
  "created_at": "2026-10-30T09:00:00Z",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "xf_text_1": "text",
  "xf_text_2": "text"
}

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

Sample request

curl "https://demo.tranxact.ai/api/scm/uom-conversions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/uom-conversionsCreate a unit conversion

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
item_iduuidNoItem — Leave empty for a company-wide rule. Naming an item makes it that item’s own, and it wins. An item’s rule has the item’s base unit on one side.
from_uom_iduuidYesFrom unit
to_uom_iduuidYesTo unit
numeratornumericNoNumerator — One case is twelve each: numerator 12, denominator 1. A ratio rather than a decimal, because 1/12 is not exact.
denominatornumericNoDenominator
is_reversiblebooleanNoWorks the other way round too
valid_fromdateNoIn force from
valid_todateNoUntil
notestextNoNotes

Sample body

{
  "from_uom_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "to_uom_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "numerator": "1250.00",
  "denominator": "1250.00",
  "is_reversible": true
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "from_uom_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "to_uom_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "numerator": "1250.00",
  "denominator": "1250.00",
  "is_reversible": true,
  "valid_from": "2026-10-30",
  "valid_to": "2026-10-30",
  "notes": "text",
  "created_at": "2026-10-30T09:00:00Z",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "xf_text_1": "text",
  "xf_text_2": "text"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/scm/uom-conversions" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"from_uom_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","to_uom_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","item_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","numerator":"1250.00","denominator":"1250.00","is_reversible":true}'
PUT/api/scm/uom-conversions/{id}Change a unit conversion

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_iduuidNoItem — Leave empty for a company-wide rule. Naming an item makes it that item’s own, and it wins. An item’s rule has the item’s base unit on one side.
from_uom_iduuidYesFrom unit
to_uom_iduuidYesTo unit
numeratornumericNoNumerator — One case is twelve each: numerator 12, denominator 1. A ratio rather than a decimal, because 1/12 is not exact.
denominatornumericNoDenominator
is_reversiblebooleanNoWorks the other way round too
valid_fromdateNoIn force from
valid_todateNoUntil
notestextNoNotes

Sample body

{
  "from_uom_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "to_uom_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "from_uom_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "to_uom_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "numerator": "1250.00",
  "denominator": "1250.00",
  "is_reversible": true,
  "valid_from": "2026-10-30",
  "valid_to": "2026-10-30",
  "notes": "text",
  "created_at": "2026-10-30T09:00:00Z",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "xf_text_1": "text",
  "xf_text_2": "text"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/scm/uom-conversions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"from_uom_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","to_uom_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'
DELETE/api/scm/uom-conversions/{id}Delete a unit conversion

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/uom-conversions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/uom-conversions/{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/uom-conversions/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 conversion, 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 — Leave empty for a company-wide rule. Naming an item makes it that item’s own, and it wins. An item’s rule has the item’s base unit on one side.
from_uom_iduuidread, writeFrom unit
to_uom_iduuidread, writeTo unit
numeratornumericread, writeNumerator — One case is twelve each: numerator 12, denominator 1. A ratio rather than a decimal, because 1/12 is not exact.
denominatornumericread, writeDenominator
is_reversiblebooleanread, writeWorks the other way round too
valid_fromdateread, writeIn force from
valid_todateread, writeUntil
notestextread, writeNotes
created_attimestamp with time zoneread onlyCreated at
org_unit_iduuidread onlyOrg unit id
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 › Unit Conversions 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.