TRANXACT.AI Help

Supply Chain · Reachable by link

Supplier · Certifications

What the supplier holds that lets us use them, its scope, and what happens when it lapses. The status follows the dates rather than being typed.

Type REST6 operationsBase path /api/scm/supplier-certificationsPublished as /api/v1/supplier-certifications

Download specification (OpenAPI 3.1) Screen: Supplier · Certifications

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 · Certifications 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_certifications · 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-certificationsList supplier · certifications

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",
      "site_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "scheme": "text",
      "certificate_no": "CER-000001",
      "scope": "text",
      "standard_version": "text",
      "accreditation_body": "text",
      "certifying_body": "text",
      "issued_on": "2026-10-30",
      "expires_on": "2026-10-30",
      "next_surveillance_on": "2026-10-30",
      "status": "draft",
      "on_expiry": "ignore"
    }
  ],
  "count": 1
}

Sample request

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

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",
  "site_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "scheme": "text",
  "certificate_no": "CER-000001",
  "scope": "text",
  "standard_version": "text",
  "accreditation_body": "text",
  "certifying_body": "text",
  "issued_on": "2026-10-30",
  "expires_on": "2026-10-30",
  "next_surveillance_on": "2026-10-30",
  "status": "draft",
  "on_expiry": "ignore"
}

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

Sample request

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

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
supplier_iduuidYesSupplier
site_iduuidNoSite id
schemetextYesScheme — ISO 9001, IATF 16949, AS9100, FSSC 22000, ISO 14001…
certificate_notextNoCertificate number
scopetextNoScope — What it actually covers. A certificate for one site is not a certificate for the company.
standard_versiontextNoStandard version
accreditation_bodytextNoAccreditation body
certifying_bodytextNoCertifying body
issued_ondateNoIssued
expires_ondateNoExpires
next_surveillance_ondateNoNext surveillance
on_expirytextNoWhen it lapses
Allowed: ignore warn block_new_orders block_all suspend_supplier
is_mandatorybooleanNoMandatory
applies_to_category_iduuidNoApplies to category id
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",
  "scheme": "text",
  "site_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "certificate_no": "CER-000001",
  "scope": "text",
  "standard_version": "text"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "site_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "scheme": "text",
  "certificate_no": "CER-000001",
  "scope": "text",
  "standard_version": "text",
  "accreditation_body": "text",
  "certifying_body": "text",
  "issued_on": "2026-10-30",
  "expires_on": "2026-10-30",
  "next_surveillance_on": "2026-10-30",
  "status": "draft",
  "on_expiry": "ignore"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/scm/supplier-certifications" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"supplier_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","scheme":"text","site_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","certificate_no":"CER-000001","scope":"text","standard_version":"text"}'
PUT/api/scm/supplier-certifications/{id}Change a supplier certifications

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
site_iduuidNoSite id
schemetextYesScheme — ISO 9001, IATF 16949, AS9100, FSSC 22000, ISO 14001…
certificate_notextNoCertificate number
scopetextNoScope — What it actually covers. A certificate for one site is not a certificate for the company.
standard_versiontextNoStandard version
accreditation_bodytextNoAccreditation body
certifying_bodytextNoCertifying body
issued_ondateNoIssued
expires_ondateNoExpires
next_surveillance_ondateNoNext surveillance
on_expirytextNoWhen it lapses
Allowed: ignore warn block_new_orders block_all suspend_supplier
is_mandatorybooleanNoMandatory
applies_to_category_iduuidNoApplies to category id
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",
  "scheme": "text"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "site_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "scheme": "text",
  "certificate_no": "CER-000001",
  "scope": "text",
  "standard_version": "text",
  "accreditation_body": "text",
  "certifying_body": "text",
  "issued_on": "2026-10-30",
  "expires_on": "2026-10-30",
  "next_surveillance_on": "2026-10-30",
  "status": "draft",
  "on_expiry": "ignore"
}

Sample request

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

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-certifications/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/supplier-certifications/{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-certifications/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 certifications, 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
site_iduuidread, writeSite id
schemetextread, writeScheme — ISO 9001, IATF 16949, AS9100, FSSC 22000, ISO 14001…
certificate_notextread, writeCertificate number
scopetextread, writeScope — What it actually covers. A certificate for one site is not a certificate for the company.
standard_versiontextread, writeStandard version
accreditation_bodytextread, writeAccreditation body
certifying_bodytextread, writeCertifying body
issued_ondateread, writeIssued
expires_ondateread, writeExpires
next_surveillance_ondateread, writeNext surveillance
statustextread onlyStatus
on_expirytextread, writeWhen it lapses
Allowed: ignore warn block_new_orders block_all suspend_supplier
is_mandatorybooleanread, writeMandatory
applies_to_category_iduuidread, writeApplies to category id
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 · Certifications 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.