TRANXACT.AI Help

Supply Chain · Strategic Sourcing

Responses

What each supplier offered, and how it scored on the weights declared before the event opened.

Type REST10 operationsBase path /api/scm/rfx-responsesPublished as /api/v1/rfx-responses

Download specification (OpenAPI 3.1) Screen: Responses

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 › Responses 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_responses · 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

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

GET/api/scm/rfx-responsesList responses

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",
      "supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "submitted_at": "2026-10-30T09:00:00Z",
      "currency": "USD",
      "total": "1250.00",
      "lead_time_days": 10,
      "payment_terms_days": 10,
      "validity_days": 10,
      "notes": "text",
      "technical_score": "1250.00",
      "commercial_score": "1250.00",
      "total_score": "1250.00",
      "rank": 10
    }
  ],
  "count": 1
}

Sample request

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

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",
  "supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "submitted_at": "2026-10-30T09:00:00Z",
  "currency": "USD",
  "total": "1250.00",
  "lead_time_days": 10,
  "payment_terms_days": 10,
  "validity_days": 10,
  "notes": "text",
  "technical_score": "1250.00",
  "commercial_score": "1250.00",
  "total_score": "1250.00",
  "rank": 10
}

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

Sample request

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

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
lead_time_daysintegerNoLead time for every line (days) — Sets this lead time on every priced line of the response. To give lines different lead times, change them under Priced lines; the response’s lead time is then the longest of them.
payment_terms_daysintegerNoPayment terms (days of credit)
validity_daysintegerNoValid for (days)
notestextNoNotes
technical_scorenumericNoTechnical score
statustextNoStatus
Allowed: submitted scored shortlisted rejected

Sample body

{
  "lead_time_days": 10,
  "payment_terms_days": 10,
  "validity_days": 10,
  "notes": "text"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "rfx_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "submitted_at": "2026-10-30T09:00:00Z",
  "currency": "USD",
  "total": "1250.00",
  "lead_time_days": 10,
  "payment_terms_days": 10,
  "validity_days": 10,
  "notes": "text",
  "technical_score": "1250.00",
  "commercial_score": "1250.00",
  "total_score": "1250.00",
  "rank": 10
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/scm/rfx-responses" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"lead_time_days":10,"payment_terms_days":10,"validity_days":10,"notes":"text"}'
PUT/api/scm/rfx-responses/{id}Change a rfx responses

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
lead_time_daysintegerNoLead time for every line (days) — Sets this lead time on every priced line of the response. To give lines different lead times, change them under Priced lines; the response’s lead time is then the longest of them.
payment_terms_daysintegerNoPayment terms (days of credit)
validity_daysintegerNoValid for (days)
notestextNoNotes
technical_scorenumericNoTechnical score
statustextNoStatus
Allowed: submitted scored shortlisted rejected

Sample body

{
  "lead_time_days": 10,
  "payment_terms_days": 10
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "rfx_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "submitted_at": "2026-10-30T09:00:00Z",
  "currency": "USD",
  "total": "1250.00",
  "lead_time_days": 10,
  "payment_terms_days": 10,
  "validity_days": 10,
  "notes": "text",
  "technical_score": "1250.00",
  "commercial_score": "1250.00",
  "total_score": "1250.00",
  "rank": 10
}

Sample request

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

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-responses/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/rfx-responses/{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-responses/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"overrides":"value","preview":"value","withLines":"value"}'
GET/api/scm/rfx-responses/{parentId}/linesLines

Path parameters

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/scm/rfx-responses/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/lines" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/rfx-responses/{parentId}/linesLines

Path parameters

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.

No body is required.

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-responses/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/lines" \
  -H "Authorization: Bearer $TOKEN"
PUT/api/scm/rfx-responses/{parentId}/lines/{lineId}Lines

Path parameters

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (uuid)The record's lineId, as a list returns it.

No body is required.

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 PUT "https://demo.tranxact.ai/api/scm/rfx-responses/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/lines/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
DELETE/api/scm/rfx-responses/{parentId}/lines/{lineId}Lines

Path parameters

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (uuid)The record's lineId, as a list returns it.

No body is required.

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 DELETE "https://demo.tranxact.ai/api/scm/rfx-responses/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/lines/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"

Data model

Every field of a rfx responses, 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 onlyRfx id
supplier_iduuidread onlySupplier id
submitted_attimestamp with time zoneread onlySubmitted at
currencytextread onlyCurrency
totalnumericread onlyTotal
lead_time_daysintegerread, writeLead time for every line (days) — Sets this lead time on every priced line of the response. To give lines different lead times, change them under Priced lines; the response’s lead time is then the longest of them.
payment_terms_daysintegerread, writePayment terms (days of credit)
validity_daysintegerread, writeValid for (days)
notestextread, writeNotes
technical_scorenumericread, writeTechnical score
commercial_scorenumericread onlyCommercial score
total_scorenumericread onlyTotal score
rankintegerread onlyRank
statustextread, writeStatus
Allowed: submitted scored shortlisted rejected
org_unit_iduuidread onlyOrg unit id
rank_nointegerread onlyRank no
is_awardedbooleanread onlyIs awarded
award_reasontextread onlyAward reason
awarded_byuuidread onlyAwarded by
awarded_attimestamp with time zoneread onlyAwarded at
purchase_order_iduuidread onlyPurchase order id
criteria_scorenumericread onlyCriteria score
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
portal_user_iduuidread onlyPortal user 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 › Responses 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.