Peach Finance

Workflow Types

Get workflow types

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
companyId
required
string

The unique company identifier.

Responses
200

OK

get/companies/{companyId}/workflow-types
Response samples
application/json
{
  • "status": 0,
  • "total": 0,
  • "count": 0,
  • "nextUrl": "string",
  • "previousUrl": "string",
  • "data": [
    ]
}

Create workflow type

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
companyId
required
string

The unique company identifier.

Request Body schema: application/json
required

The new workflow type

id
string
createdAt
string <date-time>
updatedAt
string or null <date-time>
deletedAt
string or null <date-time>
refId
string <uuid>

The globally unique identifier of the workflow type.

name
string

A short name of workflow. For example: bankruptcy or identity theft.

description
string

Description of the workflow type. Used internally.

version
integer

Version of the workflow type.

versionStatus
string (VersionStatus)
Enum: "draft" "active" "deprecated"
steps
Array of strings

List of step types that comprise a workflow of this type.

Array of objects or null (CaseApprovalConditions)

Set of steps’ statuses that must be met before case outcome can be set to approved. Currently, we support “and” only between the steps.

Responses
200

OK

post/companies/{companyId}/workflow-types
Request samples
application/json
{
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "refId": "639293c5-5581-48d7-94b9-83aceaff93f8",
  • "name": "string",
  • "description": "string",
  • "version": 0,
  • "versionStatus": "draft",
  • "steps": [
    ],
  • "approvalConditions": [
    ]
}
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Export workflow, step and work item types.

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
companyId
required
string

The unique company identifier.

query Parameters
format
string
Default: "json"

The output format

Enum: "json" "yaml"
Responses
200

OK

post/companies/{companyId}/workflow-types/export
Response samples
[
  • { }
]

Restore previously exported workflow, step and work item types.

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
companyId
required
string

The unique company identifier.

Request Body schema: application/octet-stream
required

The data to import

string <binary>
Responses
204

success

post/companies/{companyId}/workflow-types/import

Get workflow type by ID

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
companyId
required
string

The unique company identifier.

workflowTypeId
required
string

The workflow type ID

query Parameters
expand
boolean
Default: false

Replace component IDs with corresponding objects

Responses
200

OK

get/companies/{companyId}/workflow-types/{workflowTypeId}
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Update workflow type

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
companyId
required
string

The unique company identifier.

workflowTypeId
required
string

The workflow type ID

Request Body schema: application/json
required
id
string
createdAt
string <date-time>
updatedAt
string or null <date-time>
deletedAt
string or null <date-time>
refId
string <uuid>

The globally unique identifier of the workflow type.

name
string

A short name of workflow. For example: bankruptcy or identity theft.

description
string

Description of the workflow type. Used internally.

version
integer

Version of the workflow type.

versionStatus
string (VersionStatus)
Enum: "draft" "active" "deprecated"
steps
Array of strings

List of step types that comprise a workflow of this type.

Array of objects or null (CaseApprovalConditions)

Set of steps’ statuses that must be met before case outcome can be set to approved. Currently, we support “and” only between the steps.

Responses
200

OK

put/companies/{companyId}/workflow-types/{workflowTypeId}
Request samples
application/json
{
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "refId": "639293c5-5581-48d7-94b9-83aceaff93f8",
  • "name": "string",
  • "description": "string",
  • "version": 0,
  • "versionStatus": "draft",
  • "steps": [
    ],
  • "approvalConditions": [
    ]
}
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Delete workflow type

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
companyId
required
string

The unique company identifier.

workflowTypeId
required
string

The workflow type ID

Responses
204

No content

delete/companies/{companyId}/workflow-types/{workflowTypeId}

Get workflow step types

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
companyId
required
string

The unique company identifier.

Responses
200

OK

get/companies/{companyId}/workflow-step-types
Response samples
application/json
{
  • "status": 0,
  • "total": 0,
  • "count": 0,
  • "nextUrl": "string",
  • "previousUrl": "string",
  • "data": [
    ]
}

Create workflow step type

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
companyId
required
string

The unique company identifier.

Request Body schema: application/json
required
id
string
createdAt
string <date-time>
updatedAt
string or null <date-time>
deletedAt
string or null <date-time>
refId
string <uuid>

The globally unique identifier of the workflow step type.

descriptionShort
string

A short description of the step. Displayed to agents in the UI. Can be a sentence.

descriptionLong
string or null

Additional details on how to complete the step. Normally displayed to an agent when clicked on “more info” or “?” or “i” icons.

decisionQuestion
string

Decision question is what leads to the “accepted” or “rejected” outcome of the step. This question is displayed to an agent next to the outcome of the step. The questions can lead to accept/reject or to yes/no answers.

decisionQuestionType
string (DecisionQuestionType)
Enum: "yesNo" "approveReject"
mandatory
boolean
visibility
string (StepVisibility)
Enum: "normal" "closingApproved" "closingDenied" "closingFalsePositive" "closingNoOutcome"
version
integer

Version of the workflow step type.

versionStatus
string (VersionStatus)
Enum: "draft" "active" "deprecated"
workItems
Array of strings

List of work item types that comprise this workflow step type.

Responses
200

OK

post/companies/{companyId}/workflow-step-types
Request samples
application/json
{
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "refId": "639293c5-5581-48d7-94b9-83aceaff93f8",
  • "descriptionShort": "string",
  • "descriptionLong": "string",
  • "decisionQuestion": "string",
  • "decisionQuestionType": "yesNo",
  • "mandatory": true,
  • "visibility": "normal",
  • "version": 0,
  • "versionStatus": "draft",
  • "workItems": [
    ]
}
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Get workflow step type

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
companyId
required
string

The unique company identifier.

workflowStepTypeId
required
string

The workflow step type ID

query Parameters
expand
boolean
Default: false

Replace component IDs with corresponding objects

Responses
200

OK

get/companies/{companyId}/workflow-step-types/{workflowStepTypeId}
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Update workflow step type

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
companyId
required
string

The unique company identifier.

workflowStepTypeId
required
string

The workflow step type ID

Request Body schema: application/json
required
id
string
createdAt
string <date-time>
updatedAt
string or null <date-time>
deletedAt
string or null <date-time>
refId
string <uuid>

The globally unique identifier of the workflow step type.

descriptionShort
string

A short description of the step. Displayed to agents in the UI. Can be a sentence.

descriptionLong
string or null

Additional details on how to complete the step. Normally displayed to an agent when clicked on “more info” or “?” or “i” icons.

decisionQuestion
string

Decision question is what leads to the “accepted” or “rejected” outcome of the step. This question is displayed to an agent next to the outcome of the step. The questions can lead to accept/reject or to yes/no answers.

decisionQuestionType
string (DecisionQuestionType)
Enum: "yesNo" "approveReject"
mandatory
boolean
visibility
string (StepVisibility)
Enum: "normal" "closingApproved" "closingDenied" "closingFalsePositive" "closingNoOutcome"
version
integer

Version of the workflow step type.

versionStatus
string (VersionStatus)
Enum: "draft" "active" "deprecated"
workItems
Array of strings

List of work item types that comprise this workflow step type.

Responses
200

OK

put/companies/{companyId}/workflow-step-types/{workflowStepTypeId}
Request samples
application/json
{
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "refId": "639293c5-5581-48d7-94b9-83aceaff93f8",
  • "descriptionShort": "string",
  • "descriptionLong": "string",
  • "decisionQuestion": "string",
  • "decisionQuestionType": "yesNo",
  • "mandatory": true,
  • "visibility": "normal",
  • "version": 0,
  • "versionStatus": "draft",
  • "workItems": [
    ]
}
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Delete workflow step type

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
companyId
required
string

The unique company identifier.

workflowStepTypeId
required
string

The workflow step type ID

Responses
204

No content

delete/companies/{companyId}/workflow-step-types/{workflowStepTypeId}

Get work item types

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
companyId
required
string

The unique company identifier.

Responses
200

OK

get/companies/{companyId}/workflow-workitem-types
Response samples
application/json
{
  • "status": 0,
  • "total": 0,
  • "count": 0,
  • "nextUrl": "string",
  • "previousUrl": "string",
  • "data": [
    ]
}

Create work item type

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
companyId
required
string

The unique company identifier.

Request Body schema: application/json
required
id
string
createdAt
string <date-time>
updatedAt
string or null <date-time>
deletedAt
string or null <date-time>
refId
string <uuid>

The globally unique identifier of the workflow workitem type.

version
integer

Version of the work item type.

versionStatus
string (VersionStatus)
Enum: "draft" "active" "deprecated"
descriptionShort
string

A short description of the work item. Displayed to agents in the UI. Can be a sentence.

descriptionLong
string or null

Additional information required to complete the work item.

Responses
200

OK

post/companies/{companyId}/workflow-workitem-types
Request samples
application/json
{
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "refId": "639293c5-5581-48d7-94b9-83aceaff93f8",
  • "version": 0,
  • "versionStatus": "draft",
  • "descriptionShort": "string",
  • "descriptionLong": "string"
}
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Get work item type

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
companyId
required
string

The unique company identifier.

workflowWorkitemTypeId
required
string

The work item type ID

Responses
200

OK

get/companies/{companyId}/workflow-workitem-types/{workflowWorkitemTypeId}
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Update work item type

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
companyId
required
string

The unique company identifier.

workflowWorkitemTypeId
required
string

The work item type ID

Request Body schema: application/json
required
id
string
createdAt
string <date-time>
updatedAt
string or null <date-time>
deletedAt
string or null <date-time>
refId
string <uuid>

The globally unique identifier of the workflow workitem type.

version
integer

Version of the work item type.

versionStatus
string (VersionStatus)
Enum: "draft" "active" "deprecated"
descriptionShort
string

A short description of the work item. Displayed to agents in the UI. Can be a sentence.

descriptionLong
string or null

Additional information required to complete the work item.

Responses
200

OK

put/companies/{companyId}/workflow-workitem-types/{workflowWorkitemTypeId}
Request samples
application/json
{
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "refId": "639293c5-5581-48d7-94b9-83aceaff93f8",
  • "version": 0,
  • "versionStatus": "draft",
  • "descriptionShort": "string",
  • "descriptionLong": "string"
}
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Delete work item type

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
companyId
required
string

The unique company identifier.

workflowWorkitemTypeId
required
string

The work item type ID

Responses
204

No content

delete/companies/{companyId}/workflow-workitem-types/{workflowWorkitemTypeId}
➔ Next to Tasks