WorkflowStatusModel
A Workflow Status represents the state for a specific workflow for an entity.
Methods
The following API methods use this data model.
Read-Only Fields
These fields are assigned by the API server and cannot be changed.
id
uuid, read-only
The unique ID of this record, automatically assigned by Lockstep when this record is
added to the Accounting Data Services platform.
created
date-time, read-only
The date that the workflow status was created.
createdUserId
uuid, read-only
The ID of the user who created the workflow status.
modified
date-time, read-only
The date that the workflow status was last modified.
modifiedUserId
uuid, read-only
The ID of the user who last modified the workflow status.
Required Fields
name
string, 1-100 characters
The name of the workflow status.
isNotesRequired
Indicates whether notes are required or not.
promoteToErp
Indicates whether the status change should be reported to the ERP or not.
statusSource
WorkflowStatusSource
Possible sources for a Workflow Status.
Optional Fields
description
string, nullable, max 500 characters
The description explaining the use of the workflow status.
parentWorkflowStatusId
uuid, nullable
The prior workflow status ID.
category
string, nullable, max 100 characters
The category of the workflow status.
code
string, nullable, max 100 characters
The code of the workflow status.
Updated 20 days ago