TRANXACT.AI Help

Supply Chain · Reachable by link

Supplier · Exclusions

Reasons a supplier may not be used, and exactly what each one blocks. Distinct from diversity on purpose: one is a preference, this is a control.

Type REST6 operationsBase path /api/scm/supplier-exclusionsPublished as /api/v1/supplier-exclusions

Download specification (OpenAPI 3.1) Screen: Supplier · Exclusions

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 › Supplier · Exclusions 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.supplier_exclusions · 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/supplier-exclusionsList supplier · exclusions

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",
      "supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "exclusion_type": "debarment",
      "authority": "text",
      "reference": "text",
      "reason": "text",
      "blocks_new_orders": true,
      "blocks_receipts": true,
      "blocks_payments": true,
      "blocks_rfq": true,
      "severity": "advisory",
      "raised_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "raised_on": "2026-10-30"
    }
  ],
  "count": 1
}

Sample request

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

Path parameters

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "exclusion_type": "debarment",
  "authority": "text",
  "reference": "text",
  "reason": "text",
  "blocks_new_orders": true,
  "blocks_receipts": true,
  "blocks_payments": true,
  "blocks_rfq": true,
  "severity": "advisory",
  "raised_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "raised_on": "2026-10-30"
}

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

Sample request

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

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
supplier_iduuidYesSupplier
org_unit_iduuidNoOrg unit id
exclusion_typetextYesType
Allowed: debarment sanctions conflict_of_interest performance quality financial ethical legal internal_policy duplicate
authoritytextNoAuthority — Who says so. A government debarment and an internal decision differ in weight.
referencetextNoReference
reasontextYesReason
blocks_new_ordersbooleanNoBlocks new orders
blocks_receiptsbooleanNoBlocks receipts
blocks_paymentsbooleanNoBlocks payments
blocks_rfqbooleanNoBlocks quotations
severitytextNoSeverity
Allowed: advisory warn block
raised_byuuidNoRaised by
raised_ondateNoRaised on
lifted_byuuidNoLifted by
lifted_ondateNoLifted on
lift_reasontextNoWhy it was lifted
review_ondateNoReview on
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.

Sample body

{
  "supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "exclusion_type": "debarment",
  "reason": "text",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "authority": "text",
  "reference": "text",
  "blocks_new_orders": true
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "exclusion_type": "debarment",
  "authority": "text",
  "reference": "text",
  "reason": "text",
  "blocks_new_orders": true,
  "blocks_receipts": true,
  "blocks_payments": true,
  "blocks_rfq": true,
  "severity": "advisory",
  "raised_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "raised_on": "2026-10-30"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/scm/supplier-exclusions" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"supplier_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","exclusion_type":"debarment","reason":"text","org_unit_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","authority":"text","reference":"text","blocks_new_orders":true}'
PUT/api/scm/supplier-exclusions/{id}Change a supplier exclusions

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
supplier_iduuidYesSupplier
org_unit_iduuidNoOrg unit id
exclusion_typetextYesType
Allowed: debarment sanctions conflict_of_interest performance quality financial ethical legal internal_policy duplicate
authoritytextNoAuthority — Who says so. A government debarment and an internal decision differ in weight.
referencetextNoReference
reasontextYesReason
blocks_new_ordersbooleanNoBlocks new orders
blocks_receiptsbooleanNoBlocks receipts
blocks_paymentsbooleanNoBlocks payments
blocks_rfqbooleanNoBlocks quotations
severitytextNoSeverity
Allowed: advisory warn block
raised_byuuidNoRaised by
raised_ondateNoRaised on
lifted_byuuidNoLifted by
lifted_ondateNoLifted on
lift_reasontextNoWhy it was lifted
review_ondateNoReview on
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.

Sample body

{
  "supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "exclusion_type": "debarment"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "exclusion_type": "debarment",
  "authority": "text",
  "reference": "text",
  "reason": "text",
  "blocks_new_orders": true,
  "blocks_receipts": true,
  "blocks_payments": true,
  "blocks_rfq": true,
  "severity": "advisory",
  "raised_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "raised_on": "2026-10-30"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/scm/supplier-exclusions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"supplier_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","exclusion_type":"debarment"}'
DELETE/api/scm/supplier-exclusions/{id}Delete a supplier exclusions

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/supplier-exclusions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/supplier-exclusions/{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/supplier-exclusions/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 supplier exclusions, 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
supplier_iduuidread, writeSupplier
org_unit_iduuidread, writeOrg unit id
exclusion_typetextread, writeType
Allowed: debarment sanctions conflict_of_interest performance quality financial ethical legal internal_policy duplicate
authoritytextread, writeAuthority — Who says so. A government debarment and an internal decision differ in weight.
referencetextread, writeReference
reasontextread, writeReason
blocks_new_ordersbooleanread, writeBlocks new orders
blocks_receiptsbooleanread, writeBlocks receipts
blocks_paymentsbooleanread, writeBlocks payments
blocks_rfqbooleanread, writeBlocks quotations
severitytextread, writeSeverity
Allowed: advisory warn block
raised_byuuidread, writeRaised by
raised_ondateread, writeRaised on
lifted_byuuidread, writeLifted by
lifted_ondateread, writeLifted on
lift_reasontextread, writeWhy it was lifted
review_ondateread, writeReview on
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

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 › Supplier · Exclusions 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.