Supply Chain · Reachable by link
Item · Purchasing
Who it is bought from, on what terms, with what tolerance, and how the invoice is matched.
/api/scm/item-purchasingPublished as /api/v1/item-purchasingDownload specification (OpenAPI 3.1) Screen: Item · Purchasing
Overview
| 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 · Purchasing 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_purchasing · 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-purchasingList item · purchasing
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",
"is_purchasable": true,
"purchasing_uom": "text",
"purchasing_uom_conversion": "1250.00",
"buyer_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"commodity_category_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"default_supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"default_supplier_site_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"list_price": "1250.00",
"last_price_paid": "1250.00",
"price_tolerance_pct": "1250.00",
"receipt_tolerance_pct": "1250.00"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/scm/item-purchasing?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/scm/item-purchasing/{id}Read one item purchasing
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",
"is_purchasable": true,
"purchasing_uom": "text",
"purchasing_uom_conversion": "1250.00",
"buyer_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"commodity_category_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"default_supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"default_supplier_site_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"list_price": "1250.00",
"last_price_paid": "1250.00",
"price_tolerance_pct": "1250.00",
"receipt_tolerance_pct": "1250.00"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/scm/item-purchasing/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/item-purchasingCreate a item purchasing
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. |
is_purchasable | boolean | No | Purchasable |
purchasing_uom | text | No | Purchasing unit of measure |
purchasing_uom_conversion | numeric | No | Conversion to stock unit |
buyer_id | uuid | No | Buyer |
commodity_category_id | uuid | No | Commodity category id |
default_supplier_id | uuid | No | Default supplier |
default_supplier_site_id | uuid | No | Default supplier site id |
list_price | numeric | No | Price |
last_price_paid | numeric | No | Last price paid |
price_tolerance_pct | numeric | No | Price tolerance % |
receipt_tolerance_pct | numeric | No | Over-receipt tolerance % |
invoice_match_option | text | No | Invoice matching Allowed: two_way three_way four_way none |
receipt_routing | text | No | On receipt Allowed: direct inspection standard |
lead_time_days | integer | No | Lead time (days) |
minimum_order_qty | numeric | No | Minimum order quantity |
order_multiple | numeric | No | Order multiple |
fixed_order_cost | numeric | No | Fixed order cost |
allow_auto_source | boolean | No | May be ordered automatically |
requires_approval | boolean | No | Requires approval |
is_consigned | boolean | No | Consigned |
is_outsourced | boolean | No | Subcontract manufacture |
hs_code | text | No | HS code |
country_of_origin | text | No | Country of origin |
is_hazmat_regulated | boolean | No | Is hazmat regulated |
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. |
quantity_tolerance_pct | numeric | No | Quantity tolerance % |
source_list_required | boolean | No | Source list required — Purchase orders for this item, in this unit and beneath it, may only go to suppliers on its Source List (Supply Chain › Source List). |
Sample body
{
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"is_purchasable": true,
"purchasing_uom": "text",
"purchasing_uom_conversion": "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",
"is_purchasable": true,
"purchasing_uom": "text",
"purchasing_uom_conversion": "1250.00",
"buyer_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"commodity_category_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"default_supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"default_supplier_site_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"list_price": "1250.00",
"last_price_paid": "1250.00",
"price_tolerance_pct": "1250.00",
"receipt_tolerance_pct": "1250.00"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/scm/item-purchasing" \
-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","is_purchasable":true,"purchasing_uom":"text","purchasing_uom_conversion":"1250.00"}'PUT/api/scm/item-purchasing/{id}Change a item purchasing
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. |
is_purchasable | boolean | No | Purchasable |
purchasing_uom | text | No | Purchasing unit of measure |
purchasing_uom_conversion | numeric | No | Conversion to stock unit |
buyer_id | uuid | No | Buyer |
commodity_category_id | uuid | No | Commodity category id |
default_supplier_id | uuid | No | Default supplier |
default_supplier_site_id | uuid | No | Default supplier site id |
list_price | numeric | No | Price |
last_price_paid | numeric | No | Last price paid |
price_tolerance_pct | numeric | No | Price tolerance % |
receipt_tolerance_pct | numeric | No | Over-receipt tolerance % |
invoice_match_option | text | No | Invoice matching Allowed: two_way three_way four_way none |
receipt_routing | text | No | On receipt Allowed: direct inspection standard |
lead_time_days | integer | No | Lead time (days) |
minimum_order_qty | numeric | No | Minimum order quantity |
order_multiple | numeric | No | Order multiple |
fixed_order_cost | numeric | No | Fixed order cost |
allow_auto_source | boolean | No | May be ordered automatically |
requires_approval | boolean | No | Requires approval |
is_consigned | boolean | No | Consigned |
is_outsourced | boolean | No | Subcontract manufacture |
hs_code | text | No | HS code |
country_of_origin | text | No | Country of origin |
is_hazmat_regulated | boolean | No | Is hazmat regulated |
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. |
quantity_tolerance_pct | numeric | No | Quantity tolerance % |
source_list_required | boolean | No | Source list required — Purchase orders for this item, in this unit and beneath it, may only go to suppliers on its Source List (Supply Chain › Source List). |
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",
"is_purchasable": true,
"purchasing_uom": "text",
"purchasing_uom_conversion": "1250.00",
"buyer_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"commodity_category_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"default_supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"default_supplier_site_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"list_price": "1250.00",
"last_price_paid": "1250.00",
"price_tolerance_pct": "1250.00",
"receipt_tolerance_pct": "1250.00"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/scm/item-purchasing/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-purchasing/{id}Delete a item purchasing
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-purchasing/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/item-purchasing/{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-purchasing/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 purchasing, 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. |
is_purchasable | boolean | read, write | Purchasable |
purchasing_uom | text | read, write | Purchasing unit of measure |
purchasing_uom_conversion | numeric | read, write | Conversion to stock unit |
buyer_id | uuid | read, write | Buyer |
commodity_category_id | uuid | read, write | Commodity category id |
default_supplier_id | uuid | read, write | Default supplier |
default_supplier_site_id | uuid | read, write | Default supplier site id |
list_price | numeric | read, write | Price |
last_price_paid | numeric | read, write | Last price paid |
price_tolerance_pct | numeric | read, write | Price tolerance % |
receipt_tolerance_pct | numeric | read, write | Over-receipt tolerance % |
invoice_match_option | text | read, write | Invoice matching Allowed: two_way three_way four_way none |
receipt_routing | text | read, write | On receipt Allowed: direct inspection standard |
lead_time_days | integer | read, write | Lead time (days) |
minimum_order_qty | numeric | read, write | Minimum order quantity |
order_multiple | numeric | read, write | Order multiple |
fixed_order_cost | numeric | read, write | Fixed order cost |
allow_auto_source | boolean | read, write | May be ordered automatically |
requires_approval | boolean | read, write | Requires approval |
is_consigned | boolean | read, write | Consigned |
is_outsourced | boolean | read, write | Subcontract manufacture |
hs_code | text | read, write | HS code |
country_of_origin | text | read, write | Country of origin |
is_hazmat_regulated | boolean | read, write | Is hazmat regulated |
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 |
quantity_tolerance_pct | numeric | read, write | Quantity tolerance % |
source_list_required | boolean | read, write | Source list required — Purchase orders for this item, in this unit and beneath it, may only go to suppliers on its Source List (Supply Chain › Source List). |
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 · Purchasing 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.