ConnectCloud Developers

Assign the types of the Original-Eingangsbeleg and the Zusatzbeleg (tenant:settings:write)

PUT /api/dms/v1/document-type-roles

Module: DMS · operationId: setDocumentTypeRoles · Tag: Document types · Auth: access token (Authorization: Bearer <accessToken>)

Both need an existing, active type, and they must differ (422). Moving the Original-Eingangsbeleg role moves the target module trade.invoice along: the new type gets it when its target was none, the previous type gives it up when it had it.

Request body

application/json (required)

  • incomingOriginal (string, required): Type of the Original-Eingangsbeleg
  • incomingSupplement (string, required): Type of the Zusatzbeleg

Example:

{
  "incomingOriginal": "incoming_document",
  "incomingSupplement": "incoming_supplement"
}

Responses

  • 200 Roles (application/json)
  • 400 Error (application/json)

Fields of the 200 answer:

  • incomingOriginal (string, required): Type of the Original-Eingangsbeleg
  • incomingSupplement (string, required): Type of the Zusatzbeleg

Example 200 answer:

{
  "incomingOriginal": "incoming_document",
  "incomingSupplement": "incoming_supplement"
}

Example request

curl -X PUT 'https://api.mbcom.cloud/api/dms/v1/document-type-roles' \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  --data '{"incomingOriginal":"incoming_document","incomingSupplement":"incoming_supplement"}'

View as Markdown · Interactive reference · OpenAPI