NFS Export Job Controller

Retrieve A Specific Export

HTTP Request

GET /api/v1/exports/{id}

📋 Description: Retrieves detailed information about a specific export identified by its unique ID, facilitating access to relevant lease, contract, and financial obligation data 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

ResponseNfsExportJobDto

Example Responses

 1{
 2  "code": {
 3    "name": "OK",
 4    "captionKey": "enum.responseCode.ok",
 5    "caption": "OK"
 6  },
 7  "errors": {
 8    "all": []
 9  },
10  "object": {
11    "id": 10000001,
12    "taskCount": 100,
13    "failedTaskCount": 100,
14    "doneTaskCount": 100,
15    "inProgressTaskCount": 100,
16    "cancelledTaskCount": 100,
17    "errorMessage": "sample_errorMessage",
18    "batchSize": 1000,
19    "totalObjectCount": 100,
20    "queueTime": "2025-01-01T10:00:00Z",
21    "startTime": "2025-01-01T10:00:00Z",
22    "endTime": "2025-01-01T10:00:00Z",
23    "status": {
24      "name": "PROCESSING",
25      "captionKey": "enum.batchJobStatus.processing",
26      "caption": "Processing"
27    },
28    "fileStorageId": "sample_fileStorageId",
29    "generatingExportFile": false,
30    "startedGeneratingExportFileAt": "2025-01-01T10:00:00Z",
31    "version": 100,
32    "readOnly": false,
33    "docStoreId": 10000001,
34    "filter": {
35      "principalPositionType": {
36        "name": "LESSEE",
37        "captionKey": "enum.principalpositiontype.lessee",
38        "caption": "Lessee"
39      },
40      "migratedFilterType": {
41        "name": "ALL",
42        "captionKey": "enum.migratedFilterType.all",
43        "caption": "All"
44      },
45      "erpSystemIds": [],
46      "leaseAreaIds": [],
47      "businessUnitIds": [],
48      "companyIds": [],
49      "erpSystemFilterType": {
50        "name": "ALL",
51        "captionKey": "enum.filterType.all",
52        "caption": "All"
53      },
54      "leaseAreaFilterType": {
55        "name": "ALL",
56        "captionKey": "enum.filterType.all",
57        "caption": "All"
58      },
59      "businessUnitFilterType": {
60        "name": "ALL",
61        "captionKey": "enum.filterType.all",
62        "caption": "All"
63      },
64      "companyFilterType": {
65        "name": "ALL",
66        "captionKey": "enum.filterType.all",
67        "caption": "All"
68      },
69      "objectTypeFilter": {
70        "name": "CONTRACT",
71        "captionKey": "enum.listObjectType.contract",
72        "caption": "Contract"
73      },
74      "ids": [],
75      "leaseComponentRevisionId": 10000001,
76      "leaseMeasurementId": 10000001,
77      "fromYear": 100,
78      "toYear": 100,
79      "unitIds": []
80    },
81    "requestReferences": [],
82    "sheetTypes": [],
83    "sheetGroupTypes": {
84      "name": "LEASE_COMPONENT",
85      "captionKey": "enum.SheetGroupTypes.leaseComponent",
86      "caption": "Lease Component"
87    }
88  }
89}

Update A Export

HTTP Request

PUT /api/v1/exports/{id}

📋 Description: Updates the specified export record in the Nakisa Lease Accounting Suite, allowing users to modify lease, contract, or financial obligation details associated with accounting entries.

Parameters

Name

In

Type

Required

Description

id

path

integer

true

Unique identifier for the resource

body

body

NfsExportJobDto

false

Request body containing updated lease contract details, including financial obligations and accounting entries, for the specified export identified by {id}.

Body Parameters

 1{
 2  "id": 10000001,
 3  "taskCount": 100,
 4  "failedTaskCount": 100,
 5  "doneTaskCount": 100,
 6  "inProgressTaskCount": 100,
 7  "cancelledTaskCount": 100,
 8  "errorMessage": "sample_errorMessage",
 9  "batchSize": 1000,
10  "totalObjectCount": 100,
11  "queueTime": "2025-01-01T10:00:00Z",
12  "startTime": "2025-01-01T10:00:00Z",
13  "endTime": "2025-01-01T10:00:00Z",
14  "status": {
15    "name": "PROCESSING",
16    "captionKey": "enum.batchJobStatus.processing",
17    "caption": "Processing"
18  },
19  "fileStorageId": "sample_fileStorageId",
20  "generatingExportFile": false,
21  "startedGeneratingExportFileAt": "2025-01-01T10:00:00Z",
22  "version": 100,
23  "readOnly": false,
24  "docStoreId": 10000001,
25  "filter": {
26    "principalPositionType": {
27      "name": "LESSEE",
28      "captionKey": "enum.principalpositiontype.lessee",
29      "caption": "Lessee"
30    },
31    "migratedFilterType": {
32      "name": "ALL",
33      "captionKey": "enum.migratedFilterType.all",
34      "caption": "All"
35    },
36    "erpSystemIds": [],
37    "leaseAreaIds": [],
38    "businessUnitIds": [],
39    "companyIds": [],
40    "erpSystemFilterType": {
41      "name": "ALL",
42      "captionKey": "enum.filterType.all",
43      "caption": "All"
44    },
45    "leaseAreaFilterType": {
46      "name": "ALL",
47      "captionKey": "enum.filterType.all",
48      "caption": "All"
49    },
50    "businessUnitFilterType": {
51      "name": "ALL",
52      "captionKey": "enum.filterType.all",
53      "caption": "All"
54    },
55    "companyFilterType": {
56      "name": "ALL",
57      "captionKey": "enum.filterType.all",
58      "caption": "All"
59    },
60    "objectTypeFilter": {
61      "name": "CONTRACT",
62      "captionKey": "enum.listObjectType.contract",
63      "caption": "Contract"
64    },
65    "ids": [],
66    "leaseComponentRevisionId": 10000001,
67    "leaseMeasurementId": 10000001,
68    "fromYear": 100,
69    "toYear": 100,
70    "unitIds": []
71  },
72  "requestReferences": [],
73  "sheetTypes": [],
74  "sheetGroupTypes": {
75    "name": "LEASE_COMPONENT",
76    "captionKey": "enum.SheetGroupTypes.leaseComponent",
77    "caption": "Lease Component"
78  }
79}

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseNfsExportJobDto

Example Responses

 1{
 2  "code": {
 3    "name": "OK",
 4    "captionKey": "enum.responseCode.ok",
 5    "caption": "OK"
 6  },
 7  "errors": {
 8    "all": []
 9  },
10  "object": {
11    "id": 10000001,
12    "taskCount": 100,
13    "failedTaskCount": 100,
14    "doneTaskCount": 100,
15    "inProgressTaskCount": 100,
16    "cancelledTaskCount": 100,
17    "errorMessage": "sample_errorMessage",
18    "batchSize": 1000,
19    "totalObjectCount": 100,
20    "queueTime": "2025-01-01T10:00:00Z",
21    "startTime": "2025-01-01T10:00:00Z",
22    "endTime": "2025-01-01T10:00:00Z",
23    "status": {
24      "name": "PROCESSING",
25      "captionKey": "enum.batchJobStatus.processing",
26      "caption": "Processing"
27    },
28    "fileStorageId": "sample_fileStorageId",
29    "generatingExportFile": false,
30    "startedGeneratingExportFileAt": "2025-01-01T10:00:00Z",
31    "version": 100,
32    "readOnly": false,
33    "docStoreId": 10000001,
34    "filter": {
35      "principalPositionType": {
36        "name": "LESSEE",
37        "captionKey": "enum.principalpositiontype.lessee",
38        "caption": "Lessee"
39      },
40      "migratedFilterType": {
41        "name": "ALL",
42        "captionKey": "enum.migratedFilterType.all",
43        "caption": "All"
44      },
45      "erpSystemIds": [],
46      "leaseAreaIds": [],
47      "businessUnitIds": [],
48      "companyIds": [],
49      "erpSystemFilterType": {
50        "name": "ALL",
51        "captionKey": "enum.filterType.all",
52        "caption": "All"
53      },
54      "leaseAreaFilterType": {
55        "name": "ALL",
56        "captionKey": "enum.filterType.all",
57        "caption": "All"
58      },
59      "businessUnitFilterType": {
60        "name": "ALL",
61        "captionKey": "enum.filterType.all",
62        "caption": "All"
63      },
64      "companyFilterType": {
65        "name": "ALL",
66        "captionKey": "enum.filterType.all",
67        "caption": "All"
68      },
69      "objectTypeFilter": {
70        "name": "CONTRACT",
71        "captionKey": "enum.listObjectType.contract",
72        "caption": "Contract"
73      },
74      "ids": [],
75      "leaseComponentRevisionId": 10000001,
76      "leaseMeasurementId": 10000001,
77      "fromYear": 100,
78      "toYear": 100,
79      "unitIds": []
80    },
81    "requestReferences": [],
82    "sheetTypes": [],
83    "sheetGroupTypes": {
84      "name": "LEASE_COMPONENT",
85      "captionKey": "enum.SheetGroupTypes.leaseComponent",
86      "caption": "Lease Component"
87    }
88  }
89}

Bulk Upsert Exports

HTTP Request

PUT /api/v1/exports/createOrUpdate/bulk

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

Parameters

Name

In

Type

Required

Description

body

body

NfsExportJobDto

false

Request body containing bulk data for lease contracts, including financial obligations and accounting entries, to facilitate the creation or update of export records in the Nakisa Lease Accounting Suite.

Body Parameters

 1[
 2  {
 3    "id": 10000001,
 4    "taskCount": 100,
 5    "failedTaskCount": 100,
 6    "doneTaskCount": 100,
 7    "inProgressTaskCount": 100,
 8    "cancelledTaskCount": 100,
 9    "errorMessage": "sample_errorMessage",
10    "batchSize": 1000,
11    "totalObjectCount": 100,
12    "queueTime": "2025-01-01T10:00:00Z",
13    "startTime": "2025-01-01T10:00:00Z",
14    "endTime": "2025-01-01T10:00:00Z",
15    "status": {
16      "name": "PROCESSING",
17      "captionKey": "enum.batchJobStatus.processing",
18      "caption": "Processing"
19    },
20    "fileStorageId": "sample_fileStorageId",
21    "generatingExportFile": false,
22    "startedGeneratingExportFileAt": "2025-01-01T10:00:00Z",
23    "version": 100,
24    "readOnly": false,
25    "docStoreId": 10000001,
26    "filter": {
27      "principalPositionType": {
28        "name": "LESSEE",
29        "captionKey": "enum.principalpositiontype.lessee",
30        "caption": "Lessee"
31      },
32      "migratedFilterType": {
33        "name": "ALL",
34        "captionKey": "enum.migratedFilterType.all",
35        "caption": "All"
36      },
37      "erpSystemIds": [],
38      "leaseAreaIds": [],
39      "businessUnitIds": [],
40      "companyIds": [],
41      "erpSystemFilterType": {
42        "name": "ALL",
43        "captionKey": "enum.filterType.all",
44        "caption": "All"
45      },
46      "leaseAreaFilterType": {
47        "name": "ALL",
48        "captionKey": "enum.filterType.all",
49        "caption": "All"
50      },
51      "businessUnitFilterType": {
52        "name": "ALL",
53        "captionKey": "enum.filterType.all",
54        "caption": "All"
55      },
56      "companyFilterType": {
57        "name": "ALL",
58        "captionKey": "enum.filterType.all",
59        "caption": "All"
60      },
61      "objectTypeFilter": {
62        "name": "CONTRACT",
63        "captionKey": "enum.listObjectType.contract",
64        "caption": "Contract"
65      },
66      "ids": [],
67      "leaseComponentRevisionId": 10000001,
68      "leaseMeasurementId": 10000001,
69      "fromYear": 100,
70      "toYear": 100,
71      "unitIds": []
72    },
73    "requestReferences": [],
74    "sheetTypes": [],
75    "sheetGroupTypes": {
76      "name": "LEASE_COMPONENT",
77      "captionKey": "enum.SheetGroupTypes.leaseComponent",
78      "caption": "Lease Component"
79    }
80  }
81]

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseListNfsExportJobDto

Example Responses

 1{
 2  "code": {
 3    "name": "OK",
 4    "captionKey": "enum.responseCode.ok",
 5    "caption": "OK"
 6  },
 7  "errors": {
 8    "all": []
 9  },
10  "object": []
11}

Upsert Export

HTTP Request

PUT /api/v1/exports/createOrUpdate

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

Parameters

Name

In

Type

Required

Description

body

body

NfsExportJobDto

false

Request body containing lease and contract data, including financial obligations and accounting entries, for creating or updating export records in the Nakisa Lease Accounting Suite.

Body Parameters

 1{
 2  "id": 10000001,
 3  "taskCount": 100,
 4  "failedTaskCount": 100,
 5  "doneTaskCount": 100,
 6  "inProgressTaskCount": 100,
 7  "cancelledTaskCount": 100,
 8  "errorMessage": "sample_errorMessage",
 9  "batchSize": 1000,
10  "totalObjectCount": 100,
11  "queueTime": "2025-01-01T10:00:00Z",
12  "startTime": "2025-01-01T10:00:00Z",
13  "endTime": "2025-01-01T10:00:00Z",
14  "status": {
15    "name": "PROCESSING",
16    "captionKey": "enum.batchJobStatus.processing",
17    "caption": "Processing"
18  },
19  "fileStorageId": "sample_fileStorageId",
20  "generatingExportFile": false,
21  "startedGeneratingExportFileAt": "2025-01-01T10:00:00Z",
22  "version": 100,
23  "readOnly": false,
24  "docStoreId": 10000001,
25  "filter": {
26    "principalPositionType": {
27      "name": "LESSEE",
28      "captionKey": "enum.principalpositiontype.lessee",
29      "caption": "Lessee"
30    },
31    "migratedFilterType": {
32      "name": "ALL",
33      "captionKey": "enum.migratedFilterType.all",
34      "caption": "All"
35    },
36    "erpSystemIds": [],
37    "leaseAreaIds": [],
38    "businessUnitIds": [],
39    "companyIds": [],
40    "erpSystemFilterType": {
41      "name": "ALL",
42      "captionKey": "enum.filterType.all",
43      "caption": "All"
44    },
45    "leaseAreaFilterType": {
46      "name": "ALL",
47      "captionKey": "enum.filterType.all",
48      "caption": "All"
49    },
50    "businessUnitFilterType": {
51      "name": "ALL",
52      "captionKey": "enum.filterType.all",
53      "caption": "All"
54    },
55    "companyFilterType": {
56      "name": "ALL",
57      "captionKey": "enum.filterType.all",
58      "caption": "All"
59    },
60    "objectTypeFilter": {
61      "name": "CONTRACT",
62      "captionKey": "enum.listObjectType.contract",
63      "caption": "Contract"
64    },
65    "ids": [],
66    "leaseComponentRevisionId": 10000001,
67    "leaseMeasurementId": 10000001,
68    "fromYear": 100,
69    "toYear": 100,
70    "unitIds": []
71  },
72  "requestReferences": [],
73  "sheetTypes": [],
74  "sheetGroupTypes": {
75    "name": "LEASE_COMPONENT",
76    "captionKey": "enum.SheetGroupTypes.leaseComponent",
77    "caption": "Lease Component"
78  }
79}

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseNfsExportJobDto

Example Responses

 1{
 2  "code": {
 3    "name": "OK",
 4    "captionKey": "enum.responseCode.ok",
 5    "caption": "OK"
 6  },
 7  "errors": {
 8    "all": []
 9  },
10  "object": {
11    "id": 10000001,
12    "taskCount": 100,
13    "failedTaskCount": 100,
14    "doneTaskCount": 100,
15    "inProgressTaskCount": 100,
16    "cancelledTaskCount": 100,
17    "errorMessage": "sample_errorMessage",
18    "batchSize": 1000,
19    "totalObjectCount": 100,
20    "queueTime": "2025-01-01T10:00:00Z",
21    "startTime": "2025-01-01T10:00:00Z",
22    "endTime": "2025-01-01T10:00:00Z",
23    "status": {
24      "name": "PROCESSING",
25      "captionKey": "enum.batchJobStatus.processing",
26      "caption": "Processing"
27    },
28    "fileStorageId": "sample_fileStorageId",
29    "generatingExportFile": false,
30    "startedGeneratingExportFileAt": "2025-01-01T10:00:00Z",
31    "version": 100,
32    "readOnly": false,
33    "docStoreId": 10000001,
34    "filter": {
35      "principalPositionType": {
36        "name": "LESSEE",
37        "captionKey": "enum.principalpositiontype.lessee",
38        "caption": "Lessee"
39      },
40      "migratedFilterType": {
41        "name": "ALL",
42        "captionKey": "enum.migratedFilterType.all",
43        "caption": "All"
44      },
45      "erpSystemIds": [],
46      "leaseAreaIds": [],
47      "businessUnitIds": [],
48      "companyIds": [],
49      "erpSystemFilterType": {
50        "name": "ALL",
51        "captionKey": "enum.filterType.all",
52        "caption": "All"
53      },
54      "leaseAreaFilterType": {
55        "name": "ALL",
56        "captionKey": "enum.filterType.all",
57        "caption": "All"
58      },
59      "businessUnitFilterType": {
60        "name": "ALL",
61        "captionKey": "enum.filterType.all",
62        "caption": "All"
63      },
64      "companyFilterType": {
65        "name": "ALL",
66        "captionKey": "enum.filterType.all",
67        "caption": "All"
68      },
69      "objectTypeFilter": {
70        "name": "CONTRACT",
71        "captionKey": "enum.listObjectType.contract",
72        "caption": "Contract"
73      },
74      "ids": [],
75      "leaseComponentRevisionId": 10000001,
76      "leaseMeasurementId": 10000001,
77      "fromYear": 100,
78      "toYear": 100,
79      "unitIds": []
80    },
81    "requestReferences": [],
82    "sheetTypes": [],
83    "sheetGroupTypes": {
84      "name": "LEASE_COMPONENT",
85      "captionKey": "enum.SheetGroupTypes.leaseComponent",
86      "caption": "Lease Component"
87    }
88  }
89}

Bulk Update Exports

HTTP Request

PUT /api/v1/exports/bulk

📋 Description: Updates multiple lease and contract records in the Nakisa Lease Accounting Suite, facilitating the management of financial obligations and accounting entries in bulk.

Parameters

Name

In

Type

Required

Description

body

body

NfsExportJobDto

false

Request body containing bulk export data for leases, contracts, financial obligations, and accounting entries to facilitate streamlined reporting and compliance within the Nakisa Lease Accounting Suite.

Body Parameters

 1[
 2  {
 3    "id": 10000001,
 4    "taskCount": 100,
 5    "failedTaskCount": 100,
 6    "doneTaskCount": 100,
 7    "inProgressTaskCount": 100,
 8    "cancelledTaskCount": 100,
 9    "errorMessage": "sample_errorMessage",
10    "batchSize": 1000,
11    "totalObjectCount": 100,
12    "queueTime": "2025-01-01T10:00:00Z",
13    "startTime": "2025-01-01T10:00:00Z",
14    "endTime": "2025-01-01T10:00:00Z",
15    "status": {
16      "name": "PROCESSING",
17      "captionKey": "enum.batchJobStatus.processing",
18      "caption": "Processing"
19    },
20    "fileStorageId": "sample_fileStorageId",
21    "generatingExportFile": false,
22    "startedGeneratingExportFileAt": "2025-01-01T10:00:00Z",
23    "version": 100,
24    "readOnly": false,
25    "docStoreId": 10000001,
26    "filter": {
27      "principalPositionType": {
28        "name": "LESSEE",
29        "captionKey": "enum.principalpositiontype.lessee",
30        "caption": "Lessee"
31      },
32      "migratedFilterType": {
33        "name": "ALL",
34        "captionKey": "enum.migratedFilterType.all",
35        "caption": "All"
36      },
37      "erpSystemIds": [],
38      "leaseAreaIds": [],
39      "businessUnitIds": [],
40      "companyIds": [],
41      "erpSystemFilterType": {
42        "name": "ALL",
43        "captionKey": "enum.filterType.all",
44        "caption": "All"
45      },
46      "leaseAreaFilterType": {
47        "name": "ALL",
48        "captionKey": "enum.filterType.all",
49        "caption": "All"
50      },
51      "businessUnitFilterType": {
52        "name": "ALL",
53        "captionKey": "enum.filterType.all",
54        "caption": "All"
55      },
56      "companyFilterType": {
57        "name": "ALL",
58        "captionKey": "enum.filterType.all",
59        "caption": "All"
60      },
61      "objectTypeFilter": {
62        "name": "CONTRACT",
63        "captionKey": "enum.listObjectType.contract",
64        "caption": "Contract"
65      },
66      "ids": [],
67      "leaseComponentRevisionId": 10000001,
68      "leaseMeasurementId": 10000001,
69      "fromYear": 100,
70      "toYear": 100,
71      "unitIds": []
72    },
73    "requestReferences": [],
74    "sheetTypes": [],
75    "sheetGroupTypes": {
76      "name": "LEASE_COMPONENT",
77      "captionKey": "enum.SheetGroupTypes.leaseComponent",
78      "caption": "Lease Component"
79    }
80  }
81]

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseListNfsExportJobDto

Example Responses

 1{
 2  "code": {
 3    "name": "OK",
 4    "captionKey": "enum.responseCode.ok",
 5    "caption": "OK"
 6  },
 7  "errors": {
 8    "all": []
 9  },
10  "object": []
11}

Create New Export

HTTP Request

POST /api/v1/exports/types

📋 Description: Creates a new export type for lease, contract, financial obligation, or accounting entry within the Nakisa Lease Accounting Suite, facilitating streamlined data management and reporting.

Responses

Status

Meaning

Description

Schema

200

OK

OK

Inline

Example Responses

1[
2  "string"
3]

Response Schema

Create New Export (With Sub Items)

HTTP Request

POST /api/v1/exports/sub-items

📋 Description: Submits a request to export sub-items related to leases and contracts, facilitating the extraction of financial obligations and accounting entries for reporting and analysis within the Nakisa Lease Accounting Suite.

Parameters

Name

In

Type

Required

Description

body

body

NfsExportJobDto

false

Request body containing detailed information on sub-items related to leases, contracts, and financial obligations for accurate accounting entry processing.

Body Parameters

 1{
 2  "id": 10000001,
 3  "taskCount": 100,
 4  "failedTaskCount": 100,
 5  "doneTaskCount": 100,
 6  "inProgressTaskCount": 100,
 7  "cancelledTaskCount": 100,
 8  "errorMessage": "sample_errorMessage",
 9  "batchSize": 1000,
10  "totalObjectCount": 100,
11  "queueTime": "2025-01-01T10:00:00Z",
12  "startTime": "2025-01-01T10:00:00Z",
13  "endTime": "2025-01-01T10:00:00Z",
14  "status": {
15    "name": "PROCESSING",
16    "captionKey": "enum.batchJobStatus.processing",
17    "caption": "Processing"
18  },
19  "fileStorageId": "sample_fileStorageId",
20  "generatingExportFile": false,
21  "startedGeneratingExportFileAt": "2025-01-01T10:00:00Z",
22  "version": 100,
23  "readOnly": false,
24  "docStoreId": 10000001,
25  "filter": {
26    "principalPositionType": {
27      "name": "LESSEE",
28      "captionKey": "enum.principalpositiontype.lessee",
29      "caption": "Lessee"
30    },
31    "migratedFilterType": {
32      "name": "ALL",
33      "captionKey": "enum.migratedFilterType.all",
34      "caption": "All"
35    },
36    "erpSystemIds": [],
37    "leaseAreaIds": [],
38    "businessUnitIds": [],
39    "companyIds": [],
40    "erpSystemFilterType": {
41      "name": "ALL",
42      "captionKey": "enum.filterType.all",
43      "caption": "All"
44    },
45    "leaseAreaFilterType": {
46      "name": "ALL",
47      "captionKey": "enum.filterType.all",
48      "caption": "All"
49    },
50    "businessUnitFilterType": {
51      "name": "ALL",
52      "captionKey": "enum.filterType.all",
53      "caption": "All"
54    },
55    "companyFilterType": {
56      "name": "ALL",
57      "captionKey": "enum.filterType.all",
58      "caption": "All"
59    },
60    "objectTypeFilter": {
61      "name": "CONTRACT",
62      "captionKey": "enum.listObjectType.contract",
63      "caption": "Contract"
64    },
65    "ids": [],
66    "leaseComponentRevisionId": 10000001,
67    "leaseMeasurementId": 10000001,
68    "fromYear": 100,
69    "toYear": 100,
70    "unitIds": []
71  },
72  "requestReferences": [],
73  "sheetTypes": [],
74  "sheetGroupTypes": {
75    "name": "LEASE_COMPONENT",
76    "captionKey": "enum.SheetGroupTypes.leaseComponent",
77    "caption": "Lease Component"
78  }
79}

Responses

Status

Meaning

Description

Schema

200

OK

OK

Inline

Example Responses

 1[
 2  {
 3    "persistentId": "sample_persistentId",
 4    "rowCaption": "sample_rowCaption",
 5    "sheetGroupType": {
 6      "name": "LEASE_COMPONENT",
 7      "captionKey": "enum.SheetGroupTypes.leaseComponent",
 8      "caption": "Lease Component"
 9    },
10    "sheetCaption": "sample_sheetCaption",
11    "tabCaption": "sample_tabCaption",
12    "principalPositionMode": {
13      "name": "LESSEE",
14      "captionKey": "enum.principalPositionMode.lessee",
15      "caption": "Lessee"
16    },
17    "order": 100,
18    "name": "Sample Name"
19  }
20]

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

Get Units For Export

HTTP Request

POST /api/v1/exports/search/units

📋 Description: Submits a request to export search results for units related to leases, contracts, and financial obligations within the Nakisa Lease Accounting Suite, facilitating streamlined accounting entry management.

Parameters

Name

In

Type

Required

Description

body

body

object

false

Request body containing the search criteria and filters for retrieving units related to leases, contracts, and financial obligations within the Nakisa Lease Accounting Suite.

Body Parameters

1{}

Responses

Status

Meaning

Description

Schema

200

OK

OK

PageLightUnitDto

Example Responses

 1{
 2  "totalElements": 10000001,
 3  "totalPages": 100,
 4  "pageable": {
 5    "pageNumber": 0,
 6    "unpaged": false,
 7    "paged": true,
 8    "pageSize": 100,
 9    "offset": 0,
10    "sort": {
11      "unsorted": false,
12      "sorted": true,
13      "empty": false
14    }
15  },
16  "numberOfElements": 100,
17  "size": 100,
18  "content": [],
19  "number": 100,
20  "sort": {
21    "unsorted": false,
22    "sorted": true,
23    "empty": false
24  },
25  "first": false,
26  "last": false,
27  "empty": false
28}

Get Master Agreements For Export

HTTP Request

POST /api/v1/exports/search/master-agreements

📋 Description: Submits a request to export master agreements related to leases and financial obligations, facilitating streamlined access to accounting entries for enhanced financial management.

Parameters

Name

In

Type

Required

Description

body

body

object

false

Request body containing the search criteria and filters for retrieving master agreements related to leases and financial obligations within the Nakisa Lease Accounting Suite.

Body Parameters

1{}

Responses

Status

Meaning

Description

Schema

200

OK

OK

PageMasterAgreementDto

Example Responses

  1{
  2  "totalElements": 76,
  3  "totalPages": 1,
  4  "pageable": {
  5    "pageNumber": 0,
  6    "unpaged": false,
  7    "paged": true,
  8    "pageSize": 100,
  9    "offset": 0,
 10    "sort": {
 11      "unsorted": false,
 12      "sorted": true,
 13      "empty": false
 14    }
 15  },
 16  "numberOfElements": 76,
 17  "size": 100,
 18  "content": [
 19    {
 20      "id": 10000086,
 21      "displayId": "MA-2025-0001",
 22      "year": 2023,
 23      "name": "Global HQ Lease Agreement",
 24      "description": "Master lease agreement for HQ premises.",
 25      "validFrom": "2019-08-24",
 26      "validTo": "2019-08-24",
 27      "targetValue": 1000000,
 28      "legalJurisdiction": "Germany",
 29      "approverComment": "Reviewed and approved by legal team.",
 30      "signingPerson": "John Doe",
 31      "placeOfSignature": "Berlin, Germany",
 32      "dateOfSignature": "2019-08-24",
 33      "state": {
 34        "name": "MLA_ACTIVE",
 35        "captionKey": "enum.mlaStatus.mlaActive",
 36        "caption": "Active"
 37      },
 38      "dataCreationInfo": {
 39        "id": 10000001,
 40        "idGenerationType": {
 41          "name": "AUTO",
 42          "captionKey": "enum.idGenerationType.auto",
 43          "caption": "Auto"
 44        },
 45        "source": "sample_source",
 46        "type": {
 47          "name": "MIGRATION",
 48          "captionKey": "enum.dataType.migration",
 49          "caption": "Migration"
 50        },
 51        "startDateTime": "2025-01-01T10:00:00Z",
 52        "endDateTime": "2025-01-01T10:00:00Z"
 53      },
 54      "agreementGroup": {
 55        "id": 20000001,
 56        "displayId": "AG-001",
 57        "status": {
 58          "name": "ACTIVE",
 59          "captionKey": "enum.objectStatus.active",
 60          "active": true,
 61          "caption": "Active"
 62        },
 63        "name": "Global Agreement Group"
 64      },
 65      "currency": {
 66        "id": 840,
 67        "displayId": "USD",
 68        "status": {
 69          "name": "ACTIVE",
 70          "captionKey": "enum.objectStatus.active",
 71          "active": true,
 72          "caption": "Active"
 73        },
 74        "name": "United States Dollar",
 75        "decimalPoints": 2
 76      },
 77      "internalAssetClass": {
 78        "id": 10000001,
 79        "displayId": "IAC-001",
 80        "status": {
 81          "name": "ACTIVE",
 82          "captionKey": "enum.objectStatus.active",
 83          "active": true,
 84          "caption": "Active"
 85        },
 86        "name": "Machinery and Equipment",
 87        "assetClassType": "PROPERTY",
 88        "infiniteUsefulLife": false
 89      },
 90      "leaseArea": {
 91        "id": 10000001,
 92        "displayId": "0001",
 93        "status": {
 94          "name": "ACTIVE",
 95          "captionKey": "enum.objectStatus.active",
 96          "active": true,
 97          "caption": "Active"
 98        },
 99        "name": "Global Lease Area"
100      },
101      "businessUnit": {
102        "id": 10000001,
103        "displayId": "BU0001",
104        "status": {
105          "name": "ACTIVE",
106          "captionKey": "enum.objectStatus.active",
107          "active": true,
108          "caption": "Active"
109        },
110        "name": "North America Business Unit"
111      },
112      "companyCode": {
113        "id": 10000006,
114        "displayId": "1005",
115        "status": {
116          "name": "ACTIVE",
117          "captionKey": "enum.objectStatus.active",
118          "active": true,
119          "caption": "Active"
120        },
121        "erpSystemId": 10000001,
122        "erpSystemDisplayId": "FINQ8S-300",
123        "countryId": 10000095,
124        "countryDisplayId": "CA",
125        "name": "string",
126        "postingPeriodVariantId": 0,
127        "fiscalVariantId": 0
128      },
129      "department": {
130        "id": 300001,
131        "displayId": "DEP-01",
132        "status": {
133          "name": "ACTIVE",
134          "captionKey": "enum.objectStatus.active",
135          "active": true,
136          "caption": "Active"
137        },
138        "name": "Finance Department"
139      },
140      "leaseGroup": {
141        "id": 60000001,
142        "displayId": "LG-001",
143        "status": {
144          "name": "ACTIVE",
145          "captionKey": "enum.objectStatus.active",
146          "active": true,
147          "caption": "Active"
148        },
149        "name": "Global Lease Group"
150      },
151      "allowsSystemGenerateNewId": true,
152      "numberRangeIdentifierValue": "0001",
153      "numberRangeIdentifierType": {
154        "name": "COMPANY_CODE"
155      },
156      "numberRangeType": {
157        "name": "CONTRACT"
158      }
159    }
160  ],
161  "number": 0,
162  "sort": {
163    "unsorted": false,
164    "sorted": true,
165    "empty": false
166  },
167  "first": true,
168  "last": true,
169  "empty": false
170}

Get Lease Components For Export

HTTP Request

POST /api/v1/exports/search/lease-components

📋 Description: Submits a request to export lease components based on specified search criteria, facilitating the management of contracts and financial obligations within the Nakisa Lease Accounting Suite.

Parameters

Name

In

Type

Required

Description

body

body

object

false

Request body containing search criteria and filters for lease components related to contracts and financial obligations within the Nakisa Lease Accounting Suite.

Body Parameters

1{}

Responses

Status

Meaning

Description

Schema

200

OK

OK

PageLeaseComponentDto

Example Responses

  1{
  2  "totalElements": 76,
  3  "totalPages": 1,
  4  "pageable": {
  5    "pageNumber": 0,
  6    "unpaged": false,
  7    "paged": true,
  8    "pageSize": 100,
  9    "offset": 0,
 10    "sort": {
 11      "unsorted": false,
 12      "sorted": true,
 13      "empty": false
 14    }
 15  },
 16  "numberOfElements": 76,
 17  "size": 100,
 18  "content": [
 19    {
 20      "id": 10000003,
 21      "displayId": "LC-100000002",
 22      "principalPositionType": {
 23        "name": "LESSEE",
 24        "captionKey": "enum.principalpositiontype.lessee",
 25        "caption": "Lessee"
 26      },
 27      "name": "patched lease component",
 28      "description": "string",
 29      "bulkAsset": false,
 30      "rouStartDate": "2019-08-24",
 31      "rouEndDate": "2019-08-24",
 32      "approverComment": "string",
 33      "fairMarketValue": 0,
 34      "allocationNumber": "string",
 35      "guaranteedResidualValue": 0,
 36      "unitDistributions": [],
 37      "revision": {
 38        "id": 10000003,
 39        "displayId": "0461332847-20250827-142605",
 40        "name": "Inception",
 41        "inception": true,
 42        "revisionType": "ACTIVE",
 43        "state": "LC_DEFINE",
 44        "approvedBy": "string",
 45        "approvedAt": "2019-08-24",
 46        "parentRevisionId": 0,
 47        "approverComment": "string",
 48        "leaseComponentId": 10000003,
 49        "leaseComponentDisplayId": "LC-100000002",
 50        "leaseComponentName": "Test2 lease component",
 51        "contractRevisionId": 10000001,
 52        "contractRevisionDisplayId": "1617141777-20250724-115809",
 53        "numberRangeIdentifierValue": "string",
 54        "numberRangeIdentifierType": {
 55          "name": "COMPANY_CODE"
 56        },
 57        "numberRangeType": {
 58          "name": "CONTRACT"
 59        },
 60        "allowsSystemGenerateNewId": false
 61      },
 62      "internalAssetClass": {
 63        "id": 10000001,
 64        "displayId": "IAC-001",
 65        "status": {
 66          "name": "ACTIVE",
 67          "captionKey": "enum.objectStatus.active",
 68          "active": true,
 69          "caption": "Active"
 70        },
 71        "name": "Machinery and Equipment",
 72        "assetClassType": "PROPERTY",
 73        "infiniteUsefulLife": false
 74      },
 75      "unitOfMeasure": {
 76        "id": 10000198,
 77        "displayId": "MPA",
 78        "status": {
 79          "name": "ACTIVE",
 80          "captionKey": "enum.objectStatus.active",
 81          "active": true,
 82          "caption": "Active"
 83        },
 84        "name": "Megapascal",
 85        "erpSystemId": 10000001
 86      },
 87      "notifications": [],
 88      "spreadingFrequency": "NONE",
 89      "contractId": 10000001,
 90      "contractDisplayId": "CT-100000000",
 91      "companyCodeId": 10000002,
 92      "companyCodeDisplayId": "string",
 93      "userDeterminedLeaseType": {
 94        "name": "LEASE_CONTRACT_FIX",
 95        "captionKey": "enum.leaseType.fix",
 96        "principalPositionType": "LESSEE",
 97        "caption": "Fixed Lease Contract"
 98      },
 99      "endOfTermDate": "2019-08-24",
100      "endOfTermPeriod": "string",
101      "allowsSystemGenerateNewId": false,
102      "transferInfo": {
103        "transferredFromDisplayId": "CTR-00012",
104        "transferredFromRevisionId": 20000001,
105        "transferredToDisplayId": "CTR-00015",
106        "transferredToRevisionId": 20000005
107      },
108      "numberRangeIdentifierValue": "string",
109      "numberRangeIdentifierType": {
110        "name": "COMPANY_CODE"
111      },
112      "numberRangeType": {
113        "name": "CONTRACT"
114      },
115      "type": "LESSEE"
116    }
117  ],
118  "number": 0,
119  "sort": {
120    "unsorted": false,
121    "sorted": true,
122    "empty": false
123  },
124  "first": true,
125  "last": true,
126  "empty": false
127}

Get Contracts For Export

HTTP Request

POST /api/v1/exports/search/contracts

📋 Description: Submits a request to export search results for contracts related to leases, enabling users to analyze financial obligations and accounting entries efficiently.

Parameters

Name

In

Type

Required

Description

body

body

object

false

Request body containing the search criteria and filters for retrieving lease contract data related to financial obligations and accounting entries.

Body Parameters

1{}

Responses

Status

Meaning

Description

Schema

200

OK

OK

PageContractDto

Example Responses

  1{
  2  "totalElements": 76,
  3  "totalPages": 1,
  4  "pageable": {
  5    "pageNumber": 0,
  6    "unpaged": false,
  7    "paged": true,
  8    "pageSize": 100,
  9    "offset": 0,
 10    "sort": {
 11      "unsorted": false,
 12      "sorted": true,
 13      "empty": false
 14    }
 15  },
 16  "numberOfElements": 76,
 17  "size": 100,
 18  "content": [
 19    {
 20      "id": 10000018,
 21      "displayId": "CT-100001000",
 22      "name": "Testtt Contract",
 23      "principalPositionType": {
 24        "name": "LESSEE",
 25        "captionKey": "enum.principalpositiontype.lessee",
 26        "caption": "Lessee"
 27      },
 28      "validFrom": "2019-08-24",
 29      "validTo": "2019-08-24",
 30      "amendmentDate": "2019-08-24",
 31      "approverComment": "string",
 32      "contractPhase": "INITIAL",
 33      "dataCreationInfo": {
 34        "id": 10000001,
 35        "idGenerationType": {
 36          "name": "AUTO",
 37          "captionKey": "enum.idGenerationType.auto",
 38          "caption": "Auto"
 39        },
 40        "source": "sample_source",
 41        "type": {
 42          "name": "MIGRATION",
 43          "captionKey": "enum.dataType.migration",
 44          "caption": "Migration"
 45        },
 46        "startDateTime": "2025-01-01T10:00:00Z",
 47        "endDateTime": "2025-01-01T10:00:00Z"
 48      },
 49      "leaseType": {
 50        "name": "LEASE_CONTRACT_FIX",
 51        "captionKey": "enum.leaseType.fix",
 52        "principalPositionType": "LESSEE",
 53        "caption": "Fixed Lease Contract"
 54      },
 55      "revision": {
 56        "id": 10000008,
 57        "displayId": "CR-0001",
 58        "name": "Initial Revision",
 59        "inception": "2019-08-24",
 60        "revisionType": "ACTIVE",
 61        "state": "LC_DEFINE",
 62        "approvedBy": "manager.user@company.com",
 63        "approvedAt": "2019-08-24T14:15:22Z",
 64        "parentRevisionId": 10000010,
 65        "approverComment": "Approved with changes.",
 66        "contractId": 20000001,
 67        "contractDisplayId": "C-0001",
 68        "contractName": "Office Lease Contract",
 69        "principalPositionType": {
 70          "name": "LESSEE",
 71          "captionKey": "enum.principalpositiontype.lessee",
 72          "caption": "Lessee"
 73        },
 74        "mlaId": 30000001,
 75        "companyId": 40000001,
 76        "description": "Revision to adjust payment terms.",
 77        "externalReference": "EXT-REF-001",
 78        "internalReference": "INT-REF-001",
 79        "formOfLease": "FULL",
 80        "jointVentureLeaseType": "GROSS_LEASE",
 81        "businessPlace": "New York Office",
 82        "tradingPartner": {
 83          "id": 50000001,
 84          "displayId": "TP-0001",
 85          "status": {
 86            "name": "ACTIVE",
 87            "captionKey": "enum.objectStatus.active",
 88            "active": true,
 89            "caption": "Active"
 90          },
 91          "name": "ABC Real Estate Partners",
 92          "erpSystemId": 60000001,
 93          "erpSystemDisplayId": "ERP-SYS-01"
 94        },
 95        "contractCategoryGroup": {
 96          "id": 10000001,
 97          "displayId": "sample_displayId",
 98          "status": {
 99            "name": "ACTIVE",
100            "captionKey": "enum.objectStatus.active",
101            "active": true,
102            "caption": "Active"
103          },
104          "name": "Sample Name"
105        },
106        "contractGroup1": {
107          "id": 400001,
108          "displayId": "CG1-01",
109          "status": {
110            "name": "ACTIVE",
111            "captionKey": "enum.objectStatus.active",
112            "active": true,
113            "caption": "Active"
114          },
115          "name": "Real Estate Contracts"
116        },
117        "contractGroup2": {
118          "id": 500001,
119          "displayId": "CG2-01",
120          "status": {
121            "name": "ACTIVE",
122            "captionKey": "enum.objectStatus.active",
123            "active": true,
124            "caption": "Active"
125          },
126          "name": "Equipment Leasing Contracts"
127        },
128        "group3": "Group3-Value",
129        "group4": "Group4-Value",
130        "signingPerson": "John Doe",
131        "placeOfSignature": "Montreal, Canada",
132        "dateOfSignature": "2019-08-24T14:15:22Z",
133        "numberRangeIdentifierValue": "0001",
134        "numberRangeIdentifierType": {
135          "name": "COMPANY_CODE"
136        },
137        "numberRangeType": {
138          "name": "CONTRACT"
139        },
140        "allowsSystemGenerateNewId": true
141      },
142      "currency": {
143        "id": 840,
144        "displayId": "USD",
145        "status": {
146          "name": "ACTIVE",
147          "captionKey": "enum.objectStatus.active",
148          "active": true,
149          "caption": "Active"
150        },
151        "name": "United States Dollar",
152        "decimalPoints": 2
153      },
154      "companyCurrency": {
155        "id": 840,
156        "displayId": "USD",
157        "status": {
158          "name": "ACTIVE",
159          "captionKey": "enum.objectStatus.active",
160          "active": true,
161          "caption": "Active"
162        },
163        "name": "United States Dollar",
164        "decimalPoints": 2
165      },
166      "indexedCurrency": true,
167      "assetValueCurrencyType": "CONTRACT_CURRENCY",
168      "currencyLocked": true,
169      "leaseArea": {
170        "id": 10000001,
171        "displayId": "0001",
172        "status": {
173          "name": "ACTIVE",
174          "captionKey": "enum.objectStatus.active",
175          "active": true,
176          "caption": "Active"
177        },
178        "name": "Global Lease Area"
179      },
180      "businessUnit": {
181        "id": 10000001,
182        "displayId": "BU0001",
183        "status": {
184          "name": "ACTIVE",
185          "captionKey": "enum.objectStatus.active",
186          "active": true,
187          "caption": "Active"
188        },
189        "name": "North America Business Unit"
190      },
191      "businessUnitLocked": true,
192      "companyCode": {
193        "id": 10000006,
194        "displayId": "1005",
195        "status": {
196          "name": "ACTIVE",
197          "captionKey": "enum.objectStatus.active",
198          "active": true,
199          "caption": "Active"
200        },
201        "erpSystemId": 10000001,
202        "erpSystemDisplayId": "FINQ8S-300",
203        "countryId": 10000095,
204        "countryDisplayId": "CA",
205        "name": "string",
206        "postingPeriodVariantId": 0,
207        "fiscalVariantId": 0
208      },
209      "companyCodeLocked": true,
210      "department": {
211        "id": 300001,
212        "displayId": "DEP-01",
213        "status": {
214          "name": "ACTIVE",
215          "captionKey": "enum.objectStatus.active",
216          "active": true,
217          "caption": "Active"
218        },
219        "name": "Finance Department"
220      },
221      "departmentLocked": true,
222      "leaseGroup": {
223        "id": 60000001,
224        "displayId": "LG-001",
225        "status": {
226          "name": "ACTIVE",
227          "captionKey": "enum.objectStatus.active",
228          "active": true,
229          "caption": "Active"
230        },
231        "name": "Global Lease Group"
232      },
233      "leaseGroupLocked": true,
234      "subleasingInternalAssetClass": {
235        "id": 10000001,
236        "displayId": "IAC-001",
237        "status": {
238          "name": "ACTIVE",
239          "captionKey": "enum.objectStatus.active",
240          "active": true,
241          "caption": "Active"
242        },
243        "name": "Machinery and Equipment",
244        "assetClassType": "PROPERTY",
245        "infiniteUsefulLife": false
246      },
247      "contractGroup1": {
248        "id": 400001,
249        "displayId": "CG1-01",
250        "status": {
251          "name": "ACTIVE",
252          "captionKey": "enum.objectStatus.active",
253          "active": true,
254          "caption": "Active"
255        },
256        "name": "Real Estate Contracts"
257      },
258      "contractGroup2": {
259        "id": 500001,
260        "displayId": "CG2-01",
261        "status": {
262          "name": "ACTIVE",
263          "captionKey": "enum.objectStatus.active",
264          "active": true,
265          "caption": "Active"
266        },
267        "name": "Equipment Leasing Contracts"
268      },
269      "subleasing": false,
270      "subleasingContractRevisionInfo": {
271        "id": 50000001,
272        "contractId": 40000001,
273        "contractDisplayId": "CTR-0001",
274        "contractName": "Sublease Agreement for Office Space"
275      },
276      "subleasingLeaseComponentRevisionInfo": {
277        "id": 61000001,
278        "leaseComponentId": 80000001,
279        "leaseComponentDisplayId": "LC-0001",
280        "leaseComponentName": "Vehicle Lease Component"
281      },
282      "subleasingActivationGroupRevisionInfo": {
283        "id": 60000001,
284        "activationGroupId": 70000001,
285        "activationGroupDisplayId": "AG-001",
286        "activationGroupName": "Office Equipment Activation Group"
287      },
288      "notifications": [
289        {
290          "id": 10000001,
291          "topic": {
292            "enCaption": "Lease Component Updated",
293            "frCaption": "Composant de bail mis à jour",
294            "name": "LEASE_COMPONENT_UPDATED",
295            "priority": "HIGH"
296          },
297          "username": "super.admin@nakisa.com",
298          "contractId": 10000001,
299          "contractDisplayId": "CT-100000000",
300          "targetId": "CT-100000000",
301          "targetType": "CONTRACT"
302        }
303      ],
304      "masterAgreementId": 10000001,
305      "masterAgreementDisplayId": "string",
306      "allowsSystemGenerateNewId": true,
307      "transferInfo": {
308        "transferredFromDisplayId": "CTR-00012",
309        "transferredFromRevisionId": 20000001,
310        "transferredToDisplayId": "CTR-00015",
311        "transferredToRevisionId": 20000005
312      },
313      "numberRangeIdentifierValue": "",
314      "numberRangeIdentifierType": {
315        "name": "COMPANY_CODE"
316      },
317      "numberRangeType": {
318        "name": "CONTRACT"
319      }
320    }
321  ],
322  "number": 0,
323  "sort": {
324    "unsorted": false,
325    "sorted": true,
326    "empty": false
327  },
328  "first": true,
329  "last": true,
330  "empty": false
331}

Create A New Charge

HTTP Request

POST /api/v1/exports/search/charges

📋 Description: Submits a request to export search results for charges related to leases and contracts, facilitating the management of 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 search criteria for charges related to leases and contracts, including relevant financial obligations and accounting entries.

Body Parameters

1{}

Responses

Status

Meaning

Description

Schema

200

OK

OK

PageChargeDto

Example Responses

 1{
 2  "totalElements": 10000001,
 3  "totalPages": 100,
 4  "pageable": {
 5    "pageNumber": 0,
 6    "unpaged": false,
 7    "paged": true,
 8    "pageSize": 100,
 9    "offset": 0,
10    "sort": {
11      "unsorted": false,
12      "sorted": true,
13      "empty": false
14    }
15  },
16  "numberOfElements": 100,
17  "size": 100,
18  "content": [],
19  "number": 0,
20  "sort": {
21    "unsorted": false,
22    "sorted": true,
23    "empty": false
24  },
25  "first": true,
26  "last": false,
27  "empty": false
28}

Get Activation Groups For Export

HTTP Request

POST /api/v1/exports/search/activation-groups

📋 Description: Submits a request to create and export activation groups related to leases and contracts, facilitating the management of 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 search criteria for activation groups related to leases, contracts, and financial obligations within the Nakisa Lease Accounting Suite.

Body Parameters

1{}

Responses

Status

Meaning

Description

Schema

200

OK

OK

PageActivationGroupDto

Example Responses

  1{
  2  "totalElements": 76,
  3  "totalPages": 1,
  4  "pageable": {
  5    "pageNumber": 0,
  6    "unpaged": false,
  7    "paged": true,
  8    "pageSize": 100,
  9    "offset": 0,
 10    "sort": {
 11      "unsorted": false,
 12      "sorted": true,
 13      "empty": false
 14    }
 15  },
 16  "numberOfElements": 76,
 17  "size": 100,
 18  "content": [
 19    {
 20      "id": 10000001,
 21      "displayId": "AG-100000000",
 22      "principalPositionType": {
 23        "name": "LESSEE",
 24        "captionKey": "enum.principalpositiontype.lessee",
 25        "caption": "Lessee"
 26      },
 27      "name": "Test2",
 28      "description": "test2",
 29      "approverComment": "Approved after review",
 30      "snapshotData": {
 31        "isParallelCurrencyEnabled": true,
 32        "isCostCenterAllocationEnabled": false,
 33        "useSpotRateForGroupCurrency": true,
 34        "usePostingOrDocumentDateForCurrency": true,
 35        "exchangeRateTypes": [
 36          {
 37            "currencyDefinitionType": "CONTRACT_CURRENCY",
 38            "sourceCurrencyType": "COMPANY_CURRENCY",
 39            "translationDateType": "POSTING_DATE",
 40            "targetCurrency": {
 41              "id": "string",
 42              "displayId": "US Dollar",
 43              "decimalPoints": 2
 44            },
 45            "referenceCurrency": {
 46              "id": "string",
 47              "displayId": "Euro"
 48            },
 49            "currencyType": "GROUP_CURRENCY",
 50            "exchangeRateType": "STANDARD"
 51          }
 52        ]
 53      },
 54      "revision": {
 55        "id": 10000001,
 56        "displayId": "0374999413-20250903-161147",
 57        "name": "Inception",
 58        "inception": true,
 59        "revisionType": "REVISION",
 60        "state": "MLA_DEFINE",
 61        "approvedBy": "approver.admin@nakisa.com",
 62        "approvedAt": "2019-08-24T14:15:22Z",
 63        "parentRevisionId": 10000000,
 64        "approverComment": "Approved after financial validation.",
 65        "rouStartDate": "2025-08-01",
 66        "rouEndDate": "2025-08-20",
 67        "activationGroupModification": {
 68          "modificationDate": "2025-08-15",
 69          "terminationType": "CASUALTY",
 70          "terminationDate": {
 71            "timing": "START_OF_DAY",
 72            "year": 2025,
 73            "monthValue": 9,
 74            "dayOfMonth": 4,
 75            "leapYear": false,
 76            "month": "SEPTEMBER",
 77            "dayOfWeek": "THURSDAY",
 78            "dayOfYear": 247
 79          },
 80          "useManualFmvValue": true,
 81          "useManualAssetValues": false,
 82          "enforceNonLeaseOnIndexation": false,
 83          "applyIndexationLease": true,
 84          "applyIndexationNonLease": false,
 85          "indexationTreatmentType": "DEFAULT",
 86          "indexationStartDate": "2025-09-01",
 87          "indexationDateType": "USER_DEFINED",
 88          "indexationStartDateNonLease": "2025-09-10",
 89          "indexationDateTypeNonLease": "USER_DEFINED",
 90          "modificationReasons": [
 91            "CONTRACT_RATE_CHANGE",
 92            "INDEXATION"
 93          ],
 94          "modificationPerClassificationList": [
 95            {
 96              "accountingStandardId": 1001,
 97              "classificationType": "NON_LEASE",
 98              "accountingStandardType": "IFRS",
 99              "impairmentAmount": 2500.5,
100              "recoverableAmount": 2000,
101              "decreaseInAsset": 1500,
102              "decreaseInTerm": 6
103            }
104          ],
105          "massIndexationTaskId": 987654
106        },
107        "activationGroupId": 10000001,
108        "activationGroupDisplayId": "AG-100000000",
109        "activationGroupName": "Test2",
110        "leaseComponentRevisionId": 10000007,
111        "leaseComponentRevisionDisplayId": "0738001403-20250828-113111",
112        "lastLeaseComponentRevisionId": 10000006,
113        "lastLeaseComponentRevisionDisplayId": "0738001403-20250828-113000",
114        "clonedFromRevisionId": 10000002,
115        "clonedFromRevisionDisplayId": "0374999413-20250820-101200",
116        "lockReason": "PENDING_TERMINATION",
117        "infiniteUsefulLife": false,
118        "transferOfOwnership": false,
119        "specializedAsset": false,
120        "fairMarketValue": 1,
121        "residualValue": 1,
122        "endOfTermIntention": "TO_BE_DETERMINED",
123        "endOfTermDate": "2025-08-11",
124        "endOfTermPeriod": 9,
125        "activationDocumentDate": "2019-08-24",
126        "activationPostingDate": "2019-08-24",
127        "closingDocumentDate": "2019-08-24",
128        "closingPostingDate": "2019-08-24",
129        "numberRangeIdentifierValue": "1000",
130        "numberRangeIdentifierType": {
131          "name": "COMPANY_CODE"
132        },
133        "numberRangeType": {
134          "name": "CONTRACT"
135        },
136        "allowsSystemGenerateNewId": false
137      },
138      "leaseComponentId": 10000007,
139      "leaseComponentDisplayId": "LC-100000200",
140      "companyCodeId": 10000002,
141      "companyCodeDisplayId": "1000",
142      "splittedFromActivationGroupRevisionId": {
143        "id": 10000001,
144        "displayId": "0374999413-20250903-161147",
145        "name": "Inception",
146        "inception": true,
147        "revisionType": "REVISION",
148        "state": "MLA_DEFINE",
149        "approvedBy": "approver.admin@nakisa.com",
150        "approvedAt": "2019-08-24T14:15:22Z",
151        "parentRevisionId": 10000000,
152        "approverComment": "Approved after financial validation.",
153        "rouStartDate": "2025-08-01",
154        "rouEndDate": "2025-08-20",
155        "activationGroupModification": {
156          "modificationDate": "2025-08-15",
157          "terminationType": "CASUALTY",
158          "terminationDate": {
159            "timing": "START_OF_DAY",
160            "year": 2025,
161            "monthValue": 9,
162            "dayOfMonth": 4,
163            "leapYear": false,
164            "month": "SEPTEMBER",
165            "dayOfWeek": "THURSDAY",
166            "dayOfYear": 247
167          },
168          "useManualFmvValue": true,
169          "useManualAssetValues": false,
170          "enforceNonLeaseOnIndexation": false,
171          "applyIndexationLease": true,
172          "applyIndexationNonLease": false,
173          "indexationTreatmentType": "DEFAULT",
174          "indexationStartDate": "2025-09-01",
175          "indexationDateType": "USER_DEFINED",
176          "indexationStartDateNonLease": "2025-09-10",
177          "indexationDateTypeNonLease": "USER_DEFINED",
178          "modificationReasons": [
179            "CONTRACT_RATE_CHANGE",
180            "INDEXATION"
181          ],
182          "modificationPerClassificationList": [
183            {
184              "accountingStandardId": 1001,
185              "classificationType": "NON_LEASE",
186              "accountingStandardType": "IFRS",
187              "impairmentAmount": 2500.5,
188              "recoverableAmount": 2000,
189              "decreaseInAsset": 1500,
190              "decreaseInTerm": 6
191            }
192          ],
193          "massIndexationTaskId": 987654
194        },
195        "activationGroupId": 10000001,
196        "activationGroupDisplayId": "AG-100000000",
197        "activationGroupName": "Test2",
198        "leaseComponentRevisionId": 10000007,
199        "leaseComponentRevisionDisplayId": "0738001403-20250828-113111",
200        "lastLeaseComponentRevisionId": 10000006,
201        "lastLeaseComponentRevisionDisplayId": "0738001403-20250828-113000",
202        "clonedFromRevisionId": 10000002,
203        "clonedFromRevisionDisplayId": "0374999413-20250820-101200",
204        "lockReason": "PENDING_TERMINATION",
205        "infiniteUsefulLife": false,
206        "transferOfOwnership": false,
207        "specializedAsset": false,
208        "fairMarketValue": 1,
209        "residualValue": 1,
210        "endOfTermIntention": "TO_BE_DETERMINED",
211        "endOfTermDate": "2025-08-11",
212        "endOfTermPeriod": 9,
213        "activationDocumentDate": "2019-08-24",
214        "activationPostingDate": "2019-08-24",
215        "closingDocumentDate": "2019-08-24",
216        "closingPostingDate": "2019-08-24",
217        "numberRangeIdentifierValue": "1000",
218        "numberRangeIdentifierType": {
219          "name": "COMPANY_CODE"
220        },
221        "numberRangeType": {
222          "name": "CONTRACT"
223        },
224        "allowsSystemGenerateNewId": false
225      },
226      "notifications": [
227        {
228          "id": 100045,
229          "topic": {
230            "enCaption": "Lease Component Updated",
231            "frCaption": "Composant de bail mis à jour",
232            "name": "LEASE_COMPONENT_UPDATED",
233            "priority": "HIGH"
234          },
235          "username": "jdoe",
236          "activationGroupId": 20000123,
237          "activationGroupDisplayId": "AG-100045",
238          "targetId": "jdoe@example.com",
239          "targetType": "USER"
240        }
241      ],
242      "transferInfo": {
243        "transferredFromDisplayId": "CTR-00012",
244        "transferredFromRevisionId": 20000001,
245        "transferredToDisplayId": "CTR-00015",
246        "transferredToRevisionId": 20000005
247      },
248      "numberRangeIdentifierValue": "1000",
249      "numberRangeIdentifierType": {
250        "name": "COMPANY_CODE"
251      },
252      "numberRangeType": {
253        "name": "CONTRACT"
254      },
255      "allowsSystemGenerateNewId": false
256    }
257  ],
258  "number": 0,
259  "sort": {
260    "unsorted": false,
261    "sorted": true,
262    "empty": false
263  },
264  "first": true,
265  "last": true,
266  "empty": false
267}

Search Exports

HTTP Request

POST /api/v1/exports/search

📋 Description: Submits a request to export search results related to leases, contracts, and financial obligations, facilitating streamlined accounting entry management within the Nakisa Lease Accounting Suite.

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

NfsExportJobDtoFilterExtended

false

Request body containing search criteria for leases, contracts, financial obligations, and accounting entries to facilitate targeted data retrieval within the Nakisa Lease Accounting Suite.

Default Values

Parameter

Default

Type

sort

["createdAt,ASC"]

query

Body Parameters

 1{
 2  "idIn": [],
 3  "idEqual": 10000001,
 4  "idLike": "sample_idLike",
 5  "createdAtGreaterThanOrEqual": "2025-01-01T10:00:00Z",
 6  "createdAtLessThanOrEqual": "2025-01-01T10:00:00Z",
 7  "createdByLike": "sample_createdByLike",
 8  "createdByEqual": "sample_createdByEqual",
 9  "modifiedAtGreaterThanOrEqual": "2025-01-01T10:00:00Z",
10  "modifiedAtLessThanOrEqual": "2025-01-01T10:00:00Z",
11  "modifiedByLike": "sample_modifiedByLike",
12  "modifiedByEqual": "sample_modifiedByEqual",
13  "sheetGroupTypeIn": {
14    "name": "LEASE_COMPONENT",
15    "captionKey": "enum.SheetGroupTypes.leaseComponent",
16    "caption": "Lease Component"
17  },
18  "requestReferencesEqual": []
19}

Responses

Status

Meaning

Description

Schema

200

OK

OK

PageNfsExportJobDto

Example Responses

 1{
 2  "totalElements": 10000001,
 3  "totalPages": 100,
 4  "pageable": {
 5    "pageNumber": 0,
 6    "unpaged": false,
 7    "paged": true,
 8    "pageSize": 100,
 9    "offset": 0,
10    "sort": {
11      "unsorted": false,
12      "sorted": true,
13      "empty": false
14    }
15  },
16  "numberOfElements": 100,
17  "size": 100,
18  "content": [],
19  "number": 100,
20  "sort": {
21    "unsorted": false,
22    "sorted": true,
23    "empty": false
24  },
25  "first": false,
26  "last": false,
27  "empty": false
28}

Create A New Schedule Export Threshold

HTTP Request

POST /api/v1/exports/schedule-export-threshold

📋 Description: Creates a new schedule export threshold with the provided information. All required fields must be included in the request body. Returns the created schedule export threshold with its assigned unique identifier.

Parameters

Name

In

Type

Required

Description

body

body

NfsExportJobDto

false

none

Body Parameters

 1{
 2  "id": 10000001,
 3  "taskCount": 100,
 4  "failedTaskCount": 100,
 5  "doneTaskCount": 100,
 6  "inProgressTaskCount": 100,
 7  "cancelledTaskCount": 100,
 8  "errorMessage": "sample_errorMessage",
 9  "batchSize": 1000,
10  "totalObjectCount": 100,
11  "queueTime": "2025-01-01T10:00:00Z",
12  "startTime": "2025-01-01T10:00:00Z",
13  "endTime": "2025-01-01T10:00:00Z",
14  "status": {
15    "name": "PROCESSING",
16    "captionKey": "enum.batchJobStatus.processing",
17    "caption": "Processing"
18  },
19  "fileStorageId": "sample_fileStorageId",
20  "generatingExportFile": false,
21  "startedGeneratingExportFileAt": "2025-01-01T10:00:00Z",
22  "version": 100,
23  "readOnly": false,
24  "docStoreId": 10000001,
25  "filter": {
26    "principalPositionType": {
27      "name": "LESSEE",
28      "captionKey": "enum.principalpositiontype.lessee",
29      "caption": "Lessee"
30    },
31    "migratedFilterType": {
32      "name": "ALL",
33      "captionKey": "enum.migratedFilterType.all",
34      "caption": "All"
35    },
36    "erpSystemIds": [],
37    "leaseAreaIds": [],
38    "businessUnitIds": [],
39    "companyIds": [],
40    "erpSystemFilterType": {
41      "name": "ALL",
42      "captionKey": "enum.filterType.all",
43      "caption": "All"
44    },
45    "leaseAreaFilterType": {
46      "name": "ALL",
47      "captionKey": "enum.filterType.all",
48      "caption": "All"
49    },
50    "businessUnitFilterType": {
51      "name": "ALL",
52      "captionKey": "enum.filterType.all",
53      "caption": "All"
54    },
55    "companyFilterType": {
56      "name": "ALL",
57      "captionKey": "enum.filterType.all",
58      "caption": "All"
59    },
60    "objectTypeFilter": {
61      "name": "CONTRACT",
62      "captionKey": "enum.listObjectType.contract",
63      "caption": "Contract"
64    },
65    "ids": [],
66    "leaseComponentRevisionId": 10000001,
67    "leaseMeasurementId": 10000001,
68    "fromYear": 100,
69    "toYear": 100,
70    "unitIds": []
71  },
72  "requestReferences": [],
73  "sheetTypes": [],
74  "sheetGroupTypes": {
75    "name": "LEASE_COMPONENT",
76    "captionKey": "enum.SheetGroupTypes.leaseComponent",
77    "caption": "Lease Component"
78  }
79}

Responses

Status

Meaning

Description

Schema

200

OK

OK

integer

Example Responses

10

Cancel Export

HTTP Request

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

📋 Description: Cancels a specified export operation within the Nakisa Lease Accounting Suite, allowing users to manage lease and contract-related financial obligations efficiently. This operation ensures that unnecessary accounting entries are not processed, maintaining accurate financial records.

Parameters

Name

In

Type

Required

Description

id

path

integer

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

200

OK

OK

None

Bulk Cancel Exports

HTTP Request

POST /api/v1/exports/cancel/bulk

📋 Description: Initiates the cancellation of multiple export requests within the Nakisa Lease Accounting Suite, ensuring the timely management of lease contracts and associated financial obligations.

Parameters

Name

In

Type

Required

Description

body

body

array[integer]

false

Request body containing an array of lease and contract identifiers for bulk cancellation of financial obligations within the Nakisa Lease Accounting Suite.

Body Parameters

1[
2  0
3]

Responses

Status

Meaning

Description

Schema

200

OK

OK

None

List All Exports

HTTP Request

GET /api/v1/exports

📋 Description: Retrieves a list of export records related to leases and contracts, enabling users to manage financial obligations and accounting entries efficiently.

Parameters

Name

In

Type

Required

Description

pageable

query

Pageable

true

Indicates whether the results of the lease export request should be returned in a paginated format, facilitating efficient data retrieval for lease, contract, and financial obligation management.

Responses

Status

Meaning

Description

Schema

200

OK

OK

PageNfsExportJobDto

Example Responses

 1{
 2  "totalElements": 10000001,
 3  "totalPages": 100,
 4  "pageable": {
 5    "pageNumber": 0,
 6    "unpaged": false,
 7    "paged": true,
 8    "pageSize": 100,
 9    "offset": 0,
10    "sort": {
11      "unsorted": false,
12      "sorted": true,
13      "empty": false
14    }
15  },
16  "numberOfElements": 100,
17  "size": 100,
18  "content": [],
19  "number": 100,
20  "sort": {
21    "unsorted": false,
22    "sorted": true,
23    "empty": false
24  },
25  "first": false,
26  "last": false,
27  "empty": false
28}

Create A New Export

HTTP Request

POST /api/v1/exports

📋 Description: Creates a new export of lease and contract data, facilitating the generation of financial obligations and accounting entries within the Nakisa Lease Accounting Suite.

Parameters

Name

In

Type

Required

Description

body

body

NfsExportJobDto

false

Request body containing the lease and contract export data, including financial obligations and accounting entries, for processing within the Nakisa Lease Accounting Suite.

Body Parameters

 1{
 2  "id": 10000001,
 3  "taskCount": 100,
 4  "failedTaskCount": 100,
 5  "doneTaskCount": 100,
 6  "inProgressTaskCount": 100,
 7  "cancelledTaskCount": 100,
 8  "errorMessage": "sample_errorMessage",
 9  "batchSize": 1000,
10  "totalObjectCount": 100,
11  "queueTime": "2025-01-01T10:00:00Z",
12  "startTime": "2025-01-01T10:00:00Z",
13  "endTime": "2025-01-01T10:00:00Z",
14  "status": {
15    "name": "PROCESSING",
16    "captionKey": "enum.batchJobStatus.processing",
17    "caption": "Processing"
18  },
19  "fileStorageId": "sample_fileStorageId",
20  "generatingExportFile": false,
21  "startedGeneratingExportFileAt": "2025-01-01T10:00:00Z",
22  "version": 100,
23  "readOnly": false,
24  "docStoreId": 10000001,
25  "filter": {
26    "principalPositionType": {
27      "name": "LESSEE",
28      "captionKey": "enum.principalpositiontype.lessee",
29      "caption": "Lessee"
30    },
31    "migratedFilterType": {
32      "name": "ALL",
33      "captionKey": "enum.migratedFilterType.all",
34      "caption": "All"
35    },
36    "erpSystemIds": [],
37    "leaseAreaIds": [],
38    "businessUnitIds": [],
39    "companyIds": [],
40    "erpSystemFilterType": {
41      "name": "ALL",
42      "captionKey": "enum.filterType.all",
43      "caption": "All"
44    },
45    "leaseAreaFilterType": {
46      "name": "ALL",
47      "captionKey": "enum.filterType.all",
48      "caption": "All"
49    },
50    "businessUnitFilterType": {
51      "name": "ALL",
52      "captionKey": "enum.filterType.all",
53      "caption": "All"
54    },
55    "companyFilterType": {
56      "name": "ALL",
57      "captionKey": "enum.filterType.all",
58      "caption": "All"
59    },
60    "objectTypeFilter": {
61      "name": "CONTRACT",
62      "captionKey": "enum.listObjectType.contract",
63      "caption": "Contract"
64    },
65    "ids": [],
66    "leaseComponentRevisionId": 10000001,
67    "leaseMeasurementId": 10000001,
68    "fromYear": 100,
69    "toYear": 100,
70    "unitIds": []
71  },
72  "requestReferences": [],
73  "sheetTypes": [],
74  "sheetGroupTypes": {
75    "name": "LEASE_COMPONENT",
76    "captionKey": "enum.SheetGroupTypes.leaseComponent",
77    "caption": "Lease Component"
78  }
79}

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseNfsExportJobDto

Example Responses

 1{
 2  "code": {
 3    "name": "OK",
 4    "captionKey": "enum.responseCode.ok",
 5    "caption": "OK"
 6  },
 7  "errors": {
 8    "all": []
 9  },
10  "object": {
11    "id": 10000001,
12    "taskCount": 100,
13    "failedTaskCount": 100,
14    "doneTaskCount": 100,
15    "inProgressTaskCount": 100,
16    "cancelledTaskCount": 100,
17    "errorMessage": "sample_errorMessage",
18    "batchSize": 1000,
19    "totalObjectCount": 100,
20    "queueTime": "2025-01-01T10:00:00Z",
21    "startTime": "2025-01-01T10:00:00Z",
22    "endTime": "2025-01-01T10:00:00Z",
23    "status": {
24      "name": "PROCESSING",
25      "captionKey": "enum.batchJobStatus.processing",
26      "caption": "Processing"
27    },
28    "fileStorageId": "sample_fileStorageId",
29    "generatingExportFile": false,
30    "startedGeneratingExportFileAt": "2025-01-01T10:00:00Z",
31    "version": 100,
32    "readOnly": false,
33    "docStoreId": 10000001,
34    "filter": {
35      "principalPositionType": {
36        "name": "LESSEE",
37        "captionKey": "enum.principalpositiontype.lessee",
38        "caption": "Lessee"
39      },
40      "migratedFilterType": {
41        "name": "ALL",
42        "captionKey": "enum.migratedFilterType.all",
43        "caption": "All"
44      },
45      "erpSystemIds": [],
46      "leaseAreaIds": [],
47      "businessUnitIds": [],
48      "companyIds": [],
49      "erpSystemFilterType": {
50        "name": "ALL",
51        "captionKey": "enum.filterType.all",
52        "caption": "All"
53      },
54      "leaseAreaFilterType": {
55        "name": "ALL",
56        "captionKey": "enum.filterType.all",
57        "caption": "All"
58      },
59      "businessUnitFilterType": {
60        "name": "ALL",
61        "captionKey": "enum.filterType.all",
62        "caption": "All"
63      },
64      "companyFilterType": {
65        "name": "ALL",
66        "captionKey": "enum.filterType.all",
67        "caption": "All"
68      },
69      "objectTypeFilter": {
70        "name": "CONTRACT",
71        "captionKey": "enum.listObjectType.contract",
72        "caption": "Contract"
73      },
74      "ids": [],
75      "leaseComponentRevisionId": 10000001,
76      "leaseMeasurementId": 10000001,
77      "fromYear": 100,
78      "toYear": 100,
79      "unitIds": []
80    },
81    "requestReferences": [],
82    "sheetTypes": [],
83    "sheetGroupTypes": {
84      "name": "LEASE_COMPONENT",
85      "captionKey": "enum.SheetGroupTypes.leaseComponent",
86      "caption": "Lease Component"
87    }
88  }
89}

Get Export By ID (With Task And Task ID)

HTTP Request

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

📋 Description: Retrieves detailed export reports for a specific task identified by the taskId, providing insights into lease, contract, financial obligation, and accounting entry data 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

 1[
 2  {
 3    "id": 10000001,
 4    "exportTaskId": 10000001,
 5    "sheetType": {
 6      "persistentId": "sample_persistentId",
 7      "rowCaption": "sample_rowCaption",
 8      "sheetGroupType": {
 9        "name": "LEASE_COMPONENT",
10        "captionKey": "enum.SheetGroupTypes.leaseComponent",
11        "caption": "Lease Component"
12      },
13      "sheetCaption": "sample_sheetCaption",
14      "tabCaption": "sample_tabCaption",
15      "principalPositionMode": {
16        "name": "LESSEE",
17        "captionKey": "enum.principalPositionMode.lessee",
18        "caption": "Lessee"
19      },
20      "order": 100,
21      "name": "Sample Name"
22    },
23    "startedAt": "2025-01-01T10:00:00Z",
24    "finishedAt": "2025-01-01T10:00:00Z",
25    "doneItemCount": 100,
26    "failedItemCount": 100,
27    "skippedItemCount": 100,
28    "cancelledItemCount": 100,
29    "totalItemCount": 100
30  }
31]

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[NfsExportItemDto]

false

none

[NfsExportItemDto is a data transfer object that encapsulates the details of lease-related financial obligations and accounting entries within the Nakisa Lease Accounting Suite, facilitating efficient management and reporting of contract data.]

» id

integer(int64)

false

none

Unique identifier for the resource

» exportTaskId

integer(int64)

false

none

Unique identifier for the export 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 NfsExportItemDto

» finishedAt

string(date-time)

false

none

Text value for finishedAt in NfsExportItemDto

» 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

Get Export By ID

HTTP Request

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

📋 Description: Retrieves the export report associated with a specific job ID, providing insights into lease, contract, and financial obligation data relevant to 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

 1[
 2  {
 3    "ids": [],
 4    "sheetType": {
 5      "persistentId": "sample_persistentId",
 6      "rowCaption": "sample_rowCaption",
 7      "sheetGroupType": {
 8        "name": "LEASE_COMPONENT",
 9        "captionKey": "enum.SheetGroupTypes.leaseComponent",
10        "caption": "Lease Component"
11      },
12      "sheetCaption": "sample_sheetCaption",
13      "tabCaption": "sample_tabCaption",
14      "principalPositionMode": {
15        "name": "LESSEE",
16        "captionKey": "enum.principalPositionMode.lessee",
17        "caption": "Lessee"
18      },
19      "order": 100,
20      "name": "Sample Name"
21    },
22    "startedAt": "2025-01-01T10:00:00Z",
23    "finishedAt": "2025-01-01T10:00:00Z",
24    "doneItemCount": 100,
25    "failedItemCount": 100,
26    "skippedItemCount": 100,
27    "cancelledItemCount": 100,
28    "totalItemCount": 100
29  }
30]

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[NfsJobExportItemDto]

false

none

[NfsJobExportItemDto is a data transfer object that encapsulates the details of a lease or contract-related financial obligation, facilitating the export of 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 NfsJobExportItemDto

» finishedAt

string(date-time)

false

none

Text value for finishedAt in NfsJobExportItemDto

» 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

List All List All Object Typess

HTTP Request

GET /api/v1/exports/list-all-object-types

📋 Description: Retrieves a comprehensive list of all object types related to leases, contracts, financial obligations, and accounting entries within the Nakisa Lease Accounting Suite.

Responses

Status

Meaning

Description

Schema

200

OK

OK

Inline

Example Responses

1[
2  "string"
3]

Response Schema

Retrieve A Specific Generate

HTTP Request

GET /api/v1/exports/generate/{id}

📋 Description: Generates and retrieves export data for a specific lease or contract identified by the provided ID, facilitating the management 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

Retrieve A Specific Download

HTTP Request

GET /api/v1/exports/download/{id}

📋 Description: Downloads the specified export file associated with a lease or contract, enabling users to access financial obligations and accounting entries efficiently.

Parameters

Name

In

Type

Required

Description

id

path

integer

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

200

OK

OK

None