ConnectCloud Developers

List the protocol of a transaction (tenant:trade:sales|purchasing|inbound:read by document type)

GET /api/trade/v1/sales/transactions/{id}/protocol

Module: Trade · operationId: listTransactionProtocol · Tag: Transactions · Auth: access token (Authorization: Bearer <accessToken>)

Oldest first, for documents of any type, also deleted ones. An unknown id answers an empty list.

Parameters

Name In Type Required Description
id path string (uuid) yes

Responses

  • 200 Protocol entries (application/json)
  • 401 No valid session or bearer token (no body).

Fields of the 200 answer:

  • items (array of ProtocolEntry, required)
    • action (string): New actions may be added. (one of CREATED, CONVERTED, REVISION_CREATED, UPDATED, STATUS_CHANGED, LINES_CHANGED, DELETED, WORKFLOW_STATUS, WORKFLOW_CHANGES, RECEIVED, REPROCESSED)
    • actor (object): Who made the change.
      • kind (string): user, service, system, workflow or public. (one of user, service, system, workflow, public)
      • name (string): Display name of the actor.
      • ref (string): Lower-case e-mail of a person, instance id of a workflow.
    • changes (array of object): Changed fields and lines.
      • field (string): Name of the changed field.
      • from (any): Value before.
      • lineId (string): Id of the changed line.
      • op (string): added or removed for a line; absent for a changed field. (one of added, removed)
      • position (integer): Position of the changed line.
      • to (any): Value after.
    • createdAt (string (date-time)): When the change was made.
    • fromStatus (string): Status before the change.
    • id (string (uuid)): Id of the protocol entry.
    • note (string): Comment of the change.
    • toStatus (string): Status after the change.
    • transactionId (string (uuid)): Id of the transaction.
    • transactionNumber (string): Number of the transaction.
    • transactionType (string): Type code of the transaction.

Example 200 answer:

{
  "items": [
    {
      "action": "CREATED",
      "actor": {
        "kind": "user",
        "name": "Felix Neumann",
        "ref": "felix.neumann@muster-it.example"
      },
      "createdAt": "2026-11-02T09:14:00Z",
      "id": "4d7e8f9a-0b1c-4d2e-9f3a-6b7c8d9e0f01",
      "toStatus": "DRAFT",
      "transactionId": "2f6b1d84-7c3e-4a5b-9e21-6a0c4d8b1e01",
      "transactionNumber": "AN-2026-0187",
      "transactionType": "OFFER"
    },
    {
      "action": "LINES_CHANGED",
      "actor": {
        "kind": "user",
        "name": "Felix Neumann",
        "ref": "felix.neumann@muster-it.example"
      },
      "changes": [
        {
          "field": "quantity",
          "from": 5,
          "lineId": "8b1c2d3e-4f5a-4b6c-9d7e-0f1a2b3c4d01",
          "position": 1,
          "to": 6
        },
        {
          "field": "netTotal",
          "from": 3082,
          "to": 3311
        }
      ],
      "createdAt": "2026-11-02T09:25:00Z",
      "id": "4d7e8f9a-0b1c-4d2e-9f3a-6b7c8d9e0f02",
      "note": "Sechs statt fünf Access Points",
      "transactionId": "2f6b1d84-7c3e-4a5b-9e21-6a0c4d8b1e01",
      "transactionNumber": "AN-2026-0187",
      "transactionType": "OFFER"
    },
    {
      "action": "STATUS_CHANGED",
      "actor": {
        "kind": "user",
        "name": "Felix Neumann",
        "ref": "felix.neumann@muster-it.example"
      },
      "createdAt": "2026-11-02T09:31:00Z",
      "fromStatus": "DRAFT",
      "id": "4d7e8f9a-0b1c-4d2e-9f3a-6b7c8d9e0f03",
      "toStatus": "SENT",
      "transactionId": "2f6b1d84-7c3e-4a5b-9e21-6a0c4d8b1e01",
      "transactionNumber": "AN-2026-0187",
      "transactionType": "OFFER"
    }
  ]
}

Example request

curl -X GET 'https://api.mbcom.cloud/api/trade/v1/sales/transactions/3f2b8c1e-7d4a-4e9b-9c2a-5b1d6e8f0a12/protocol' \
  -H "Authorization: Bearer $ACCESS_TOKEN"

View as Markdown · Interactive reference · OpenAPI