TRANXACT.AI Help

Supply Chain · Procurement Control

Vendor Evaluation Scores

What each vendor scored on each criterion, and what it was worth once weighted. Price, lead time and payment terms are each scored against the best response: the lowest offer, the shortest lead time, the longest credit. Unless the event says otherwise they weigh 60%, 20% and 20%.

Type REST6 operationsBase path /api/scm/rfx-scoresPublished as /api/v1/rfx-scores

Download specification (OpenAPI 3.1) Screen: Vendor Evaluation Scores

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 › Vendor Evaluation Scores 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.rfx_scores · 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/rfx-scoresList vendor evaluation scores

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",
      "rfx_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "response_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "criterion_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "raw_value": "1250.00",
      "score": "1250.00",
      "weighted_score": "1250.00",
      "is_compliant": true,
      "comment": "text",
      "scored_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "scored_at": "2026-10-30T09:00:00Z",
      "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-scores?limit=20" \
  -H "Authorization: Bearer $TOKEN"
GET/api/scm/rfx-scores/{id}Read one evaluation score

Path parameters

NameTypeDescription
idstring (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",
  "response_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "criterion_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "raw_value": "1250.00",
  "score": "1250.00",
  "weighted_score": "1250.00",
  "is_compliant": true,
  "comment": "text",
  "scored_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "scored_at": "2026-10-30T09:00:00Z",
  "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-scores/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/rfx-scoresCreate a evaluation score

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
rfx_iduuidYesRfx id
response_iduuidYesResponse id
criterion_iduuidYesCriterion id
raw_valuenumericNoRaw value
scorenumericNoScore
weighted_scorenumericNoWeighted score
is_compliantbooleanNoIs compliant
commenttextNoComment

Sample body

{
  "rfx_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "response_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "criterion_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "raw_value": "1250.00",
  "score": "1250.00",
  "weighted_score": "1250.00",
  "is_compliant": true
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "rfx_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "response_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "criterion_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "raw_value": "1250.00",
  "score": "1250.00",
  "weighted_score": "1250.00",
  "is_compliant": true,
  "comment": "text",
  "scored_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "scored_at": "2026-10-30T09:00:00Z",
  "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-scores" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"rfx_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","response_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","criterion_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","raw_value":"1250.00","score":"1250.00","weighted_score":"1250.00","is_compliant":true}'
PUT/api/scm/rfx-scores/{id}Change a evaluation score

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
rfx_iduuidYesRfx id
response_iduuidYesResponse id
criterion_iduuidYesCriterion id
raw_valuenumericNoRaw value
scorenumericNoScore
weighted_scorenumericNoWeighted score
is_compliantbooleanNoIs compliant
commenttextNoComment

Sample body

{
  "rfx_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "response_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "rfx_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "response_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "criterion_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "raw_value": "1250.00",
  "score": "1250.00",
  "weighted_score": "1250.00",
  "is_compliant": true,
  "comment": "text",
  "scored_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "scored_at": "2026-10-30T09:00:00Z",
  "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-scores/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"rfx_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","response_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'
DELETE/api/scm/rfx-scores/{id}Delete a evaluation score

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/rfx-scores/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/rfx-scores/{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/rfx-scores/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 score, 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
rfx_iduuidread, writeRfx id
response_iduuidread, writeResponse id
criterion_iduuidread, writeCriterion id
raw_valuenumericread, writeRaw value
scorenumericread, writeScore
weighted_scorenumericread, writeWeighted score
is_compliantbooleanread, writeIs compliant
commenttextread, writeComment
scored_byuuidread onlyScored by
scored_attimestamp with time zoneread onlyScored at
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_attimestamp with time zoneread onlyCreated at
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 › Vendor Evaluation Scores 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.