ConnectCloud Developers

Get the e-invoice check of an issued invoice (tenant:trade:sales:read)

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

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

The newest check of the e-invoice sent with the invoice, with all findings.

Parameters

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

Responses

  • 200 Check (application/json)
  • 401 No valid session or bearer token (no body).
  • 404 No invoice with this id, or it was issued without e-invoice. (application/json)

Fields of the 200 answer:

  • createdAt (string (date-time)): When the check ran.
  • customerNo (string): Customer number of the tenant.
  • customizationId (string): Customization id (BT-24) of the e-invoice.
  • dmsDocumentId (string): The checked file in DMS (empty when it was refused).
  • documentNumber (string): Invoice or document number (Belegnummer).
  • documentType (string): microtech transaction type, e.g. Rechnung I.
  • engineVersion (string): Version of the validator.
  • errorCount (integer): Number of errors.
  • fileName (string): File name of the checked XML.
  • findings (array of EInvoiceFinding): Findings of the validation.
    • location (string): XPath of the element; for schema errors the element path with line and column.
    • message (string): Message of the rule.
    • ruleId (string): Rule of EN 16931 or XRechnung (e.g. BR-DE-15), a schema error code of the validator (e.g. cvc-complex-type.2.4.a: violates the XML schema; the rules did not run), generic-error (not well-formed XML), no-scenario (no validation scenario fits the document), processing-error or PROCESSING_ERROR (the validator could not process it), KOSIT-NOT-XML, TRADE-MALWARE, TRADE-UNREADABLE (a microtech e-invoice that could not be read or checked).
    • severity (string): Severity of the finding (e.g. error, warning). (one of error, warning, information)
  • id (string (uuid)): Id of the e-invoice check.
  • invoiceId (string (uuid)): The issued invoice (source issue).
  • mode (string): The tenant setting applied to an issued invoice. (one of warn, block, ``)
  • rulesVersion (string): Version of the validation rules.
  • scenario (string): KoSIT scenario the document was validated with.
  • source (string): What was checked: issue (issued in trade) or microtech (synchronised from the ERP). (one of issue, microtech)
  • syntax (string): Syntax of the e-invoice (e.g. UBL, CII).
  • tenantName (string): Name of the tenant.
  • valid (boolean): The document passed the check (no errors).
  • warningCount (integer): Number of warnings.

Example 200 answer:

{
  "createdAt": "2026-11-19T09:05:00Z",
  "customerNo": "99999",
  "customizationId": "urn:cen.eu:en16931:2017#compliant#urn:xeinkauf.de:kosit:xrechnung_3.0",
  "dmsDocumentId": "6a7b8c9d-0e1f-4a2b-8c3d-4e5f6a7b8c01",
  "documentNumber": "RE-2026-0398",
  "engineVersion": "1.5.0",
  "errorCount": 0,
  "fileName": "RE-2026-0398.xml",
  "findings": [
    {
      "location": "/rsm:CrossIndustryInvoice/rsm:ExchangedDocumentContext/ram:GuidelineSpecifiedDocumentContextParameter/ram:ID",
      "message": "Das Element \"Specification identifier\" (BT-24) soll syntaktisch der Kennung des Standards XRechnung entsprechen.",
      "ruleId": "BR-DE-21",
      "severity": "warning"
    }
  ],
  "id": "7c0d1e2f-3a4b-4c5d-8e6f-8a9b0c1d2e01",
  "invoiceId": "2f6b1d84-7c3e-4a5b-9e21-6a0c4d8b1e04",
  "mode": "warn",
  "rulesVersion": "xrechnung-3.0.2",
  "scenario": "EN16931 XRechnung (CII)",
  "source": "issue",
  "syntax": "CII",
  "tenantName": "DEMO",
  "valid": true,
  "warningCount": 1
}

Example request

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

View as Markdown · Interactive reference · OpenAPI