Supply Chain · Procurement Control
Vendor Evaluation Criteria
What responses will be compared on, and how much each counts — declared before any response is opened. Criteria chosen afterwards are criteria chosen to fit the preferred answer.
/api/scm/rfx-criteriaPublished as /api/v1/rfx-criteriaDownload specification (OpenAPI 3.1) Screen: Vendor Evaluation Criteria
Overview
| 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 › Vendor Evaluation Criteria 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.rfx_criteria · 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
6 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/scm/rfx-criteriaList vendor evaluation criteria
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",
"rfx_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"criterion_kind": "price",
"weight_pct": "1250.00",
"higher_is_better": true,
"max_score": "1250.00",
"is_mandatory": true,
"description": "text",
"sort_order": 10,
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"xf_text_1": "text",
"xf_text_2": "text"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/scm/rfx-criteria?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/scm/rfx-criteria/{id}Read one evaluation criterion
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",
"rfx_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"criterion_kind": "price",
"weight_pct": "1250.00",
"higher_is_better": true,
"max_score": "1250.00",
"is_mandatory": true,
"description": "text",
"sort_order": 10,
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"xf_text_1": "text",
"xf_text_2": "text"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/scm/rfx-criteria/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/rfx-criteriaCreate a evaluation criterion
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
rfx_id | uuid | Yes | Sourcing event |
code | text | Yes | Code |
name | text | Yes | Criterion |
criterion_kind | text | No | Scored from — Price, delivery, lead time and payment terms are scored from what the vendor quoted. The rest are a person’s judgement, marked under Evaluate on the criteria. Allowed: price delivery quality technical performance payment_terms lead_time capacity certification manual |
weight_pct | numeric | No | Weight % |
higher_is_better | boolean | No | More is better — Off for a price or a lead time, where less is better. |
max_score | numeric | No | Out of |
is_mandatory | boolean | No | A vendor failing this is non-compliant |
description | text | No | What it means |
sort_order | integer | No | Order |
Sample body
{
"rfx_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"criterion_kind": "price",
"weight_pct": "1250.00",
"higher_is_better": true,
"max_score": "1250.00"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"rfx_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"criterion_kind": "price",
"weight_pct": "1250.00",
"higher_is_better": true,
"max_score": "1250.00",
"is_mandatory": true,
"description": "text",
"sort_order": 10,
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"xf_text_1": "text",
"xf_text_2": "text"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/scm/rfx-criteria" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"rfx_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","code":"COD-000001","name":"Example","criterion_kind":"price","weight_pct":"1250.00","higher_is_better":true,"max_score":"1250.00"}'PUT/api/scm/rfx-criteria/{id}Change a evaluation criterion
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 |
|---|---|---|---|
rfx_id | uuid | Yes | Sourcing event |
code | text | Yes | Code |
name | text | Yes | Criterion |
criterion_kind | text | No | Scored from — Price, delivery, lead time and payment terms are scored from what the vendor quoted. The rest are a person’s judgement, marked under Evaluate on the criteria. Allowed: price delivery quality technical performance payment_terms lead_time capacity certification manual |
weight_pct | numeric | No | Weight % |
higher_is_better | boolean | No | More is better — Off for a price or a lead time, where less is better. |
max_score | numeric | No | Out of |
is_mandatory | boolean | No | A vendor failing this is non-compliant |
description | text | No | What it means |
sort_order | integer | No | Order |
Sample body
{
"rfx_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"rfx_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"criterion_kind": "price",
"weight_pct": "1250.00",
"higher_is_better": true,
"max_score": "1250.00",
"is_mandatory": true,
"description": "text",
"sort_order": 10,
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"xf_text_1": "text",
"xf_text_2": "text"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/scm/rfx-criteria/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"rfx_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","code":"COD-000001"}'DELETE/api/scm/rfx-criteria/{id}Delete a evaluation criterion
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/rfx-criteria/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/rfx-criteria/{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/rfx-criteria/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 evaluation criterion, 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 |
rfx_id | uuid | read, write | Sourcing event |
code | text | read, write | Code |
name | text | read, write | Criterion |
criterion_kind | text | read, write | Scored from — Price, delivery, lead time and payment terms are scored from what the vendor quoted. The rest are a person’s judgement, marked under Evaluate on the criteria. Allowed: price delivery quality technical performance payment_terms lead_time capacity certification manual |
weight_pct | numeric | read, write | Weight % |
higher_is_better | boolean | read, write | More is better — Off for a price or a lead time, where less is better. |
max_score | numeric | read, write | Out of |
is_mandatory | boolean | read, write | A vendor failing this is non-compliant |
description | text | read, write | What it means |
sort_order | integer | read, write | Order |
org_unit_id | uuid | read only | Org unit id |
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 |
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 › Vendor Evaluation Criteria 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.