TRANXACT.AI Help

Supply Chain · Collaboration

Supplier Collaboration

The conversation, against the document it is about. Whose turn it is follows from who spoke last.

Type REST11 operationsBase path /api/scm/collab-threadsPublished as /api/v1/collab-threads

Download specification (OpenAPI 3.1) Screen: Supplier Collaboration

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 › Supplier Collaboration 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.collab_threads · 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

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

GET/api/scm/collab-threadsList supplier collaboration

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",
      "thread_no": "THR-000001",
      "supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "subject": "text",
      "topic": "text",
      "reference_type": "purchase_order",
      "reference_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "reference_no": "REF-000001",
      "priority": "low",
      "status": "open",
      "message_count": 10,
      "owner_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "due_date": "2026-10-30",
      "resolved_at": "2026-10-30T09:00:00Z"
    }
  ],
  "count": 1
}

Sample request

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

Path parameters

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "thread_no": "THR-000001",
  "supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "subject": "text",
  "topic": "text",
  "reference_type": "purchase_order",
  "reference_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "reference_no": "REF-000001",
  "priority": "low",
  "status": "open",
  "message_count": 10,
  "owner_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "due_date": "2026-10-30",
  "resolved_at": "2026-10-30T09:00:00Z"
}

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

Sample request

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

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
supplier_iduuidNoSupplier
subjecttextYesSubject
topictextNoTopic
reference_typetextNoAbout what
Allowed: purchase_order invoice delivery contract rfx forecast other
reference_iduuidNoReference id
reference_notextNoDocument number
prioritytextNoPriority
Allowed: low normal high urgent
statustextNoStatus
Allowed: open awaiting_supplier awaiting_buyer resolved closed
owner_iduuidNoOwner
due_datedateNoDue

Sample body

{
  "subject": "text",
  "supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "topic": "text",
  "reference_type": "purchase_order",
  "reference_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "thread_no": "THR-000001",
  "supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "subject": "text",
  "topic": "text",
  "reference_type": "purchase_order",
  "reference_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "reference_no": "REF-000001",
  "priority": "low",
  "status": "open",
  "message_count": 10,
  "owner_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "due_date": "2026-10-30",
  "resolved_at": "2026-10-30T09:00:00Z"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/scm/collab-threads" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"subject":"text","supplier_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","topic":"text","reference_type":"purchase_order","reference_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'
PUT/api/scm/collab-threads/{id}Change a collab threads

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_iduuidNoSupplier
subjecttextYesSubject
topictextNoTopic
reference_typetextNoAbout what
Allowed: purchase_order invoice delivery contract rfx forecast other
reference_iduuidNoReference id
reference_notextNoDocument number
prioritytextNoPriority
Allowed: low normal high urgent
statustextNoStatus
Allowed: open awaiting_supplier awaiting_buyer resolved closed
owner_iduuidNoOwner
due_datedateNoDue

Sample body

{
  "subject": "text",
  "supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "thread_no": "THR-000001",
  "supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "subject": "text",
  "topic": "text",
  "reference_type": "purchase_order",
  "reference_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "reference_no": "REF-000001",
  "priority": "low",
  "status": "open",
  "message_count": 10,
  "owner_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "due_date": "2026-10-30",
  "resolved_at": "2026-10-30T09:00:00Z"
}

Sample request

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

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

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

body*, authorSide, authorName, attachmentRef; authorSide one of buyer|supplier|system

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/collab-threads/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/post" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"body":"value","authorSide":"value","authorName":"value","attachmentRef;":"value"}'
GET/api/scm/collab-threads/{parentId}/messagesMessages

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

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

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/collab-threads/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/messages/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
DELETE/api/scm/collab-threads/{parentId}/messages/{lineId}Messages

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/collab-threads/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/messages/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"

Data model

Every field of a collab threads, 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
thread_notextread onlyThread no
supplier_iduuidread, writeSupplier
subjecttextread, writeSubject
topictextread, writeTopic
reference_typetextread, writeAbout what
Allowed: purchase_order invoice delivery contract rfx forecast other
reference_iduuidread, writeReference id
reference_notextread, writeDocument number
prioritytextread, writePriority
Allowed: low normal high urgent
statustextread, writeStatus
Allowed: open awaiting_supplier awaiting_buyer resolved closed
message_countintegerread onlyMessage count
owner_iduuidread, writeOwner
due_datedateread, writeDue
resolved_attimestamp with time zoneread onlyResolved at
created_attimestamp with time zoneread onlyCreated 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_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 › Supplier Collaboration 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.