Rendering

API for starting template rendering from kVASy XML

This API accepts raw kVASy XML in the request body, maps it to an Output.Rocks rendering request, and starts document rendering asynchronously. The child element directly below `<formular>` is dynamic and usually matches the form/template name, for example `<abschlagsformular>` or `<rechnungsformular>`.

POST/api/rendering/kvasy

Authorizations

X-AUTH-TOKEN
stringheaderrequired

Value for the X-AUTH-TOKEN header parameter.

Query Parameters

format
stringdefault:pdf

Document format to render.

comment
string

Rendering comment.

webhook
string

Webhook (identifier) to execute after document rendering. Maximum 255 characters.

emailServer
string

Identifier of Email-Server configuration in Output.Rocks. Maximum 255 characters.

externalId
string

External ID for the rendering request, e.g. a correlation ID handed over by the target system. Overrides the ID derived from the XML payload (transaction number, message number or formular ID). Maximum 255 characters. Available in webhooks as `<<document.externalId>>`.

metadata
string

Optional metadata as a JSON string to be used in webhooks. Output.Rocks adds the reserved key `eInvoiceStandalone` when `xrechnung` or `eInvoiceProfile` is set.

pdfUniversalAccessibility
booleandefault:false

Enable PDF universal accessibility.

xrechnung
booleandefault:false

Produce a standalone e-invoice XML instead of a PDF. Shorthand for `eInvoiceProfile=xrechnung`.

eInvoiceProfile
string

E-invoice profile for the standalone e-invoice output. Setting it enables standalone mode just like `xrechnung=true`.

skipValidation
booleandefault:false

Skip KoSIT validation of the standalone e-invoice. Only evaluated together with `xrechnung` or `eInvoiceProfile`.

Request Body

application/xml
required

Raw kVASy XML payload.

{
  "id": "string",
  "staticAttachment": [
    {
      "fileName": "Example name",
      "content": "string"
    }
  ]
}
text/xml
required

Raw kVASy XML payload.

{
  "id": "string",
  "staticAttachment": [
    {
      "fileName": "Example name",
      "content": "string"
    }
  ]
}

Response

201application/json

Rendering resource created