ConnectCloud Developers

Get an MSP invoice as the customer will read it (tenant:trade:msp:read)

GET /api/trade/v1/msp/invoices/{id}/sheet

Module: Trade · operationId: getMspInvoiceSheet · Tag: MSP billing · Auth: access token (Authorization: Bearer <accessToken>)

The Verkauf document once the MSP invoice has one (transactionId), else the preview of what approving books: address, payment terms, company profile with bank account, lines, VAT and totals. Same answer as getInvoiceSheet.

Parameters

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

Responses

  • 200 The sheet (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)
  • 404 Not found in the tenant. (application/json)
  • 502 A dependent service (DMS, masterdata, a distributor) failed or is unreachable. (application/json)

Fields of the 200 answer:

  • document (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).
  • problems (array of string, required): What is missing to read the sheet completely, in German.
  • taxes (array of object, required): VAT per rate of the billable lines, ordered by rate.
    • net (number, required): Net amount taxed at the rate.
    • rate (number, required): Tax rate in percent.
    • tax (number, required): Tax amount at the rate.
  • buyer (object): Invoice address of the customer (absent without a masterdata address).
    • name (string, required): Name of the buyer.
    • addressLine2 (string): Second address line.
    • buyerReference (string): Buyer reference (Leitweg-ID, BT-10).
    • city (string): City.
    • countryCode (string): Country code (ISO 3166-1 alpha-2).
    • customerNumber (string): Customer number of the buyer.
    • email (string): E-mail address.
    • postalCode (string): Postal code.
    • street (string): Street and house number.
    • vatId (string): VAT identification number.
  • seller (object): The tenant's company profile (absent without one).
    • bankName (string): Name of the bank.
    • bic (string): BIC.
    • city (string): City.
    • commercialRegister (string): Commercial register number.
    • companyName (string): Company name of the seller.
    • companyNameAddition (string): Addition to the company name.
    • contactEmail (string): E-mail of the contact person.
    • contactName (string): Name of the contact person.
    • contactPhone (string): Phone of the contact person.
    • countryCode (string): Country code (ISO 3166-1 alpha-2).
    • electronicAddress (string): Electronic address of the seller (BT-34).
    • email (string): E-mail address.
    • iban (string): IBAN.
    • managingDirectors (string): Managing directors.
    • phone (string): Phone number.
    • postalCode (string): Postal code.
    • registerCourt (string): Register court.
    • sepaCreditorId (string): SEPA creditor id.
    • street (string): Street and house number.
    • taxNumber (string): Tax number.
    • vatId (string): VAT identification number.
    • website (string): Website.

Example 200 answer:

{
  "buyer": {
    "city": "Regensburg",
    "countryCode": "DE",
    "customerNumber": "10002",
    "email": "f.pichler@hofmann-partner.example",
    "name": "Kanzlei Hofmann \u0026 Partner Rechtsanwälte mbB",
    "postalCode": "93047",
    "street": "Maximilianstraße 21"
  },
  "document": {
    "addressId": "3c5e7a91-2b4d-4f6a-8c1e-5d7f9a0b1c02",
    "currency": "EUR",
    "documentDate": "2026-11-05T00:00:00Z",
    "grossTotal": 570.25,
    "headerText": "MSP-Abrechnung Oktober 2026",
    "items": [
      {
        "articleNumber": "MSFTCFQ7TTC0LDPB0001P1YM",
        "name": "Microsoft 365 Business Standard 1YM",
        "positionNumber": 1,
        "quantity": 12,
        "taxRate": 19,
        "totalPriceNet": 150,
        "unit": "LIZ",
        "unitPriceNet": 12.5
      },
      {
        "articleNumber": "ITC7030222P1MM",
        "description": "VM: kanzlei-srv01",
        "name": "ITC CLOUD Server CPU Performance Plus",
        "positionNumber": 2,
        "quantity": 4,
        "taxRate": 19,
        "totalPriceNet": 38,
        "unit": "MON",
        "unitPriceNet": 9.5
      },
      {
        "articleNumber": "ITC7030220P1MM",
        "description": "VM: kanzlei-srv01",
        "name": "ITC CLOUD Server RAM 1 GB",
        "positionNumber": 3,
        "quantity": 16,
        "taxRate": 19,
        "totalPriceNet": 51.2,
        "unit": "MON",
        "unitPriceNet": 3.2
      },
      {
        "articleNumber": "ITC7030003P1MM",
        "description": "VM: kanzlei-srv01",
        "name": "ITC CLOUD 3 Wege Storage Standard je GB",
        "positionNumber": 4,
        "quantity": 500,
        "taxRate": 19,
        "totalPriceNet": 60,
        "unit": "MON",
        "unitPriceNet": 0.12
      },
      {
        "articleNumber": "DL-9005",
        "name": "Supportpauschale Fernwartung, monatlich",
        "positionNumber": 5,
        "quantity": 1,
        "taxRate": 19,
        "totalPriceNet": 180,
        "unit": "MON",
        "unitPriceNet": 180
      }
    ],
    "netDays": 30,
    "netTotal": 479.2,
    "paymentTermsText": "30 Tage netto",
    "recipientCompany": "Kanzlei Hofmann \u0026 Partner Rechtsanwälte mbB",
    "status": "DRAFT",
    "taxTotal": 91.05,
    "transactionType": "INVOICE"
  },
  "problems": [],
  "seller": {
    "bankName": "Deutsche Kreditbank",
    "bic": "BYLADEM1001",
    "city": "Regensburg",
    "companyName": "Muster IT-Systemhaus GmbH",
    "countryCode": "DE",
    "email": "info@muster-it.example",
    "iban": "DE02120300000000202051",
    "postalCode": "93055",
    "street": "Industriestraße 12",
    "vatId": "DE999000111"
  },
  "taxes": [
    {
      "net": 479.2,
      "rate": 19,
      "tax": 91.05
    }
  ]
}

Example request

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

View as Markdown · Interactive reference · OpenAPI