ConnectCloud Developers

List transactions (tenant:trade:sales|purchasing|inbound:read by document type)

GET /api/trade/v1/sales/transactions

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

Newest first. Without filters every type is listed; lists contain the lines only where the store loads them.

Parameters

Name In Type Required Description
search query string Substring of the number, the partner's number or the partner name (case-insensitive).
type query string Transaction type code.
direction query string Only types of this direction (case-insensitive). (one of IN, OUT)
status query string Exact status.
number query string Exact transaction number (case-insensitive, trimmed).
source query string (uuid) Only documents made from this document or any revision of it (its delivery notes, the invoices listing them in typeData.sources, credit notes of an invoice).
opportunityId query string (uuid) Only documents of this crm opportunity (opportunityId; a value that is no UUID matches nothing).
limit query integer Page size; at most 500. (default 50; max 500)
cursor query string The nextCursor of the previous page; omit for the first page. A cursor of another list is 400 invalid.

Responses

  • 200 A page of transactions, newest first (creation time, then id); nextCursor continues it. (application/json)
  • 400 Error (application/json)
  • 401 No valid session or bearer token (no body).
  • 403 Missing permission, no active tenant in the token, or a missing CSRF token on a cookie write. (application/json)

Fields of the 200 answer:

  • items (array of Transaction, required)
    • addressId (string (uuid)): Masterdata address of the partner.
    • createdAt (string (date-time), read-only): When the transaction was created.
    • currency (string): ISO 4217; EUR when empty.
    • customerNo (string, read-only): Customer number of the tenant.
    • deliveryDate (string (date-time)): Delivery date.
    • documentDate (string (date-time)): Today when empty on create.
    • documentRefId (string (uuid)): DMS document of the transaction.
    • dueDate (string (date-time)): Due date.
    • eInvoiceValidation (object, read-only): The newest e-invoice check of the document (details: getInvoiceValidation). Set only for invoices and credit notes, only on reads (listTransactions, getTransaction), and absent when no check ran.
    • error (string, read-only): Error of the last processing (e.g. of an inbound invoice).
    • exchangeRate (number): 1 when empty.
    • externalTransactionNumber (string): The other party's number: the supplier's invoice number (inbound invoices) or order confirmation number (purchase orders; only there it is written through this API).
    • footerText (string): Text printed below the lines.
    • frozenSnapshot (object, read-only): Evidence copy of an accepted offer; written once.
    • grossTotal (number, read-only): Gross total, computed from the lines.
    • headerText (string): Text printed above the lines.
    • id (string (uuid), read-only): Id of the transaction.
    • items (array of TransactionLine): Lines; on update they replace all lines when present.
      • name (string, required): Name of the article or line.
      • quantity (number, required): Quantity.
      • articleNumber (string): Article number in masterdata.
      • createdAt (string (date-time), read-only): When the line was created.
      • description (string): Description of the line.
      • discountPercent (number): Discount in percent.
      • ean (string): EAN (GTIN) of the article.
      • id (string (uuid), read-only): Id of the line.
      • isOptional (boolean): The line is optional (position type optional).
      • isSelected (boolean): Selected optional lines count in the totals.
      • lineData (object): Facts of the line by type (e.g. serial numbers, sources).
      • mpn (string): Manufacturer part number.
      • parentItemId (string (uuid)): Line this line belongs to (e.g. a component of a bundle).
      • positionNumber (integer, read-only): Set from the order of items.
      • positionType (PositionType)
      • predecessorLineId (string (uuid), read-only): The line of the previous version.
      • productId (string (uuid)): Masterdata article (product) id.
      • sortOrder (integer): Sort order (ascending).
      • sourceLineId (string (uuid), read-only): Line this one was made from (order line of a delivery note or draft invoice, invoice line of a credit note). Set by the system; a value sent by a client is dropped.
      • taxRate (number): Percent.
      • totalPriceGross (number, read-only): Gross total of the line, computed.
      • totalPriceNet (number, read-only): Net total of the line, computed.
      • transactionId (string (uuid), read-only): Id of the transaction.
      • unit (string): Unit of measure.
      • unitPriceNet (number): Negative for a credit position.
      • updatedAt (string (date-time), read-only): When the line was last changed.
    • metadata (object): metadata.workflow is owned by the workflow module and kept on every write.
    • netDays (integer): Days until the net amount is due.
    • netTotal (number, read-only): Computed from the lines.
    • numberPending (boolean, read-only): A draft invoice or credit note another module made: transactionNumber is its id until releaseTransaction gives it the gapless number. Edits keep its number and status.
    • opportunityId (string (uuid)): The crm opportunity the document was made for. Only the format is checked (400 invalid, field opportunityId). A document made from another one (sourceTransactionId, e.g. the order of an accepted offer) inherits it; an update without it keeps the stored one. Carried in the events trade.transaction.* and trade.offer.accepted.
    • partnerReference (string): The partner's order reference (BT-13).
    • paymentMethodCode (string): Code of the payment method in masterdata.
    • paymentTermCode (string): Code of the payment terms: a snapshot taken when the document is made.
    • paymentTermsText (string): Payment terms as printed text.
    • predecessorId (string (uuid)): Previous version of the same document.
    • recipientAddress (object): Address snapshot of the partner.
    • recipientCompany (string): Company of the recipient.
    • recipientEmail (string): E-mail of the recipient.
    • recipientName (string): Name of the recipient.
    • skontoDays1 (integer): Days of the first cash discount.
    • skontoDays2 (integer): Days of the second cash discount.
    • skontoRate1 (number): Rate in percent of the first cash discount.
    • skontoRate2 (number): Rate in percent of the second cash discount.
    • sourceKind (string): Where it came from: MANUAL (default), PORTAL, or the e-invoice/OCR kind of inbound invoices.
    • sourceTransactionId (string (uuid)): Document this one was made from.
    • status (TransactionStatus): Sales statuses are DRAFT, SENT, ACCEPTED, EXPIRED, REVOKED, CONVERTED; delivery notes made from an order are DELIVERED or CANCELLED; issued invoices and credit notes are ISSUED (set only by issueInvoiceDraft); purchase orders, goods receipts, inbound invoices and documents of the snapshot API use their own statuses (e.g. open, posted, MATCHED, issued).
    • taxTotal (number, read-only): Tax total, computed from the lines.
    • tenantName (string, read-only): Name of the tenant.
    • transactionNumber (string): Assigned with the type's prefix when empty on create.
    • transactionType (string): Code of a type of the tenant's catalogue; required on create.
    • typeData (object): Facts of exactly one type (e.g. extraction of inbound invoices, acceptance of accepted offers, sources of a draft invoice, correctedInvoice and returnToStock of a credit note, einvoice of an issued invoice, dropShipDelivery of a drop-ship delivery note, issueRefusal {reason, problems, at, mspInvoiceId} of a draft invoice whose issue the MSP poster refused – issuing it with issueInvoiceDraft marks that MSP invoice posted).
    • updatedAt (string (date-time), read-only): When the transaction was last changed.
    • validUntil (string (date-time)): Offers only.
    • version (integer, read-only): Version of the document (createTransactionRevision adds one).
  • nextCursor (string): Pass as cursor for the next page; absent on the last one.

Example 200 answer:

{
  "items": [
    {
      "addressId": "3c5e7a91-2b4d-4f6a-8c1e-5d7f9a0b1c01",
      "createdAt": "2026-11-18T08:20:00Z",
      "currency": "EUR",
      "documentDate": "2026-11-19T00:00:00Z",
      "dueDate": "2026-12-19T00:00:00Z",
      "eInvoiceValidation": {
        "createdAt": "2026-11-19T09:05:00Z",
        "errorCount": 0,
        "id": "7c0d1e2f-3a4b-4c5d-8e6f-8a9b0c1d2e01",
        "valid": true,
        "warningCount": 1
      },
      "grossTotal": 2464.49,
      "id": "2f6b1d84-7c3e-4a5b-9e21-6a0c4d8b1e04",
      "netTotal": 2071,
      "recipientCompany": "Alpenhotel Seeblick GmbH \u0026 Co. KG",
      "status": "ISSUED",
      "taxTotal": 393.49,
      "transactionNumber": "RE-2026-0398",
      "transactionType": "INVOICE",
      "updatedAt": "2026-11-19T09:05:00Z",
      "version": 1
    },
    {
      "addressId": "3c5e7a91-2b4d-4f6a-8c1e-5d7f9a0b1c01",
      "createdAt": "2026-11-17T07:45:00Z",
      "currency": "EUR",
      "documentDate": "2026-11-17T00:00:00Z",
      "grossTotal": 2464.49,
      "id": "2f6b1d84-7c3e-4a5b-9e21-6a0c4d8b1e03",
      "netTotal": 2071,
      "recipientCompany": "Alpenhotel Seeblick GmbH \u0026 Co. KG",
      "status": "DELIVERED",
      "taxTotal": 393.49,
      "transactionNumber": "LS-2026-0211",
      "transactionType": "DELIVERY_NOTE",
      "updatedAt": "2026-11-17T07:45:00Z",
      "version": 1
    }
  ],
  "nextCursor": "Y3JlYXRlZHwyMDI2LTExLTE3VDA3OjQ1OjAwWnwyZjZiMWQ4NC03YzNlLTRhNWItOWUyMS02YTBjNGQ4YjFlMDM"
}

Example request

curl -X GET 'https://api.mbcom.cloud/api/trade/v1/sales/transactions' \
  -H "Authorization: Bearer $ACCESS_TOKEN"

View as Markdown · Interactive reference · OpenAPI