NFS Import Job Controller

Retrieve A Specific Import

HTTP Request

GET /api/v1/imports/{id}

Interactive Demo

📋 Description: Retrieves detailed information about a specific lease import identified by the provided ID, facilitating insights into associated contracts, financial obligations, and accounting entries within the Nakisa Lease Accounting Suite.

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseNfsImportJobDto

Example Responses

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

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

Update A Import

HTTP Request

PUT /api/v1/imports/{id}

Interactive Demo

📋 Description: Updates the specified lease import identified by {id}, allowing for modifications to lease contracts, financial obligations, and associated accounting entries within the Nakisa Lease Accounting Suite.

Parameters

Name	In	Type	Required	Description
id	path	integer	true	Unique identifier for the resource
body	body	NfsImportJobDto	false	Request body containing the updated lease and contract information, including financial obligations and accounting entries, for the specified import ID.

Body Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseNfsImportJobDto

Example Responses

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

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

Bulk Upsert Imports

HTTP Request

PUT /api/v1/imports/createOrUpdate/bulk

Interactive Demo

📋 Description: Creates or updates multiple lease contracts and their associated financial obligations in the Nakisa Lease Accounting Suite, ensuring accurate accounting entries and streamlined lease management.

Parameters

Name	In	Type	Required	Description
body	body	NfsImportJobDto	false	Request body containing bulk lease and contract data, including financial obligations and accounting entries, for creation or update within the Nakisa Lease Accounting Suite.

Body Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListNfsImportJobDto

Example Responses

{
  "code": {
    "name": "OK",
    "captionKey": "enum.responseCode.ok",
    "caption": "OK"
  },
  "errors": {
    "all": []
  },
  "object": []
}

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

Upsert Import

HTTP Request

PUT /api/v1/imports/createOrUpdate

Interactive Demo

📋 Description: Updates or creates lease and contract records within the Nakisa Lease Accounting Suite, ensuring accurate financial obligations and accounting entries are maintained. This operation streamlines the management of lease data for enhanced compliance and reporting.

Parameters

Name	In	Type	Required	Description
body	body	NfsImportJobDto	false	Request body containing lease and contract details, including financial obligations and accounting entries, for creating or updating records in the Nakisa Lease Accounting Suite.

Body Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseNfsImportJobDto

Example Responses

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

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

Bulk Update Imports

HTTP Request

PUT /api/v1/imports/bulk

Interactive Demo

📋 Description: Updates multiple lease contracts and their associated financial obligations in the Nakisa Lease Accounting Suite, ensuring accurate accounting entries are reflected in the system.

Parameters

Name	In	Type	Required	Description
body	body	NfsImportJobDto	false	Request body containing bulk import data for leases, contracts, financial obligations, and accounting entries to facilitate streamlined processing within the Nakisa Lease Accounting Suite.

Body Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListNfsImportJobDto

Example Responses

{
  "code": {
    "name": "OK",
    "captionKey": "enum.responseCode.ok",
    "caption": "OK"
  },
  "errors": {
    "all": []
  },
  "object": []
}

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

Create New Import

HTTP Request

POST /api/v1/imports/types

Interactive Demo

📋 Description: Submits new import types for leases, contracts, and financial obligations into the Nakisa Lease Accounting Suite, facilitating the accurate recording of accounting entries.

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Example Responses

[
  "string"
]

Response Schema

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

Create A New Template

HTTP Request

POST /api/v1/imports/template

Interactive Demo

📋 Description: Submits a new import template for lease contracts, enabling the efficient management of financial obligations and accounting entries within the Nakisa Lease Accounting Suite.

Parameters

Name	In	Type	Required	Description
sampleData	query	boolean	false	Indicates whether to include sample data in the import process for lease and contract financial obligations within the Nakisa Lease Accounting Suite.
body	body	NfsImportJobDto	false	Request body containing the template data for importing lease contracts and associated financial obligations into the Nakisa Lease Accounting Suite.

Body Parameters

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

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

Search Imports (With Tasks And Search)

HTTP Request

POST /api/v1/imports/tasks/search

Interactive Demo

📋 Description: Submits a search request for import tasks related to leases, contracts, and financial obligations within the Nakisa Lease Accounting Suite, enabling users to efficiently locate and manage accounting entries.

Parameters

Name	In	Type	Required	Description
body	body	object	false	Request body containing the search criteria for lease, contract, financial obligation, and accounting entry tasks to facilitate efficient data retrieval within the Nakisa Lease Accounting Suite.

Body Parameters

{}

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageNfsImportTaskDto

Example Responses

{
  "totalElements": 10000001,
  "totalPages": 100,
  "pageable": {
    "pageNumber": 0,
    "unpaged": false,
    "paged": true,
    "pageSize": 100,
    "offset": 0,
    "sort": {
      "unsorted": false,
      "sorted": true,
      "empty": false
    }
  },
  "numberOfElements": 100,
  "size": 100,
  "content": [],
  "number": 100,
  "sort": {
    "unsorted": false,
    "sorted": true,
    "empty": false
  },
  "first": false,
  "last": false,
  "empty": false
}

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

Create New Import (With Sub Items)

HTTP Request

POST /api/v1/imports/sub-items

Interactive Demo

📋 Description: Imports sub-items related to leases and contracts into the Nakisa Lease Accounting Suite, facilitating the management of financial obligations and accounting entries.

Parameters

Name	In	Type	Required	Description
body	body	NfsImportJobDto	false	Request body containing the sub-item data related to leases and contracts, including financial obligations and accounting entries for import into the Nakisa Lease Accounting Suite.

Body Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Example Responses

[
  {
    "persistentId": "sample_persistentId",
    "rowCaption": "sample_rowCaption",
    "sheetGroupType": {
      "name": "LEASE_COMPONENT",
      "captionKey": "enum.SheetGroupTypes.leaseComponent",
      "caption": "Lease Component"
    },
    "sheetCaption": "sample_sheetCaption",
    "tabCaption": "sample_tabCaption",
    "principalPositionMode": {
      "name": "LESSEE",
      "captionKey": "enum.principalPositionMode.lessee",
      "caption": "Lessee"
    },
    "order": 100,
    "name": "Sample Name"
  }
]

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[INfsSheetType]	false	none	[Data structure representing a lease sheet type within the Nakisa Lease Accounting Suite, encompassing essential details related to contracts, financial obligations, and accounting entries.]
» persistentId	string	true	none	Unique identifier for the persistent
» rowCaption	string	true	none	Text value for rowCaption in INfsSheetType
» sheetGroupType	SheetGroupTypes	true	none	Represents the type of entity or object in the system.
»» name	string	false	none	Enum name representing the entity type.
»» captionKey	string	false	none	Localization key for the entity type caption.
»» caption	string	false	none	Localized caption of the entity type.
» sheetCaption	string	true	none	Text value for sheetCaption in INfsSheetType
» tabCaption	string	true	none	Text value for tabCaption in INfsSheetType
» principalPositionMode	PrincipalPositionModeE	true	none	Represents the principal position mode including lessee, lessor, or both.
»» name	string	false	none	Enum name representing the principal position mode.
»» captionKey	string	false	none	Localization key for the principal position mode caption.
»» caption	string	false	none	Localized caption of the principal position mode.
» order	integer(int32)	false	none	Numeric value representing order
» name	string	true	none	Name of the resource

Enumerated Values

Attribute	Value
name	ACTIVATION_GROUP, CHARGE, CONTACT, CONTRACT, LEASE_COMPONENT, LESSEE, LESSEE_LESSOR, LESSOR, MASTER_AGREEMENT, NOT_AVAILABLE, SCHEDULE, UNIT

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

Search Imports

HTTP Request

POST /api/v1/imports/search

Interactive Demo

📋 Description: Submits a request to import search criteria for leases, contracts, and financial obligations into the Nakisa Lease Accounting Suite, facilitating efficient accounting entry management.

Parameters

Name	In	Type	Required	Description
page	query	integer	false	Zero-based page index (0..N)
size	query	integer	false	The size of the page to be returned
sort	query	array[string]	false	Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
body	body	NfsImportJobDtoFilterExtended	false	Request body containing the lease and contract details, including financial obligations and accounting entries, for processing import searches within the Nakisa Lease Accounting Suite.

Default Values

Parameter	Default	Type
sort	["createdAt,ASC"]	query

Body Parameters

{
  "idIn": [],
  "idEqual": 10000001,
  "idLike": "sample_idLike",
  "createdAtGreaterThanOrEqual": "2025-01-01T10:00:00Z",
  "createdAtLessThanOrEqual": "2025-01-01T10:00:00Z",
  "createdByLike": "sample_createdByLike",
  "createdByEqual": "sample_createdByEqual",
  "modifiedAtGreaterThanOrEqual": "2025-01-01T10:00:00Z",
  "modifiedAtLessThanOrEqual": "2025-01-01T10:00:00Z",
  "modifiedByLike": "sample_modifiedByLike",
  "modifiedByEqual": "sample_modifiedByEqual",
  "sheetGroupTypeIn": {
    "name": "LEASE_COMPONENT",
    "captionKey": "enum.SheetGroupTypes.leaseComponent",
    "caption": "Lease Component"
  },
  "requestReferencesEqual": []
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageNfsImportJobDto

Example Responses

{
  "totalElements": 10000001,
  "totalPages": 100,
  "pageable": {
    "pageNumber": 0,
    "unpaged": false,
    "paged": true,
    "pageSize": 100,
    "offset": 0,
    "sort": {
      "unsorted": false,
      "sorted": true,
      "empty": false
    }
  },
  "numberOfElements": 100,
  "size": 100,
  "content": [],
  "number": 100,
  "sort": {
    "unsorted": false,
    "sorted": true,
    "empty": false
  },
  "first": false,
  "last": false,
  "empty": false
}

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

Search imports (with Reports, Details and Search)

HTTP Request

POST /api/v1/imports/reports/details/search

Interactive Demo

📋 Description: Submits a request to search for detailed reports related to leases, contracts, and financial obligations within the Nakisa Lease Accounting Suite, enabling users to efficiently access relevant accounting entries.

Parameters

Name	In	Type	Required	Description
body	body	object	false	Request body containing detailed search criteria for lease, contract, financial obligation, and accounting entry reports within the Nakisa Lease Accounting Suite.

Body Parameters

{}

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageNfsImportItemReportDto

Example Responses

{
  "totalElements": 10000001,
  "totalPages": 100,
  "pageable": {
    "pageNumber": 0,
    "unpaged": false,
    "paged": true,
    "pageSize": 100,
    "offset": 0,
    "sort": {
      "unsorted": false,
      "sorted": true,
      "empty": false
    }
  },
  "numberOfElements": 100,
  "size": 100,
  "content": [],
  "number": 100,
  "sort": {
    "unsorted": false,
    "sorted": true,
    "empty": false
  },
  "first": false,
  "last": false,
  "empty": false
}

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

Create New Import (With Number Of Filtered Entities)

HTTP Request

POST /api/v1/imports/number-of-filtered-entities

Interactive Demo

📋 Description: Submits a request to import the count of filtered entities related to leases, contracts, financial obligations, and accounting entries within the Nakisa Lease Accounting Suite.

Parameters

Name	In	Type	Required	Description
body	body	object	false	Request body containing the details of the lease, contract, financial obligation, and accounting entry to determine the number of filtered entities for import into the Nakisa Lease Accounting Suite.

Body Parameters

{}

Responses

Status	Meaning	Description	Schema
200	OK	OK	integer

Example Responses

0

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

Create A New Main Sheets

HTTP Request

POST /api/v1/imports/main-sheets

Interactive Demo

📋 Description: Uploads and processes main sheets for lease contracts, enabling the integration of financial obligations into the Nakisa Lease Accounting Suite for accurate accounting entries.

Parameters

Name	In	Type	Required	Description
principalPositionType	query	string	false	Type of the principal position
body	body	array[string]	false	Request body containing the main sheets data for lease and contract management, including financial obligations and accounting entries.

Body Parameters

[
  "string"
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Example Responses

[
  "string"
]

Response Schema

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

Cancel Import

HTTP Request

POST /api/v1/imports/cancel/{id}

Interactive Demo

📋 Description: Cancels a specified import operation in the Nakisa Lease Accounting Suite, allowing users to manage lease and contract data effectively while ensuring accurate financial obligations and accounting entries.

Parameters

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

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

Bulk Cancel Imports

HTTP Request

POST /api/v1/imports/cancel/bulk

Interactive Demo

📋 Description: Cancels multiple lease import transactions in bulk within the Nakisa Lease Accounting Suite, ensuring accurate management of contracts and financial obligations in the accounting system.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	false	Request body containing an array of lease and contract identifiers to facilitate the bulk cancellation of financial obligations within the Nakisa Lease Accounting Suite.

Body Parameters

[
  0
]

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

List All Imports

HTTP Request

GET /api/v1/imports

Interactive Demo

📋 Description: Retrieves a list of import records related to leases, contracts, and financial obligations within the Nakisa Lease Accounting Suite, enabling users to efficiently manage and review accounting entries.

Parameters

Name	In	Type	Required	Description
pageable	query	Pageable	true	Indicates whether the results of the lease import query should be returned in a paginated format, facilitating efficient data retrieval for financial obligations and accounting entries.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageNfsImportJobDto

Example Responses

{
  "totalElements": 10000001,
  "totalPages": 100,
  "pageable": {
    "pageNumber": 0,
    "unpaged": false,
    "paged": true,
    "pageSize": 100,
    "offset": 0,
    "sort": {
      "unsorted": false,
      "sorted": true,
      "empty": false
    }
  },
  "numberOfElements": 100,
  "size": 100,
  "content": [],
  "number": 100,
  "sort": {
    "unsorted": false,
    "sorted": true,
    "empty": false
  },
  "first": false,
  "last": false,
  "empty": false
}

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

Create A New Import

HTTP Request

POST /api/v1/imports

Interactive Demo

📋 Description: Imports lease contracts and associated financial obligations into the Nakisa Lease Accounting Suite, facilitating accurate accounting entries and streamlined lease management.

Parameters

Name	In	Type	Required	Description
body	body	object	false	Request body containing the lease and contract data, including financial obligations and accounting entries, for import into the Nakisa Lease Accounting Suite.

Body Parameters

{}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseNfsImportJobDto

Example Responses

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

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

Get Import By ID (With Permissible End States And Entity Type)

HTTP Request

GET /api/v1/imports/{entity_type}/permissible-end-states

Interactive Demo

📋 Description: Retrieves the permissible end states for specified entity types, such as leases, contracts, financial obligations, or accounting entries, within the Nakisa Lease Accounting Suite.

Parameters

Name	In	Type	Required	Description
entity_type	path	string	true	Specifies the type of entity—such as lease, contract, financial obligation, or accounting entry—whose permissible end states are being retrieved from the Nakisa Lease Accounting Suite.
principalPositionType	query	string	false	Type of the principal position

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Example Responses

[
  "string"
]

Response Schema

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

Get Import By ID (With Ordered Possible Terminal States And Entity Type)

HTTP Request

GET /api/v1/imports/{entity_type}/ordered-possible-terminal-states

Interactive Demo

📋 Description: Retrieves the ordered possible terminal states for a specified entity type, such as leases or contracts, within the Nakisa Lease Accounting Suite, facilitating informed decision-making for financial obligations and accounting entries.

Parameters

Name	In	Type	Required	Description
entity_type	path	string	true	Specifies the type of entity—such as lease, contract, financial obligation, or accounting entry—used to retrieve the ordered possible terminal states in the Nakisa Lease Accounting Suite.
principalPositionType	query	string	false	Type of the principal position

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Example Responses

[
  "string"
]

Response Schema

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

Get Import By ID (With Task And Task ID)

HTTP Request

GET /api/v1/imports/reports/task/{taskId}

Interactive Demo

📋 Description: Retrieves the detailed report for a specific import task identified by the taskId, providing insights into lease and contract financial obligations and their corresponding accounting entries within the Nakisa Lease Accounting Suite.

Parameters

Name	In	Type	Required	Description
taskId	path	integer	true	Unique identifier for the task

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Example Responses

[
  {
    "id": 10000001,
    "importTaskId": 10000001,
    "sheetType": {
      "persistentId": "sample_persistentId",
      "rowCaption": "sample_rowCaption",
      "sheetGroupType": {
        "name": "LEASE_COMPONENT",
        "captionKey": "enum.SheetGroupTypes.leaseComponent",
        "caption": "Lease Component"
      },
      "sheetCaption": "sample_sheetCaption",
      "tabCaption": "sample_tabCaption",
      "principalPositionMode": {
        "name": "LESSEE",
        "captionKey": "enum.principalPositionMode.lessee",
        "caption": "Lessee"
      },
      "order": 100,
      "name": "Sample Name"
    },
    "startedAt": "2025-01-01T10:00:00Z",
    "finishedAt": "2025-01-01T10:00:00Z",
    "doneItemCount": 100,
    "failedItemCount": 100,
    "skippedItemCount": 100,
    "cancelledItemCount": 100,
    "totalItemCount": 100
  }
]

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[NfsImportItemDto]	false	none	[NfsImportItemDto is a data transfer object that encapsulates the details of a lease or contract-related financial obligation, facilitating the accurate recording and management of accounting entries within the Nakisa Lease Accounting Suite.]
» id	integer(int64)	false	none	Unique identifier for the resource
» importTaskId	integer(int64)	false	none	Unique identifier for the import task
» sheetType	INfsSheetType	false	none	Data structure representing a lease sheet type within the Nakisa Lease Accounting Suite, encompassing essential details related to contracts, financial obligations, and accounting entries.
»» persistentId	string	true	none	Unique identifier for the persistent
»» rowCaption	string	true	none	Text value for rowCaption in INfsSheetType
»» sheetGroupType	SheetGroupTypes	true	none	Represents the type of entity or object in the system.
»»» name	string	false	none	Enum name representing the entity type.
»»» captionKey	string	false	none	Localization key for the entity type caption.
»»» caption	string	false	none	Localized caption of the entity type.
»» sheetCaption	string	true	none	Text value for sheetCaption in INfsSheetType
»» tabCaption	string	true	none	Text value for tabCaption in INfsSheetType
»» principalPositionMode	PrincipalPositionModeE	true	none	Represents the principal position mode including lessee, lessor, or both.
»»» name	string	false	none	Enum name representing the principal position mode.
»»» captionKey	string	false	none	Localization key for the principal position mode caption.
»»» caption	string	false	none	Localized caption of the principal position mode.
»» order	integer(int32)	false	none	Numeric value representing order
»» name	string	true	none	Name of the resource
» startedAt	string(date-time)	false	none	Text value for startedAt in NfsImportItemDto
» finishedAt	string(date-time)	false	none	Text value for finishedAt in NfsImportItemDto
» doneItemCount	integer(int32)	false	none	Count of done item
» failedItemCount	integer(int32)	false	none	Count of failed item
» skippedItemCount	integer(int32)	false	none	Count of skipped item
» cancelledItemCount	integer(int32)	false	none	Count of cancelled item
» totalItemCount	integer(int32)	false	none	Count of total item

Enumerated Values

Attribute	Value
name	ACTIVATION_GROUP, CHARGE, CONTACT, CONTRACT, LEASE_COMPONENT, LESSEE, LESSEE_LESSOR, LESSOR, MASTER_AGREEMENT, NOT_AVAILABLE, SCHEDULE, UNIT

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

Get Import By ID

HTTP Request

GET /api/v1/imports/reports/job/{jobId}

Interactive Demo

📋 Description: Retrieves the import report for a specific job identified by {jobId}, providing insights into lease and contract data relevant to financial obligations and accounting entries within the Nakisa Lease Accounting Suite.

Parameters

Name	In	Type	Required	Description
jobId	path	integer	true	Unique identifier for the job

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Example Responses

[
  {
    "ids": [],
    "sheetType": {
      "persistentId": "sample_persistentId",
      "rowCaption": "sample_rowCaption",
      "sheetGroupType": {
        "name": "LEASE_COMPONENT",
        "captionKey": "enum.SheetGroupTypes.leaseComponent",
        "caption": "Lease Component"
      },
      "sheetCaption": "sample_sheetCaption",
      "tabCaption": "sample_tabCaption",
      "principalPositionMode": {
        "name": "LESSEE",
        "captionKey": "enum.principalPositionMode.lessee",
        "caption": "Lessee"
      },
      "order": 100,
      "name": "Sample Name"
    },
    "startedAt": "2025-01-01T10:00:00Z",
    "finishedAt": "2025-01-01T10:00:00Z",
    "doneItemCount": 100,
    "failedItemCount": 100,
    "skippedItemCount": 100,
    "cancelledItemCount": 100,
    "totalItemCount": 100
  }
]

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[NfsJobImportItemDto]	false	none	[NfsJobImportItemDto is a data transfer object that encapsulates the details of lease-related job imports, including associated contracts and financial obligations, facilitating accurate accounting entries within the Nakisa Lease Accounting Suite.]
» ids	[integer]	false	none	List of ids items
» sheetType	INfsSheetType	false	none	Data structure representing a lease sheet type within the Nakisa Lease Accounting Suite, encompassing essential details related to contracts, financial obligations, and accounting entries.
»» persistentId	string	true	none	Unique identifier for the persistent
»» rowCaption	string	true	none	Text value for rowCaption in INfsSheetType
»» sheetGroupType	SheetGroupTypes	true	none	Represents the type of entity or object in the system.
»»» name	string	false	none	Enum name representing the entity type.
»»» captionKey	string	false	none	Localization key for the entity type caption.
»»» caption	string	false	none	Localized caption of the entity type.
»» sheetCaption	string	true	none	Text value for sheetCaption in INfsSheetType
»» tabCaption	string	true	none	Text value for tabCaption in INfsSheetType
»» principalPositionMode	PrincipalPositionModeE	true	none	Represents the principal position mode including lessee, lessor, or both.
»»» name	string	false	none	Enum name representing the principal position mode.
»»» captionKey	string	false	none	Localization key for the principal position mode caption.
»»» caption	string	false	none	Localized caption of the principal position mode.
»» order	integer(int32)	false	none	Numeric value representing order
»» name	string	true	none	Name of the resource
» startedAt	string(date-time)	false	none	Text value for startedAt in NfsJobImportItemDto
» finishedAt	string(date-time)	false	none	Text value for finishedAt in NfsJobImportItemDto
» doneItemCount	integer(int32)	false	none	Count of done item
» failedItemCount	integer(int32)	false	none	Count of failed item
» skippedItemCount	integer(int32)	false	none	Count of skipped item
» cancelledItemCount	integer(int32)	false	none	Count of cancelled item
» totalItemCount	integer(int32)	false	none	Count of total item

Enumerated Values

Attribute	Value
name	ACTIVATION_GROUP, CHARGE, CONTACT, CONTRACT, LEASE_COMPONENT, LESSEE, LESSEE_LESSOR, LESSOR, MASTER_AGREEMENT, NOT_AVAILABLE, SCHEDULE, UNIT

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

Retrieve A Specific Download Xlsx Report

HTTP Request

GET /api/v1/imports/download_xlsx_report/{id}

Interactive Demo

📋 Description: Downloads the specified XLSX report for a lease or contract identified by the given ID, facilitating the review of financial obligations and accounting entries within the Nakisa Lease Accounting Suite.

Parameters

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

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

Retrieve A Specific Download Original

HTTP Request

GET /api/v1/imports/download_original/{id}

Interactive Demo

📋 Description: Downloads the original document associated with a specified lease or contract, facilitating access to essential financial obligation details for accounting entries within the Nakisa Lease Accounting Suite.

Parameters

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

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

---