TRANXACT.AI Help

Supply Chain · Buying

Guided Buying

What a person may buy without asking, when quotes or a sourcing event are required, and where to buy it from. Ask the guide rather than a colleague.

Type REST6 operationsBase path /api/scm/buying-policiesPublished as /api/v1/buying-policies

Download specification (OpenAPI 3.1) Screen: Guided Buying

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 › Guided Buying 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.buying_policies · 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/buying-policiesList guided buying

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",
      "code": "COD-000001",
      "name": "Example",
      "category": "text",
      "priority": 10,
      "no_approval_below": "1250.00",
      "requires_quotes_above": "1250.00",
      "minimum_quotes": 10,
      "requires_rfx_above": "1250.00",
      "requires_contract": true,
      "preferred_supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "preferred_catalog_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "approver_role_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "required_form": "text"
    }
  ],
  "count": 1
}

Sample request

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

Path parameters

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "category": "text",
  "priority": 10,
  "no_approval_below": "1250.00",
  "requires_quotes_above": "1250.00",
  "minimum_quotes": 10,
  "requires_rfx_above": "1250.00",
  "requires_contract": true,
  "preferred_supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "preferred_catalog_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "approver_role_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "required_form": "text"
}

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

Sample request

curl "https://demo.tranxact.ai/api/scm/buying-policies/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/buying-policiesCreate a buying policies

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
codetextYesPolicy code
nametextYesName
categorytextYesCategory
priorityintegerNoPriority — Lower wins.
no_approval_belownumericNoNo approval below
requires_quotes_abovenumericNoQuotes required above
minimum_quotesintegerNoHow many quotes
requires_rfx_abovenumericNoSourcing event required above
requires_contractbooleanNoA contract must be in place
preferred_supplier_iduuidNoPreferred supplier
preferred_catalog_iduuidNoPreferred catalog
approver_role_iduuidNoApprover role
required_formtextNoForm that must be completed
is_blockedbooleanNoBuying in this category is blocked
block_reasontextNoWhy it is blocked
guidancetextNoGuidance
is_activebooleanNoActive

Sample body

{
  "code": "COD-000001",
  "name": "Example",
  "category": "text",
  "priority": 10,
  "no_approval_below": "1250.00",
  "requires_quotes_above": "1250.00",
  "minimum_quotes": 10
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "category": "text",
  "priority": 10,
  "no_approval_below": "1250.00",
  "requires_quotes_above": "1250.00",
  "minimum_quotes": 10,
  "requires_rfx_above": "1250.00",
  "requires_contract": true,
  "preferred_supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "preferred_catalog_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "approver_role_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "required_form": "text"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/scm/buying-policies" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"code":"COD-000001","name":"Example","category":"text","priority":10,"no_approval_below":"1250.00","requires_quotes_above":"1250.00","minimum_quotes":10}'
PUT/api/scm/buying-policies/{id}Change a buying policies

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
codetextYesPolicy code
nametextYesName
categorytextYesCategory
priorityintegerNoPriority — Lower wins.
no_approval_belownumericNoNo approval below
requires_quotes_abovenumericNoQuotes required above
minimum_quotesintegerNoHow many quotes
requires_rfx_abovenumericNoSourcing event required above
requires_contractbooleanNoA contract must be in place
preferred_supplier_iduuidNoPreferred supplier
preferred_catalog_iduuidNoPreferred catalog
approver_role_iduuidNoApprover role
required_formtextNoForm that must be completed
is_blockedbooleanNoBuying in this category is blocked
block_reasontextNoWhy it is blocked
guidancetextNoGuidance
is_activebooleanNoActive

Sample body

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "category": "text",
  "priority": 10,
  "no_approval_below": "1250.00",
  "requires_quotes_above": "1250.00",
  "minimum_quotes": 10,
  "requires_rfx_above": "1250.00",
  "requires_contract": true,
  "preferred_supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "preferred_catalog_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "approver_role_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "required_form": "text"
}

Sample request

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

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/buying-policies/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/buying-policies/{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/buying-policies/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 buying policies, 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
codetextread, writePolicy code
nametextread, writeName
categorytextread, writeCategory
priorityintegerread, writePriority — Lower wins.
no_approval_belownumericread, writeNo approval below
requires_quotes_abovenumericread, writeQuotes required above
minimum_quotesintegerread, writeHow many quotes
requires_rfx_abovenumericread, writeSourcing event required above
requires_contractbooleanread, writeA contract must be in place
preferred_supplier_iduuidread, writePreferred supplier
preferred_catalog_iduuidread, writePreferred catalog
approver_role_iduuidread, writeApprover role
required_formtextread, writeForm that must be completed
is_blockedbooleanread, writeBuying in this category is blocked
block_reasontextread, writeWhy it is blocked
guidancetextread, writeGuidance
is_activebooleanread, writeActive
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_attimestamp with time zoneread onlyCreated at
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 › Guided Buying 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.