API docs by Redocly

Workflows (1.0)

Download OpenAPI specification:Download

APIs dealing with workflows

Workflow

Get Workflows

Used to retrieve workflows for a company

Authorizations:
XCompleatApiKey
path Parameters
tenantId
required
string <guid>
Example: d025eedc-5ea0-4de8-be9f-f8873545add9

Id of the tenant to retrieve information for. The account requesting the data must have access to this tenant Id

companyId
required
string <guid>
Example: 8d4bb975-eade-42fd-a064-bf448e493c1e

Id of the company to retrieve workflows for. Must be a valid company within the tenant

transactionType
required
string
Enum: "INV" "ORD"
Example: ORD

Transaction type for workflows

header Parameters
x-api-version
required
integer
Value: 1
Example: 1

Indicates the version of this API to be used.

x-api-compleat-key
required
string <guid>
Example: d025eedc-5ea0-4de8-be9f-f8873545add9

The header containing compleat api key.

Responses

Response samples

Content type
application/json
{
  • "Workflows": [
    ],
  • "MetaData": {
    }
}

Get Workflows

Used to retrieve workflows for a company

Authorizations:
XCompleatApiKey
path Parameters
tenantId
required
string <guid>
Example: d025eedc-5ea0-4de8-be9f-f8873545add9

Id of the tenant to retrieve information for. The account requesting the data must have access to this tenant Id

companyId
required
string <guid>
Example: 8d4bb975-eade-42fd-a064-bf448e493c1e

Id of the company to retrieve layouts for. Must be a valid company within the tenant

header Parameters
x-api-version
required
integer
Value: 1
Example: 1

Indicates the version of this API to be used.

x-api-compleat-key
required
string <guid>
Example: d025eedc-5ea0-4de8-be9f-f8873545add9

The header containing compleat api key.

Responses

Response samples

Content type
application/json
{
  • "Workflows": [
    ],
  • "MetaData": {
    }
}