ConnectCloud Developers

Get an invoice or credit note as it reads (tenant:trade:sales:read)

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

Module: Trade · operationId: getInvoiceSheet · Tag: Issued documents · Auth: access token (Authorization: Bearer <accessToken>)

The invoice or credit note in any status as the customer reads it: the document, the seller (company profile with bank account), the buyer (invoice address of the customer's masterdata), the VAT per rate and what is missing. problems names in German what keeps the sheet incomplete (no company profile, no customer address). Unknown ids and documents that are no invoice or credit note answer 404; a failing masterdata 502.

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).
  • 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": "Schönau am Königssee",
    "countryCode": "DE",
    "customerNumber": "10001",
    "email": "buchhaltung@alpenhotel-seeblick.example",
    "name": "Alpenhotel Seeblick GmbH \u0026 Co. KG",
    "postalCode": "83471",
    "street": "Seestraße 4"
  },
  "document": {
    "addressId": "3c5e7a91-2b4d-4f6a-8c1e-5d7f9a0b1c01",
    "currency": "EUR",
    "deliveryDate": "2026-11-17T00:00:00Z",
    "documentDate": "2026-11-19T00:00:00Z",
    "dueDate": "2026-12-19T00:00:00Z",
    "grossTotal": 2464.49,
    "id": "2f6b1d84-7c3e-4a5b-9e21-6a0c4d8b1e04",
    "items": [
      {
        "articleNumber": "NW-2002",
        "id": "1e4f5a6b-7c8d-4e9f-8a0b-3c4d5e6f7a01",
        "lineData": {
          "serialNumbers": [
            "AP6-24K0113",
            "AP6-24K0114",
            "AP6-24K0115",
            "AP6-24K0116",
            "AP6-24K0117",
            "AP6-24K0118"
          ]
        },
        "name": "WLAN Access Point Wi-Fi 6, Deckenmontage",
        "positionNumber": 1,
        "positionType": "normal",
        "productId": "4b7d9f13-5e6a-4c8b-a1d2-3e4f5a6b7c02",
        "quantity": 6,
        "sortOrder": 1,
        "sourceLineId": "0d3e4f5a-6b7c-4d8e-9f0a-2b3c4d5e6f01",
        "taxRate": 19,
        "totalPriceGross": 1635.06,
        "totalPriceNet": 1374,
        "transactionId": "2f6b1d84-7c3e-4a5b-9e21-6a0c4d8b1e04",
        "unit": "STK",
        "unitPriceNet": 229
      },
      {
        "articleNumber": "NW-2001",
        "id": "1e4f5a6b-7c8d-4e9f-8a0b-3c4d5e6f7a02",
        "lineData": {
          "serialNumbers": [
            "SW24-9K2207"
          ]
        },
        "name": "Switch 24 Port Gigabit PoE+, managed",
        "positionNumber": 2,
        "positionType": "normal",
        "productId": "4b7d9f13-5e6a-4c8b-a1d2-3e4f5a6b7c01",
        "quantity": 1,
        "sortOrder": 2,
        "sourceLineId": "0d3e4f5a-6b7c-4d8e-9f0a-2b3c4d5e6f02",
        "taxRate": 19,
        "totalPriceGross": 712.81,
        "totalPriceNet": 599,
        "transactionId": "2f6b1d84-7c3e-4a5b-9e21-6a0c4d8b1e04",
        "unit": "STK",
        "unitPriceNet": 599
      },
      {
        "articleNumber": "NW-2003",
        "id": "1e4f5a6b-7c8d-4e9f-8a0b-3c4d5e6f7a03",
        "name": "Patchkabel Cat.6a 2 m, grau",
        "positionNumber": 3,
        "positionType": "normal",
        "productId": "4b7d9f13-5e6a-4c8b-a1d2-3e4f5a6b7c03",
        "quantity": 20,
        "sortOrder": 3,
        "sourceLineId": "0d3e4f5a-6b7c-4d8e-9f0a-2b3c4d5e6f03",
        "taxRate": 19,
        "totalPriceGross": 116.62,
        "totalPriceNet": 98,
        "transactionId": "2f6b1d84-7c3e-4a5b-9e21-6a0c4d8b1e04",
        "unit": "STK",
        "unitPriceNet": 4.9
      }
    ],
    "netTotal": 2071,
    "partnerReference": "Auftrag vom 06.11.2026, K. Stadler",
    "paymentTermsText": "14 Tage 2 % Skonto, 30 Tage netto",
    "recipientCompany": "Alpenhotel Seeblick GmbH \u0026 Co. KG",
    "status": "ISSUED",
    "taxTotal": 393.49,
    "transactionNumber": "RE-2026-0398",
    "transactionType": "INVOICE"
  },
  "problems": [],
  "seller": {
    "bankName": "Deutsche Kreditbank",
    "bic": "BYLADEM1001",
    "city": "Regensburg",
    "commercialRegister": "HRB 15432",
    "companyName": "Muster IT-Systemhaus GmbH",
    "contactEmail": "buchhaltung@muster-it.example",
    "contactName": "Christina Adler",
    "countryCode": "DE",
    "electronicAddress": "rechnung@muster-it.example",
    "email": "info@muster-it.example",
    "iban": "DE02120300000000202051",
    "managingDirectors": "Thomas Pfeiffer",
    "phone": "+49 941 123450",
    "postalCode": "93055",
    "registerCourt": "Amtsgericht Regensburg",
    "street": "Industriestraße 12",
    "taxNumber": "244/123/45678",
    "vatId": "DE999000111",
    "website": "https://www.muster-it.example"
  },
  "taxes": [
    {
      "net": 2071,
      "rate": 19,
      "tax": 393.49
    }
  ]
}

Example request

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

View as Markdown · Interactive reference · OpenAPI