Workspace

Cleanup

HTTP Request

POST /api/v1/workspaces/cleanup

Interactive Demo

📋 Description: Initiates a cleanup process for workspaces within the Nakisa Lease Accounting Suite, ensuring that obsolete lease and contract data is removed to maintain accurate financial obligations and accounting entries.

Parameters

Name	In	Type	Required	Description
message	query	string	true	Textual content detailing the specific cleanup instructions for lease and contract-related financial obligations within the Nakisa Lease Accounting Suite.

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

Create

HTTP Request

POST /api/v1/workspaces

Interactive Demo

📋 Description: Creates a new workspace within the Nakisa Lease Accounting Suite, enabling users to manage leases, contracts, and associated financial obligations effectively.

Parameters

Name	In	Type	Required	Description
body	body	object	true	Request body containing the workspace configuration data, including lease details, contract specifications, and associated financial obligations for accurate accounting entries.
» request	body	NfsImportJobDto	true	NfsImportJobDto is a data transfer object that encapsulates the details of a lease import job, including its status and associated metadata, facilitating the management of financial obligations and accounting entries within the Nakisa Lease Accounting Suite.
»» id	body	integer(int64)	false	Unique identifier for the resource
»» taskCount	body	integer(int32)	false	Count of task
»» failedTaskCount	body	integer(int32)	false	Count of failed task
»» doneTaskCount	body	integer(int32)	false	Count of done task
»» inProgressTaskCount	body	integer(int32)	false	Count of in progress task
»» cancelledTaskCount	body	integer(int32)	false	Count of cancelled task
»» errorMessage	body	string	false	Text value for errorMessage in NfsImportJobDto
»» queueTime	body	string(date-time)	false	Time of the queue
»» startTime	body	string(date-time)	false	Time of the start
»» endTime	body	string(date-time)	false	Time of the end
»» status	body	BatchJobStatus	false	Represents the execution status of a batch job or task.
»»» name	body	string	false	Enum name representing the batch job status.
»»» captionKey	body	string	false	Localization key for the batch job status caption.
»»» caption	body	string	false	Localized caption of the batch job status.
»» batchSize	body	integer(int32)	false	Numeric value representing batchSize
»» totalObjectCount	body	integer(int32)	false	Count of total object
»» fileStorageId	body	string	false	Identifier of the associated file storage.
»» importDocumentFileName	body	string	false	Name of the import document file
»» version	body	integer(int32)	false	Numeric value representing version
»» readOnly	body	boolean	false	Boolean flag indicating readOnly status
»» importDocumentStoreId	body	integer(int64)	false	Unique identifier for the import document store
»» input	body	NfsImportJobInput	false	NfsImportJobInput is a data transfer object that encapsulates the parameters required for initiating an import job within the Nakisa Lease Accounting Suite, facilitating the integration of lease contracts and financial obligations into the accounting system.
»»» erpSystemId	body	integer(int64)	false	Unique identifier for the erp system
»»» principalPositionType	body	PrincipalPositionType	false	Represents the type of principal position with localized captions.
»»»» name	body	string	false	Enum name representing the principal position type.
»»»» captionKey	body	string	false	Localization key for the principal position type caption.
»»»» caption	body	string	false	Localized caption of the principal position type.
»»» useMassWorkflowTransition	body	boolean	false	Boolean flag indicating useMassWorkflowTransition status
»»» massWorkflowJobBatchSize	body	integer(int32)	false	Numeric value representing massWorkflowJobBatchSize
»»» terminalState	body	ActivityAnalysisActivationGroupStatus	false	Represents the lifecycle status of various entities including Master Lease Agreements (MLA), Contracts, Lease Components (LC), Activation Groups (AG), and Units.
»»»» name	body	string	false	Enum name representing the entity status.
»»»» captionKey	body	string	false	Localization key for the entity status caption.
»»»» caption	body	string	false	Localized caption of the entity status.
»»» transitions	body	WorkflowTransitionE	false	Represents the workflow state transition for various entities including Master Lease Agreements (MLA), Contracts, Lease Components (LC), Activation Groups (AG), and Units.
»»»» name	body	string	false	Enum name representing the workflow transition.
»»»» captionKey	body	string	false	Localization key for the workflow transition caption.
»»»» caption	body	string	false	Localized caption of the workflow transition.
»»» useDefaultMassWorkflowWorkbookInput	body	boolean	false	Boolean flag indicating useDefaultMassWorkflowWorkbookInput status
»»» leaseComponentRevisionId	body	integer(int64)	false	Unique identifier for the lease component revision
»» requestReferences	body	[NfsExcelRequestReference]	false	List of requestReferences items
»»» key	body	string	false	Text value for key in NfsExcelRequestReference
»»» value	body	string	false	Text value for value in NfsExcelRequestReference
»» sheetTypes	body	[INfsSheetType]	false	List of sheetTypes items
»»» persistentId	body	string	true	Unique identifier for the persistent
»»» rowCaption	body	string	true	Text value for rowCaption in INfsSheetType
»»» sheetGroupType	body	SheetGroupTypes	true	Represents the type of entity or object in the system.
»»»» name	body	string	false	Enum name representing the entity type.
»»»» captionKey	body	string	false	Localization key for the entity type caption.
»»»» caption	body	string	false	Localized caption of the entity type.
»»» sheetCaption	body	string	true	Text value for sheetCaption in INfsSheetType
»»» tabCaption	body	string	true	Text value for tabCaption in INfsSheetType
»»» principalPositionMode	body	PrincipalPositionModeE	true	Represents the principal position mode including lessee, lessor, or both.
»»»» name	body	string	false	Enum name representing the principal position mode.
»»»» captionKey	body	string	false	Localization key for the principal position mode caption.
»»»» caption	body	string	false	Localized caption of the principal position mode.
»»» order	body	integer(int32)	false	Numeric value representing order
»»» name	body	string	true	Name of the resource
»» sheetGroupTypes	body	SheetGroupTypes	false	Represents the type of entity or object in the system.
» file	body	string(binary)	true	none

Example Values

Parameter	Example	Type
»» id	10000001	body
»» taskCount	100	body
»» failedTaskCount	100	body
»» doneTaskCount	100	body
»» inProgressTaskCount	100	body
»» cancelledTaskCount	100	body
»» errorMessage	sample_errorMessage	body
»» queueTime	2025-01-01T10:00:00Z	body
»» startTime	2025-01-01T10:00:00Z	body
»» endTime	2025-01-01T10:00:00Z	body
»»» name	PROCESSING	body
»»» captionKey	enum.batchJobStatus.processing	body
»»» caption	Processing	body
»» batchSize	1000	body
»» totalObjectCount	100	body
»» fileStorageId	sample_fileStorageId	body
»» importDocumentFileName	sample_importDocumentFileName	body
»» version	100	body
»» readOnly	false	body
»» importDocumentStoreId	10000001	body
»»» erpSystemId	10000001	body
»»»» name	LESSEE	body
»»»» captionKey	enum.principalpositiontype.lessee	body
»»»» caption	Lessee	body
»»» useMassWorkflowTransition	false	body
»»» massWorkflowJobBatchSize	100	body
»»»» name	AG_ACTIVE	body
»»»» captionKey	enum.entityStatus.agActive	body
»»»» caption	Active	body
»»»» name	AG_DEFINE_TO_GENERATING	body
»»»» captionKey	enum.workflowTransition.agDefineToGenerating	body
»»»» caption	AG Define To Generating	body
»»» useDefaultMassWorkflowWorkbookInput	false	body
»»» leaseComponentRevisionId	10000001	body
»» requestReferences	[]	body
»»» key	sample_key	body
»»» value	sample_value	body
»» sheetTypes	[]	body
»»» persistentId	sample_persistentId	body
»»» rowCaption	sample_rowCaption	body
»»»» name	LEASE_COMPONENT	body
»»»» captionKey	enum.SheetGroupTypes.leaseComponent	body
»»»» caption	Lease Component	body
»»» sheetCaption	sample_sheetCaption	body
»»» tabCaption	sample_tabCaption	body
»»»» name	LESSEE	body
»»»» captionKey	enum.principalPositionMode.lessee	body
»»»» caption	Lessee	body
»»» order	100	body
»»» name	Sample Name	body

Enumerated Values

Attribute	Value
»»» name	CANCELLED, CANCELLING, CREATED, CREATING, DONE, FAILED, INTERRUPTED, INTERRUPTING, KILLING, PENDING, PROCESSING, SCHEDULED
»»»» name	ACTIVATION_GROUP, AG_ACTIVATING, AG_ACTIVATING_TO_ACTIVE, AG_ACTIVE, AG_ACTIVE_TO_LEASE_ENDING, AG_CLASSIFIED, AG_CLASSIFIED_TO_ACTIVATING, AG_CLASSIFIED_TO_DEFINE, AG_CLASSIFIED_TO_REJECTED, AG_CLOSED, AG_CLOSING, AG_CLOSING_TO_CLOSE, AG_DEFINE, AG_DEFINE_TO_GENERATING, AG_DEFINE_TO_GENERATING_2, AG_GENERATING_SCHEDULE, AG_GENERATING_SCHEDULE_2, AG_GENERATING_TO_DEFINE, AG_GENERATING_TO_PENDING_ASSESSMENT, AG_INACTIVE, AG_LEASE_END, AG_LEASE_ENDING, AG_LEASE_ENDING_TO_LEASE_END, AG_LEASE_END_TO_CLOSING, AG_PENDING_ASSESSMENT, AG_PENDING_ASSESSMENT_TO_DEFINE, AG_PENDING_ASSESSMENT_TO_PENDING_CLASSIFICATION, AG_PENDING_CLASSIFICATION, AG_PENDING_CLASSIFICATION_TO_CLASSIFIED, AG_PENDING_CLASSIFICATION_TO_DEFINE, AG_RECLOSE, AG_RECLOSE_TO_CLOSING, AG_REJECTED, AG_REPROCESS, AG_REPROCESS_TO_ACTIVATING, AG_REPROCESS_TO_REVERSING, AG_REVERSING, AG_REVERSING_TO_DEFINE, AG_REVERTED, AG_REVERTING, AG_REVISION, AG_SPLITTING, AG_SPLITTING_TO_UNKNOWN, CHARGE, CONTACT, CONTRACT, CONTRACT_ACTIVE, CONTRACT_ACTIVE_TO_CLOSE, CONTRACT_ACTIVE_TO_DEFINE, CONTRACT_ACTIVE_TO_REJECTED, CONTRACT_CLOSED, CONTRACT_DEFINE, CONTRACT_DEFINE_TO_WAITING_FOR_APPROVAL, CONTRACT_REJECTED, CONTRACT_REVISION, CONTRACT_WAITING_FOR_APPROVAL, CONTRACT_WAITING_FOR_APPROVAL_TO_APPROVED, CONTRACT_WAITING_FOR_APPROVAL_TO_DEFINE, LC_ACTIVATING, LC_ACTIVATING_TO_APPROVED, LC_ACTIVE, LC_ACTIVE_TO_CLOSE, LC_ACTIVE_TO_DEFINE, LC_ACTIVE_TO_REJECTED, LC_CLOSED, LC_DEFINE, LC_DEFINE_TO_WAITING_FOR_APPROVAL, LC_REJECTED, LC_REVISION, LC_WAITING_FOR_APPROVAL, LC_WAITING_FOR_APPROVAL_TO_ACTIVATING, LC_WAITING_FOR_APPROVAL_TO_DEFINE, LEASE_COMPONENT, LESSEE, LESSEE_LESSOR, LESSOR, MASTER_AGREEMENT, MLA_ACTIVE, MLA_ACTIVE_TO_CLOSED, MLA_ACTIVE_TO_DEFINE, MLA_CLOSED, MLA_DEFINE, MLA_DEFINE_TO_WAITING_FOR_APPROVAL, MLA_DISCARDED, MLA_WAITING_FOR_APPROVAL, MLA_WAITING_FOR_APPROVAL_TO_ACTIVE, MLA_WAITING_FOR_APPROVAL_TO_DEFINE, MLA_WAITING_FOR_APPROVAL_TO_DISCARDED, NOT_AVAILABLE, SCHEDULE, UNIT, UNIT_ACTIVE, UNIT_ACTIVE_TO_CLOSED, UNIT_CASUALTY, UNIT_DELIVERED, UNIT_DELIVERED_TO_REACQUIRED, UNIT_DELIVERED_TO_RELINQUISHED, UNIT_DRAFT, UNIT_DRAFT_TO_INITIAL, UNIT_INITIAL, UNIT_INITIAL_TO_RECEIVED, UNIT_INITIAL_TO_SHIPPED, UNIT_PURCHASED, UNIT_REACQUIRED, UNIT_RECEIVED, UNIT_RECEIVED_TO_ACTIVE, UNIT_RELINQUISHED, UNIT_RETURNED, UNIT_SHIPPED, UNIT_SHIPPED_TO_DELIVERED

Parameter Constraints

Parameter	Constraints
»» batchSize	Min: 1000, Max: 15000

Body Parameters

{
    "file": "string",
    "request": {
        "batchSize": 1000,
        "cancelledTaskCount": 100,
        "doneTaskCount": 100,
        "endTime": "2025-01-01 10:00:00+00:00",
        "errorMessage": "sample_errorMessage",
        "failedTaskCount": 100,
        "fileStorageId": "sample_fileStorageId",
        "id": 10000001,
        "importDocumentFileName": "sample_importDocumentFileName",
        "importDocumentStoreId": 10000001,
        "inProgressTaskCount": 100,
        "input": {
            "erpSystemId": 10000001,
            "leaseComponentRevisionId": 10000001,
            "massWorkflowJobBatchSize": 100,
            "principalPositionType": {
                "caption": "Lessee",
                "captionKey": "enum.principalpositiontype.lessee",
                "name": "LESSEE"
            },
            "terminalState": {
                "caption": "Active",
                "captionKey": "enum.entityStatus.agActive",
                "name": "AG_ACTIVE"
            },
            "transitions": {
                "caption": "AG Define To Generating",
                "captionKey": "enum.workflowTransition.agDefineToGenerating",
                "name": "AG_DEFINE_TO_GENERATING"
            },
            "useDefaultMassWorkflowWorkbookInput": false,
            "useMassWorkflowTransition": false
        },
        "queueTime": "2025-01-01 10:00:00+00:00",
        "readOnly": false,
        "requestReferences": [],
        "sheetGroupTypes": {
            "caption": "Lease Component",
            "captionKey": "enum.SheetGroupTypes.leaseComponent",
            "name": "LEASE_COMPONENT"
        },
        "sheetTypes": [],
        "startTime": "2025-01-01 10:00:00+00:00",
        "status": {
            "caption": "Processing",
            "captionKey": "enum.batchJobStatus.processing",
            "name": "PROCESSING"
        },
        "taskCount": 100,
        "totalObjectCount": 100,
        "version": 100
    }
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	WorkspaceDto

Example Responses

{
  "id": 0,
  "name": "string",
  "comments": [
    {
      "id": 0,
      "comment": "string"
    }
  ],
  "actions": [
    {
      "id": 0,
      "actionType": "MASS_IMPORT",
      "interventionType": "MANUAL",
      "correspondingTaskId": 0,
      "authorizedUsers": [
        "string"
      ],
      "actionStatus": "PENDING",
      "comments": [
        {
          "id": 0,
          "comment": "string"
        }
      ],
      "history": [
        {
          "id": 0,
          "actionTaken": "APPROVED",
          "comments": [
            {
              "id": 0,
              "comment": "string"
            }
          ],
          "workspaceActionId": 0
        }
      ],
      "workspaceId": 0
    }
  ]
}

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

Get

HTTP Request

GET /api/v1/workspaces/{id}

Interactive Demo

📋 Description: Retrieves detailed information about a specific workspace identified by its unique ID, facilitating effective management of leases, contracts, and associated financial obligations within the Nakisa Lease Accounting Suite.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource

Responses

Status	Meaning	Description	Schema
200	OK	OK	WorkspaceDto

Example Responses

{
  "id": 0,
  "name": "string",
  "comments": [
    {
      "id": 0,
      "comment": "string"
    }
  ],
  "actions": [
    {
      "id": 0,
      "actionType": "MASS_IMPORT",
      "interventionType": "MANUAL",
      "correspondingTaskId": 0,
      "authorizedUsers": [
        "string"
      ],
      "actionStatus": "PENDING",
      "comments": [
        {
          "id": 0,
          "comment": "string"
        }
      ],
      "history": [
        {
          "id": 0,
          "actionTaken": "APPROVED",
          "comments": [
            {
              "id": 0,
              "comment": "string"
            }
          ],
          "workspaceActionId": 0
        }
      ],
      "workspaceId": 0
    }
  ]
}

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

---