E-Invoicing

Endpointhttps://api.kontorion.eu/v1

E-invoice artifacts (EN 16931 / XRechnung / Peppol): generation, validation findings, and document downloads.

Count e-invoice documents per invoice (batch)

GET

https://api.kontorion.eu/v1

/e-invoicing/document-counts

Returns a flat {invoice_id: count} map so the invoice list can render a per-row "has e-invoice document" badge in one extra round-trip rather than N. Up to 200 ids per call.

Count e-invoice documents per invoice (batch) › query Parameters

invoice_ids

string

Comma-separated invoice UUIDs (max 200)

Count e-invoice documents per invoice (batch) › Headers

X-Workspace-Id

string

Selects the workspace this request operates in, by workspace UUID or slug (e.g. a sandbox workspace for test integrations). Omitted: the organization's default live workspace. Unknown workspace: 404; workspace outside your organization: 403. Discover workspaces via GET /workspaces.

Workspace UUID or slug.

Count e-invoice documents per invoice (batch) › Responses

object · required

List e-invoice documents

GET

https://api.kontorion.eu/v1

/e-invoicing/documents

Every artifact ever rendered for the org, most recent first — the single canonical home for e-invoice documents. Filter to one parent with ?invoice_id= or ?credit_note_id= (the per-parent list the invoice/credit-note detail pages use); omit both for the org-wide, cursor-paginated feed that powers the global "E-Invoice Documents" page.

List e-invoice documents › query Parameters

invoice_id

string · uuid

Scope to one invoice's documents (canonical replacement for the retired /e-invoicing/invoices/{id}/documents nesting)

credit_note_id

string · uuid

Scope to one credit note's documents (canonical replacement for the retired /e-invoicing/credit-notes/{id}/documents nesting)

profile

string

Exact profile ID match

quarantined_only

string

Return only quarantined docs (true/1)

limit

integer · min: 1

Page size. Values above the server-side cap are clamped (standard default 50, cap 200; a few document-heavy lists use larger windows). Invalid values fall back to the default.

Example: 50

cursor

string

Opaque continuation token from the previous response's pagination.cursor. Omit for the first page. Cursors are stateless and do not expire, but are only valid for the list and filters that produced them.

List e-invoice documents › Headers

X-Workspace-Id

string

Workspace UUID or slug.

List e-invoice documents › Responses

array | null · required

object · required

GET/e-invoicing/documents

curl --request GET \
  --url https://api.kontorion.eu/v1/e-invoicing/documents

shell

Example Responses

{
  "data": [
    {
      "byte_size": 0,
      "content_hash": "content_hash",
      "content_type": "content_type",
      "created_at": "2024-08-25T15:00:00Z",
      "credit_note_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
      "id": "0f8fad5b-d9cb-469f-a165-70867728950e",
      "invoice_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
      "jurisdiction": "jurisdiction",
      "profile": "profile",
      "quarantine_reason": "quarantine_reason",
      "signed": true,
      "syntax": "syntax"
    }
  ],
  "pagination": {
    "counts": {
      "key": {
        "key": 0
      }
    },
    "cursor": "cursor",
    "has_more": true,
    "total_count": 0
  }
}

json

application/json

Generate an e-invoice document for an invoice

POST

https://api.kontorion.eu/v1

/e-invoicing/documents

Renders and stores a new e-invoice artifact for the invoice named in the body (invoice_id, plus optional profile). Creates a row in the /e-invoicing/documents collection; 201 with the generated document.

Generate an e-invoice document for an invoice › Headers

Idempotency-Key

string · required

Unique key that makes this POST safe to retry: repeats with the same key replay the first response instead of re-executing. Replays are scoped to the retrying principal (same API key / user) and kept for 24 hours. Required on every POST.

Client-generated idempotency key (e.g. a UUID).

X-Workspace-Id

string

Workspace UUID or slug.

Generate an e-invoice document for an invoice › Request Body

credit_note_id

string · uuid

Credit note to generate the e-invoice for; set exactly one of invoice_id or credit_note_id.

Example: 0f8fad5b-d9cb-469f-a165-70867728950e

invoice_id

string · uuid

Invoice to generate the e-invoice for; set exactly one of invoice_id or credit_note_id.

Example: 0f8fad5b-d9cb-469f-a165-70867728950e

jurisdiction

string · maxLength: 100

Optional jurisdiction hint (e.g. DE) that selects jurisdiction-specific rules.

profile

string · maxLength: 100

Target e-invoice profile (e.g. EN16931_UBL, XRECHNUNG_CII, PEPPOL_BIS); required.

Generate an e-invoice document for an invoice › Responses

Created

object · required

POST/e-invoicing/documents

curl --request POST \
  --url https://api.kontorion.eu/v1/e-invoicing/documents \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <string>' \
  --data '
{
  "credit_note_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
  "invoice_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
  "jurisdiction": "jurisdiction",
  "profile": "profile"
}
'

shell

Example Request Body

{
  "credit_note_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
  "invoice_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
  "jurisdiction": "jurisdiction",
  "profile": "profile"
}

json

Example Responses

{
  "data": {
    "byte_size": 0,
    "content_hash": "content_hash",
    "created_at": "2024-08-25T15:00:00Z",
    "document_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "findings": [
      {
        "message": "message",
        "rule_id": "rule_id",
        "severity": "severity",
        "xpath": "xpath"
      }
    ],
    "profile": "profile",
    "quarantined": true,
    "storage_bucket": "storage_bucket",
    "storage_key": "storage_key",
    "syntax": "syntax"
  }
}

json

application/json

Get an e-invoice document's metadata

GET

https://api.kontorion.eu/v1

/e-invoicing/documents/{id}

Returns the document's metadata row (parent invoice or credit note, profile, syntax, jurisdiction, content hash, byte size, quarantine reason) without the artifact bytes — use /e-invoicing/documents/{id}/raw for the payload.

Get an e-invoice document's metadata › path Parameters

id

string · uuid · required

Document UUID

Get an e-invoice document's metadata › Headers

X-Workspace-Id

string

Workspace UUID or slug.

Get an e-invoice document's metadata › Responses

object · required

List validation findings for an e-invoice document

GET

https://api.kontorion.eu/v1

/e-invoicing/documents/{id}/findings

Returns every validation finding recorded for the document, resolved ones included (those carry resolved_at and resolution_notes). Findings identify the violated rule, severity, and the XPath of the offending element where available.

List validation findings for an e-invoice document › path Parameters

id

string · uuid · required

Document UUID

List validation findings for an e-invoice document › Headers

X-Workspace-Id

string

Workspace UUID or slug.

List validation findings for an e-invoice document › Responses

array | null · required

object · required

Download an e-invoice document's bytes

GET

https://api.kontorion.eu/v1

/e-invoicing/documents/{id}/raw

Streams the artifact bytes with a Content-Disposition attachment header. With ?presigned=1 the response is a 302 redirect to a short-lived presigned URL instead.

Download an e-invoice document's bytes › path Parameters

id

string · uuid · required

Document UUID

Download an e-invoice document's bytes › query Parameters

presigned

string

Return a 302 redirect to a presigned URL instead of streaming (presigned=1)

Download an e-invoice document's bytes › Headers

X-Workspace-Id

string

Workspace UUID or slug.

Download an e-invoice document's bytes › Responses

Document bytes

No data returned

Mark a finding resolved (operator override)

POST

https://api.kontorion.eu/v1

/e-invoicing/findings/{id}/resolve

Stamps the finding resolved_at with optional operator notes from the body ({"notes": "..."}; a bare POST resolves with empty notes). Record-keeping only: the document is not re-validated and its quarantine state is untouched. A finding that is already resolved responds 404.

Mark a finding resolved (operator override) › path Parameters

id

string · uuid · required

Finding UUID

Mark a finding resolved (operator override) › Headers

Idempotency-Key

string · required

Client-generated idempotency key (e.g. a UUID).

X-Workspace-Id

string

Workspace UUID or slug.

Mark a finding resolved (operator override) › Request Body

notes

string · maxLength: 2000

Optional operator notes explaining why the finding was overridden/resolved.

Mark a finding resolved (operator override) › Responses

No Content

No data returned

Tax Compliance Subscription Add-Ons

Kontorion Billing API

E-Invoicing

Endpointhttps://api.kontorion.eu/v1

E-invoice artifacts (EN 16931 / XRechnung / Peppol): generation, validation findings, and document downloads.

Count e-invoice documents per invoice (batch)

GET

https://api.kontorion.eu/v1

/e-invoicing/document-counts

Returns a flat {invoice_id: count} map so the invoice list can render a per-row "has e-invoice document" badge in one extra round-trip rather than N. Up to 200 ids per call.

Count e-invoice documents per invoice (batch) › query Parameters

invoice_ids

string

Comma-separated invoice UUIDs (max 200)

Count e-invoice documents per invoice (batch) › Headers

X-Workspace-Id

string

Workspace UUID or slug.

Count e-invoice documents per invoice (batch) › Responses

object · required

List e-invoice documents

GET

https://api.kontorion.eu/v1

/e-invoicing/documents

List e-invoice documents › query Parameters

invoice_id

string · uuid

Scope to one invoice's documents (canonical replacement for the retired /e-invoicing/invoices/{id}/documents nesting)

credit_note_id

string · uuid

Scope to one credit note's documents (canonical replacement for the retired /e-invoicing/credit-notes/{id}/documents nesting)

profile

string

Exact profile ID match

quarantined_only

string

Return only quarantined docs (true/1)

limit

integer · min: 1

Page size. Values above the server-side cap are clamped (standard default 50, cap 200; a few document-heavy lists use larger windows). Invalid values fall back to the default.

Example: 50

cursor

string

List e-invoice documents › Headers

X-Workspace-Id

string

Workspace UUID or slug.

List e-invoice documents › Responses

array | null · required

object · required

GET/e-invoicing/documents

curl --request GET \
  --url https://api.kontorion.eu/v1/e-invoicing/documents

shell

Example Responses

{
  "data": [
    {
      "byte_size": 0,
      "content_hash": "content_hash",
      "content_type": "content_type",
      "created_at": "2024-08-25T15:00:00Z",
      "credit_note_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
      "id": "0f8fad5b-d9cb-469f-a165-70867728950e",
      "invoice_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
      "jurisdiction": "jurisdiction",
      "profile": "profile",
      "quarantine_reason": "quarantine_reason",
      "signed": true,
      "syntax": "syntax"
    }
  ],
  "pagination": {
    "counts": {
      "key": {
        "key": 0
      }
    },
    "cursor": "cursor",
    "has_more": true,
    "total_count": 0
  }
}

json

application/json

Generate an e-invoice document for an invoice

POST

https://api.kontorion.eu/v1

/e-invoicing/documents

Generate an e-invoice document for an invoice › Headers

Idempotency-Key

string · required

Client-generated idempotency key (e.g. a UUID).

X-Workspace-Id

string

Workspace UUID or slug.

Generate an e-invoice document for an invoice › Request Body

credit_note_id

string · uuid

Credit note to generate the e-invoice for; set exactly one of invoice_id or credit_note_id.

Example: 0f8fad5b-d9cb-469f-a165-70867728950e

invoice_id

string · uuid

Invoice to generate the e-invoice for; set exactly one of invoice_id or credit_note_id.

Example: 0f8fad5b-d9cb-469f-a165-70867728950e

jurisdiction

string · maxLength: 100

Optional jurisdiction hint (e.g. DE) that selects jurisdiction-specific rules.

profile

string · maxLength: 100

Target e-invoice profile (e.g. EN16931_UBL, XRECHNUNG_CII, PEPPOL_BIS); required.

Generate an e-invoice document for an invoice › Responses

Created

object · required

POST/e-invoicing/documents

curl --request POST \
  --url https://api.kontorion.eu/v1/e-invoicing/documents \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <string>' \
  --data '
{
  "credit_note_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
  "invoice_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
  "jurisdiction": "jurisdiction",
  "profile": "profile"
}
'

shell

Example Request Body

{
  "credit_note_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
  "invoice_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
  "jurisdiction": "jurisdiction",
  "profile": "profile"
}

json

Example Responses

{
  "data": {
    "byte_size": 0,
    "content_hash": "content_hash",
    "created_at": "2024-08-25T15:00:00Z",
    "document_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "findings": [
      {
        "message": "message",
        "rule_id": "rule_id",
        "severity": "severity",
        "xpath": "xpath"
      }
    ],
    "profile": "profile",
    "quarantined": true,
    "storage_bucket": "storage_bucket",
    "storage_key": "storage_key",
    "syntax": "syntax"
  }
}

json

application/json

Get an e-invoice document's metadata

GET

https://api.kontorion.eu/v1

/e-invoicing/documents/{id}

Get an e-invoice document's metadata › path Parameters

id

string · uuid · required

Document UUID

Get an e-invoice document's metadata › Headers

X-Workspace-Id

string

Workspace UUID or slug.

Get an e-invoice document's metadata › Responses

object · required

List validation findings for an e-invoice document

GET

https://api.kontorion.eu/v1

/e-invoicing/documents/{id}/findings

List validation findings for an e-invoice document › path Parameters

id

string · uuid · required

Document UUID

List validation findings for an e-invoice document › Headers

X-Workspace-Id

string

Workspace UUID or slug.

List validation findings for an e-invoice document › Responses

array | null · required

object · required

Download an e-invoice document's bytes

GET

https://api.kontorion.eu/v1

/e-invoicing/documents/{id}/raw

Streams the artifact bytes with a Content-Disposition attachment header. With ?presigned=1 the response is a 302 redirect to a short-lived presigned URL instead.

Download an e-invoice document's bytes › path Parameters

id

string · uuid · required

Document UUID

Download an e-invoice document's bytes › query Parameters

presigned

string

Return a 302 redirect to a presigned URL instead of streaming (presigned=1)

Download an e-invoice document's bytes › Headers

X-Workspace-Id

string

Workspace UUID or slug.

Download an e-invoice document's bytes › Responses

Document bytes

No data returned

Mark a finding resolved (operator override)

POST

https://api.kontorion.eu/v1

/e-invoicing/findings/{id}/resolve

Mark a finding resolved (operator override) › path Parameters

id

string · uuid · required

Finding UUID

Mark a finding resolved (operator override) › Headers

Idempotency-Key

string · required

Client-generated idempotency key (e.g. a UUID).

X-Workspace-Id

string

Workspace UUID or slug.

Mark a finding resolved (operator override) › Request Body

notes

string · maxLength: 2000

Optional operator notes explaining why the finding was overridden/resolved.

Mark a finding resolved (operator override) › Responses

No Content

No data returned

Tax Compliance Subscription Add-Ons