NFS State Machine

NFS State Machine - Start Transition

HTTP Request

POST /api/v1/workflow/start-transition/{event-id}

Interactive Demo

📋 Description: Initiates a workflow transition for a specified event within the Nakisa Lease Accounting Suite, facilitating the management of leases, contracts, and associated financial obligations.

Parameters

Name	In	Type	Required	Description
event-id	path	string	true	Unique identifier for the specific event associated with initiating a workflow transition in the Nakisa Lease Accounting Suite, relevant to lease and contract management.
sync-transition	query	boolean	false	Indicates whether to synchronize the transition of a lease or contract event within the Nakisa Lease Accounting Suite, ensuring accurate accounting entries and financial obligations are maintained.
body	body	ITransitionInput	true	Request body containing the details required to initiate a workflow transition for a specified event, including relevant lease and contract information essential for managing financial obligations and accounting entries.

Default Values

Parameter	Default	Type
sync-transition	false	query

Body Parameters

{
  "objectId": 0,
  "objectType": "string",
  "comment": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	StateProcessResult

Example Responses

{
  "id": 0,
  "success": true,
  "cancelled": true,
  "failureMessage": "string",
  "warningMessage": "string"
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

NFS State Machine - Cancel Auto Transitive

HTTP Request

POST /api/v1/workflow/cancel-auto-transition/{event-id}

Interactive Demo

📋 Description: Cancels the automatic transition of a specified event within the Nakisa Lease Accounting Suite, ensuring that lease and contract-related financial obligations are accurately managed and reflected in accounting entries.

Parameters

Name	In	Type	Required	Description
event-id	path	string	true	Unique identifier for the specific event associated with the lease or contract that is being targeted for cancellation of the automatic transition in the Nakisa Lease Accounting Suite.
body	body	CancelAutoTransitionInput	true	Request body containing the details necessary to cancel an automatic transition for a specified event, including relevant lease and contract identifiers to ensure accurate processing within the Nakisa Lease Accounting Suite.

Body Parameters

{
  "objectId": 0,
  "objectType": "string",
  "currentStateId": "string",
  "comment": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	None

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

NFS State Machine - Bulk Transition

HTTP Request

POST /api/v1/workflow/bulk-transition/{event-id}

Interactive Demo

📋 Description: Initiates a bulk transition of lease-related workflows based on the specified event ID, facilitating efficient updates to contracts and financial obligations within the Nakisa Lease Accounting Suite.

Parameters

Name	In	Type	Required	Description
event-id	path	string	true	Unique identifier for the specific event associated with bulk transitions of leases and contracts within the Nakisa Lease Accounting Suite.
sync-transition	query	boolean	false	Indicates whether the bulk transition of leases, contracts, and financial obligations should be synchronized with existing accounting entries.
body	body	IBulkTransitionInputITransitionInput	true	Request body containing an array of lease and contract identifiers along with their associated financial obligations for bulk transitioning to a specified event in the Nakisa Lease Accounting Suite.

Default Values

Parameter	Default	Type
sync-transition	false	query

Body Parameters

{}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Example Responses

[
  {
    "id": 0,
    "success": true,
    "cancelled": true,
    "failureMessage": "string",
    "warningMessage": "string"
  }
]

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[StateProcessResult]	false	none	[Data transfer object representing the outcome of a state process within the Nakisa Lease Accounting Suite, encompassing lease and contract evaluations, financial obligations, and accounting entries.]
» id	integer(int64)	false	none	Unique identifier for the resource
» success	boolean	false	none	Boolean flag indicating success status
» cancelled	boolean	false	none	Boolean flag indicating cancelled status
» failureMessage	string	false	none	Descriptive message detailing the reason for a failure in processing lease-related transactions within the Nakisa Lease Accounting Suite.
» warningMessage	string	false	none	Contains a message indicating any warnings related to the lease or contract processing within the Nakisa Lease Accounting Suite.

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

NFS State Machine - Get Graph Nodes By Object Type

HTTP Request

GET /api/v1/workflow/nodes/{object-type}

Interactive Demo

📋 Description: Retrieves workflow nodes associated with a specified object type, such as lease, contract, financial obligation, or accounting entry, within the Nakisa Lease Accounting Suite.

Parameters

Name	In	Type	Required	Description
object-type	path	string	true	Specifies the type of object to retrieve within the Nakisa Lease Accounting Suite, such as a lease, contract, financial obligation, or accounting entry.

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Example Responses

[
  {
    "state": {
      "id": "string",
      "name": "string",
      "captionKey": "string",
      "latestStateHistoryFailureMessage": "string",
      "latestStateHistoryWarningMessage": "string",
      "final": true,
      "initial": true,
      "transitionState": true,
      "caption": "string"
    },
    "objectType": "string",
    "nodeInfo": "string",
    "type": "INPUT",
    "sourcePosition": "BOTTOM",
    "targetPosition": "BOTTOM",
    "customLayout": [
      {
        "position": "BOTTOM"
      }
    ],
    "xcoordinate": 0,
    "ycoordinate": 0,
    "transitionStateNode": true,
    "startStateNode": true,
    "endStateNode": true,
    "caption": "string"
  }
]

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[WorkflowInfoGraphNode]	false	none	[Data structure representing a node within the workflow of the Nakisa Lease Accounting Suite, encapsulating essential information related to leases, contracts, financial obligations, and accounting entries.]
» state	StateMachineState	false	none	Data transfer object representing the current state of a lease or contract within the Nakisa Lease Accounting Suite, encapsulating essential information related to financial obligations and accounting entries.
»» id	string	false	none	Unique identifier for the resource
»» name	string	false	none	Name of the resource
»» captionKey	string	false	none	Unique key representing the caption associated with a specific state in the lease accounting process, facilitating clarity in lease, contract, and financial obligation management.
»» latestStateHistoryFailureMessage	string	false	none	Contains the most recent failure message related to the state history of a lease or contract within the Nakisa Lease Accounting Suite, providing critical insights for managing financial obligations and accounting entries.
»» latestStateHistoryWarningMessage	string	false	none	none
»» final	boolean	false	none	Boolean flag indicating final status
»» initial	boolean	false	none	Boolean flag indicating initial status
»» transitionState	boolean	false	none	Current state of the lease
»» caption	string	false	none	Descriptive text associated with the state of a lease or contract within the Nakisa Lease Accounting Suite, providing clarity on the financial obligation or accounting entry.
» objectType	string	false	none	Type of the object
» nodeInfo	string	false	none	Represents detailed information about a specific node within the workflow graph, essential for managing lease contracts and associated financial obligations in the Nakisa Lease Accounting Suite.
» type	string	false	none	Type of the resource
» sourcePosition	string	false	none	Indicates the originating position of a lease or contract within the Nakisa Lease Accounting Suite, facilitating accurate tracking of financial obligations and accounting entries.
» targetPosition	string	false	none	Specifies the desired position within the workflow for managing lease contracts and financial obligations in the Nakisa Lease Accounting Suite.
» customLayout	[WorkflowInfoGraphCustomNode]	false	none	List of customLayout items
»» position	string	false	none	Represents the specific role or placement of a financial obligation within a lease contract in the Nakisa Lease Accounting Suite.
» xcoordinate	integer(int32)	false	none	Numeric value representing xcoordinate
» ycoordinate	integer(int32)	false	none	Numeric value representing ycoordinate
» transitionStateNode	boolean	false	none	Boolean flag indicating transitionStateNode status
» startStateNode	boolean	false	none	Boolean flag indicating startStateNode status
» endStateNode	boolean	false	none	Boolean flag indicating endStateNode status
» caption	string	false	none	Descriptive text that provides context for the lease or contract associated with a financial obligation in the Nakisa Lease Accounting Suite.

Enumerated Values

Attribute	Value
position	BOTTOM, LEFT, RIGHT, TOP
sourcePosition	BOTTOM, LEFT, RIGHT, TOP
targetPosition	BOTTOM, LEFT, RIGHT, TOP
type	CUSTOM, DEFAULT, INPUT, OUTPUT

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

NFS State Machine - Get Graph Edges By Object Type

HTTP Request

GET /api/v1/workflow/edges/{object-type}

Interactive Demo

📋 Description: Retrieves workflow edges associated with specified object types, such as leases, contracts, financial obligations, or accounting entries, to facilitate streamlined data management within the Nakisa Lease Accounting Suite.

Parameters

Name	In	Type	Required	Description
object-type	path	string	true	Specifies the type of object to retrieve from the Nakisa Lease Accounting Suite, which can include lease, contract, financial obligation, or accounting entry.

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Example Responses

[
  {
    "event": {
      "id": "string",
      "eventName": "string",
      "captionKey": "string",
      "objectType": "string",
      "disabledReason": "string",
      "warningReason": "string",
      "hasWarnings": true,
      "disabled": true,
      "caption": "string"
    },
    "sourceNodeId": "string",
    "targetNodeId": "string",
    "sourceHandle": "BOTTOM",
    "targetHandle": "BOTTOM",
    "customLabel": "string",
    "xoffset": 0,
    "yoffset": 0,
    "caption": "string"
  }
]

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[WorkflowInfoGraphEdge]	false	none	[Data structure representing the connections between various components of a lease workflow, including contracts, financial obligations, and accounting entries, within the Nakisa Lease Accounting Suite.]
» event	StateMachineEvent	false	none	Data transfer object representing an event within the state machine of the Nakisa Lease Accounting Suite, which facilitates the management of lease contracts, financial obligations, and accounting entries throughout their lifecycle.
»» id	string	false	none	Unique identifier for the resource
»» eventName	string	false	none	Name of the event
»» captionKey	string	false	none	Unique key representing the caption associated with a lease or contract event within the Nakisa Lease Accounting Suite, facilitating accurate tracking of financial obligations and accounting entries.
»» objectType	string	false	none	Type of the object
»» disabledReason	string	false	none	Reason for the disabled state of a lease or contract within the Nakisa Lease Accounting Suite, providing clarity on the status of financial obligations and accounting entries.
»» warningReason	string	false	none	Indicates the reason for a warning related to lease contracts or financial obligations within the Nakisa Lease Accounting Suite.
»» hasWarnings	boolean	false	none	Whether the resource has has warnings
»» disabled	boolean	false	none	Whether this feature is disabled
»» caption	string	false	none	Descriptive text associated with the lease or contract event, providing context for the financial obligation or accounting entry within the Nakisa Lease Accounting Suite.
» sourceNodeId	string	false	none	Unique identifier for the source node
» targetNodeId	string	false	none	Unique identifier for the target node
» sourceHandle	string	false	none	Identifier for the source of the workflow edge, linking lease, contract, financial obligation, or accounting entry within the Nakisa Lease Accounting Suite.
» targetHandle	string	false	none	Unique identifier for the target entity in the lease accounting workflow, facilitating the management of financial obligations and accounting entries related to contracts.
» customLabel	string	false	none	Label for the custom
» xoffset	integer(int32)	false	none	Numeric value representing xoffset
» yoffset	integer(int32)	false	none	Numeric value representing yoffset
» caption	string	false	none	Descriptive text associated with the workflow edge, providing context for the lease, contract, or financial obligation within the Nakisa Lease Accounting Suite.

Enumerated Values

Attribute	Value
sourceHandle	BOTTOM, LEFT, RIGHT, TOP
targetHandle	BOTTOM, LEFT, RIGHT, TOP

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

NFS State Machine - Get Current State

HTTP Request

GET /api/v1/workflow/current-state/{object-type}/{object-id}

Interactive Demo

📋 Description: Retrieves the current state of a specified object, such as a lease, contract, financial obligation, or accounting entry, within the Nakisa Lease Accounting Suite, providing essential insights for effective financial management and decision-making.

Parameters

Name	In	Type	Required	Description
object-type	path	string	true	Specifies the type of object—such as lease, contract, financial obligation, or accounting entry—whose current state is being retrieved from the Nakisa Lease Accounting Suite.
object-id	path	integer(int64)	true	Unique identifier for the specified object type, such as lease, contract, financial obligation, or accounting entry, used to retrieve the current state within the Nakisa Lease Accounting Suite.

Responses

Status	Meaning	Description	Schema
200	OK	OK	StateMachineState

Example Responses

{
  "id": "string",
  "name": "string",
  "captionKey": "string",
  "latestStateHistoryFailureMessage": "string",
  "latestStateHistoryWarningMessage": "string",
  "final": true,
  "initial": true,
  "transitionState": true,
  "caption": "string"
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

NFS State Machine - List Available Events

HTTP Request

GET /api/v1/workflow/available-events/{object-type}/{object-id}

Interactive Demo

📋 Description: Retrieves available events related to a specified object type and ID within the Nakisa Lease Accounting Suite, facilitating effective management of leases, contracts, financial obligations, and accounting entries.

Parameters

Name	In	Type	Required	Description
object-type	path	string	true	Specifies the type of object—such as lease, contract, financial obligation, or accounting entry—associated with the available events in the Nakisa Lease Accounting Suite.
object-id	path	integer(int64)	true	Unique identifier for the specified object, such as a lease, contract, financial obligation, or accounting entry, used to retrieve available events within the Nakisa Lease Accounting Suite.

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Example Responses

[
  {
    "id": "string",
    "eventName": "string",
    "captionKey": "string",
    "objectType": "string",
    "disabledReason": "string",
    "warningReason": "string",
    "hasWarnings": true,
    "disabled": true,
    "caption": "string"
  }
]

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[StateMachineEvent]	false	none	[Data transfer object representing an event within the state machine of the Nakisa Lease Accounting Suite, which facilitates the management of lease contracts, financial obligations, and accounting entries throughout their lifecycle.]
» id	string	false	none	Unique identifier for the resource
» eventName	string	false	none	Name of the event
» captionKey	string	false	none	Unique key representing the caption associated with a lease or contract event within the Nakisa Lease Accounting Suite, facilitating accurate tracking of financial obligations and accounting entries.
» objectType	string	false	none	Type of the object
» disabledReason	string	false	none	Reason for the disabled state of a lease or contract within the Nakisa Lease Accounting Suite, providing clarity on the status of financial obligations and accounting entries.
» warningReason	string	false	none	Indicates the reason for a warning related to lease contracts or financial obligations within the Nakisa Lease Accounting Suite.
» hasWarnings	boolean	false	none	Whether the resource has has warnings
» disabled	boolean	false	none	Whether this feature is disabled
» caption	string	false	none	Descriptive text associated with the lease or contract event, providing context for the financial obligation or accounting entry within the Nakisa Lease Accounting Suite.

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

NFS State Machine - List All Events By Object Type

HTTP Request

GET /api/v1/workflow/all-events/{object-type}

Interactive Demo

📋 Description: Retrieves all events related to a specified object type, such as lease, contract, financial obligation, or accounting entry, within the Nakisa Lease Accounting Suite.

Parameters

Name	In	Type	Required	Description
object-type	path	string	true	Specifies the type of object to retrieve events for, such as lease, contract, financial obligation, or accounting entry, within the Nakisa Lease Accounting Suite.

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Example Responses

[
  {
    "id": "string",
    "eventName": "string",
    "captionKey": "string",
    "objectType": "string",
    "disabledReason": "string",
    "warningReason": "string",
    "hasWarnings": true,
    "disabled": true,
    "caption": "string"
  }
]

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[StateMachineEvent]	false	none	[Data transfer object representing an event within the state machine of the Nakisa Lease Accounting Suite, which facilitates the management of lease contracts, financial obligations, and accounting entries throughout their lifecycle.]
» id	string	false	none	Unique identifier for the resource
» eventName	string	false	none	Name of the event
» captionKey	string	false	none	Unique key representing the caption associated with a lease or contract event within the Nakisa Lease Accounting Suite, facilitating accurate tracking of financial obligations and accounting entries.
» objectType	string	false	none	Type of the object
» disabledReason	string	false	none	Reason for the disabled state of a lease or contract within the Nakisa Lease Accounting Suite, providing clarity on the status of financial obligations and accounting entries.
» warningReason	string	false	none	Indicates the reason for a warning related to lease contracts or financial obligations within the Nakisa Lease Accounting Suite.
» hasWarnings	boolean	false	none	Whether the resource has has warnings
» disabled	boolean	false	none	Whether this feature is disabled
» caption	string	false	none	Descriptive text associated with the lease or contract event, providing context for the financial obligation or accounting entry within the Nakisa Lease Accounting Suite.

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

---