ConnectCloud Developers

List the transaction type catalogue (a trade read permission or tenant:settings:read)

GET /api/trade/v1/sales/transaction-types

Module: Trade · operationId: listTransactionTypes · Tag: Transaction types · Auth: access token (Authorization: Bearer <accessToken>)

All types of the tenant, active and inactive, by sort order.

Responses

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

Fields of the 200 answer:

  • items (array of TransactionType, required)
    • code (string, read-only): Taken from the path on PUT.
    • createdAt (string (date-time), read-only): When the type was created.
    • customerNo (string, read-only): Customer number of the tenant.
    • direction (string): Case-insensitive on input. (one of IN, OUT)
    • eInvoiceCode (string): UNTDID 1001 document type code (BT-3) of e-invoices of this type, or empty; unique per tenant. Inbound e-invoices are filed under the IN type with their code.
    • isActive (boolean): The type can be used for new documents.
    • label (string): Display name of the type.
    • metadata (object): Free-form metadata.
    • numberPrefix (string): Prefix of the document numbers.
    • sortOrder (integer): Sort order (ascending).
    • tenantName (string, read-only): Name of the tenant.
    • updatedAt (string (date-time), read-only): When the type was last changed.

Example 200 answer:

{
  "items": [
    {
      "code": "OFFER",
      "direction": "OUT",
      "eInvoiceCode": "",
      "isActive": true,
      "label": "Angebot",
      "numberPrefix": "AN",
      "sortOrder": 10
    },
    {
      "code": "ORDER",
      "direction": "OUT",
      "eInvoiceCode": "",
      "isActive": true,
      "label": "Auftragsbestätigung",
      "numberPrefix": "AB",
      "sortOrder": 20
    },
    {
      "code": "DELIVERY_NOTE",
      "direction": "OUT",
      "eInvoiceCode": "",
      "isActive": true,
      "label": "Lieferschein",
      "numberPrefix": "LS",
      "sortOrder": 30
    },
    {
      "code": "INVOICE",
      "direction": "OUT",
      "eInvoiceCode": "380",
      "isActive": true,
      "label": "Rechnung",
      "numberPrefix": "RE",
      "sortOrder": 40
    },
    {
      "code": "CREDIT_NOTE",
      "direction": "OUT",
      "eInvoiceCode": "381",
      "isActive": true,
      "label": "Gutschrift",
      "numberPrefix": "GS",
      "sortOrder": 50
    },
    {
      "code": "INBOUND_INVOICE",
      "direction": "IN",
      "eInvoiceCode": "380",
      "isActive": true,
      "label": "Eingangsrechnung",
      "numberPrefix": "ER",
      "sortOrder": 70
    },
    {
      "code": "INBOUND_CREDIT_NOTE",
      "direction": "IN",
      "eInvoiceCode": "381",
      "isActive": true,
      "label": "Eingangsgutschrift",
      "numberPrefix": "EG",
      "sortOrder": 75
    }
  ]
}

Example request

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

View as Markdown · Interactive reference · OpenAPI