TRANXACT.AI Help

Supply Chain · Reachable by link

Supplier · Diversity

Classification and the evidence behind it. Self-declared and third-party certified are different evidence, and spend reporting that conflates them will not survive an audit.

Type REST6 operationsBase path /api/scm/supplier-diversityPublished as /api/v1/supplier-diversity

Download specification (OpenAPI 3.1) Screen: Supplier · Diversity

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 · Diversity 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_diversity · 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-diversityList supplier · diversity

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",
      "classification": "minority_owned",
      "certifying_body": "text",
      "certificate_no": "CER-000001",
      "evidence": "self_declared",
      "certified_on": "2026-10-30",
      "expires_on": "2026-10-30",
      "ownership_pct": "1250.00",
      "counts_towards_target": true,
      "target_program": "text",
      "document_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "verified_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "verified_on": "2026-10-30"
    }
  ],
  "count": 1
}

Sample request

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

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",
  "classification": "minority_owned",
  "certifying_body": "text",
  "certificate_no": "CER-000001",
  "evidence": "self_declared",
  "certified_on": "2026-10-30",
  "expires_on": "2026-10-30",
  "ownership_pct": "1250.00",
  "counts_towards_target": true,
  "target_program": "text",
  "document_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "verified_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "verified_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-diversity/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/supplier-diversityCreate a supplier diversity

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
supplier_iduuidYesSupplier
classificationtextYesClassification
Allowed: minority_owned women_owned veteran_owned disability_owned lgbtq_owned small_business indigenous_owned social_enterprise local_supplier b_corp disadvantaged_business
certifying_bodytextNoCertifying body
certificate_notextNoCertificate number
evidencetextNoEvidence
Allowed: self_declared third_party_certified government_registered audited
certified_ondateNoCertified
expires_ondateNoExpires
ownership_pctnumericNoOwnership %
counts_towards_targetbooleanNoCounts towards a target
target_programtextNoProgramme
document_iduuidNoDocument id
verified_byuuidNoVerified by
verified_ondateNoVerified on
notestextNoNotes
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",
  "classification": "minority_owned",
  "certifying_body": "text",
  "certificate_no": "CER-000001",
  "evidence": "self_declared",
  "certified_on": "2026-10-30"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "classification": "minority_owned",
  "certifying_body": "text",
  "certificate_no": "CER-000001",
  "evidence": "self_declared",
  "certified_on": "2026-10-30",
  "expires_on": "2026-10-30",
  "ownership_pct": "1250.00",
  "counts_towards_target": true,
  "target_program": "text",
  "document_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "verified_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "verified_on": "2026-10-30"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/scm/supplier-diversity" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"supplier_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","classification":"minority_owned","certifying_body":"text","certificate_no":"CER-000001","evidence":"self_declared","certified_on":"2026-10-30"}'
PUT/api/scm/supplier-diversity/{id}Change a supplier diversity

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
classificationtextYesClassification
Allowed: minority_owned women_owned veteran_owned disability_owned lgbtq_owned small_business indigenous_owned social_enterprise local_supplier b_corp disadvantaged_business
certifying_bodytextNoCertifying body
certificate_notextNoCertificate number
evidencetextNoEvidence
Allowed: self_declared third_party_certified government_registered audited
certified_ondateNoCertified
expires_ondateNoExpires
ownership_pctnumericNoOwnership %
counts_towards_targetbooleanNoCounts towards a target
target_programtextNoProgramme
document_iduuidNoDocument id
verified_byuuidNoVerified by
verified_ondateNoVerified on
notestextNoNotes
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",
  "classification": "minority_owned"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "classification": "minority_owned",
  "certifying_body": "text",
  "certificate_no": "CER-000001",
  "evidence": "self_declared",
  "certified_on": "2026-10-30",
  "expires_on": "2026-10-30",
  "ownership_pct": "1250.00",
  "counts_towards_target": true,
  "target_program": "text",
  "document_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "verified_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "verified_on": "2026-10-30"
}

Sample request

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

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-diversity/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/supplier-diversity/{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-diversity/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 diversity, 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
classificationtextread, writeClassification
Allowed: minority_owned women_owned veteran_owned disability_owned lgbtq_owned small_business indigenous_owned social_enterprise local_supplier b_corp disadvantaged_business
certifying_bodytextread, writeCertifying body
certificate_notextread, writeCertificate number
evidencetextread, writeEvidence
Allowed: self_declared third_party_certified government_registered audited
certified_ondateread, writeCertified
expires_ondateread, writeExpires
ownership_pctnumericread, writeOwnership %
counts_towards_targetbooleanread, writeCounts towards a target
target_programtextread, writeProgramme
document_iduuidread, writeDocument id
verified_byuuidread, writeVerified by
verified_ondateread, writeVerified on
notestextread, writeNotes
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.
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_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 · Diversity 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.