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.
/api/scm/suppliersPublished as /api/v1/suppliersOverview
| Package | Supply Chain |
|---|---|
| Authentication | Bearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key |
| Authorization | The 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. |
| Table | scm.suppliers · kept per company (and organisational unit where it has one) |
| Record | Created, changed and (where the screen allows) deleted; key id |
| Rules | The 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
| Name | Description | Example |
|---|---|---|
limit | Rows per page (50 by default, at most 200) | limit=100 |
offset | Rows to skip | offset=200 |
q | Free-text search over the search columns | q=acme |
sort | column:asc or column:desc, several separated by commas | sort=created_at:desc |
filter | A JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sorted | filter={"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
| Name | Type | Description |
|---|---|---|
id | string (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.
| Field | Type | Required | Description |
|---|---|---|---|
supplier_no | text | Yes | Supplier number — Left blank, the platform allocates the next one from the number range. |
name | text | Yes | Name |
country | text | No | Country |
currency | text | No | Currency |
payment_terms_days | integer | No | Payment terms (days) |
contact_email | text | No | Email — 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. |
status | text | No | Status Allowed: prospective approved hold inactive |
quality_score | numeric | No | Quality score |
delivery_score | numeric | No | Delivery score |
risk_rating | text | No | Risk rating |
categories | _text | No | Registered 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. |
website | text | No | Website — The company’s web address, e.g. https://example.com |
phone | text | No | Main telephone |
legal_name | text | No | Legal 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. |
industry | text | No | Industry |
address_line1 | text | No | Address line1 |
city | text | No | City |
region | text | No | Region |
postal_code | text | No | Postal code |
employee_count | integer | No | Employees |
founded_year | integer | No | Founded (year) |
description | text | No | About the company |
inspect_on_receipt | boolean | No | Inspect 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
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
Only the fields to change; fields left out keep their value.
| Field | Type | Required | Description |
|---|---|---|---|
supplier_no | text | Yes | Supplier number — Left blank, the platform allocates the next one from the number range. |
name | text | Yes | Name |
country | text | No | Country |
currency | text | No | Currency |
payment_terms_days | integer | No | Payment terms (days) |
contact_email | text | No | Email — 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. |
status | text | No | Status Allowed: prospective approved hold inactive |
quality_score | numeric | No | Quality score |
delivery_score | numeric | No | Delivery score |
risk_rating | text | No | Risk rating |
categories | _text | No | Registered 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. |
website | text | No | Website — The company’s web address, e.g. https://example.com |
phone | text | No | Main telephone |
legal_name | text | No | Legal 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. |
industry | text | No | Industry |
address_line1 | text | No | Address line1 |
city | text | No | City |
region | text | No | Region |
postal_code | text | No | Postal code |
employee_count | integer | No | Employees |
founded_year | integer | No | Founded (year) |
description | text | No | About the company |
inspect_on_receipt | boolean | No | Inspect 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
| Name | Type | Description |
|---|---|---|
id | string (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
| Name | Type | Description |
|---|---|---|
id | string (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, complianceScoreResponse
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
| Name | Type | Description |
|---|---|---|
id | string (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
| Name | Type | Description |
|---|---|---|
id | string (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
| Name | Type | Description |
|---|---|---|
id | string (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, withLinesResponse
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.
| Field | Type | Access | Description |
|---|---|---|---|
id | uuid | read only | Id |
org_id | uuid | read only | Org id |
supplier_no | text | read, write | Supplier number — Left blank, the platform allocates the next one from the number range. |
name | text | read, write | Name |
country | text | read, write | Country |
currency | text | read, write | Currency |
payment_terms_days | integer | read, write | Payment terms (days) |
contact_email | text | read, write | Email — 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. |
status | text | read, write | Status Allowed: prospective approved hold inactive |
quality_score | numeric | read, write | Quality score |
delivery_score | numeric | read, write | Delivery score |
risk_rating | text | read, write | Risk rating |
org_unit_id | uuid | read only | Org unit id |
location_id | uuid | read only | Location id |
warehouse_id | uuid | read only | Warehouse id |
categories | _text | read, write | Registered 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_1 | text | read only | Xf text 1 |
xf_text_2 | text | read only | Xf text 2 |
xf_text_3 | text | read only | Xf text 3 |
xf_text_4 | text | read only | Xf text 4 |
xf_text_5 | text | read only | Xf text 5 |
xf_num_1 | numeric | read only | Xf num 1 |
xf_num_2 | numeric | read only | Xf num 2 |
xf_num_3 | numeric | read only | Xf num 3 |
xf_date_1 | date | read only | Xf date 1 |
xf_date_2 | date | read only | Xf date 2 |
created_at | timestamp with time zone | read only | Created at |
created_by | uuid | read only | Created by |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
website | text | read, write | Website — The company’s web address, e.g. https://example.com |
phone | text | read, write | Main telephone |
legal_name | text | read, write | Legal 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. |
industry | text | read, write | Industry |
address_line1 | text | read, write | Address line1 |
city | text | read, write | City |
region | text | read, write | Region |
postal_code | text | read, write | Postal code |
employee_count | integer | read, write | Employees |
founded_year | integer | read, write | Founded (year) |
description | text | read, write | About the company |
gstin | text | read only | Gstin |
pan | text | read only | Pan |
state_code | text | read only | State code |
gst_registration_type | text | read only | Gst registration type |
is_rcm_applicable | boolean | read only | Is rcm applicable |
tds_section | text | read only | Tds section |
inspect_on_receipt | boolean | read, write | Inspect every delivery — What is received from this supplier goes on quality hold until its incoming inspection passes. |
merged_into_id | uuid | read only | Merged into id |
Errors
| Status | Meaning |
|---|---|
| 400 | The request could not be read: a filter that is not JSON, a bad parameter |
| 401 | No credential, or it is wrong, revoked or expired |
| 403 | The caller's roles do not hold Supply Chain › Suppliers for this verb, or the address or origin is not allowed |
| 404 | No record with that id is visible to the caller |
| 409 | A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else |
| 422 | Refused 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.