TRANXACT.AI Help

Supply Chain · Automation

Automation Rules

What runs on its own: MRP and firming, reorder, order confirmation and release, ASN receipt with quality hold, preventive maintenance, sourcing award, return approval, outbound EDI and carrier tracking. Each rule is switched on here and given its limits; what it may change is the company's autonomy level for its key.

Type REST7 operationsBase path /api/scm/automation-rulesPublished as /api/v1/automation-rules

Download specification (OpenAPI 3.1) Screen: Automation Rules

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 › Automation Rules 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.automation_rules · 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

7 operations. Open one for its parameters, bodies, responses and a sample request.

GET/api/scm/automation-rulesList automation rules

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",
      "rule_code": "RUL-000001",
      "name": "Example",
      "description": "text",
      "job_code": "JOB-000001",
      "job_key": "text",
      "is_enabled": true,
      "max_value": "1250.00",
      "tolerance_pct": "1250.00",
      "fence_days": 10,
      "threshold": "1250.00",
      "strategy": "round_robin",
      "reasons": []
    }
  ],
  "count": 1
}

Sample request

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

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",
  "rule_code": "RUL-000001",
  "name": "Example",
  "description": "text",
  "job_code": "JOB-000001",
  "job_key": "text",
  "is_enabled": true,
  "max_value": "1250.00",
  "tolerance_pct": "1250.00",
  "fence_days": 10,
  "threshold": "1250.00",
  "strategy": "round_robin",
  "reasons": []
}

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

Sample request

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

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
nametextYesName
descriptiontextNoDescription
is_enabledbooleanNoSwitched on — Off, the rule’s job finds nothing. On, what it may change is still the company’s autonomy level for the rule’s key: notify (the default) only tells people.
max_valuenumericNoValue limit — Nothing worth more than this is done automatically. Blank is no limit.
tolerance_pctnumericNoTolerance % — How far a quantity may differ and still match (ASN receipt).
fence_daysintegerNoDays — The firm fence (MRP), the notice window (renewals) or the idle days (stale pipeline).
thresholdnumericNoThreshold — The lowest score that is acted on (sourcing award, churn).
strategytextNoStrategy — Who gets a lead or a case: in turn, by territory, or whoever has the fewest open.
Allowed: round_robin territory load skill
reasons_textNoReasons — Return reasons the rule approves, e.g. damaged_in_transit, wrong_item.
settingsjsonbNoSettings — The rule’s own named values, e.g. {"horizonDays": 90} or {"teamCode": "EAST"}.

Sample body

{
  "name": "Example",
  "description": "text",
  "is_enabled": true,
  "max_value": "1250.00",
  "tolerance_pct": "1250.00"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "rule_code": "RUL-000001",
  "name": "Example",
  "description": "text",
  "job_code": "JOB-000001",
  "job_key": "text",
  "is_enabled": true,
  "max_value": "1250.00",
  "tolerance_pct": "1250.00",
  "fence_days": 10,
  "threshold": "1250.00",
  "strategy": "round_robin",
  "reasons": []
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/scm/automation-rules" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"Example","description":"text","is_enabled":true,"max_value":"1250.00","tolerance_pct":"1250.00"}'
PUT/api/scm/automation-rules/{id}Change a automation rule

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
nametextYesName
descriptiontextNoDescription
is_enabledbooleanNoSwitched on — Off, the rule’s job finds nothing. On, what it may change is still the company’s autonomy level for the rule’s key: notify (the default) only tells people.
max_valuenumericNoValue limit — Nothing worth more than this is done automatically. Blank is no limit.
tolerance_pctnumericNoTolerance % — How far a quantity may differ and still match (ASN receipt).
fence_daysintegerNoDays — The firm fence (MRP), the notice window (renewals) or the idle days (stale pipeline).
thresholdnumericNoThreshold — The lowest score that is acted on (sourcing award, churn).
strategytextNoStrategy — Who gets a lead or a case: in turn, by territory, or whoever has the fewest open.
Allowed: round_robin territory load skill
reasons_textNoReasons — Return reasons the rule approves, e.g. damaged_in_transit, wrong_item.
settingsjsonbNoSettings — The rule’s own named values, e.g. {"horizonDays": 90} or {"teamCode": "EAST"}.

Sample body

{
  "name": "Example",
  "description": "text"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "rule_code": "RUL-000001",
  "name": "Example",
  "description": "text",
  "job_code": "JOB-000001",
  "job_key": "text",
  "is_enabled": true,
  "max_value": "1250.00",
  "tolerance_pct": "1250.00",
  "fence_days": 10,
  "threshold": "1250.00",
  "strategy": "round_robin",
  "reasons": []
}

Sample request

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

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/automation-rules/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/automation-rules/{id}/armArm

Path parameters

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

No body is required.

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/automation-rules/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/arm" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/automation-rules/{id}/runRun

Path parameters

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

No body is required.

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/automation-rules/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/run" \
  -H "Authorization: Bearer $TOKEN"

Data model

Every field of a automation rule, 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
rule_codetextread onlyRule code
nametextread, writeName
descriptiontextread, writeDescription
job_codetextread onlyJob code
job_keytextread onlyJob key
is_enabledbooleanread, writeSwitched on — Off, the rule’s job finds nothing. On, what it may change is still the company’s autonomy level for the rule’s key: notify (the default) only tells people.
max_valuenumericread, writeValue limit — Nothing worth more than this is done automatically. Blank is no limit.
tolerance_pctnumericread, writeTolerance % — How far a quantity may differ and still match (ASN receipt).
fence_daysintegerread, writeDays — The firm fence (MRP), the notice window (renewals) or the idle days (stale pipeline).
thresholdnumericread, writeThreshold — The lowest score that is acted on (sourcing award, churn).
strategytextread, writeStrategy — Who gets a lead or a case: in turn, by territory, or whoever has the fewest open.
Allowed: round_robin territory load skill
reasons_textread, writeReasons — Return reasons the rule approves, e.g. damaged_in_transit, wrong_item.
settingsjsonbread, writeSettings — The rule’s own named values, e.g. {"horizonDays": 90} or {"teamCode": "EAST"}.
last_run_attimestamp with time zoneread onlyLast run at
last_outcometextread onlyLast outcome
created_attimestamp with time zoneread onlyCreated at
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
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

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 › Automation Rules 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.