If something’s missing or unclear, let us know.
Send feedback
Ctrlk
npmGitHubAdmin-Center
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Aktivitäten

CRM Aktivitäten

Find an existing Resource by identifier

get
Path parameters
idinteger · int64Required

an identifier

Responses
200

successful operation

application/json

CRM Aktivitäten

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

systembooleanRead-onlyOptional

Handelt es sich um eine System-Aktivität?

commentstringOptional

Inhalt dieser Aktivität

notesstringOptional

Notizen

startDateTimestring · date-timeOptional

tatsächliche Startzeit

durationInSecondsinteger · int32Optional

Dauer der Aktivität in Sekunden

customanyOptional

Search-Dialog

billablebooleanRead-onlyOptional

Abrechenbar?

Default: false
billingTypestring · enumOptional

Abrechungsart von Aktivitäten

Possible values:
internalBilledbooleanRead-onlyOptional

Aktivität intern abgerechnet?

Default: false
billingDiscountnumberOptional

Rabatt zur Abrechnung

durationToBillInSecondsinteger · int32Optional

tatsächliche Dauer

publishedbooleanOptional

Ist die Aktivität veröffentlicht

Default: false
plannedDurationInSecondsinteger · int32Optional

geplante Dauer

plannedStartDateTimestring · date-timeOptional

geplante Startzeit

emailbooleanRead-onlyOptional

Handelt es sich bei der Aktivität um eine E-Mail

Default: false
get/erp/crm-activities/{id}
GET /api/erp/crm-activities/{id} HTTP/1.1
Host: 10.102.24.197:32795
Accept: */*

{
  "version": "text",
  "info": {
    "createdAt": "2026-01-01T00:00:00.000Z",
    "createdFrom": "text",
    "updatedAt": "2026-01-01T00:00:00.000Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "type": {
    "version": "text",
    "info": {
      "createdAt": "2026-01-01T00:00:00.000Z",
      "createdFrom": "text",
      "updatedAt": "2026-01-01T00:00:00.000Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "label": "text",
    "description": "text",
    "sortOrder": 1,
    "defaultBillingType": "LIKE_TASK",
    "billable": false,
    "possibleUsingTypes": [
      "ACCOUNT"
    ],
    "defaultForComments": false,
    "emailArchiving": false,
    "emailProcessing": false,
    "active": true,
    "descriptionTemplate": "text",
    "canBePublished": true
  },
  "accountRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "crmParent": {
    "id": 1,
    "type": "TASK",
    "number": "text",
    "label": "text",
    "description": "text",
    "state": {
      "version": "text",
      "info": {
        "createdAt": "2026-01-01T00:00:00.000Z",
        "createdFrom": "text",
        "updatedAt": "2026-01-01T00:00:00.000Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "label": "text",
      "description": "text",
      "crmSubTypes": [],
      "sortOrder": 1,
      "startState": false,
      "finishState": false,
      "readyToBill": false,
      "needsCommentOnPositiveFinish": false,
      "needsCommentOnNegativeFinish": false,
      "active": true,
      "portalEnumRef": {
        "id": "text",
        "label": "text",
        "description": "text"
      }
    },
    "subType": {
      "version": "text",
      "info": {
        "createdAt": "2026-01-01T00:00:00.000Z",
        "createdFrom": "text",
        "updatedAt": "2026-01-01T00:00:00.000Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "label": "text",
      "description": "text",
      "sortOrder": 1,
      "active": true
    }
  },
  "userRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "system": true,
  "comment": "text",
  "notes": "text",
  "startDateTime": "2026-01-01T00:00:00.000Z",
  "durationInSeconds": 1,
  "custom": null,
  "billable": false,
  "billingType": "LIKE_TASK",
  "billingDocumentLineRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "internalBilled": false,
  "billingDiscount": 1,
  "durationToBillInSeconds": 1,
  "published": false,
  "accountPersonRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "plannedDurationInSeconds": 1,
  "plannedStartDateTime": "2026-01-01T00:00:00.000Z",
  "email": false
}

Update existing Resource

put
Path parameters
idinteger · int64Required

an identifier

Body

CRM Aktivitäten

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

systembooleanRead-onlyOptional

Handelt es sich um eine System-Aktivität?

commentstringOptional

Inhalt dieser Aktivität

notesstringOptional

Notizen

startDateTimestring · date-timeOptional

tatsächliche Startzeit

durationInSecondsinteger · int32Optional

Dauer der Aktivität in Sekunden

customanyOptional

Search-Dialog

billablebooleanRead-onlyOptional

Abrechenbar?

Default: false
billingTypestring · enumOptional

Abrechungsart von Aktivitäten

Possible values:
internalBilledbooleanRead-onlyOptional

Aktivität intern abgerechnet?

Default: false
billingDiscountnumberOptional

Rabatt zur Abrechnung

durationToBillInSecondsinteger · int32Optional

tatsächliche Dauer

publishedbooleanOptional

Ist die Aktivität veröffentlicht

Default: false
plannedDurationInSecondsinteger · int32Optional

geplante Dauer

plannedStartDateTimestring · date-timeOptional

geplante Startzeit

emailbooleanRead-onlyOptional

Handelt es sich bei der Aktivität um eine E-Mail

Default: false
Responses
200

successful operation

application/json

CRM Aktivitäten

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

systembooleanRead-onlyOptional

Handelt es sich um eine System-Aktivität?

commentstringOptional

Inhalt dieser Aktivität

notesstringOptional

Notizen

startDateTimestring · date-timeOptional

tatsächliche Startzeit

durationInSecondsinteger · int32Optional

Dauer der Aktivität in Sekunden

customanyOptional

Search-Dialog

billablebooleanRead-onlyOptional

Abrechenbar?

Default: false
billingTypestring · enumOptional

Abrechungsart von Aktivitäten

Possible values:
internalBilledbooleanRead-onlyOptional

Aktivität intern abgerechnet?

Default: false
billingDiscountnumberOptional

Rabatt zur Abrechnung

durationToBillInSecondsinteger · int32Optional

tatsächliche Dauer

publishedbooleanOptional

Ist die Aktivität veröffentlicht

Default: false
plannedDurationInSecondsinteger · int32Optional

geplante Dauer

plannedStartDateTimestring · date-timeOptional

geplante Startzeit

emailbooleanRead-onlyOptional

Handelt es sich bei der Aktivität um eine E-Mail

Default: false
put/erp/crm-activities/{id}
PUT /api/erp/crm-activities/{id} HTTP/1.1
Host: 10.102.24.197:32795
Content-Type: application/json
Accept: */*
Content-Length: 1233

{
  "version": "text",
  "info": {},
  "id": "text",
  "type": {
    "version": "text",
    "info": {},
    "id": "text",
    "label": "text",
    "description": "text",
    "sortOrder": 1,
    "defaultBillingType": "LIKE_TASK",
    "billable": false,
    "possibleUsingTypes": [
      "ACCOUNT"
    ],
    "defaultForComments": false,
    "emailArchiving": false,
    "emailProcessing": false,
    "descriptionTemplate": "text",
    "canBePublished": true
  },
  "accountRef": {
    "id": "text"
  },
  "crmParent": {
    "id": 1,
    "type": "TASK",
    "number": "text",
    "label": "text",
    "description": "text",
    "state": {
      "version": "text",
      "info": {},
      "id": "text",
      "label": "text",
      "description": "text",
      "crmSubTypes": [],
      "sortOrder": 1,
      "startState": false,
      "finishState": false,
      "readyToBill": false,
      "needsCommentOnPositiveFinish": false,
      "needsCommentOnNegativeFinish": false,
      "portalEnumRef": {
        "id": "text",
        "label": "text"
      }
    },
    "subType": {
      "version": "text",
      "info": {},
      "id": "text",
      "label": "text",
      "description": "text",
      "sortOrder": 1
    }
  },
  "userRef": {
    "id": "text"
  },
  "comment": "text",
  "notes": "text",
  "startDateTime": "2026-01-01T00:00:00.000Z",
  "durationInSeconds": 1,
  "custom": null,
  "billingType": "LIKE_TASK",
  "billingDocumentLineRef": {
    "id": "text"
  },
  "billingDiscount": 1,
  "durationToBillInSeconds": 1,
  "published": false,
  "accountPersonRef": {
    "id": "text"
  },
  "plannedDurationInSeconds": 1,
  "plannedStartDateTime": "2026-01-01T00:00:00.000Z"
}
{
  "version": "text",
  "info": {
    "createdAt": "2026-01-01T00:00:00.000Z",
    "createdFrom": "text",
    "updatedAt": "2026-01-01T00:00:00.000Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "type": {
    "version": "text",
    "info": {
      "createdAt": "2026-01-01T00:00:00.000Z",
      "createdFrom": "text",
      "updatedAt": "2026-01-01T00:00:00.000Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "label": "text",
    "description": "text",
    "sortOrder": 1,
    "defaultBillingType": "LIKE_TASK",
    "billable": false,
    "possibleUsingTypes": [
      "ACCOUNT"
    ],
    "defaultForComments": false,
    "emailArchiving": false,
    "emailProcessing": false,
    "active": true,
    "descriptionTemplate": "text",
    "canBePublished": true
  },
  "accountRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "crmParent": {
    "id": 1,
    "type": "TASK",
    "number": "text",
    "label": "text",
    "description": "text",
    "state": {
      "version": "text",
      "info": {
        "createdAt": "2026-01-01T00:00:00.000Z",
        "createdFrom": "text",
        "updatedAt": "2026-01-01T00:00:00.000Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "label": "text",
      "description": "text",
      "crmSubTypes": [],
      "sortOrder": 1,
      "startState": false,
      "finishState": false,
      "readyToBill": false,
      "needsCommentOnPositiveFinish": false,
      "needsCommentOnNegativeFinish": false,
      "active": true,
      "portalEnumRef": {
        "id": "text",
        "label": "text",
        "description": "text"
      }
    },
    "subType": {
      "version": "text",
      "info": {
        "createdAt": "2026-01-01T00:00:00.000Z",
        "createdFrom": "text",
        "updatedAt": "2026-01-01T00:00:00.000Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "label": "text",
      "description": "text",
      "sortOrder": 1,
      "active": true
    }
  },
  "userRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "system": true,
  "comment": "text",
  "notes": "text",
  "startDateTime": "2026-01-01T00:00:00.000Z",
  "durationInSeconds": 1,
  "custom": null,
  "billable": false,
  "billingType": "LIKE_TASK",
  "billingDocumentLineRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "internalBilled": false,
  "billingDiscount": 1,
  "durationToBillInSeconds": 1,
  "published": false,
  "accountPersonRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "plannedDurationInSeconds": 1,
  "plannedStartDateTime": "2026-01-01T00:00:00.000Z",
  "email": false
}

Delete an existing Resource

delete
Path parameters
idinteger · int64Required

an identifier

Responses
200

successful operation

application/json
contextstringOptional

message context

messageValuestringOptional

message

delete/erp/crm-activities/{id}
DELETE /api/erp/crm-activities/{id} HTTP/1.1
Host: 10.102.24.197:32795
Accept: */*

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

Request markieren von Aktivitäten als "abgerechnet"

activityIdsinteger · int64[]Required

IDs der Aktivitäten, welche als abgerechnet markiert werden sollen

billingDocumentIdinteger · int64Required

ID des Abrechnungsbelegs, der mit den Aktivitäten verknüpft werden soll

Responses
200

OK

application/json

CRM Aktivitäten

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

systembooleanRead-onlyOptional

Handelt es sich um eine System-Aktivität?

commentstringOptional

Inhalt dieser Aktivität

notesstringOptional

Notizen

startDateTimestring · date-timeOptional

tatsächliche Startzeit

durationInSecondsinteger · int32Optional

Dauer der Aktivität in Sekunden

customanyOptional

Search-Dialog

billablebooleanRead-onlyOptional

Abrechenbar?

Default: false
billingTypestring · enumOptional

Abrechungsart von Aktivitäten

Possible values:
internalBilledbooleanRead-onlyOptional

Aktivität intern abgerechnet?

Default: false
billingDiscountnumberOptional

Rabatt zur Abrechnung

durationToBillInSecondsinteger · int32Optional

tatsächliche Dauer

publishedbooleanOptional

Ist die Aktivität veröffentlicht

Default: false
plannedDurationInSecondsinteger · int32Optional

geplante Dauer

plannedStartDateTimestring · date-timeOptional

geplante Startzeit

emailbooleanRead-onlyOptional

Handelt es sich bei der Aktivität um eine E-Mail

Default: false
put/erp/crm-activities/set-billed
PUT /api/erp/crm-activities/set-billed HTTP/1.1
Host: 10.102.24.197:32795
Content-Type: application/json
Accept: */*
Content-Length: 41

{
  "activityIds": [
    1
  ],
  "billingDocumentId": 1
}
200

OK

[]

Create new Resource

post
Body

CRM Aktivitäten

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

systembooleanRead-onlyOptional

Handelt es sich um eine System-Aktivität?

commentstringOptional

Inhalt dieser Aktivität

notesstringOptional

Notizen

startDateTimestring · date-timeOptional

tatsächliche Startzeit

durationInSecondsinteger · int32Optional

Dauer der Aktivität in Sekunden

customanyOptional

Search-Dialog

billablebooleanRead-onlyOptional

Abrechenbar?

Default: false
billingTypestring · enumOptional

Abrechungsart von Aktivitäten

Possible values:
internalBilledbooleanRead-onlyOptional

Aktivität intern abgerechnet?

Default: false
billingDiscountnumberOptional

Rabatt zur Abrechnung

durationToBillInSecondsinteger · int32Optional

tatsächliche Dauer

publishedbooleanOptional

Ist die Aktivität veröffentlicht

Default: false
plannedDurationInSecondsinteger · int32Optional

geplante Dauer

plannedStartDateTimestring · date-timeOptional

geplante Startzeit

emailbooleanRead-onlyOptional

Handelt es sich bei der Aktivität um eine E-Mail

Default: false
Responses
200

successful operation

application/json

CRM Aktivitäten

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

systembooleanRead-onlyOptional

Handelt es sich um eine System-Aktivität?

commentstringOptional

Inhalt dieser Aktivität

notesstringOptional

Notizen

startDateTimestring · date-timeOptional

tatsächliche Startzeit

durationInSecondsinteger · int32Optional

Dauer der Aktivität in Sekunden

customanyOptional

Search-Dialog

billablebooleanRead-onlyOptional

Abrechenbar?

Default: false
billingTypestring · enumOptional

Abrechungsart von Aktivitäten

Possible values:
internalBilledbooleanRead-onlyOptional

Aktivität intern abgerechnet?

Default: false
billingDiscountnumberOptional

Rabatt zur Abrechnung

durationToBillInSecondsinteger · int32Optional

tatsächliche Dauer

publishedbooleanOptional

Ist die Aktivität veröffentlicht

Default: false
plannedDurationInSecondsinteger · int32Optional

geplante Dauer

plannedStartDateTimestring · date-timeOptional

geplante Startzeit

emailbooleanRead-onlyOptional

Handelt es sich bei der Aktivität um eine E-Mail

Default: false
post/erp/crm-activities
POST /api/erp/crm-activities HTTP/1.1
Host: 10.102.24.197:32795
Content-Type: application/json
Accept: */*
Content-Length: 1233

{
  "version": "text",
  "info": {},
  "id": "text",
  "type": {
    "version": "text",
    "info": {},
    "id": "text",
    "label": "text",
    "description": "text",
    "sortOrder": 1,
    "defaultBillingType": "LIKE_TASK",
    "billable": false,
    "possibleUsingTypes": [
      "ACCOUNT"
    ],
    "defaultForComments": false,
    "emailArchiving": false,
    "emailProcessing": false,
    "descriptionTemplate": "text",
    "canBePublished": true
  },
  "accountRef": {
    "id": "text"
  },
  "crmParent": {
    "id": 1,
    "type": "TASK",
    "number": "text",
    "label": "text",
    "description": "text",
    "state": {
      "version": "text",
      "info": {},
      "id": "text",
      "label": "text",
      "description": "text",
      "crmSubTypes": [],
      "sortOrder": 1,
      "startState": false,
      "finishState": false,
      "readyToBill": false,
      "needsCommentOnPositiveFinish": false,
      "needsCommentOnNegativeFinish": false,
      "portalEnumRef": {
        "id": "text",
        "label": "text"
      }
    },
    "subType": {
      "version": "text",
      "info": {},
      "id": "text",
      "label": "text",
      "description": "text",
      "sortOrder": 1
    }
  },
  "userRef": {
    "id": "text"
  },
  "comment": "text",
  "notes": "text",
  "startDateTime": "2026-01-01T00:00:00.000Z",
  "durationInSeconds": 1,
  "custom": null,
  "billingType": "LIKE_TASK",
  "billingDocumentLineRef": {
    "id": "text"
  },
  "billingDiscount": 1,
  "durationToBillInSeconds": 1,
  "published": false,
  "accountPersonRef": {
    "id": "text"
  },
  "plannedDurationInSeconds": 1,
  "plannedStartDateTime": "2026-01-01T00:00:00.000Z"
}
{
  "version": "text",
  "info": {
    "createdAt": "2026-01-01T00:00:00.000Z",
    "createdFrom": "text",
    "updatedAt": "2026-01-01T00:00:00.000Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "type": {
    "version": "text",
    "info": {
      "createdAt": "2026-01-01T00:00:00.000Z",
      "createdFrom": "text",
      "updatedAt": "2026-01-01T00:00:00.000Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "label": "text",
    "description": "text",
    "sortOrder": 1,
    "defaultBillingType": "LIKE_TASK",
    "billable": false,
    "possibleUsingTypes": [
      "ACCOUNT"
    ],
    "defaultForComments": false,
    "emailArchiving": false,
    "emailProcessing": false,
    "active": true,
    "descriptionTemplate": "text",
    "canBePublished": true
  },
  "accountRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "crmParent": {
    "id": 1,
    "type": "TASK",
    "number": "text",
    "label": "text",
    "description": "text",
    "state": {
      "version": "text",
      "info": {
        "createdAt": "2026-01-01T00:00:00.000Z",
        "createdFrom": "text",
        "updatedAt": "2026-01-01T00:00:00.000Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "label": "text",
      "description": "text",
      "crmSubTypes": [],
      "sortOrder": 1,
      "startState": false,
      "finishState": false,
      "readyToBill": false,
      "needsCommentOnPositiveFinish": false,
      "needsCommentOnNegativeFinish": false,
      "active": true,
      "portalEnumRef": {
        "id": "text",
        "label": "text",
        "description": "text"
      }
    },
    "subType": {
      "version": "text",
      "info": {
        "createdAt": "2026-01-01T00:00:00.000Z",
        "createdFrom": "text",
        "updatedAt": "2026-01-01T00:00:00.000Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "label": "text",
      "description": "text",
      "sortOrder": 1,
      "active": true
    }
  },
  "userRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "system": true,
  "comment": "text",
  "notes": "text",
  "startDateTime": "2026-01-01T00:00:00.000Z",
  "durationInSeconds": 1,
  "custom": null,
  "billable": false,
  "billingType": "LIKE_TASK",
  "billingDocumentLineRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "internalBilled": false,
  "billingDiscount": 1,
  "durationToBillInSeconds": 1,
  "published": false,
  "accountPersonRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "plannedDurationInSeconds": 1,
  "plannedStartDateTime": "2026-01-01T00:00:00.000Z",
  "email": false
}
post
Body

Request zur Durchführung der Abrechnung von Aktivitäten

crmActivityIdsToIgnoreinteger · int64[]Optional

IDs von Aktivitäten, die nicht abgerechnet werden sollen

crmActivityIdsToBillinteger · int64[]Optional

IDs von Aktivitäten, die abgerechnet werden sollen

Responses
200

OK

application/json
contextstringOptional

message context

messageValuestringOptional

message

post/erp/crm-activities/perform-billing
POST /api/erp/crm-activities/perform-billing HTTP/1.1
Host: 10.102.24.197:32795
Content-Type: application/json
Accept: */*
Content-Length: 238

{
  "variables": {
    "variableSubstitutions": []
  },
  "queryPredicate": {
    "type": "JUNCTION",
    "operator": "AND",
    "children": [],
    "property": "text",
    "values": [
      "text"
    ],
    "visible": true,
    "functions": [
      "text"
    ]
  },
  "crmActivityIdsToIgnore": [
    1
  ],
  "crmActivityIdsToBill": [
    1
  ]
}
200

OK

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

Request zum Anlegen einer Aktivität E-Mail

crmIdinteger · int64Optional

ID vom CRM-Objekt

crmTypestring · enumOptional

Möglich CRM-Typen

Possible values:
accountIdinteger · int64Optional

ID vom Account

emailsAsProcessingbooleanOptional

Soll die Aktivität als "E-Mail-Bearbeitung" angelegt werden?

Default: false
Responses
200

OK

application/json

CRM Aktivitäten

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

systembooleanRead-onlyOptional

Handelt es sich um eine System-Aktivität?

commentstringOptional

Inhalt dieser Aktivität

notesstringOptional

Notizen

startDateTimestring · date-timeOptional

tatsächliche Startzeit

durationInSecondsinteger · int32Optional

Dauer der Aktivität in Sekunden

customanyOptional

Search-Dialog

billablebooleanRead-onlyOptional

Abrechenbar?

Default: false
billingTypestring · enumOptional

Abrechungsart von Aktivitäten

Possible values:
internalBilledbooleanRead-onlyOptional

Aktivität intern abgerechnet?

Default: false
billingDiscountnumberOptional

Rabatt zur Abrechnung

durationToBillInSecondsinteger · int32Optional

tatsächliche Dauer

publishedbooleanOptional

Ist die Aktivität veröffentlicht

Default: false
plannedDurationInSecondsinteger · int32Optional

geplante Dauer

plannedStartDateTimestring · date-timeOptional

geplante Startzeit

emailbooleanRead-onlyOptional

Handelt es sich bei der Aktivität um eine E-Mail

Default: false
post/erp/crm-activities/for-email
POST /api/erp/crm-activities/for-email HTTP/1.1
Host: 10.102.24.197:32795
Content-Type: application/json
Accept: */*
Content-Length: 69

{
  "crmId": 1,
  "crmType": "TASK",
  "accountId": 1,
  "emailsAsProcessing": false
}
200

OK

{
  "version": "text",
  "info": {
    "createdAt": "2026-01-01T00:00:00.000Z",
    "createdFrom": "text",
    "updatedAt": "2026-01-01T00:00:00.000Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "type": {
    "version": "text",
    "info": {
      "createdAt": "2026-01-01T00:00:00.000Z",
      "createdFrom": "text",
      "updatedAt": "2026-01-01T00:00:00.000Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "label": "text",
    "description": "text",
    "sortOrder": 1,
    "defaultBillingType": "LIKE_TASK",
    "billable": false,
    "possibleUsingTypes": [
      "ACCOUNT"
    ],
    "defaultForComments": false,
    "emailArchiving": false,
    "emailProcessing": false,
    "active": true,
    "descriptionTemplate": "text",
    "canBePublished": true
  },
  "accountRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "crmParent": {
    "id": 1,
    "type": "TASK",
    "number": "text",
    "label": "text",
    "description": "text",
    "state": {
      "version": "text",
      "info": {
        "createdAt": "2026-01-01T00:00:00.000Z",
        "createdFrom": "text",
        "updatedAt": "2026-01-01T00:00:00.000Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "label": "text",
      "description": "text",
      "crmSubTypes": [],
      "sortOrder": 1,
      "startState": false,
      "finishState": false,
      "readyToBill": false,
      "needsCommentOnPositiveFinish": false,
      "needsCommentOnNegativeFinish": false,
      "active": true,
      "portalEnumRef": {
        "id": "text",
        "label": "text",
        "description": "text"
      }
    },
    "subType": {
      "version": "text",
      "info": {
        "createdAt": "2026-01-01T00:00:00.000Z",
        "createdFrom": "text",
        "updatedAt": "2026-01-01T00:00:00.000Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "label": "text",
      "description": "text",
      "sortOrder": 1,
      "active": true
    }
  },
  "userRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "system": true,
  "comment": "text",
  "notes": "text",
  "startDateTime": "2026-01-01T00:00:00.000Z",
  "durationInSeconds": 1,
  "custom": null,
  "billable": false,
  "billingType": "LIKE_TASK",
  "billingDocumentLineRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "internalBilled": false,
  "billingDiscount": 1,
  "durationToBillInSeconds": 1,
  "published": false,
  "accountPersonRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "plannedDurationInSeconds": 1,
  "plannedStartDateTime": "2026-01-01T00:00:00.000Z",
  "email": false
}

Liefert den Status der aktuellen Workflow-Instanz zu der gegebenen Referenz

get
Path parameters
refIdinteger · int64Required
Responses
200

Workflow-Instanz gefunden

application/json
string · enumOptional

Status einer Workflow-Instanz

Possible values:
get/erp/crm-activities/{refId}/workflow-state
GET /api/erp/crm-activities/{refId}/workflow-state HTTP/1.1
Host: 10.102.24.197:32795
Accept: */*

CREATED

Liefert ein Query-Preset zur Selektion aller Workflow-Instanzen zu der gegebenen Referenz

get
Path parameters
refIdinteger · int64Required
Responses
200

Workflow-Instanz gefunden

application/json

Adhoc Preset

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

modestring · enumRequired

Was kann mit diesem Preset abgebildet werden QUERY oder STATEMENT

Default: QUERYPossible values:
templateIdstringRequired

template dem dieser filter zugeordnet worden ist.

templateGroupKeystringRequired

templateGroupKey dem dieser filter zugeordnet worden ist.

labelstringRequired

label für diesen filter

uiPayloadanyOptional

Search-Dialog

queryStatementstringOptional

bei mode == STATEMENT, das vql-query

forWorkflowbooleanRequired

für Workflows vorgesehen

Default: false
outputReportGroupIdentifierstringOptional

Identifier einer OutputReportGroup (moduleKey=cunit), die als Druckvorlage für dieses Preset verwendet wird

get/erp/crm-activities/{refId}/workflow-instances-preset
GET /api/erp/crm-activities/{refId}/workflow-instances-preset HTTP/1.1
Host: 10.102.24.197:32795
Accept: */*
200

Workflow-Instanz gefunden

{
  "version": "text",
  "info": {
    "createdAt": "2026-01-01T00:00:00.000Z",
    "createdFrom": "text",
    "updatedAt": "2026-01-01T00:00:00.000Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "mode": "QUERY",
  "templateId": "text",
  "templateGroupKey": "text",
  "label": "text",
  "uiPayload": null,
  "variables": [],
  "queryStatement": "text",
  "queryPredicate": {
    "type": "JUNCTION",
    "operator": "AND",
    "children": [],
    "property": "text",
    "values": [
      "text"
    ],
    "visible": true,
    "functions": [
      "text"
    ]
  },
  "results": [],
  "sortAndOrders": [],
  "pageable": {
    "limit": 1
  },
  "option": {
    "distinctResult": true
  },
  "transformations": [],
  "arithmeticQueryTerms": [],
  "definition": [
    {
      "_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,
        "digitsFraction": 1
      },
      "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": []
    }
  ],
  "permissionAggregation": {
    "version": "text",
    "info": {
      "createdAt": "2026-01-01T00:00:00.000Z",
      "createdFrom": "text",
      "updatedAt": "2026-01-01T00:00:00.000Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "userPermissions": [],
    "groupPermissions": [],
    "operationForAllUsers": "READ_ONLY"
  },
  "forWorkflow": false,
  "outputReportGroupIdentifier": "text",
  "userOptions": {
    "version": "text",
    "info": {
      "createdAt": "2026-01-01T00:00:00.000Z",
      "createdFrom": "text",
      "updatedAt": "2026-01-01T00:00:00.000Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "pinned": false
  }
}

Liefert die neuste Workflow-Instanz zu der gegebenen Referenz

get
Path parameters
refIdinteger · int64Required
Responses
200

Workflow-Instanz gefunden

application/json
versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

statestring · enumOptional

Status einer Workflow-Instanz

Possible values:
get/erp/crm-activities/{refId}/latest-workflow-instance
GET /api/erp/crm-activities/{refId}/latest-workflow-instance HTTP/1.1
Host: 10.102.24.197:32795
Accept: */*

{
  "version": "text",
  "info": {
    "createdAt": "2026-01-01T00:00:00.000Z",
    "createdFrom": "text",
    "updatedAt": "2026-01-01T00:00:00.000Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "state": "CREATED",
  "workflowRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "workItems": [],
  "logEntries": []
}
PreviousArticleNextImport Rule Set

Last updated

Was this helpful?