Onboarding

Get custom document template render data example

Returns an example DocumentTemplateRenderDataV1 JSON payload for the given country and document type. Used to preview template rendering in the editor.

get/onboarding/v2/templates/schema/data

Request

  • The document declares no server URL.
  • Auth
    API key in header Ocp-Apim-Subscription-Key

Query parameters

business_modelstring

Business model (e.g. B2B, B2C, CRN, DBN). Defaults to B2B if omitted.

country_codestring

ISO 3166-1 alpha-2 country code (e.g. PL). Required.

document_typestring

Document type (e.g. INVOICE). Defaults to INVOICE if omitted.

Response

Ok - example DocumentTemplateRenderDataV1 payload returned in the standard API envelope.

messagestring
statusstring

Example response

{
  "data": {
    "schema_version": "document_template_render_data_v1",
    "source": {
      "kind": "sample"
    }
  },
  "errors": [
    {
      "type": "validation"
    }
  ],
  "status": "success"
}

Changes

No recorded changes to this operation across all 1 revision of this API.