WSE · Schnittstellen

Dokumente & Export

Verbinden Sie WSE mit Ihren Anwendungen. Entdecken Sie Endpunkte, Datenmodelle und Schnittstellen – nach Funktionsbereichen und Add-ons geordnet.

OpenAPI herunterladen ↓
REST · JSONBearer-Authentifizierung
API docs by Redocly

Dokumente & Export

ERP API Dokumentation

Dokumente

Get Document

Authorizations:
BearerAuth
path Parameters
customer_id
required
string <uuid4> (Customer Id)
document_id
required
string <uuid4> (Document Id)

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/customers/string/documents/string' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/json
{
  • "document_id": "string",
  • "customer_id": "string",
  • "service_id": "string",
  • "document_type_key": "invoice",
  • "source_document_id": "string",
  • "source_document_type_key": "invoice",
  • "has_embedded_xml": true,
  • "embedded_xml_filename": "string",
  • "is_einvoice_conform": true,
  • "template_id": "string",
  • "display_name": "string",
  • "description": "string",
  • "document_date": "2019-08-24",
  • "created_by": "string",
  • "last_change": "2019-08-24T14:15:22Z",
  • "template": {
    },
  • "active_storage_object": {
    },
  • "render_manifest_storage_object": {
    },
  • "render_manifest": { },
  • "has_active_file": true,
  • "has_xml_file": true,
  • "has_render_manifest": true
}

Delete Document

Authorizations:
BearerAuth
path Parameters
customer_id
required
string <uuid4> (Customer Id)
document_id
required
string <uuid4> (Document Id)

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request DELETE \
  --url 'https://your-instance.example.invalid/customers/string/documents/string' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/json
{
  • "message": "string"
}

Get Document By Source Document Id

Authorizations:
BearerAuth
path Parameters
source_document_id
required
string <uuid4> (Source Document Id)

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/source-documents/string' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/json
{
  • "document_id": "string",
  • "customer_id": "string",
  • "service_id": "string",
  • "document_type_key": "invoice",
  • "source_document_id": "string",
  • "source_document_type_key": "invoice",
  • "has_embedded_xml": true,
  • "embedded_xml_filename": "string",
  • "is_einvoice_conform": true,
  • "template_id": "string",
  • "display_name": "string",
  • "description": "string",
  • "document_date": "2019-08-24",
  • "created_by": "string",
  • "last_change": "2019-08-24T14:15:22Z",
  • "template": {
    },
  • "active_storage_object": {
    },
  • "render_manifest_storage_object": {
    },
  • "render_manifest": { },
  • "has_active_file": true,
  • "has_xml_file": true,
  • "has_render_manifest": true
}

Get Documents

Authorizations:
BearerAuth
query Parameters
customer_id
required
string <uuid4> (Customer Id)
Service Id (string) or Service Id (null) (Service Id)
DocumentTypeEnum (string) or Document Type Key (null) (Document Type Key)
skip
integer (Skip) >= 0
Default: 0
limit
integer (Limit) [ 1 .. 500 ]
Default: 100

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/documents?customer_id=string&service_id=string&document_type_key=invoice&skip=0&limit=100' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/json
{
  • "total_count": 0,
  • "items": [
    ]
}

Create Document

Control the full document-generation flow from type/template resolution to PDF/A upload and API response.

Authorizations:
BearerAuth
Request Body schema: application/json
required
document_type_key
required
string (DocumentTypeEnum)
Enum: "invoice" "corrective_invoice" "order_confirmation" "quotation" "self_billing_invoice" "payment_reminder"

Fixed document type that should be generated

source_document_id
required
string <uuid4> (Source Document Id)

ID of the commercial core document used to resolve the rendering context

Template Id (string) or Template Id (null) (Template Id)

Optional explicit template ID. If omitted, the active default template of the type is used

Any of
string <uuid4> (Template Id)

Optional explicit template ID. If omitted, the active default template of the type is used

Display Name (string) or Display Name (null) (Display Name)

Optional display name of the generated document

Any of
[ 1 .. 255 ] characters
string (Display Name) [ 1 .. 255 ] characters

Optional display name of the generated document

Description (string) or Description (null) (Description)

Optional description of the generated document

Any of
<= 500 characters
string (Description) <= 500 characters

Optional description of the generated document

Document Date (string) or Document Date (null) (Document Date)

Optional business date stored on the generated document metadata

Any of
string <date> (Document Date)

Optional business date stored on the generated document metadata

Responses

Request samples

Content type
application/json
{
  • "document_type_key": "invoice",
  • "template_id": "string",
  • "source_document_id": "string",
  • "display_name": "string",
  • "description": "string",
  • "document_date": "2026-03-18"
}

Response samples

Content type
application/json
{
  • "document_id": "string",
  • "customer_id": "string",
  • "service_id": "string",
  • "document_type_key": "invoice",
  • "source_document_id": "string",
  • "source_document_type_key": "invoice",
  • "has_embedded_xml": true,
  • "embedded_xml_filename": "string",
  • "is_einvoice_conform": true,
  • "template_id": "string",
  • "display_name": "string",
  • "description": "string",
  • "document_date": "2019-08-24",
  • "created_by": "string",
  • "last_change": "2019-08-24T14:15:22Z",
  • "template": {
    },
  • "active_storage_object": {
    },
  • "render_manifest_storage_object": {
    },
  • "render_manifest": { },
  • "has_active_file": true,
  • "has_xml_file": true,
  • "has_render_manifest": true
}

Get All Documents

Authorizations:
BearerAuth
path Parameters
customer_id
required
string <uuid4> (Customer Id)
query Parameters
Service Id (string) or Service Id (null) (Service Id)
DocumentTypeEnum (string) or Document Type Key (null) (Document Type Key)
skip
integer (Skip) >= 0
Default: 0
limit
integer (Limit) [ 1 .. 500 ]
Default: 100

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/customers/string/documents?service_id=string&document_type_key=invoice&skip=0&limit=100' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/json
{
  • "total_count": 0,
  • "items": [
    ]
}

Get Document File

Authorizations:
BearerAuth
path Parameters
customer_id
required
string <uuid4> (Customer Id)
document_id
required
string <uuid4> (Document Id)
query Parameters
download
boolean (Download)
Default: false

If true, return Content-Disposition attachment instead of inline

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/customers/string/documents/string/file?download=false' \
  --header 'Accept: application/pdf' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/problem+json
{
  • "type": "urn:wse:problem:bad-request",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "parameters": null,
  • "errors": null
}

Get Document Xml

Authorizations:
BearerAuth
path Parameters
customer_id
required
string <uuid4> (Customer Id)
document_id
required
string <uuid4> (Document Id)
query Parameters
download
boolean (Download)
Default: false

If true, return Content-Disposition attachment instead of inline

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/customers/string/documents/string/xml?download=false' \
  --header 'Accept: application/xml' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/problem+json
{
  • "type": "urn:wse:problem:bad-request",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "parameters": null,
  • "errors": null
}

Preview Document

Render one preview PDF without committing, numbering or status changes on the source document.

Authorizations:
BearerAuth
Request Body schema: application/json
required
document_type_key
required
string (DocumentTypeEnum)
Enum: "invoice" "corrective_invoice" "order_confirmation" "quotation" "self_billing_invoice" "payment_reminder"

Fixed document type that should be generated

source_document_id
required
string <uuid4> (Source Document Id)

ID of the commercial core document used to resolve the rendering context

Template Id (string) or Template Id (null) (Template Id)

Optional explicit template ID. If omitted, the active default template of the type is used

Any of
string <uuid4> (Template Id)

Optional explicit template ID. If omitted, the active default template of the type is used

Display Name (string) or Display Name (null) (Display Name)

Optional display name of the generated document

Any of
[ 1 .. 255 ] characters
string (Display Name) [ 1 .. 255 ] characters

Optional display name of the generated document

Description (string) or Description (null) (Description)

Optional description of the generated document

Any of
<= 500 characters
string (Description) <= 500 characters

Optional description of the generated document

Document Date (string) or Document Date (null) (Document Date)

Optional business date stored on the generated document metadata

Any of
string <date> (Document Date)

Optional business date stored on the generated document metadata

Responses

Request samples

Content type
application/json
{
  • "document_type_key": "invoice",
  • "template_id": "string",
  • "source_document_id": "string",
  • "display_name": "string",
  • "description": "string",
  • "document_date": "2026-03-18"
}

Response samples

Content type
application/problem+json
{
  • "type": "urn:wse:problem:bad-request",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "parameters": null,
  • "errors": null
}

Vorlagen

Get Document Template Placeholders

Return template placeholders and helper metadata for template editors.

Authorizations:
BearerAuth
query Parameters
DocumentTypeEnum (string) or Document Type Key (null) (Document Type Key)
Search (string) or Search (null) (Search)

Case-insensitive placeholder filter comparable to ILIKE %term%.

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/document-templates/placeholders?document_type_key=invoice&search=string' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/json
{
  • "document_type_key": "invoice",
  • "available_document_types": [
    ],
  • "schema": "string",
  • "placeholders": [
    ],
  • "helpers": [
    ]
}

Get Document Template Compliance Requirements

Return the configured template compliance requirements for one document type.

Authorizations:
BearerAuth
query Parameters
document_type_key
string (DocumentTypeEnum)
Default: "invoice"
Enum: "invoice" "corrective_invoice" "order_confirmation" "quotation" "self_billing_invoice" "payment_reminder"

Supported fixed business document types.

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/document-templates/compliance-requirements?document_type_key=invoice' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/json
{
  • "document_type_key": "invoice",
  • "requirements": [
    ]
}

Get Document Template Compliance

Check one document template version for compliance by template id.

Authorizations:
BearerAuth
path Parameters
template_id
required
string <uuid4> (Template Id)

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/document-templates/string/compliance' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/json
{
  • "template_id": "string",
  • "template_key": "string",
  • "document_type_key": "invoice",
  • "is_compliant": true,
  • "required_paths": [
    ],
  • "alternative_path_groups": [
    ],
  • "used_paths": [
    ],
  • "missing_paths": [
    ],
  • "missing_alternative_path_groups": [
    ],
  • "missing_requirements": [
    ]
}

Get Document Template

Return one document template including style, background and active source metadata.

Authorizations:
BearerAuth
path Parameters
template_id
required
string <uuid4> (Template Id)

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/document-templates/string' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/json
{
  • "template_family_id": "string",
  • "version_no": 1,
  • "previous_template_id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "template_id": "string",
  • "document_type_key": "invoice",
  • "style_id": "string",
  • "background_id": "string",
  • "background": {
    },
  • "template_key": "string",
  • "is_default": true,
  • "is_active": true,
  • "last_change": "2019-08-24T14:15:22Z",
  • "style": {
    },
  • "has_editor_definition": true,
  • "editor_definition": {
    },
  • "active_storage_object": {
    }
}

Update Document Template

Update mutable metadata for an existing document template.

Authorizations:
BearerAuth
path Parameters
template_id
required
string <uuid4> (Template Id)
Request Body schema: application/x-www-form-urlencoded
required
Style Id (string) or Style Id (null) (Style Id)
Any of
string (Style Id)
Background Id (string) or Background Id (null) (Background Id)
Any of
string (Background Id)
Is Default (boolean) or Is Default (null) (Is Default)
Any of
boolean (Is Default)
Is Active (boolean) or Is Active (null) (Is Active)
Any of
boolean (Is Active)
DocumentTypeEnum (string) or null
Any of
string (DocumentTypeEnum)
Enum: "invoice" "corrective_invoice" "order_confirmation" "quotation" "self_billing_invoice" "payment_reminder"

Supported fixed business document types.

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request PATCH \
  --url 'https://your-instance.example.invalid/document-templates/string' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-raw 'style_id=string&background_id=string&is_default=true&is_active=true&document_type_key=invoice'

Response samples

Content type
application/json
{
  • "template_family_id": "string",
  • "version_no": 1,
  • "previous_template_id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "template_id": "string",
  • "document_type_key": "invoice",
  • "style_id": "string",
  • "background_id": "string",
  • "background": {
    },
  • "template_key": "string",
  • "is_default": true,
  • "is_active": true,
  • "last_change": "2019-08-24T14:15:22Z",
  • "style": {
    },
  • "has_editor_definition": true,
  • "editor_definition": {
    },
  • "active_storage_object": {
    }
}

Delete Document Template

Authorizations:
BearerAuth
path Parameters
template_id
required
string <uuid4> (Template Id)

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request DELETE \
  --url 'https://your-instance.example.invalid/document-templates/string' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/json
{
  • "message": "string"
}

Get Document Template Versions

Return all versions that belong to a template family.

Authorizations:
BearerAuth
path Parameters
template_id
required
string <uuid4> (Template Id)

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/document-templates/string/versions' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/json
{
  • "total_count": 0,
  • "items": [
    ]
}

Create Document Template Version

Create a successor version of an active document template.

Authorizations:
BearerAuth
path Parameters
template_id
required
string <uuid4> (Template Id)
Request Body schema: multipart/form-data
required
file
required
string <application/octet-stream> (File)
Style Id (string) or Style Id (null) (Style Id)
Any of
string (Style Id)
Background Id (string) or Background Id (null) (Background Id)
Any of
string (Background Id)
Is Default (boolean) or Is Default (null) (Is Default)
Any of
boolean (Is Default)
Editor Definition Json (string) or Editor Definition Json (null) (Editor Definition Json)

Optional editor definition serialized as JSON string

Any of
string (Editor Definition Json)

Optional editor definition serialized as JSON string

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request POST \
  --url 'https://your-instance.example.invalid/document-templates/string/versions' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --form-string 'file=string' \
  --form-string 'style_id=string' \
  --form-string 'background_id=string' \
  --form-string 'is_default=true' \
  --form-string 'editor_definition_json=string'

Response samples

Content type
application/json
{
  • "template_family_id": "string",
  • "version_no": 1,
  • "previous_template_id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "template_id": "string",
  • "document_type_key": "invoice",
  • "style_id": "string",
  • "background_id": "string",
  • "background": {
    },
  • "template_key": "string",
  • "is_default": true,
  • "is_active": true,
  • "last_change": "2019-08-24T14:15:22Z",
  • "style": {
    },
  • "has_editor_definition": true,
  • "editor_definition": {
    },
  • "active_storage_object": {
    }
}

Get Document Template Html

Return the active HTML source of one template.

Authorizations:
BearerAuth
path Parameters
template_id
required
string <uuid4> (Template Id)

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/document-templates/string/html' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/json
{
  • "template_id": "string",
  • "html": "string",
  • "mime_type": "string",
  • "original_filename": "string"
}

Get All Document Templates

Return document templates with filtering, sorting and pagination.

Authorizations:
BearerAuth
query Parameters
skip
integer (Skip) >= 0
Default: 0
limit
integer (Limit) [ 1 .. 1000 ]
Default: 100
sort_by
string (Sort By)
Default: "last_change"
Enum: "template_key" "is_default" "is_active" "last_change"
sort_order
string (Sort Order)
Default: "asc"
Enum: "asc" "desc"
include_inactive
boolean (Include Inactive)
Default: false
DocumentTypeEnum (string) or Document Type Key (null) (Document Type Key)
Background Id (string) or Background Id (null) (Background Id)
Style Id (string) or Style Id (null) (Style Id)

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/document-templates?skip=0&limit=100&sort_by=template_key&sort_order=asc&include_inactive=false&document_type_key=invoice&background_id=string&style_id=string' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/json
{
  • "total_count": 0,
  • "items": [
    ]
}

Create Document Template

Create a document template for one fixed document type.

Authorizations:
BearerAuth
Request Body schema: multipart/form-data
required
template_key
required
string (Template Key)
file
required
string <application/octet-stream> (File)
document_type_key
required
string (DocumentTypeEnum)
Enum: "invoice" "corrective_invoice" "order_confirmation" "quotation" "self_billing_invoice" "payment_reminder"

Supported fixed business document types.

Style Id (string) or Style Id (null) (Style Id)
Any of
string (Style Id)
Background Id (string) or Background Id (null) (Background Id)
Any of
string (Background Id)
is_default
boolean (Is Default)
Default: false
is_active
boolean (Is Active)
Default: true
Editor Definition Json (string) or Editor Definition Json (null) (Editor Definition Json)

Optional editor definition serialized as JSON string

Any of
string (Editor Definition Json)

Optional editor definition serialized as JSON string

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request POST \
  --url 'https://your-instance.example.invalid/document-templates' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --form-string 'template_key=string' \
  --form-string 'file=string' \
  --form-string 'document_type_key=invoice' \
  --form-string 'style_id=string' \
  --form-string 'background_id=string' \
  --form-string 'is_default=false' \
  --form-string 'is_active=true' \
  --form-string 'editor_definition_json=string'

Response samples

Content type
application/json
{
  • "template_family_id": "string",
  • "version_no": 1,
  • "previous_template_id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "template_id": "string",
  • "document_type_key": "invoice",
  • "style_id": "string",
  • "background_id": "string",
  • "background": {
    },
  • "template_key": "string",
  • "is_default": true,
  • "is_active": true,
  • "last_change": "2019-08-24T14:15:22Z",
  • "style": {
    },
  • "has_editor_definition": true,
  • "editor_definition": {
    },
  • "active_storage_object": {
    }
}

Gestaltung

Get Document Style

Return one document style including its active source file.

Authorizations:
BearerAuth
path Parameters
style_id
required
string <uuid4> (Style Id)

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/document-styles/string' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/json
{
  • "style_id": "string",
  • "style_key": "string",
  • "is_active": true,
  • "last_change": "2019-08-24T14:15:22Z",
  • "active_storage_object": {
    }
}

Update Document Style

Update one document style's key, active state, or CSS file.

Authorizations:
BearerAuth
path Parameters
style_id
required
string <uuid4> (Style Id)
Request Body schema: multipart/form-data
required
Style Key (string) or Style Key (null) (Style Key)
Any of
string (Style Key)
Is Active (boolean) or Is Active (null) (Is Active)
Any of
boolean (Is Active)
File (string) or File (null) (File)
Any of
string <application/octet-stream> (File)

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request PATCH \
  --url 'https://your-instance.example.invalid/document-styles/string' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --form-string 'style_key=string' \
  --form-string 'is_active=true' \
  --form-string 'file=string'

Response samples

Content type
application/json
{
  • "style_id": "string",
  • "style_key": "string",
  • "is_active": true,
  • "last_change": "2019-08-24T14:15:22Z",
  • "active_storage_object": {
    }
}

Delete Document Style

Authorizations:
BearerAuth
path Parameters
style_id
required
string <uuid4> (Style Id)

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request DELETE \
  --url 'https://your-instance.example.invalid/document-styles/string' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/json
{
  • "message": "string"
}

Get Document Style

Return one document style including its active source file.

Authorizations:
BearerAuth
path Parameters
style_id
required
string <uuid4> (Style Id)

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/styles/string' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/json
{
  • "style_id": "string",
  • "style_key": "string",
  • "is_active": true,
  • "last_change": "2019-08-24T14:15:22Z",
  • "active_storage_object": {
    }
}

Update Document Style

Update one document style's key, active state, or CSS file.

Authorizations:
BearerAuth
path Parameters
style_id
required
string <uuid4> (Style Id)
Request Body schema: multipart/form-data
required
Style Key (string) or Style Key (null) (Style Key)
Any of
string (Style Key)
Is Active (boolean) or Is Active (null) (Is Active)
Any of
boolean (Is Active)
File (string) or File (null) (File)
Any of
string <application/octet-stream> (File)

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request PATCH \
  --url 'https://your-instance.example.invalid/styles/string' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --form-string 'style_key=string' \
  --form-string 'is_active=true' \
  --form-string 'file=string'

Response samples

Content type
application/json
{
  • "style_id": "string",
  • "style_key": "string",
  • "is_active": true,
  • "last_change": "2019-08-24T14:15:22Z",
  • "active_storage_object": {
    }
}

Delete Document Style

Authorizations:
BearerAuth
path Parameters
style_id
required
string <uuid4> (Style Id)

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request DELETE \
  --url 'https://your-instance.example.invalid/styles/string' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/json
{
  • "message": "string"
}

Get All Document Styles

Return document styles with filtering, sorting and pagination.

Authorizations:
BearerAuth
query Parameters
skip
integer (Skip) >= 0
Default: 0
limit
integer (Limit) [ 1 .. 1000 ]
Default: 100
sort_by
string (Sort By)
Default: "last_change"
Enum: "style_key" "is_active" "last_change"
sort_order
string (Sort Order)
Default: "asc"
Enum: "asc" "desc"
include_inactive
boolean (Include Inactive)
Default: false

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/document-styles?skip=0&limit=100&sort_by=style_key&sort_order=asc&include_inactive=false' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/json
{
  • "total_count": 0,
  • "items": [
    ]
}

Create Document Style

Create one document style and store its active CSS file.

Authorizations:
BearerAuth
Request Body schema: multipart/form-data
required
style_key
required
string (Style Key)
file
required
string <application/octet-stream> (File)
is_active
boolean (Is Active)
Default: true

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request POST \
  --url 'https://your-instance.example.invalid/document-styles' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --form-string 'style_key=string' \
  --form-string 'file=string' \
  --form-string 'is_active=true'

Response samples

Content type
application/json
{
  • "style_id": "string",
  • "style_key": "string",
  • "is_active": true,
  • "last_change": "2019-08-24T14:15:22Z",
  • "active_storage_object": {
    }
}

Get All Document Styles

Return document styles with filtering, sorting and pagination.

Authorizations:
BearerAuth
query Parameters
skip
integer (Skip) >= 0
Default: 0
limit
integer (Limit) [ 1 .. 1000 ]
Default: 100
sort_by
string (Sort By)
Default: "last_change"
Enum: "style_key" "is_active" "last_change"
sort_order
string (Sort Order)
Default: "asc"
Enum: "asc" "desc"
include_inactive
boolean (Include Inactive)
Default: false

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/styles?skip=0&limit=100&sort_by=style_key&sort_order=asc&include_inactive=false' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/json
{
  • "total_count": 0,
  • "items": [
    ]
}

Create Document Style

Create one document style and store its active CSS file.

Authorizations:
BearerAuth
Request Body schema: multipart/form-data
required
style_key
required
string (Style Key)
file
required
string <application/octet-stream> (File)
is_active
boolean (Is Active)
Default: true

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request POST \
  --url 'https://your-instance.example.invalid/styles' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --form-string 'style_key=string' \
  --form-string 'file=string' \
  --form-string 'is_active=true'

Response samples

Content type
application/json
{
  • "style_id": "string",
  • "style_key": "string",
  • "is_active": true,
  • "last_change": "2019-08-24T14:15:22Z",
  • "active_storage_object": {
    }
}

Dateien & Grafiken

Get Document Asset

Return one document asset including its active source file.

Authorizations:
BearerAuth
path Parameters
asset_id
required
string <uuid4> (Asset Id)

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/document-assets/string' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/json
{
  • "asset_id": "string",
  • "asset_key": "string",
  • "is_active": true,
  • "last_change": "2019-08-24T14:15:22Z",
  • "active_storage_object": {
    },
  • "preview_available": false
}

Update Document Asset

Update one document asset's key, active state, or source file.

Authorizations:
BearerAuth
path Parameters
asset_id
required
string <uuid4> (Asset Id)
Request Body schema: multipart/form-data
required
Asset Key (string) or Asset Key (null) (Asset Key)
Any of
string (Asset Key)
Is Active (boolean) or Is Active (null) (Is Active)
Any of
boolean (Is Active)
File (string) or File (null) (File)
Any of
string <application/octet-stream> (File)

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request PATCH \
  --url 'https://your-instance.example.invalid/document-assets/string' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --form-string 'asset_key=string' \
  --form-string 'is_active=true' \
  --form-string 'file=string'

Response samples

Content type
application/json
{
  • "asset_id": "string",
  • "asset_key": "string",
  • "is_active": true,
  • "last_change": "2019-08-24T14:15:22Z",
  • "active_storage_object": {
    },
  • "preview_available": false
}

Delete Document Asset

Authorizations:
BearerAuth
path Parameters
asset_id
required
string <uuid4> (Asset Id)

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request DELETE \
  --url 'https://your-instance.example.invalid/document-assets/string' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/json
{
  • "message": "string"
}

Get Document Asset Preview

Return the active asset image as a secure binary preview.

Authorizations:
BearerAuth
path Parameters
asset_id
required
string <uuid4> (Asset Id)

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/document-assets/string/preview' \
  --header 'Accept: image/jpeg' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/problem+json
{
  • "type": "urn:wse:problem:bad-request",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "parameters": null,
  • "errors": null
}

Get All Document Assets

Return document assets with filtering, sorting and pagination.

Authorizations:
BearerAuth
query Parameters
skip
integer (Skip) >= 0
Default: 0
limit
integer (Limit) [ 1 .. 1000 ]
Default: 100
sort_by
string (Sort By)
Default: "last_change"
Enum: "asset_key" "is_active" "last_change"
sort_order
string (Sort Order)
Default: "asc"
Enum: "asc" "desc"
include_inactive
boolean (Include Inactive)
Default: false

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/document-assets?skip=0&limit=100&sort_by=asset_key&sort_order=asc&include_inactive=false' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/json
{
  • "total_count": 0,
  • "items": [
    ]
}

Create Document Asset

Create one document asset and store its active source file.

Authorizations:
BearerAuth
Request Body schema: multipart/form-data
required
asset_key
required
string (Asset Key)
file
required
string <application/octet-stream> (File)
is_active
boolean (Is Active)
Default: true

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request POST \
  --url 'https://your-instance.example.invalid/document-assets' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --form-string 'asset_key=string' \
  --form-string 'file=string' \
  --form-string 'is_active=true'

Response samples

Content type
application/json
{
  • "asset_id": "string",
  • "asset_key": "string",
  • "is_active": true,
  • "last_change": "2019-08-24T14:15:22Z",
  • "active_storage_object": {
    },
  • "preview_available": false
}

Briefpapier

Get Document Background

Return one document background including its active source file.

Authorizations:
BearerAuth
path Parameters
background_id
required
string <uuid4> (Background Id)

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/document-backgrounds/string' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/json
{
  • "background_id": "string",
  • "background_key": "string",
  • "source_type": "html",
  • "style_id": "string",
  • "is_active": true,
  • "last_change": "2019-08-24T14:15:22Z",
  • "style": {
    },
  • "preview_available": false,
  • "active_storage_object": {
    }
}

Update Document Background

Update metadata, activation state or source file of one document background.

Authorizations:
BearerAuth
path Parameters
background_id
required
string <uuid4> (Background Id)
Request Body schema: multipart/form-data
required
Background Key (string) or Background Key (null) (Background Key)
Any of
string (Background Key)
Style Id (string) or Style Id (null) (Style Id)
Any of
string (Style Id)
Is Active (boolean) or Is Active (null) (Is Active)
Any of
boolean (Is Active)
File (string) or File (null) (File)
Any of
string <application/octet-stream> (File)

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request PATCH \
  --url 'https://your-instance.example.invalid/document-backgrounds/string' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --form-string 'background_key=string' \
  --form-string 'style_id=string' \
  --form-string 'is_active=true' \
  --form-string 'file=string'

Response samples

Content type
application/json
{
  • "background_id": "string",
  • "background_key": "string",
  • "source_type": "html",
  • "style_id": "string",
  • "is_active": true,
  • "last_change": "2019-08-24T14:15:22Z",
  • "style": {
    },
  • "preview_available": false,
  • "active_storage_object": {
    }
}

Delete Document Background

Deactivate a document background when no active template still uses it.

Authorizations:
BearerAuth
path Parameters
background_id
required
string <uuid4> (Background Id)

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request DELETE \
  --url 'https://your-instance.example.invalid/document-backgrounds/string' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/json
{
  • "message": "string"
}

Preview Document Background

Render one document background source as a secure PNG preview.

Authorizations:
BearerAuth
path Parameters
background_id
required
string <uuid4> (Background Id)
Request Body schema: application/json
Any of
CommonDocumentRenderData (object) or null

Required render payload for HTML backgrounds; ignored for PDF backgrounds

Any of
required
object (CommercialDocument)

Commercial document payload available to the template

required
object (DocumentRenderMeta)

Document metadata available to the template

Responses

Request samples

Content type
application/json
Example
{
  • "render_payload": {
    }
}

Response samples

Content type
application/problem+json
{
  • "type": "urn:wse:problem:bad-request",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "parameters": null,
  • "errors": null
}

Get All Document Backgrounds

Return document backgrounds with filtering, sorting and pagination.

Authorizations:
BearerAuth
query Parameters
skip
integer (Skip) >= 0
Default: 0
limit
integer (Limit) [ 1 .. 1000 ]
Default: 100
sort_by
string (Sort By)
Default: "last_change"
Enum: "background_key" "source_type" "is_active" "last_change"
sort_order
string (Sort Order)
Default: "asc"
Enum: "asc" "desc"
include_inactive
boolean (Include Inactive)
Default: false
DocumentBackgroundSourceTypeEnum (string) or Source Type (null) (Source Type)
Style Id (string) or Style Id (null) (Style Id)

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/document-backgrounds?skip=0&limit=100&sort_by=background_key&sort_order=asc&include_inactive=false&source_type=html&style_id=string' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/json
{
  • "total_count": 0,
  • "items": [
    ]
}

Create Document Background

Create a reusable document background and store its source file.

Authorizations:
BearerAuth
Request Body schema: multipart/form-data
required
background_key
required
string (Background Key)
source_type
required
string (DocumentBackgroundSourceTypeEnum)
Enum: "html" "pdf"

Supported source types for document background layers.

file
required
string <application/octet-stream> (File)
Style Id (string) or Style Id (null) (Style Id)
Any of
string (Style Id)
is_active
boolean (Is Active)
Default: true

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request POST \
  --url 'https://your-instance.example.invalid/document-backgrounds' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --form-string 'background_key=string' \
  --form-string 'source_type=html' \
  --form-string 'file=string' \
  --form-string 'style_id=string' \
  --form-string 'is_active=true'

Response samples

Content type
application/json
{
  • "background_id": "string",
  • "background_key": "string",
  • "source_type": "html",
  • "style_id": "string",
  • "is_active": true,
  • "last_change": "2019-08-24T14:15:22Z",
  • "style": {
    },
  • "preview_available": false,
  • "active_storage_object": {
    }
}

Dokumenterzeugung

Create Invoice Document Job

Queue one worker job that generates invoice PDFs for all eligible invoices of one invoice run.

Authorizations:
BearerAuth
Request Body schema: application/json
required
invoice_run_id
required
string <uuid4> (Invoice Run Id)

Invoice run whose invoices should be turned into documents

Responses

Request samples

Content type
application/json
{
  • "invoice_run_id": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "invoice_document_run_id": "string"
}

Get Invoice Document Runs

Return the most recent invoice-document runs.

Authorizations:
BearerAuth
query Parameters
InvoiceDocumentRunStatus (string) or Status (null) (Status)

Filter by status using exact match

Total Invoices (integer) or Total Invoices (null) (Total Invoices)

Filter by total_invoices using exact match

Start Date From (string) or Start Date From (null) (Start Date From)

Filter by start_date greater than or equal

Start Date To (string) or Start Date To (null) (Start Date To)

Filter by start_date less than or equal

End Date From (string) or End Date From (null) (End Date From)

Filter by end_date greater than or equal

End Date To (string) or End Date To (null) (End Date To)

Filter by end_date less than or equal

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/invoice-document-runs?status=pending&total_invoices=0&start_date_from=2019-08-24T14%3A15%3A22Z&start_date_to=2019-08-24T14%3A15%3A22Z&end_date_from=2019-08-24T14%3A15%3A22Z&end_date_to=2019-08-24T14%3A15%3A22Z' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/json
[
  • {
    }
]

DATEV-Exportläufe

Create Datev Export Job

Queue one worker job that builds both DATEV ZIP archives for one month.

Authorizations:
BearerAuth
Request Body schema: application/json
required
export_year
required
integer (Export Year) [ 2000 .. 2100 ]

Export year

export_month
required
integer (Export Month) [ 1 .. 12 ]

Export month (1-12)

Responses

Request samples

Content type
application/json
{
  • "export_year": 2000,
  • "export_month": 1
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "datev_export_run_id": "string"
}

Get Datev Export Runs

Return the most recent DATEV-export runs.

Authorizations:
BearerAuth
query Parameters
DatevExportRunStatus (string) or Status (null) (Status)

Filter by status using exact match

Export Year (integer) or Export Year (null) (Export Year)

Filter by export_year using exact match

Export Month (integer) or Export Month (null) (Export Month)

Filter by export_month using exact match

Total Documents (integer) or Total Documents (null) (Total Documents)

Filter by total_documents using exact match

Start Date From (string) or Start Date From (null) (Start Date From)

Filter by start_date greater than or equal

Start Date To (string) or Start Date To (null) (Start Date To)

Filter by start_date less than or equal

End Date From (string) or End Date From (null) (End Date From)

Filter by end_date greater than or equal

End Date To (string) or End Date To (null) (End Date To)

Filter by end_date less than or equal

Expired Date From (string) or Expired Date From (null) (Expired Date From)

Filter by expired_date greater than or equal

Expired Date To (string) or Expired Date To (null) (Expired Date To)

Filter by expired_date less than or equal

Not Expired (boolean) or Not Expired (null) (Not Expired)

Filter to finished exports whose expired_date has not passed yet

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/datev-export-runs?status=pending&export_year=2000&export_month=1&total_documents=0&start_date_from=2019-08-24T14%3A15%3A22Z&start_date_to=2019-08-24T14%3A15%3A22Z&end_date_from=2019-08-24T14%3A15%3A22Z&end_date_to=2019-08-24T14%3A15%3A22Z&expired_date_from=2019-08-24&expired_date_to=2019-08-24&not_expired=true' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/json
[
  • {
    }
]

Get Datev Export Job

Return one DATEV export run for polling and history.

Authorizations:
BearerAuth
path Parameters
datev_export_run_id
required
string (Datev Export Run Id)

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/datev-export-jobs/string' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/json
{
  • "datev_export_run_id": "string",
  • "start_date": "2019-08-24T14:15:22Z",
  • "end_date": "2019-08-24T14:15:22Z",
  • "heartbeat_at": "2019-08-24T14:15:22Z",
  • "status": "pending",
  • "export_year": 0,
  • "export_month": 0,
  • "export_period_start": "2019-08-24",
  • "export_period_end": "2019-08-24",
  • "total_documents": 0,
  • "processed_documents": 0,
  • "failed_documents": 0,
  • "documents_zip_filename": "string",
  • "data_zip_filename": "string",
  • "documents_zip_available": false,
  • "data_zip_available": false,
  • "comment": "string",
  • "expired_date": "2019-08-24"
}

Download Datev Documents Archive

Download the generated documents ZIP archive of one DATEV export run.

Authorizations:
BearerAuth
path Parameters
datev_export_run_id
required
string (Datev Export Run Id)

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/datev-export-jobs/string/downloads/documents' \
  --header 'Accept: application/zip' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/problem+json
{
  • "type": "urn:wse:problem:bad-request",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "parameters": null,
  • "errors": null
}

Download Datev Data Archive

Download the generated data ZIP archive of one DATEV export run.

Authorizations:
BearerAuth
path Parameters
datev_export_run_id
required
string (Datev Export Run Id)

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/datev-export-jobs/string/downloads/data' \
  --header 'Accept: application/zip' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/problem+json
{
  • "type": "urn:wse:problem:bad-request",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "parameters": null,
  • "errors": null
}