TRANXACT.AI Help

Supply Chain · Reachable by link

Item · Purchasing

Who it is bought from, on what terms, with what tolerance, and how the invoice is matched.

Type REST6 operationsBase path /api/scm/item-purchasingPublished as /api/v1/item-purchasing

Download specification (OpenAPI 3.1) Screen: Item · Purchasing

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 · 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.
Tablescm.item_purchasing · 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-purchasingList item · purchasing

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",
      "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

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",
  "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.

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.
is_purchasablebooleanNoPurchasable
purchasing_uomtextNoPurchasing unit of measure
purchasing_uom_conversionnumericNoConversion to stock unit
buyer_iduuidNoBuyer
commodity_category_iduuidNoCommodity category id
default_supplier_iduuidNoDefault supplier
default_supplier_site_iduuidNoDefault supplier site id
list_pricenumericNoPrice
last_price_paidnumericNoLast price paid
price_tolerance_pctnumericNoPrice tolerance %
receipt_tolerance_pctnumericNoOver-receipt tolerance %
invoice_match_optiontextNoInvoice matching
Allowed: two_way three_way four_way none
receipt_routingtextNoOn receipt
Allowed: direct inspection standard
lead_time_daysintegerNoLead time (days)
minimum_order_qtynumericNoMinimum order quantity
order_multiplenumericNoOrder multiple
fixed_order_costnumericNoFixed order cost
allow_auto_sourcebooleanNoMay be ordered automatically
requires_approvalbooleanNoRequires approval
is_consignedbooleanNoConsigned
is_outsourcedbooleanNoSubcontract manufacture
hs_codetextNoHS code
country_of_origintextNoCountry of origin
is_hazmat_regulatedbooleanNoIs hazmat regulated
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.
quantity_tolerance_pctnumericNoQuantity tolerance %
source_list_requiredbooleanNoSource 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

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.
is_purchasablebooleanNoPurchasable
purchasing_uomtextNoPurchasing unit of measure
purchasing_uom_conversionnumericNoConversion to stock unit
buyer_iduuidNoBuyer
commodity_category_iduuidNoCommodity category id
default_supplier_iduuidNoDefault supplier
default_supplier_site_iduuidNoDefault supplier site id
list_pricenumericNoPrice
last_price_paidnumericNoLast price paid
price_tolerance_pctnumericNoPrice tolerance %
receipt_tolerance_pctnumericNoOver-receipt tolerance %
invoice_match_optiontextNoInvoice matching
Allowed: two_way three_way four_way none
receipt_routingtextNoOn receipt
Allowed: direct inspection standard
lead_time_daysintegerNoLead time (days)
minimum_order_qtynumericNoMinimum order quantity
order_multiplenumericNoOrder multiple
fixed_order_costnumericNoFixed order cost
allow_auto_sourcebooleanNoMay be ordered automatically
requires_approvalbooleanNoRequires approval
is_consignedbooleanNoConsigned
is_outsourcedbooleanNoSubcontract manufacture
hs_codetextNoHS code
country_of_origintextNoCountry of origin
is_hazmat_regulatedbooleanNoIs hazmat regulated
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.
quantity_tolerance_pctnumericNoQuantity tolerance %
source_list_requiredbooleanNoSource 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

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-purchasing/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/item-purchasing/{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-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.

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.
is_purchasablebooleanread, writePurchasable
purchasing_uomtextread, writePurchasing unit of measure
purchasing_uom_conversionnumericread, writeConversion to stock unit
buyer_iduuidread, writeBuyer
commodity_category_iduuidread, writeCommodity category id
default_supplier_iduuidread, writeDefault supplier
default_supplier_site_iduuidread, writeDefault supplier site id
list_pricenumericread, writePrice
last_price_paidnumericread, writeLast price paid
price_tolerance_pctnumericread, writePrice tolerance %
receipt_tolerance_pctnumericread, writeOver-receipt tolerance %
invoice_match_optiontextread, writeInvoice matching
Allowed: two_way three_way four_way none
receipt_routingtextread, writeOn receipt
Allowed: direct inspection standard
lead_time_daysintegerread, writeLead time (days)
minimum_order_qtynumericread, writeMinimum order quantity
order_multiplenumericread, writeOrder multiple
fixed_order_costnumericread, writeFixed order cost
allow_auto_sourcebooleanread, writeMay be ordered automatically
requires_approvalbooleanread, writeRequires approval
is_consignedbooleanread, writeConsigned
is_outsourcedbooleanread, writeSubcontract manufacture
hs_codetextread, writeHS code
country_of_origintextread, writeCountry of origin
is_hazmat_regulatedbooleanread, writeIs hazmat regulated
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
quantity_tolerance_pctnumericread, writeQuantity tolerance %
source_list_requiredbooleanread, writeSource 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

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 · Purchasing 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.