Text Template

Textbausteine

Find an existing Resource by identifier

get

Path parameters

idinteger · int64Required

an identifier

Responses

200

successful operation

application/json

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

labelstringRequired

Bezeichnung des Bausteins

templateTypestring · enumOptional

Verwendungszweck des Templates

Default: AUTOMATICPossible values:

accountIdinteger · int64Optional

account für den diese Templates gelten

articleIdinteger · int64Optional

article für den diese Templates gelten

transferableIntoSubsequentDocumentsbooleanOptional

Erzeugte DocumentTexts beim Übergang in Folgebelege übernehmen?

Default: false

separateLinebooleanOptional

Wird eine eigene DocumentLine für den Baustein angelegt?

Default: false

positionstring · enumOptional

Position für den erzeugten DocumentText

Possible values:

activebooleanRead-onlyOptional

ist dieser Baustein aktiv?

Default: true

resolveContentInFollowUpDocumentbooleanOptional

Soll der Inhalt des Textbausteins erst bei Belegübernahme gezogen werden?

Default: false

404

Resource with given ID was not found

application/json

get/erp/text-templates/{id}

HTTPcURLJavaScriptPython

GET /api/erp/text-templates/{id} HTTP/1.1
Host: 10.102.24.218:32792
Accept: */*

{
  "version": "text",
  "info": {
    "createdAt": "2026-07-21T01:54:10.362Z",
    "createdFrom": "text",
    "updatedAt": "2026-07-21T01:54:10.362Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "label": "text",
  "templateType": "AUTOMATIC",
  "uiHintTypes": [
    "UI_HINT_MASTER_DATA"
  ],
  "accountId": 1,
  "articleId": 1,
  "targetDocumentTypes": [],
  "sourceDocumentTypes": [],
  "salesChannelRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "transferableIntoSubsequentDocuments": false,
  "separateLine": false,
  "position": "HEADER_TEXT",
  "active": true,
  "languageSpecificContents": [],
  "resolveContentInFollowUpDocument": false
}

Update existing Resource

put

Path parameters

idinteger · int64Required

an identifier

Body

application/json

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

labelstringRequired

Bezeichnung des Bausteins

templateTypestring · enumOptional

Verwendungszweck des Templates

Default: AUTOMATICPossible values:

accountIdinteger · int64Optional

account für den diese Templates gelten

articleIdinteger · int64Optional

article für den diese Templates gelten

transferableIntoSubsequentDocumentsbooleanOptional

Erzeugte DocumentTexts beim Übergang in Folgebelege übernehmen?

Default: false

separateLinebooleanOptional

Wird eine eigene DocumentLine für den Baustein angelegt?

Default: false

positionstring · enumOptional

Position für den erzeugten DocumentText

Possible values:

activebooleanRead-onlyOptional

ist dieser Baustein aktiv?

Default: true

resolveContentInFollowUpDocumentbooleanOptional

Soll der Inhalt des Textbausteins erst bei Belegübernahme gezogen werden?

Default: false

Responses

200

successful operation

application/json

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

labelstringRequired

Bezeichnung des Bausteins

templateTypestring · enumOptional

Verwendungszweck des Templates

Default: AUTOMATICPossible values:

accountIdinteger · int64Optional

account für den diese Templates gelten

articleIdinteger · int64Optional

article für den diese Templates gelten

transferableIntoSubsequentDocumentsbooleanOptional

Erzeugte DocumentTexts beim Übergang in Folgebelege übernehmen?

Default: false

separateLinebooleanOptional

Wird eine eigene DocumentLine für den Baustein angelegt?

Default: false

positionstring · enumOptional

Position für den erzeugten DocumentText

Possible values:

activebooleanRead-onlyOptional

ist dieser Baustein aktiv?

Default: true

resolveContentInFollowUpDocumentbooleanOptional

Soll der Inhalt des Textbausteins erst bei Belegübernahme gezogen werden?

Default: false

404

Resource was not found

application/json

422

Resource was not valid to process

application/json

put/erp/text-templates/{id}

HTTPcURLJavaScriptPython

PUT /api/erp/text-templates/{id} HTTP/1.1
Host: 10.102.24.218:32792
Content-Type: application/json
Accept: */*
Content-Length: 391

{
  "version": "text",
  "info": {},
  "id": "text",
  "label": "text",
  "templateType": "AUTOMATIC",
  "uiHintTypes": [
    "UI_HINT_MASTER_DATA"
  ],
  "accountId": 1,
  "articleId": 1,
  "targetDocumentTypes": [],
  "sourceDocumentTypes": [],
  "salesChannelRef": {
    "id": "text"
  },
  "transferableIntoSubsequentDocuments": false,
  "separateLine": false,
  "position": "HEADER_TEXT",
  "languageSpecificContents": [],
  "resolveContentInFollowUpDocument": false
}

{
  "version": "text",
  "info": {
    "createdAt": "2026-07-21T01:54:10.362Z",
    "createdFrom": "text",
    "updatedAt": "2026-07-21T01:54:10.362Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "label": "text",
  "templateType": "AUTOMATIC",
  "uiHintTypes": [
    "UI_HINT_MASTER_DATA"
  ],
  "accountId": 1,
  "articleId": 1,
  "targetDocumentTypes": [],
  "sourceDocumentTypes": [],
  "salesChannelRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "transferableIntoSubsequentDocuments": false,
  "separateLine": false,
  "position": "HEADER_TEXT",
  "active": true,
  "languageSpecificContents": [],
  "resolveContentInFollowUpDocument": false
}

Delete an existing Resource

delete

Path parameters

idinteger · int64Required

an identifier

Responses

200

successful operation

application/json

contextstringOptional

message context

messageValuestringOptional

message

404

Resource was not found

application/json

409

unable to delete Resource, due to constraints, existing references or internal state

application/json

delete/erp/text-templates/{id}

HTTPcURLJavaScriptPython

DELETE /api/erp/text-templates/{id} HTTP/1.1
Host: 10.102.24.218:32792
Accept: */*

{
  "context": "text",
  "messageValue": "text"
}

deaktiviert eine bestehende Resource

put

Path parameters

idinteger · int64Required

identifier

Responses

200

successful operation

application/json

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

labelstringRequired

Bezeichnung des Bausteins

templateTypestring · enumOptional

Verwendungszweck des Templates

Default: AUTOMATICPossible values:

accountIdinteger · int64Optional

account für den diese Templates gelten

articleIdinteger · int64Optional

article für den diese Templates gelten

transferableIntoSubsequentDocumentsbooleanOptional

Erzeugte DocumentTexts beim Übergang in Folgebelege übernehmen?

Default: false

separateLinebooleanOptional

Wird eine eigene DocumentLine für den Baustein angelegt?

Default: false

positionstring · enumOptional

Position für den erzeugten DocumentText

Possible values:

activebooleanRead-onlyOptional

ist dieser Baustein aktiv?

Default: true

resolveContentInFollowUpDocumentbooleanOptional

Soll der Inhalt des Textbausteins erst bei Belegübernahme gezogen werden?

Default: false

404

Resource was not found

application/json

422

Resource was not valid to process

application/json

put/erp/text-templates/{id}/deactivate

HTTPcURLJavaScriptPython

PUT /api/erp/text-templates/{id}/deactivate HTTP/1.1
Host: 10.102.24.218:32792
Accept: */*

{
  "version": "text",
  "info": {
    "createdAt": "2026-07-21T01:54:10.362Z",
    "createdFrom": "text",
    "updatedAt": "2026-07-21T01:54:10.362Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "label": "text",
  "templateType": "AUTOMATIC",
  "uiHintTypes": [
    "UI_HINT_MASTER_DATA"
  ],
  "accountId": 1,
  "articleId": 1,
  "targetDocumentTypes": [],
  "sourceDocumentTypes": [],
  "salesChannelRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "transferableIntoSubsequentDocuments": false,
  "separateLine": false,
  "position": "HEADER_TEXT",
  "active": true,
  "languageSpecificContents": [],
  "resolveContentInFollowUpDocument": false
}

aktiviert eine bestehende Resource

put

Path parameters

idinteger · int64Required

identifier

Responses

200

successful operation

application/json

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

labelstringRequired

Bezeichnung des Bausteins

templateTypestring · enumOptional

Verwendungszweck des Templates

Default: AUTOMATICPossible values:

accountIdinteger · int64Optional

account für den diese Templates gelten

articleIdinteger · int64Optional

article für den diese Templates gelten

transferableIntoSubsequentDocumentsbooleanOptional

Erzeugte DocumentTexts beim Übergang in Folgebelege übernehmen?

Default: false

separateLinebooleanOptional

Wird eine eigene DocumentLine für den Baustein angelegt?

Default: false

positionstring · enumOptional

Position für den erzeugten DocumentText

Possible values:

activebooleanRead-onlyOptional

ist dieser Baustein aktiv?

Default: true

resolveContentInFollowUpDocumentbooleanOptional

Soll der Inhalt des Textbausteins erst bei Belegübernahme gezogen werden?

Default: false

404

Resource was not found

application/json

422

Resource was not valid to process

application/json

put/erp/text-templates/{id}/activate

HTTPcURLJavaScriptPython

PUT /api/erp/text-templates/{id}/activate HTTP/1.1
Host: 10.102.24.218:32792
Accept: */*

{
  "version": "text",
  "info": {
    "createdAt": "2026-07-21T01:54:10.362Z",
    "createdFrom": "text",
    "updatedAt": "2026-07-21T01:54:10.362Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "label": "text",
  "templateType": "AUTOMATIC",
  "uiHintTypes": [
    "UI_HINT_MASTER_DATA"
  ],
  "accountId": 1,
  "articleId": 1,
  "targetDocumentTypes": [],
  "sourceDocumentTypes": [],
  "salesChannelRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "transferableIntoSubsequentDocuments": false,
  "separateLine": false,
  "position": "HEADER_TEXT",
  "active": true,
  "languageSpecificContents": [],
  "resolveContentInFollowUpDocument": false
}

Create new Resource

post

Body

application/json

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

labelstringRequired

Bezeichnung des Bausteins

templateTypestring · enumOptional

Verwendungszweck des Templates

Default: AUTOMATICPossible values:

accountIdinteger · int64Optional

account für den diese Templates gelten

articleIdinteger · int64Optional

article für den diese Templates gelten

transferableIntoSubsequentDocumentsbooleanOptional

Erzeugte DocumentTexts beim Übergang in Folgebelege übernehmen?

Default: false

separateLinebooleanOptional

Wird eine eigene DocumentLine für den Baustein angelegt?

Default: false

positionstring · enumOptional

Position für den erzeugten DocumentText

Possible values:

activebooleanRead-onlyOptional

ist dieser Baustein aktiv?

Default: true

resolveContentInFollowUpDocumentbooleanOptional

Soll der Inhalt des Textbausteins erst bei Belegübernahme gezogen werden?

Default: false

Responses

200

successful operation

application/json

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

labelstringRequired

Bezeichnung des Bausteins

templateTypestring · enumOptional

Verwendungszweck des Templates

Default: AUTOMATICPossible values:

accountIdinteger · int64Optional

account für den diese Templates gelten

articleIdinteger · int64Optional

article für den diese Templates gelten

transferableIntoSubsequentDocumentsbooleanOptional

Erzeugte DocumentTexts beim Übergang in Folgebelege übernehmen?

Default: false

separateLinebooleanOptional

Wird eine eigene DocumentLine für den Baustein angelegt?

Default: false

positionstring · enumOptional

Position für den erzeugten DocumentText

Possible values:

activebooleanRead-onlyOptional

ist dieser Baustein aktiv?

Default: true

resolveContentInFollowUpDocumentbooleanOptional

Soll der Inhalt des Textbausteins erst bei Belegübernahme gezogen werden?

Default: false

422

Resource was not valid to process

application/json

post/erp/text-templates

HTTPcURLJavaScriptPython

POST /api/erp/text-templates HTTP/1.1
Host: 10.102.24.218:32792
Content-Type: application/json
Accept: */*
Content-Length: 391

{
  "version": "text",
  "info": {},
  "id": "text",
  "label": "text",
  "templateType": "AUTOMATIC",
  "uiHintTypes": [
    "UI_HINT_MASTER_DATA"
  ],
  "accountId": 1,
  "articleId": 1,
  "targetDocumentTypes": [],
  "sourceDocumentTypes": [],
  "salesChannelRef": {
    "id": "text"
  },
  "transferableIntoSubsequentDocuments": false,
  "separateLine": false,
  "position": "HEADER_TEXT",
  "languageSpecificContents": [],
  "resolveContentInFollowUpDocument": false
}

{
  "version": "text",
  "info": {
    "createdAt": "2026-07-21T01:54:10.362Z",
    "createdFrom": "text",
    "updatedAt": "2026-07-21T01:54:10.362Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "label": "text",
  "templateType": "AUTOMATIC",
  "uiHintTypes": [
    "UI_HINT_MASTER_DATA"
  ],
  "accountId": 1,
  "articleId": 1,
  "targetDocumentTypes": [],
  "sourceDocumentTypes": [],
  "salesChannelRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "transferableIntoSubsequentDocuments": false,
  "separateLine": false,
  "position": "HEADER_TEXT",
  "active": true,
  "languageSpecificContents": [],
  "resolveContentInFollowUpDocument": false
}

get

Responses

200

OK

application/json

and

get/erp/text-templates/variables

HTTPcURLJavaScriptPython

GET /api/erp/text-templates/variables HTTP/1.1
Host: 10.102.24.218:32792
Accept: */*

200

OK

[
  {
    "_type": "text",
    "definition": "[Circular Reference]",
    "value": "[Circular Reference]"
  },
  {
    "key": "text",
    "attribute": "text",
    "path": "text",
    "displayName": "text",
    "displayNameOverride": false,
    "groupDisplayName": "text",
    "parentDisplayName": "text",
    "resultable": true,
    "filterable": true,
    "sortable": true,
    "visible": true,
    "functions": [
      "text"
    ],
    "sortDirection": "text",
    "constraint": {
      "minLength": 1,
      "maxLength": 1,
      "minValue": 1,
      "includeMinValue": true,
      "maxValue": 1,
      "includeMaxValue": true,
      "notNull": false,
      "notBlank": true
    },
    "dataType": {
      "identifier": "text",
      "jsType": "text",
      "objectRefIdentifier": "text",
      "filterOptions": {
        "filterValues": [
          "text"
        ],
        "filterDialog": null,
        "multipleChoice": false
      },
      "functions": [
        "text"
      ],
      "predicateOperations": [
        "AND"
      ]
    },
    "dataTypeIdentifier": "text",
    "modelType": "STATIC",
    "entityIdentifier": "text",
    "referencedEntityIdentifier": "text",
    "headers": []
  }
]