POST api/Supplements/CheckSupplementToSendApproval

Launch an approval flow for a given configuration parameters

Request Information

URI Parameters

None.

Body Parameters

SupplementDto
NameDescriptionTypeAdditional information
Id

integer

Required

SubcontractId

integer

Required

Type

SupplementTypeDto

Required

ExternalCode

integer

None.

InternalCode

string

Required

String length: inclusive between 0 and 2

Code

string

String length: inclusive between 0 and 4

SuplementVersions

Collection of SupplementVersionDto

None.

LastVersionId

integer

None.

LastVersion

SupplementVersionDto

None.

ApprovedExternally

boolean

None.

AutomaticallySendToSap

boolean

None.

AlreadySentToSap

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "id": 1,
  "subcontractId": 2,
  "type": {
    "id": 1,
    "name": "sample string 1",
    "description": "sample string 2"
  },
  "externalCode": 1,
  "internalCode": "sample string 3",
  "code": "sample string 4",
  "suplementVersions": [
    {
      "id": 1,
      "suplementStatus": {
        "id": 1,
        "name": "sample string 1",
        "description": "sample string 2"
      },
      "name": "sample string 2",
      "description": "sample string 3",
      "version": 1,
      "isCurrent": true,
      "signedPrice": 1.0,
      "signedDate": "2026-05-08T21:21:42.0150791+02:00"
    },
    {
      "id": 1,
      "suplementStatus": {
        "id": 1,
        "name": "sample string 1",
        "description": "sample string 2"
      },
      "name": "sample string 2",
      "description": "sample string 3",
      "version": 1,
      "isCurrent": true,
      "signedPrice": 1.0,
      "signedDate": "2026-05-08T21:21:42.0150791+02:00"
    }
  ],
  "lastVersionId": 1,
  "lastVersion": {
    "id": 1,
    "suplementStatus": {
      "id": 1,
      "name": "sample string 1",
      "description": "sample string 2"
    },
    "name": "sample string 2",
    "description": "sample string 3",
    "version": 1,
    "isCurrent": true,
    "signedPrice": 1.0,
    "signedDate": "2026-05-08T21:21:42.0150791+02:00"
  },
  "approvedExternally": true,
  "automaticallySendToSap": true,
  "alreadySentToSap": true
}

text/html

Sample:
{"id":1,"subcontractId":2,"type":{"id":1,"name":"sample string 1","description":"sample string 2"},"externalCode":1,"internalCode":"sample string 3","code":"sample string 4","suplementVersions":[{"id":1,"suplementStatus":{"id":1,"name":"sample string 1","description":"sample string 2"},"name":"sample string 2","description":"sample string 3","version":1,"isCurrent":true,"signedPrice":1.0,"signedDate":"2026-05-08T21:21:42.0150791+02:00"},{"id":1,"suplementStatus":{"id":1,"name":"sample string 1","description":"sample string 2"},"name":"sample string 2","description":"sample string 3","version":1,"isCurrent":true,"signedPrice":1.0,"signedDate":"2026-05-08T21:21:42.0150791+02:00"}],"lastVersionId":1,"lastVersion":{"id":1,"suplementStatus":{"id":1,"name":"sample string 1","description":"sample string 2"},"name":"sample string 2","description":"sample string 3","version":1,"isCurrent":true,"signedPrice":1.0,"signedDate":"2026-05-08T21:21:42.0150791+02:00"},"approvedExternally":true,"automaticallySendToSap":true,"alreadySentToSap":true}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ApiDataResultOfApprovalFlowCheckDto
NameDescriptionTypeAdditional information
Data

ApprovalFlowCheckDto

None.

Success

boolean

None.

Message

string

None.

Errors

Collection of CustomError

None.

Warnings

Collection of string

None.

Response Formats

application/json, text/json, text/html

Sample:

Sample not available.