ConnectCloud Developers

Replace the trade configuration (tenant:settings:write)

PUT /api/trade/v1/config

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

Replaces the whole configuration; masked or empty secrets keep their stored value. lastUpdate and lastEditor are set by the server. 422 also covers an invalid msp section (schedule day 1–28 or time HH:MM, automatic billing window, tax rate, notification addresses).

Request body

application/json (required)

  • active (boolean): Trade is active for the tenant.
  • ai (object): AI settings.
    • enabledFeatures (array of string): AI features turned on.
  • inbound (object): Inbound invoice settings.
    • autoGoodsReceipt (AutoGoodsReceiptConfig): Automatic goods receipt for supplier delivery notes whose lines match the open quantities of their purchase order exactly. A note read by AI must also deliver every open line of the order (a partial delivery of the order waits for a person); an EGIS note posts per shipment. Off by default.
      • minConfidence (number): Extraction confidence a delivery note needs unless it comes from EGIS (default 0.9).
      • mode (string): off (default), dryRun or on. (one of off, dryRun, on)
    • autoRelease (AutoReleaseConfig): Automatic release of inbound invoices with a clean 3-way match. Off by default.
      • excludedSupplierIds (array of string (uuid)): Supplier addresses that never release themselves; wins over supplierIds and history.
      • maxGrossEur (number): Highest gross EUR amount that releases itself; required above 0 when the mode is not off.
      • minReleasedInvoices (integer): Released invoices a supplier needs before it is trusted (default 3).
      • mode (string): off (default) stores nothing, dryRun only stores the verdict (InboundInvoice.autoRelease), on releases eligible invoices in the transaction that matches them. (one of off, dryRun, on)
      • supplierIds (array of string (uuid)): Supplier addresses trusted without history; optional.
    • fallbackVendorNo (string): Supplier number used when no supplier is found.
    • ignoredArticles (array of string): Article numbers the matching ignores (e.g. freight).
    • lastRagSync (string (date-time)): When suppliers and articles were last indexed for matching.
    • matching (MatchingTolerances)
      • allowQuantityOverhang (boolean): Accept invoiced quantities above the received ones.
      • maxPriceVarianceAbs (number): Highest accepted unit price variance as amount (e.g. 2.00 EUR).
      • maxPriceVariancePercent (number): Highest accepted unit price variance in percent (1.0 = 1 %).
    • recipientCity (string): City of the tenant as invoice recipient.
    • recipientCountry (string): Country of the tenant as invoice recipient.
    • recipientIban (string): IBAN of the tenant.
    • recipientName (string): Our company as invoice recipient (checked on inbound invoices).
    • recipientStreet (string): Street of the tenant as invoice recipient.
    • recipientVatId (string): VAT id of the tenant as invoice recipient.
    • recipientZip (string): Postal code of the tenant as invoice recipient.
    • strictEInvoice (boolean): Block invoices without structured XML.
  • itsp (object): Distributor catalog settings.
    • aiEnrichment (AIEnrichmentConfig): Null until saved once.
      • enabled (boolean): Propose article texts and product groups with AI.
      • model (string): AI model of the enrichment; empty uses the default.
    • amazon (AmazonConfig)
      • baseUrl (string): Base URL of the API; empty uses the default.
      • clientId (string): OAuth client id.
      • clientSecret (Secret): Masked (••••••••) in answers; send the mask or an empty value to keep the stored secret.
      • enabled (boolean): Search the Amazon Business catalog.
      • locale (string): Locale of the product data (e.g. de_DE).
      • refreshToken (Secret): Masked (••••••••) in answers; send the mask or an empty value to keep the stored secret.
      • region (string): Amazon region of the account.
      • sandbox (boolean): Use the sandbox environment.
      • userEmail (string): E-mail of the Amazon Business user the searches run as.
    • apiKeyId (string): API key id of the catalog service.
    • apiKeySecret (Secret): Masked (••••••••) in answers; send the mask or an empty value to keep the stored secret.
    • baseUrl (string): Base URL of the catalog service.
    • customerId (string): Customer id at the catalog service.
    • defaultCountryCode (string): Default country of the catalog searches.
    • egis (EgisConfig)
      • baseUrl (string): Base URL of the API; empty uses the default.
      • enabled (boolean): Search and order through EGIS.
      • erp (string): ERP name sent to EGIS; empty uses the default.
      • login (string): EGIS login. (max length 40)
      • password (object): EGIS password; masked in answers, the mask or an empty value keeps the stored one. (max length 40)
    • enabled (boolean): At least one catalog source is enabled.
    • infinigate (InfinigateConfig)
      • apiKey (Secret): Masked (••••••••) in answers; send the mask or an empty value to keep the stored secret.
      • baseUrl (string): Base URL of the API; empty uses the default.
      • clientId (string): OAuth client id.
      • clientSecret (Secret): Masked (••••••••) in answers; send the mask or an empty value to keep the stored secret.
      • enabled (boolean): Search and order through the Infinigate API.
      • orderingEnabled (boolean): Purchase orders of suppliers linked to Infinigate are sent through the Infinigate API (off by default; not available yet).
      • testMode (boolean): Use the Infinigate test environment.
    • ingram (IngramCatalogConfig)
      • baseUrl (string): Base URL of the API; empty uses the default.
      • clientId (string): OAuth client id.
      • clientSecret (Secret): Masked (••••••••) in answers; send the mask or an empty value to keep the stored secret.
      • countryCode (string): Ingram Micro country of the account (ISO 3166-1 alpha-2).
      • customerNumber (string): Ingram Micro customer number of the tenant.
      • enabled (boolean): Search and order through the Ingram Micro API.
      • orderingEnabled (boolean): Purchase orders of suppliers linked to Ingram Micro are sent through the Ingram API (off by default).
      • sandbox (boolean): Use the sandbox environment.
    • lastSync (string (date-time)): When the catalog was last synchronised.
    • manufacturerMappings (array of ManufacturerMapping): Manufacturer names and aliases mapped to masterdata manufacturer codes.
      • aliases (array of string): Other spellings of the manufacturer in the distributor catalogs.
      • code (string): Manufacturer code in masterdata.
      • id (string): Id of the mapping.
      • name (string): Manufacturer name in masterdata.
    • syncIntervalCron (string): Cron expression of the catalog sync.
  • lastEditor (string, read-only): Who saved the configuration last.
  • lastUpdate (string (date-time), read-only): When the configuration was last saved.
  • mail (object): Mail settings.
    • channelId (string): Comms mail channel for invoice mails; the tenant default when empty.
  • msp (TradeMSPConfig)
    • autoBilling (object): Window in the month after the billed one in which the drafts are approved without a person, once every active connector collected the month and no subscription lacks a customer or an article: at from when nothing blocks, else at every recheck and right after a collection ended, until to. When enabled, from must lie before to and every enabled connector's schedule before to (422 otherwise).
      • enabled (boolean): Bill the month automatically.
      • from (MspSchedule): A day of the month and a time of day (Europe/Berlin); unset values take the defaults (day 1, 06:00).
        • day (integer): Day of the month (1–28). (max 28)
        • time (string): HH:MM, 24 h.
      • recheckHours (integer): Hours until a blocked month (a connector missing, subscriptions without customer or article) is checked again; empty: 4. (max 168)
      • to (MspSchedule): A day of the month and a time of day (Europe/Berlin); unset values take the defaults (day 1, 06:00).
        • day (integer): Day of the month (1–28). (max 28)
        • time (string): HH:MM, 24 h.
    • enabled (boolean): MSP billing is on.
    • ingram (object): Ingram Micro cloud subscriptions (Microsoft CSP included), read through the Reseller API v7 with the Ingram connection of the distributor settings (itsp.ingram). The end customers (details, Custom_Account_ID = our address number) are read from the Cloud Marketplace API with the marketplace* access below; optional, without it customers are matched by name only.
      • articleProductGroupId (string (uuid)): Masterdata product group of the Microsoft articles MSP billing creates (see articleUnitCode).
      • articleUnitCode (string): Masterdata unit code of the Microsoft articles MSP billing creates for subscriptions without article; without unit and product group none is created.
      • enabled (boolean): Collect Ingram Micro marketplace usage.
      • marketplaceCode (string): Marketplace code.
      • marketplaceLogin (string): Ingram Micro marketplace login.
      • marketplacePassword (object): Write-only: stored encrypted, masked in answers; send the mask back to keep it.
      • marketplaceSubscriptionKey (object): Subscription key (X-Subscription-Key). Write-only: stored encrypted, masked in answers.
      • marketplaceUrl (string): Base URL of the Cloud Marketplace API gateway.
      • schedule (object): See mailstore.
      • supplierAddressId (string): See mailstore (distributor id ingram). Also the supplier of the Microsoft articles MSP billing creates.
    • itc (object): ITC Riemer (provider itc): no API, its monthly reports are uploaded (uploadMspItcReport) and count for the completeness of the month without a schedule.
      • articleProductGroupId (string (uuid)): Masterdata product group of the ITC articles MSP billing creates (see articleUnitCode).
      • articleUnitCode (string): Masterdata unit code of the ITC articles MSP billing creates for SKUs without article; without unit and product group none is created.
      • enabled (boolean): Bill ITC Riemer reports.
      • supplierAddressId (string): Masterdata address of ITC Riemer: uploaded reports are filed under it in DMS, it is the supplier of the ITC articles MSP billing creates and the reconciliation compares its inbound invoices.
    • mailstore (object): MailStore connection.
      • enabled (boolean): Collect MailStore usage.
      • password (Secret): Masked (••••••••) in answers; send the mask or an empty value to keep the stored secret.
      • schedule (object): When the previous month is collected each month.
      • supplierAddressId (string): Masterdata address of the supplier whose inbound invoices the reconciliation compares; empty: the address linked with the distributor id mailstore.
      • url (string): URL of the MailStore SPE.
      • username (string): MailStore user name.
    • notify (object): Who is told about the connector runs and the automatic billing.
      • recipients (array of string (email)): E-mail addresses; trimmed, empty and repeated ones dropped.
    • sophos (object): Sophos connection.
      • articleProductGroupId (string (uuid)): Masterdata product group of the Sophos articles MSP billing creates (see articleUnitCode).
      • articleUnitCode (string): Masterdata unit code of the Sophos articles MSP billing creates from the Infinigate catalog for SKUs without article; without unit and product group none is created.
      • clientId (string): Sophos API client id.
      • clientSecret (Secret): Masked (••••••••) in answers; send the mask or an empty value to keep the stored secret.
      • enabled (boolean): Collect Sophos usage.
      • partnerId (string): Sophos partner id.
      • schedule (object): See mailstore.
      • supplierAddressId (string): See mailstore (distributor id sophos). Also the supplier of the Sophos articles MSP billing creates (else the address of the distributor id infinigate).
    • taxRate (number): VAT rate of the MSP invoices in percent; empty: 19. (max 100)
  • outbound (object): Outgoing document settings.
    • defaultPaymentTerms (string): Payment term code used when the partner has none.
    • defaultTaxKey (string): Default tax key of outgoing documents.
    • dunningEnabled (boolean): Dunning is on.
    • eInvoiceMicrotechCheck (boolean): Validate the e-invoices of invoices and credit notes booked in microtech in the background (results: listInvoiceValidations with source=microtech).
    • eInvoiceValidation (string): What an invalid e-invoice does to an issued invoice: warn (default) issues it and raises trade.invoice.validation_failed, block refuses it with 422 einvoice_invalid. (one of warn, block)
    • numberRangeRef (string): Number range of the outgoing documents.
    • offerTokenValidityDays (integer): Days an offer link stays valid.
  • procurement (TradeProcurementConfig): Purchasing settings (purchase recommendations, carts, cart optimizer). Every field is optional.
    • allowSplit (boolean): Let the optimizer split a cart line across distributors. (default true)
    • autoCart (boolean): Put every newly opened purchase recommendation into the automatic cart. It never optimizes or orders by itself. (default false)
    • distributors (object): Cost model per offer key <source>:<distributorId> (e.g. egis:4711, masterdata:<supplierAddressId>), used when the distributor API quotes no shipping cost.
    • excluded (array of string): Offer keys the optimizer never uses.
    • includeMasterdataPrices (boolean): Use the supplier prices of masterdata articles as offers (availability unknown). (default true)
    • offerTtlMinutes (integer): How long gathered offers and a proposal built from them stay valid; 0 = 15. (default 15)
    • preferred (array of string): Offer keys that win a tie.

Example:

{
  "active": true,
  "ai": {
    "enabledFeatures": [
      "inbound_extraction",
      "delivery_note_extraction"
    ]
  },
  "inbound": {
    "autoGoodsReceipt": {
      "minConfidence": 0.9,
      "mode": "dryRun"
    },
    "autoRelease": {
      "excludedSupplierIds": [
        "6d8f0a12-3c4e-4a5b-9d6f-7e8a9b0c1d07"
      ],
      "maxGrossEur": 2500,
      "minReleasedInvoices": 3,
      "mode": "dryRun",
      "supplierIds": []
    },
    "fallbackVendorNo": "79999",
    "ignoredArticles": [
      "VERSAND",
      "FRACHT"
    ],
    "lastRagSync": "2026-11-19T02:00:00Z",
    "matching": {
      "allowQuantityOverhang": false,
      "maxPriceVarianceAbs": 2,
      "maxPriceVariancePercent": 1
    },
    "recipientCity": "Regensburg",
    "recipientCountry": "DE",
    "recipientIban": "DE02120300000000202051",
    "recipientName": "Muster IT-Systemhaus GmbH",
    "recipientStreet": "Industriestraße 12",
    "recipientVatId": "DE999000111",
    "recipientZip": "93055",
    "strictEInvoice": false
  },
  "itsp": {
    "aiEnrichment": {
      "enabled": true,
      "model": ""
    },
    "amazon": {
      "baseUrl": "",
      "clientId": "",
      "clientSecret": "",
      "enabled": false,
      "locale": "de_DE",
      "refreshToken": "",
      "region": "EU",
      "sandbox": false,
      "userEmail": ""
    },
    "egis": {
      "baseUrl": "",
      "enabled": true,
      "erp": "ConnectCloud",
      "login": "EXAMPLE-egis-login",
      "password": "••••••••"
    },
    "enabled": true,
    "infinigate": {
      "apiKey": "••••••••",
      "baseUrl": "",
      "clientId": "EXAMPLE-infinigate-client-id",
      "clientSecret": "••••••••",
      "enabled": true,
      "orderingEnabled": false,
      "testMode": false
    },
    "ingram": {
      "baseUrl": "",
      "clientId": "EXAMPLE-ingram-client-id",
      "clientSecret": "••••••••",
      "countryCode": "DE",
      "customerNumber": "EXAMPLE-20-123456",
      "enabled": true,
      "orderingEnabled": true,
      "sandbox": false
    },
    "manufacturerMappings": [
      {
        "aliases": [
          "HP Enterprise",
          "HPE Aruba"
        ],
        "code": "HPE",
        "id": "7f8a9b0c-1d2e-4f3a-8b4c-5d6e7f8a9b01",
        "name": "Hewlett Packard Enterprise"
      },
      {
        "aliases": [
          "Lenovo Global Technology",
          "LENOVO DCG"
        ],
        "code": "LNV",
        "id": "7f8a9b0c-1d2e-4f3a-8b4c-5d6e7f8a9b02",
        "name": "Lenovo"
      }
    ]
  },
  "lastEditor": "laura.kaestner@muster-it.example",
  "lastUpdate": "2026-11-18T15:40:00Z",
  "mail": {
    "channelId": ""
  },
  "msp": {
    "autoBilling": {
      "enabled": true,
      "from": {
        "day": 5,
        "time": "06:00"
      },
      "recheckHours": 4,
      "to": {
        "day": 10,
        "time": "17:00"
      }
    },
    "enabled": true,
    "ingram": {
      "articleProductGroupId": "9a0b1c2d-3e4f-4a5b-8c6d-7e8f9a0b1c04",
      "articleUnitCode": "LIZ",
      "enabled": true,
      "marketplaceCode": "de",
      "marketplaceLogin": "EXAMPLE-marketplace-login",
      "marketplacePassword": "••••••••",
      "marketplaceSubscriptionKey": "••••••••",
      "marketplaceUrl": "https://marketplace.ingram.example",
      "schedule": {
        "day": 1,
        "time": "06:00"
      },
      "supplierAddressId": "6d8f0a12-3c4e-4a5b-9d6f-7e8a9b0c1d10"
    },
    "itc": {
      "articleProductGroupId": "9a0b1c2d-3e4f-4a5b-8c6d-7e8f9a0b1c05",
      "articleUnitCode": "MON",
      "enabled": true,
      "supplierAddressId": "6d8f0a12-3c4e-4a5b-9d6f-7e8a9b0c1d03"
    },
    "mailstore": {
      "enabled": true,
      "password": "••••••••",
      "schedule": {
        "day": 1,
        "time": "06:00"
      },
      "supplierAddressId": "",
      "url": "https://mailstore.muster-it.example:8474",
      "username": "EXAMPLE-api-user"
    },
    "notify": {
      "recipients": [
        "laura.kaestner@muster-it.example",
        "christina.adler@muster-it.example"
      ]
    },
    "sophos": {
      "articleProductGroupId": "9a0b1c2d-3e4f-4a5b-8c6d-7e8f9a0b1c04",
      "articleUnitCode": "LIZ",
      "clientId": "EXAMPLE-sophos-client-id",
      "clientSecret": "••••••••",
      "enabled": true,
      "partnerId": "EXAMPLE-sophos-partner-id",
      "schedule": {
        "day": 2,
        "time": "06:00"
      },
      "supplierAddressId": "6d8f0a12-3c4e-4a5b-9d6f-7e8a9b0c1d11"
    },
    "taxRate": 19
  },
  "outbound": {
    "defaultPaymentTerms": "NETTO14",
    "defaultTaxKey": "STANDARD",
    "dunningEnabled": false,
    "eInvoiceMicrotechCheck": false,
    "eInvoiceValidation": "warn",
    "numberRangeRef": "",
    "offerTokenValidityDays": 30
  },
  "procurement": {
    "allowSplit": true,
    "autoCart": true,
    "distributors": {
      "egis:70044": {
        "defaultDeliveryDays": 1,
        "dropShipFee": 7.5,
        "freeShippingFrom": 1500,
        "minOrderSurcharge": 10,
        "minOrderValue": 50,
        "shippingCost": 8.5
      },
      "masterdata:6d8f0a12-3c4e-4a5b-9d6f-7e8a9b0c1d02": {
        "defaultDeliveryDays": 2,
        "dropShipFee": 0,
        "freeShippingFrom": 500,
        "minOrderSurcharge": 0,
        "minOrderValue": 0,
        "shippingCost": 12
      }
    },
    "excluded": [],
    "includeMasterdataPrices": true,
    "offerTtlMinutes": 15,
    "preferred": [
      "egis:70044"
    ]
  }
}

Responses

  • 200 Saved (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)
  • 422 The input is not valid for the stored data. (application/json)
  • 503 The configuration store is not available. (application/json)

Fields of the 200 answer:

  • status (string, required): Outcome of the request.

Example 200 answer:

{
  "status": "saved"
}

Example request

curl -X PUT 'https://api.mbcom.cloud/api/trade/v1/config' \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  --data '{"active":true,"ai":{"enabledFeatures":["inbound_extraction","delivery_note_extraction"]},"inbound":{"autoGoodsReceipt":{"minConfidence":0.9,"mode":"dryRun"},"autoRelease":{"excludedSupplierIds":["6d8f0a12-3c4e-4a5b-9d6f-7e8a9b0c1d07"],"maxGrossEur":2500,"minReleasedInvoices":3,"mode":"dryRun","supplierIds":[]},"fallbackVendorNo":"79999","ignoredArticles":["VERSAND","FRACHT"],"lastRagSync":"2026-11-19T02:00:00Z","matching":{"allowQuantityOverhang":false,"maxPriceVarianceAbs":2,"maxPriceVariancePercent":1},"recipientCity":"Regensburg","recipientCountry":"DE","recipientIban":"DE02120300000000202051","recipientName":"Muster IT-Systemhaus GmbH","recipientStreet":"Industriestraße 12","recipientVatId":"DE999000111","recipientZip":"93055","strictEInvoice":false},"itsp":{"aiEnrichment":{"enabled":true,"model":""},"amazon":{"baseUrl":"","clientId":"","clientSecret":"","enabled":false,"locale":"de_DE","refreshToken":"","region":"EU","sandbox":false,"userEmail":""},"egis":{"baseUrl":"","enabled":true,"erp":"ConnectCloud","login":"EXAMPLE-egis-login","password":"••••••••"},"enabled":true,"infinigate":{"apiKey":"••••••••","baseUrl":"","clientId":"EXAMPLE-infinigate-client-id","clientSecret":"••••••••","enabled":true,"orderingEnabled":false,"testMode":false},"ingram":{"baseUrl":"","clientId":"EXAMPLE-ingram-client-id","clientSecret":"••••••••","countryCode":"DE","customerNumber":"EXAMPLE-20-123456","enabled":true,"orderingEnabled":true,"sandbox":false},"manufacturerMappings":[{"aliases":["HP Enterprise","HPE Aruba"],"code":"HPE","id":"7f8a9b0c-1d2e-4f3a-8b4c-5d6e7f8a9b01","name":"Hewlett Packard Enterprise"},{"aliases":["Lenovo Global Technology","LENOVO DCG"],"code":"LNV","id":"7f8a9b0c-1d2e-4f3a-8b4c-5d6e7f8a9b02","name":"Lenovo"}]},"lastEditor":"laura.kaestner@muster-it.example","lastUpdate":"2026-11-18T15:40:00Z","mail":{"channelId":""},"msp":{"autoBilling":{"enabled":true,"from":{"day":5,"time":"06:00"},"recheckHours":4,"to":{"day":10,"time":"17:00"}},"enabled":true,"ingram":{"articleProductGroupId":"9a0b1c2d-3e4f-4a5b-8c6d-7e8f9a0b1c04","articleUnitCode":"LIZ","enabled":true,"marketplaceCode":"de","marketplaceLogin":"EXAMPLE-marketplace-login","marketplacePassword":"••••••••","marketplaceSubscriptionKey":"••••••••","marketplaceUrl":"https://marketplace.ingram.example","schedule":{"day":1,"time":"06:00"},"supplierAddressId":"6d8f0a12-3c4e-4a5b-9d6f-7e8a9b0c1d10"},"itc":{"articleProductGroupId":"9a0b1c2d-3e4f-4a5b-8c6d-7e8f9a0b1c05","articleUnitCode":"MON","enabled":true,"supplierAddressId":"6d8f0a12-3c4e-4a5b-9d6f-7e8a9b0c1d03"},"mailstore":{"enabled":true,"password":"••••••••","schedule":{"day":1,"time":"06:00"},"supplierAddressId":"","url":"https://mailstore.muster-it.example:8474","username":"EXAMPLE-api-user"},"notify":{"recipients":["laura.kaestner@muster-it.example","christina.adler@muster-it.example"]},"sophos":{"articleProductGroupId":"9a0b1c2d-3e4f-4a5b-8c6d-7e8f9a0b1c04","articleUnitCode":"LIZ","clientId":"EXAMPLE-sophos-client-id","clientSecret":"••••••••","enabled":true,"partnerId":"EXAMPLE-sophos-partner-id","schedule":{"day":2,"time":"06:00"},"supplierAddressId":"6d8f0a12-3c4e-4a5b-9d6f-7e8a9b0c1d11"},"taxRate":19},"outbound":{"defaultPaymentTerms":"NETTO14","defaultTaxKey":"STANDARD","dunningEnabled":false,"eInvoiceMicrotechCheck":false,"eInvoiceValidation":"warn","numberRangeRef":"","offerTokenValidityDays":30},"procurement":{"allowSplit":true,"autoCart":true,"distributors":{"egis:70044":{"defaultDeliveryDays":1,"dropShipFee":7.5,"freeShippingFrom":1500,"minOrderSurcharge":10,"minOrderValue":50,"shippingCost":8.5},"masterdata:6d8f0a12-3c4e-4a5b-9d6f-7e8a9b0c1d02":{"defaultDeliveryDays":2,"dropShipFee":0,"freeShippingFrom":500,"minOrderSurcharge":0,"minOrderValue":0,"shippingCost":12}},"excluded":[],"includeMasterdataPrices":true,"offerTtlMinutes":15,"preferred":["egis:70044"]}}'

View as Markdown · Interactive reference · OpenAPI