TRANXACT.AI Help

Supply Chain · Items & Suppliers

Suppliers

Open a supplier for its sites, financial terms, bank details, certifications, diversity and exclusions — the ordering address is almost never the one you pay.

Type REST9 operationsBase path /api/scm/suppliersPublished as /api/v1/suppliers

Download specification (OpenAPI 3.1) Screen: Suppliers

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 › Suppliers 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.suppliers · 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

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

GET/api/scm/suppliersList suppliers

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_no": "SUP-000001",
      "name": "Example",
      "country": "US",
      "currency": "USD",
      "payment_terms_days": 10,
      "contact_email": "someone@example.com",
      "status": "prospective",
      "quality_score": "1250.00",
      "delivery_score": "1250.00",
      "risk_rating": "text",
      "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
    }
  ],
  "count": 1
}

Sample request

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

Path parameters

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "supplier_no": "SUP-000001",
  "name": "Example",
  "country": "US",
  "currency": "USD",
  "payment_terms_days": 10,
  "contact_email": "someone@example.com",
  "status": "prospective",
  "quality_score": "1250.00",
  "delivery_score": "1250.00",
  "risk_rating": "text",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

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

Sample request

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

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
supplier_notextYesSupplier number — Left blank, the platform allocates the next one from the number range.
nametextYesName
countrytextNoCountry
currencytextNoCurrency
payment_terms_daysintegerNoPayment terms (days)
contact_emailtextNoEmail — Where an enquiry is sent. A vendor with no address here is named in the answer when an event is published, rather than silently left out.
statustextNoStatus
Allowed: prospective approved hold inactive
quality_scorenumericNoQuality score
delivery_scorenumericNoDelivery score
risk_ratingtextNoRisk rating
categories_textNoRegistered for — The spend categories this vendor supplies — add as many as apply. Publishing a sourcing event for a category sends the enquiry to everybody registered for it.
websitetextNoWebsite — The company’s web address, e.g. https://example.com
phonetextNoMain telephone
legal_nametextNoLegal name — A change to the name, legal name or country here takes effect today; to date it otherwise, change it on the Party tab (Name, legal name and country). The registered address and the tax ids are kept on the Party tab.
industrytextNoIndustry
address_line1textNoAddress line1
citytextNoCity
regiontextNoRegion
postal_codetextNoPostal code
employee_countintegerNoEmployees
founded_yearintegerNoFounded (year)
descriptiontextNoAbout the company
inspect_on_receiptbooleanNoInspect every delivery — What is received from this supplier goes on quality hold until its incoming inspection passes.

Sample body

{
  "supplier_no": "SUP-000001",
  "name": "Example",
  "country": "US",
  "currency": "USD",
  "payment_terms_days": 10,
  "contact_email": "someone@example.com"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "supplier_no": "SUP-000001",
  "name": "Example",
  "country": "US",
  "currency": "USD",
  "payment_terms_days": 10,
  "contact_email": "someone@example.com",
  "status": "prospective",
  "quality_score": "1250.00",
  "delivery_score": "1250.00",
  "risk_rating": "text",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/scm/suppliers" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"supplier_no":"SUP-000001","name":"Example","country":"US","currency":"USD","payment_terms_days":10,"contact_email":"someone@example.com"}'
PUT/api/scm/suppliers/{id}Change a suppliers

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_notextYesSupplier number — Left blank, the platform allocates the next one from the number range.
nametextYesName
countrytextNoCountry
currencytextNoCurrency
payment_terms_daysintegerNoPayment terms (days)
contact_emailtextNoEmail — Where an enquiry is sent. A vendor with no address here is named in the answer when an event is published, rather than silently left out.
statustextNoStatus
Allowed: prospective approved hold inactive
quality_scorenumericNoQuality score
delivery_scorenumericNoDelivery score
risk_ratingtextNoRisk rating
categories_textNoRegistered for — The spend categories this vendor supplies — add as many as apply. Publishing a sourcing event for a category sends the enquiry to everybody registered for it.
websitetextNoWebsite — The company’s web address, e.g. https://example.com
phonetextNoMain telephone
legal_nametextNoLegal name — A change to the name, legal name or country here takes effect today; to date it otherwise, change it on the Party tab (Name, legal name and country). The registered address and the tax ids are kept on the Party tab.
industrytextNoIndustry
address_line1textNoAddress line1
citytextNoCity
regiontextNoRegion
postal_codetextNoPostal code
employee_countintegerNoEmployees
founded_yearintegerNoFounded (year)
descriptiontextNoAbout the company
inspect_on_receiptbooleanNoInspect every delivery — What is received from this supplier goes on quality hold until its incoming inspection passes.

Sample body

{
  "supplier_no": "SUP-000001",
  "name": "Example"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "supplier_no": "SUP-000001",
  "name": "Example",
  "country": "US",
  "currency": "USD",
  "payment_terms_days": 10,
  "contact_email": "someone@example.com",
  "status": "prospective",
  "quality_score": "1250.00",
  "delivery_score": "1250.00",
  "risk_rating": "text",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Sample request

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

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

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):

period*, periodStart, periodEnd, qualityScore, serviceScore, complianceScore

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/suppliers/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/assess" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"period":"value","periodStart":"value","periodEnd":"value","qualityScore":"value","serviceScore":"value","complianceScore":"value"}'
GET/api/scm/suppliers/{id}/profileProfile

Path parameters

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

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/scm/suppliers/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/profile" \
  -H "Authorization: Bearer $TOKEN"
GET/api/scm/suppliers/{id}/usableUsable

Path parameters

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

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/scm/suppliers/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/usable" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/suppliers/{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/suppliers/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 suppliers, 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_notextread, writeSupplier number — Left blank, the platform allocates the next one from the number range.
nametextread, writeName
countrytextread, writeCountry
currencytextread, writeCurrency
payment_terms_daysintegerread, writePayment terms (days)
contact_emailtextread, writeEmail — Where an enquiry is sent. A vendor with no address here is named in the answer when an event is published, rather than silently left out.
statustextread, writeStatus
Allowed: prospective approved hold inactive
quality_scorenumericread, writeQuality score
delivery_scorenumericread, writeDelivery score
risk_ratingtextread, writeRisk rating
org_unit_iduuidread onlyOrg unit id
location_iduuidread onlyLocation id
warehouse_iduuidread onlyWarehouse id
categories_textread, writeRegistered for — The spend categories this vendor supplies — add as many as apply. Publishing a sourcing event for a category sends the enquiry to everybody registered for 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_attimestamp with time zoneread onlyCreated at
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
websitetextread, writeWebsite — The company’s web address, e.g. https://example.com
phonetextread, writeMain telephone
legal_nametextread, writeLegal name — A change to the name, legal name or country here takes effect today; to date it otherwise, change it on the Party tab (Name, legal name and country). The registered address and the tax ids are kept on the Party tab.
industrytextread, writeIndustry
address_line1textread, writeAddress line1
citytextread, writeCity
regiontextread, writeRegion
postal_codetextread, writePostal code
employee_countintegerread, writeEmployees
founded_yearintegerread, writeFounded (year)
descriptiontextread, writeAbout the company
gstintextread onlyGstin
pantextread onlyPan
state_codetextread onlyState code
gst_registration_typetextread onlyGst registration type
is_rcm_applicablebooleanread onlyIs rcm applicable
tds_sectiontextread onlyTds section
inspect_on_receiptbooleanread, writeInspect every delivery — What is received from this supplier goes on quality hold until its incoming inspection passes.
merged_into_iduuidread onlyMerged into id

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 › Suppliers 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.