Mass Modification Job¶
Get Mass Modification Job By ID¶
HTTP Request
GET /api/v1/batch/mass-modification/jobs/{id}
📋 Description: Retrieves the details of a specific mass modification job identified by the provided job ID within the Nakisa Lease Accounting Suite, facilitating effective management of lease contracts and associated financial obligations.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
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 "queueTime": "2025-01-01T10:00:00Z",
19 "startTime": "2025-01-01T10:00:00Z",
20 "endTime": "2025-01-01T10:00:00Z",
21 "status": {
22 "name": "PROCESSING",
23 "captionKey": "enum.batchJobStatus.processing",
24 "caption": "Processing"
25 },
26 "executor": {
27 "name": "MANUAL",
28 "captionKey": "enum.batchJobExecutor.manual",
29 "caption": "Manual"
30 },
31 "scheduleJobId": 10000001,
32 "batchSize": 100,
33 "totalObjectCount": 100,
34 "readOnly": false,
35 "profileId": 10000001,
36 "unauthorized": false,
37 "stage": {
38 "name": "PROCESSING_MASS_MODIFICATION",
39 "captionKey": "enum.massModificationStage.processingMassModification",
40 "caption": "Processing Mass Modification"
41 },
42 "inputFile": {
43 "templateFileStorageId": "template-file-uuid-12345",
44 "inputFileStorageId": "input-file-uuid-67890",
45 "generatingTemplateFile": false,
46 "startedGeneratingTemplateFileAt": "2024-01-15T10:30:00Z",
47 "finishedGeneratingTemplateFileAt": "2024-01-15T10:35:00Z",
48 "inputFileName": "mass_transfer_input_2024.xlsx",
49 "templateDocStoreId": 40000001,
50 "inputDocStoreId": 40000002
51 },
52 "filter": {
53 "id": 10000001,
54 "profileId": 10000001,
55 "jobId": 10000001,
56 "name": "Sample Name",
57 "principalPositionType": {
58 "name": "LESSEE",
59 "captionKey": "enum.principalpositiontype.lessee",
60 "caption": "Lessee"
61 },
62 "skipItemsWithOpenDraft": false,
63 "filterTypes": {
64 "erpSystemFilterType": {
65 "name": "ALL",
66 "captionKey": "enum.filterType.all",
67 "caption": "All"
68 },
69 "erpSystems": [],
70 "leaseAreaFilterType": {
71 "name": "ALL",
72 "captionKey": "enum.filterType.all",
73 "caption": "All"
74 },
75 "leaseAreas": [],
76 "businessUnitFilterType": {
77 "name": "ALL",
78 "captionKey": "enum.filterType.all",
79 "caption": "All"
80 },
81 "businessUnits": [],
82 "companyFilterType": {
83 "name": "ALL",
84 "captionKey": "enum.filterType.all",
85 "caption": "All"
86 },
87 "companies": [],
88 "leaseDepartmentFilterType": {
89 "name": "ALL",
90 "captionKey": "enum.filterType.all",
91 "caption": "All"
92 },
93 "leaseDepartments": [],
94 "leaseGroupFilterType": {
95 "name": "ALL",
96 "captionKey": "enum.filterType.all",
97 "caption": "All"
98 },
99 "leaseGroups": [],
100 "costCenterFilterType": {
101 "name": "ALL",
102 "captionKey": "enum.filterType.all",
103 "caption": "All"
104 },
105 "costCenters": [],
106 "profitCenterFilterType": {
107 "name": "ALL",
108 "captionKey": "enum.filterType.all",
109 "caption": "All"
110 },
111 "profitCenters": [],
112 "wbsFilterType": {
113 "name": "ALL",
114 "captionKey": "enum.filterType.all",
115 "caption": "All"
116 },
117 "wbses": [],
118 "businessAreaFilterType": {
119 "name": "ALL",
120 "captionKey": "enum.filterType.all",
121 "caption": "All"
122 },
123 "businessAreas": [],
124 "functionalAreaFilterType": {
125 "name": "ALL",
126 "captionKey": "enum.filterType.all",
127 "caption": "All"
128 },
129 "functionalAreas": []
130 },
131 "listObjectType": {
132 "name": "CONTRACT",
133 "captionKey": "enum.listObjectType.contract",
134 "caption": "Contract"
135 },
136 "objectList": []
137 },
138 "input": {
139 "id": 10000001,
140 "modificationTypes": {
141 "name": "LEASE_COMPONENT_MODIFICATION",
142 "captionKey": "enum.modificationType.leaseComponentModification",
143 "caption": "Lease Component Modification"
144 },
145 "applyGlobalOnEventName": false,
146 "leaseComponentEventName": "sample_leaseComponentEventName",
147 "activationGroupEventName": "sample_activationGroupEventName",
148 "applyGlobalOnEffectiveDates": false,
149 "effectiveDateType": {
150 "name": "JOB_DATE",
151 "captionKey": "enum.modificationDateType.jobDate",
152 "caption": "Job Date"
153 },
154 "effectiveDate": "2025-01-01",
155 "applyGlobalOnModificationDates": false,
156 "modificationDateType": {
157 "name": "JOB_DATE",
158 "captionKey": "enum.modificationDateType.jobDate",
159 "caption": "Job Date"
160 },
161 "modificationDate": "2025-01-01",
162 "activationDateType": {
163 "name": "JOB_DATE",
164 "captionKey": "enum.modificationDateType.jobDate",
165 "caption": "Job Date"
166 },
167 "postingDate": "2025-01-01",
168 "documentDate": "2025-01-01",
169 "translationDate": "2025-01-01",
170 "applyGlobalOnContractRate": false,
171 "useAutoRate": false,
172 "contractRate": 1000,
173 "applyGlobalOnTermFlags": false,
174 "exerciseTermType": {
175 "name": "APPLY_ON_ALL_TERMS",
176 "captionKey": "enum.termApplicationType.applyOnAllTerms",
177 "caption": "Apply On All Terms"
178 },
179 "applyIndexationTermType": {
180 "name": "APPLY_ON_ALL_TERMS",
181 "captionKey": "enum.termApplicationType.applyOnAllTerms",
182 "caption": "Apply On All Terms"
183 },
184 "migratedFilterType": {
185 "name": "ALL",
186 "captionKey": "enum.migratedFilterType.all",
187 "caption": "All"
188 }
189 },
190 "tasks": []
191 }
192}
Update Mass Modification Job¶
HTTP Request
PUT /api/v1/batch/mass-modification/jobs/{id}
📋 Description: Updates the specified mass modification job within the Nakisa Lease Accounting Suite, allowing users to adjust lease, contract, and financial obligation details efficiently to ensure accurate accounting entries.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer |
true |
Unique identifier for the resource |
body |
body |
false |
Request body containing the updated lease and contract details, including financial obligations and accounting entries, for the specified mass modification job. |
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 "queueTime": "2025-01-01T10:00:00Z",
10 "startTime": "2025-01-01T10:00:00Z",
11 "endTime": "2025-01-01T10:00:00Z",
12 "status": {
13 "name": "PROCESSING",
14 "captionKey": "enum.batchJobStatus.processing",
15 "caption": "Processing"
16 },
17 "executor": {
18 "name": "MANUAL",
19 "captionKey": "enum.batchJobExecutor.manual",
20 "caption": "Manual"
21 },
22 "scheduleJobId": 10000001,
23 "batchSize": 100,
24 "totalObjectCount": 100,
25 "readOnly": false,
26 "profileId": 10000001,
27 "unauthorized": false,
28 "stage": {
29 "name": "PROCESSING_MASS_MODIFICATION",
30 "captionKey": "enum.massModificationStage.processingMassModification",
31 "caption": "Processing Mass Modification"
32 },
33 "inputFile": {
34 "templateFileStorageId": "template-file-uuid-12345",
35 "inputFileStorageId": "input-file-uuid-67890",
36 "generatingTemplateFile": false,
37 "startedGeneratingTemplateFileAt": "2024-01-15T10:30:00Z",
38 "finishedGeneratingTemplateFileAt": "2024-01-15T10:35:00Z",
39 "inputFileName": "mass_transfer_input_2024.xlsx",
40 "templateDocStoreId": 40000001,
41 "inputDocStoreId": 40000002
42 },
43 "filter": {
44 "id": 10000001,
45 "profileId": 10000001,
46 "jobId": 10000001,
47 "name": "Sample Name",
48 "principalPositionType": {
49 "name": "LESSEE",
50 "captionKey": "enum.principalpositiontype.lessee",
51 "caption": "Lessee"
52 },
53 "skipItemsWithOpenDraft": false,
54 "filterTypes": {
55 "erpSystemFilterType": {
56 "name": "ALL",
57 "captionKey": "enum.filterType.all",
58 "caption": "All"
59 },
60 "erpSystems": [],
61 "leaseAreaFilterType": {
62 "name": "ALL",
63 "captionKey": "enum.filterType.all",
64 "caption": "All"
65 },
66 "leaseAreas": [],
67 "businessUnitFilterType": {
68 "name": "ALL",
69 "captionKey": "enum.filterType.all",
70 "caption": "All"
71 },
72 "businessUnits": [],
73 "companyFilterType": {
74 "name": "ALL",
75 "captionKey": "enum.filterType.all",
76 "caption": "All"
77 },
78 "companies": [],
79 "leaseDepartmentFilterType": {
80 "name": "ALL",
81 "captionKey": "enum.filterType.all",
82 "caption": "All"
83 },
84 "leaseDepartments": [],
85 "leaseGroupFilterType": {
86 "name": "ALL",
87 "captionKey": "enum.filterType.all",
88 "caption": "All"
89 },
90 "leaseGroups": [],
91 "costCenterFilterType": {
92 "name": "ALL",
93 "captionKey": "enum.filterType.all",
94 "caption": "All"
95 },
96 "costCenters": [],
97 "profitCenterFilterType": {
98 "name": "ALL",
99 "captionKey": "enum.filterType.all",
100 "caption": "All"
101 },
102 "profitCenters": [],
103 "wbsFilterType": {
104 "name": "ALL",
105 "captionKey": "enum.filterType.all",
106 "caption": "All"
107 },
108 "wbses": [],
109 "businessAreaFilterType": {
110 "name": "ALL",
111 "captionKey": "enum.filterType.all",
112 "caption": "All"
113 },
114 "businessAreas": [],
115 "functionalAreaFilterType": {
116 "name": "ALL",
117 "captionKey": "enum.filterType.all",
118 "caption": "All"
119 },
120 "functionalAreas": []
121 },
122 "listObjectType": {
123 "name": "CONTRACT",
124 "captionKey": "enum.listObjectType.contract",
125 "caption": "Contract"
126 },
127 "objectList": []
128 },
129 "input": {
130 "id": 10000001,
131 "modificationTypes": {
132 "name": "LEASE_COMPONENT_MODIFICATION",
133 "captionKey": "enum.modificationType.leaseComponentModification",
134 "caption": "Lease Component Modification"
135 },
136 "applyGlobalOnEventName": false,
137 "leaseComponentEventName": "sample_leaseComponentEventName",
138 "activationGroupEventName": "sample_activationGroupEventName",
139 "applyGlobalOnEffectiveDates": false,
140 "effectiveDateType": {
141 "name": "JOB_DATE",
142 "captionKey": "enum.modificationDateType.jobDate",
143 "caption": "Job Date"
144 },
145 "effectiveDate": "2025-01-01",
146 "applyGlobalOnModificationDates": false,
147 "modificationDateType": {
148 "name": "JOB_DATE",
149 "captionKey": "enum.modificationDateType.jobDate",
150 "caption": "Job Date"
151 },
152 "modificationDate": "2025-01-01",
153 "activationDateType": {
154 "name": "JOB_DATE",
155 "captionKey": "enum.modificationDateType.jobDate",
156 "caption": "Job Date"
157 },
158 "postingDate": "2025-01-01",
159 "documentDate": "2025-01-01",
160 "translationDate": "2025-01-01",
161 "applyGlobalOnContractRate": false,
162 "useAutoRate": false,
163 "contractRate": 1000,
164 "applyGlobalOnTermFlags": false,
165 "exerciseTermType": {
166 "name": "APPLY_ON_ALL_TERMS",
167 "captionKey": "enum.termApplicationType.applyOnAllTerms",
168 "caption": "Apply On All Terms"
169 },
170 "applyIndexationTermType": {
171 "name": "APPLY_ON_ALL_TERMS",
172 "captionKey": "enum.termApplicationType.applyOnAllTerms",
173 "caption": "Apply On All Terms"
174 },
175 "migratedFilterType": {
176 "name": "ALL",
177 "captionKey": "enum.migratedFilterType.all",
178 "caption": "All"
179 }
180 },
181 "tasks": []
182}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
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 "queueTime": "2025-01-01T10:00:00Z",
19 "startTime": "2025-01-01T10:00:00Z",
20 "endTime": "2025-01-01T10:00:00Z",
21 "status": {
22 "name": "PROCESSING",
23 "captionKey": "enum.batchJobStatus.processing",
24 "caption": "Processing"
25 },
26 "executor": {
27 "name": "MANUAL",
28 "captionKey": "enum.batchJobExecutor.manual",
29 "caption": "Manual"
30 },
31 "scheduleJobId": 10000001,
32 "batchSize": 100,
33 "totalObjectCount": 100,
34 "readOnly": false,
35 "profileId": 10000001,
36 "unauthorized": false,
37 "stage": {
38 "name": "PROCESSING_MASS_MODIFICATION",
39 "captionKey": "enum.massModificationStage.processingMassModification",
40 "caption": "Processing Mass Modification"
41 },
42 "inputFile": {
43 "templateFileStorageId": "template-file-uuid-12345",
44 "inputFileStorageId": "input-file-uuid-67890",
45 "generatingTemplateFile": false,
46 "startedGeneratingTemplateFileAt": "2024-01-15T10:30:00Z",
47 "finishedGeneratingTemplateFileAt": "2024-01-15T10:35:00Z",
48 "inputFileName": "mass_transfer_input_2024.xlsx",
49 "templateDocStoreId": 40000001,
50 "inputDocStoreId": 40000002
51 },
52 "filter": {
53 "id": 10000001,
54 "profileId": 10000001,
55 "jobId": 10000001,
56 "name": "Sample Name",
57 "principalPositionType": {
58 "name": "LESSEE",
59 "captionKey": "enum.principalpositiontype.lessee",
60 "caption": "Lessee"
61 },
62 "skipItemsWithOpenDraft": false,
63 "filterTypes": {
64 "erpSystemFilterType": {
65 "name": "ALL",
66 "captionKey": "enum.filterType.all",
67 "caption": "All"
68 },
69 "erpSystems": [],
70 "leaseAreaFilterType": {
71 "name": "ALL",
72 "captionKey": "enum.filterType.all",
73 "caption": "All"
74 },
75 "leaseAreas": [],
76 "businessUnitFilterType": {
77 "name": "ALL",
78 "captionKey": "enum.filterType.all",
79 "caption": "All"
80 },
81 "businessUnits": [],
82 "companyFilterType": {
83 "name": "ALL",
84 "captionKey": "enum.filterType.all",
85 "caption": "All"
86 },
87 "companies": [],
88 "leaseDepartmentFilterType": {
89 "name": "ALL",
90 "captionKey": "enum.filterType.all",
91 "caption": "All"
92 },
93 "leaseDepartments": [],
94 "leaseGroupFilterType": {
95 "name": "ALL",
96 "captionKey": "enum.filterType.all",
97 "caption": "All"
98 },
99 "leaseGroups": [],
100 "costCenterFilterType": {
101 "name": "ALL",
102 "captionKey": "enum.filterType.all",
103 "caption": "All"
104 },
105 "costCenters": [],
106 "profitCenterFilterType": {
107 "name": "ALL",
108 "captionKey": "enum.filterType.all",
109 "caption": "All"
110 },
111 "profitCenters": [],
112 "wbsFilterType": {
113 "name": "ALL",
114 "captionKey": "enum.filterType.all",
115 "caption": "All"
116 },
117 "wbses": [],
118 "businessAreaFilterType": {
119 "name": "ALL",
120 "captionKey": "enum.filterType.all",
121 "caption": "All"
122 },
123 "businessAreas": [],
124 "functionalAreaFilterType": {
125 "name": "ALL",
126 "captionKey": "enum.filterType.all",
127 "caption": "All"
128 },
129 "functionalAreas": []
130 },
131 "listObjectType": {
132 "name": "CONTRACT",
133 "captionKey": "enum.listObjectType.contract",
134 "caption": "Contract"
135 },
136 "objectList": []
137 },
138 "input": {
139 "id": 10000001,
140 "modificationTypes": {
141 "name": "LEASE_COMPONENT_MODIFICATION",
142 "captionKey": "enum.modificationType.leaseComponentModification",
143 "caption": "Lease Component Modification"
144 },
145 "applyGlobalOnEventName": false,
146 "leaseComponentEventName": "sample_leaseComponentEventName",
147 "activationGroupEventName": "sample_activationGroupEventName",
148 "applyGlobalOnEffectiveDates": false,
149 "effectiveDateType": {
150 "name": "JOB_DATE",
151 "captionKey": "enum.modificationDateType.jobDate",
152 "caption": "Job Date"
153 },
154 "effectiveDate": "2025-01-01",
155 "applyGlobalOnModificationDates": false,
156 "modificationDateType": {
157 "name": "JOB_DATE",
158 "captionKey": "enum.modificationDateType.jobDate",
159 "caption": "Job Date"
160 },
161 "modificationDate": "2025-01-01",
162 "activationDateType": {
163 "name": "JOB_DATE",
164 "captionKey": "enum.modificationDateType.jobDate",
165 "caption": "Job Date"
166 },
167 "postingDate": "2025-01-01",
168 "documentDate": "2025-01-01",
169 "translationDate": "2025-01-01",
170 "applyGlobalOnContractRate": false,
171 "useAutoRate": false,
172 "contractRate": 1000,
173 "applyGlobalOnTermFlags": false,
174 "exerciseTermType": {
175 "name": "APPLY_ON_ALL_TERMS",
176 "captionKey": "enum.termApplicationType.applyOnAllTerms",
177 "caption": "Apply On All Terms"
178 },
179 "applyIndexationTermType": {
180 "name": "APPLY_ON_ALL_TERMS",
181 "captionKey": "enum.termApplicationType.applyOnAllTerms",
182 "caption": "Apply On All Terms"
183 },
184 "migratedFilterType": {
185 "name": "ALL",
186 "captionKey": "enum.migratedFilterType.all",
187 "caption": "All"
188 }
189 },
190 "tasks": []
191 }
192}
Bulk Upsert Mass Modification Jobs¶
HTTP Request
PUT /api/v1/batch/mass-modification/jobs/createOrUpdate/bulk
📋 Description: Creates or updates multiple lease-related jobs in bulk within the Nakisa Lease Accounting Suite, facilitating efficient management of contracts and financial obligations.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
false |
Request body containing bulk data for creating or updating lease contracts, financial obligations, and accounting entries 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 "queueTime": "2025-01-01T10:00:00Z",
11 "startTime": "2025-01-01T10:00:00Z",
12 "endTime": "2025-01-01T10:00:00Z",
13 "status": {
14 "name": "PROCESSING",
15 "captionKey": "enum.batchJobStatus.processing",
16 "caption": "Processing"
17 },
18 "executor": {
19 "name": "MANUAL",
20 "captionKey": "enum.batchJobExecutor.manual",
21 "caption": "Manual"
22 },
23 "scheduleJobId": 10000001,
24 "batchSize": 100,
25 "totalObjectCount": 100,
26 "readOnly": false,
27 "profileId": 10000001,
28 "unauthorized": false,
29 "stage": {
30 "name": "PROCESSING_MASS_MODIFICATION",
31 "captionKey": "enum.massModificationStage.processingMassModification",
32 "caption": "Processing Mass Modification"
33 },
34 "inputFile": {
35 "templateFileStorageId": "template-file-uuid-12345",
36 "inputFileStorageId": "input-file-uuid-67890",
37 "generatingTemplateFile": false,
38 "startedGeneratingTemplateFileAt": "2024-01-15T10:30:00Z",
39 "finishedGeneratingTemplateFileAt": "2024-01-15T10:35:00Z",
40 "inputFileName": "mass_transfer_input_2024.xlsx",
41 "templateDocStoreId": 40000001,
42 "inputDocStoreId": 40000002
43 },
44 "filter": {
45 "id": 10000001,
46 "profileId": 10000001,
47 "jobId": 10000001,
48 "name": "Sample Name",
49 "principalPositionType": {
50 "name": "LESSEE",
51 "captionKey": "enum.principalpositiontype.lessee",
52 "caption": "Lessee"
53 },
54 "skipItemsWithOpenDraft": false,
55 "filterTypes": {
56 "erpSystemFilterType": {
57 "name": "ALL",
58 "captionKey": "enum.filterType.all",
59 "caption": "All"
60 },
61 "erpSystems": [],
62 "leaseAreaFilterType": {
63 "name": "ALL",
64 "captionKey": "enum.filterType.all",
65 "caption": "All"
66 },
67 "leaseAreas": [],
68 "businessUnitFilterType": {
69 "name": "ALL",
70 "captionKey": "enum.filterType.all",
71 "caption": "All"
72 },
73 "businessUnits": [],
74 "companyFilterType": {
75 "name": "ALL",
76 "captionKey": "enum.filterType.all",
77 "caption": "All"
78 },
79 "companies": [],
80 "leaseDepartmentFilterType": {
81 "name": "ALL",
82 "captionKey": "enum.filterType.all",
83 "caption": "All"
84 },
85 "leaseDepartments": [],
86 "leaseGroupFilterType": {
87 "name": "ALL",
88 "captionKey": "enum.filterType.all",
89 "caption": "All"
90 },
91 "leaseGroups": [],
92 "costCenterFilterType": {
93 "name": "ALL",
94 "captionKey": "enum.filterType.all",
95 "caption": "All"
96 },
97 "costCenters": [],
98 "profitCenterFilterType": {
99 "name": "ALL",
100 "captionKey": "enum.filterType.all",
101 "caption": "All"
102 },
103 "profitCenters": [],
104 "wbsFilterType": {
105 "name": "ALL",
106 "captionKey": "enum.filterType.all",
107 "caption": "All"
108 },
109 "wbses": [],
110 "businessAreaFilterType": {
111 "name": "ALL",
112 "captionKey": "enum.filterType.all",
113 "caption": "All"
114 },
115 "businessAreas": [],
116 "functionalAreaFilterType": {
117 "name": "ALL",
118 "captionKey": "enum.filterType.all",
119 "caption": "All"
120 },
121 "functionalAreas": []
122 },
123 "listObjectType": {
124 "name": "CONTRACT",
125 "captionKey": "enum.listObjectType.contract",
126 "caption": "Contract"
127 },
128 "objectList": []
129 },
130 "input": {
131 "id": 10000001,
132 "modificationTypes": {
133 "name": "LEASE_COMPONENT_MODIFICATION",
134 "captionKey": "enum.modificationType.leaseComponentModification",
135 "caption": "Lease Component Modification"
136 },
137 "applyGlobalOnEventName": false,
138 "leaseComponentEventName": "sample_leaseComponentEventName",
139 "activationGroupEventName": "sample_activationGroupEventName",
140 "applyGlobalOnEffectiveDates": false,
141 "effectiveDateType": {
142 "name": "JOB_DATE",
143 "captionKey": "enum.modificationDateType.jobDate",
144 "caption": "Job Date"
145 },
146 "effectiveDate": "2025-01-01",
147 "applyGlobalOnModificationDates": false,
148 "modificationDateType": {
149 "name": "JOB_DATE",
150 "captionKey": "enum.modificationDateType.jobDate",
151 "caption": "Job Date"
152 },
153 "modificationDate": "2025-01-01",
154 "activationDateType": {
155 "name": "JOB_DATE",
156 "captionKey": "enum.modificationDateType.jobDate",
157 "caption": "Job Date"
158 },
159 "postingDate": "2025-01-01",
160 "documentDate": "2025-01-01",
161 "translationDate": "2025-01-01",
162 "applyGlobalOnContractRate": false,
163 "useAutoRate": false,
164 "contractRate": 1000,
165 "applyGlobalOnTermFlags": false,
166 "exerciseTermType": {
167 "name": "APPLY_ON_ALL_TERMS",
168 "captionKey": "enum.termApplicationType.applyOnAllTerms",
169 "caption": "Apply On All Terms"
170 },
171 "applyIndexationTermType": {
172 "name": "APPLY_ON_ALL_TERMS",
173 "captionKey": "enum.termApplicationType.applyOnAllTerms",
174 "caption": "Apply On All Terms"
175 },
176 "migratedFilterType": {
177 "name": "ALL",
178 "captionKey": "enum.migratedFilterType.all",
179 "caption": "All"
180 }
181 },
182 "tasks": []
183 }
184]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
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 Mass Modification Job¶
HTTP Request
PUT /api/v1/batch/mass-modification/jobs/createOrUpdate
📋 Description: Creates or updates mass modification jobs for leases, contracts, financial obligations, and accounting entries within the Nakisa Lease Accounting Suite, ensuring efficient management of bulk changes.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
false |
Request body containing lease and contract modification data, including financial obligations and accounting entries, for creating or updating mass modification jobs. |
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 "queueTime": "2025-01-01T10:00:00Z",
10 "startTime": "2025-01-01T10:00:00Z",
11 "endTime": "2025-01-01T10:00:00Z",
12 "status": {
13 "name": "PROCESSING",
14 "captionKey": "enum.batchJobStatus.processing",
15 "caption": "Processing"
16 },
17 "executor": {
18 "name": "MANUAL",
19 "captionKey": "enum.batchJobExecutor.manual",
20 "caption": "Manual"
21 },
22 "scheduleJobId": 10000001,
23 "batchSize": 100,
24 "totalObjectCount": 100,
25 "readOnly": false,
26 "profileId": 10000001,
27 "unauthorized": false,
28 "stage": {
29 "name": "PROCESSING_MASS_MODIFICATION",
30 "captionKey": "enum.massModificationStage.processingMassModification",
31 "caption": "Processing Mass Modification"
32 },
33 "inputFile": {
34 "templateFileStorageId": "template-file-uuid-12345",
35 "inputFileStorageId": "input-file-uuid-67890",
36 "generatingTemplateFile": false,
37 "startedGeneratingTemplateFileAt": "2024-01-15T10:30:00Z",
38 "finishedGeneratingTemplateFileAt": "2024-01-15T10:35:00Z",
39 "inputFileName": "mass_transfer_input_2024.xlsx",
40 "templateDocStoreId": 40000001,
41 "inputDocStoreId": 40000002
42 },
43 "filter": {
44 "id": 10000001,
45 "profileId": 10000001,
46 "jobId": 10000001,
47 "name": "Sample Name",
48 "principalPositionType": {
49 "name": "LESSEE",
50 "captionKey": "enum.principalpositiontype.lessee",
51 "caption": "Lessee"
52 },
53 "skipItemsWithOpenDraft": false,
54 "filterTypes": {
55 "erpSystemFilterType": {
56 "name": "ALL",
57 "captionKey": "enum.filterType.all",
58 "caption": "All"
59 },
60 "erpSystems": [],
61 "leaseAreaFilterType": {
62 "name": "ALL",
63 "captionKey": "enum.filterType.all",
64 "caption": "All"
65 },
66 "leaseAreas": [],
67 "businessUnitFilterType": {
68 "name": "ALL",
69 "captionKey": "enum.filterType.all",
70 "caption": "All"
71 },
72 "businessUnits": [],
73 "companyFilterType": {
74 "name": "ALL",
75 "captionKey": "enum.filterType.all",
76 "caption": "All"
77 },
78 "companies": [],
79 "leaseDepartmentFilterType": {
80 "name": "ALL",
81 "captionKey": "enum.filterType.all",
82 "caption": "All"
83 },
84 "leaseDepartments": [],
85 "leaseGroupFilterType": {
86 "name": "ALL",
87 "captionKey": "enum.filterType.all",
88 "caption": "All"
89 },
90 "leaseGroups": [],
91 "costCenterFilterType": {
92 "name": "ALL",
93 "captionKey": "enum.filterType.all",
94 "caption": "All"
95 },
96 "costCenters": [],
97 "profitCenterFilterType": {
98 "name": "ALL",
99 "captionKey": "enum.filterType.all",
100 "caption": "All"
101 },
102 "profitCenters": [],
103 "wbsFilterType": {
104 "name": "ALL",
105 "captionKey": "enum.filterType.all",
106 "caption": "All"
107 },
108 "wbses": [],
109 "businessAreaFilterType": {
110 "name": "ALL",
111 "captionKey": "enum.filterType.all",
112 "caption": "All"
113 },
114 "businessAreas": [],
115 "functionalAreaFilterType": {
116 "name": "ALL",
117 "captionKey": "enum.filterType.all",
118 "caption": "All"
119 },
120 "functionalAreas": []
121 },
122 "listObjectType": {
123 "name": "CONTRACT",
124 "captionKey": "enum.listObjectType.contract",
125 "caption": "Contract"
126 },
127 "objectList": []
128 },
129 "input": {
130 "id": 10000001,
131 "modificationTypes": {
132 "name": "LEASE_COMPONENT_MODIFICATION",
133 "captionKey": "enum.modificationType.leaseComponentModification",
134 "caption": "Lease Component Modification"
135 },
136 "applyGlobalOnEventName": false,
137 "leaseComponentEventName": "sample_leaseComponentEventName",
138 "activationGroupEventName": "sample_activationGroupEventName",
139 "applyGlobalOnEffectiveDates": false,
140 "effectiveDateType": {
141 "name": "JOB_DATE",
142 "captionKey": "enum.modificationDateType.jobDate",
143 "caption": "Job Date"
144 },
145 "effectiveDate": "2025-01-01",
146 "applyGlobalOnModificationDates": false,
147 "modificationDateType": {
148 "name": "JOB_DATE",
149 "captionKey": "enum.modificationDateType.jobDate",
150 "caption": "Job Date"
151 },
152 "modificationDate": "2025-01-01",
153 "activationDateType": {
154 "name": "JOB_DATE",
155 "captionKey": "enum.modificationDateType.jobDate",
156 "caption": "Job Date"
157 },
158 "postingDate": "2025-01-01",
159 "documentDate": "2025-01-01",
160 "translationDate": "2025-01-01",
161 "applyGlobalOnContractRate": false,
162 "useAutoRate": false,
163 "contractRate": 1000,
164 "applyGlobalOnTermFlags": false,
165 "exerciseTermType": {
166 "name": "APPLY_ON_ALL_TERMS",
167 "captionKey": "enum.termApplicationType.applyOnAllTerms",
168 "caption": "Apply On All Terms"
169 },
170 "applyIndexationTermType": {
171 "name": "APPLY_ON_ALL_TERMS",
172 "captionKey": "enum.termApplicationType.applyOnAllTerms",
173 "caption": "Apply On All Terms"
174 },
175 "migratedFilterType": {
176 "name": "ALL",
177 "captionKey": "enum.migratedFilterType.all",
178 "caption": "All"
179 }
180 },
181 "tasks": []
182}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
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 "queueTime": "2025-01-01T10:00:00Z",
19 "startTime": "2025-01-01T10:00:00Z",
20 "endTime": "2025-01-01T10:00:00Z",
21 "status": {
22 "name": "PROCESSING",
23 "captionKey": "enum.batchJobStatus.processing",
24 "caption": "Processing"
25 },
26 "executor": {
27 "name": "MANUAL",
28 "captionKey": "enum.batchJobExecutor.manual",
29 "caption": "Manual"
30 },
31 "scheduleJobId": 10000001,
32 "batchSize": 100,
33 "totalObjectCount": 100,
34 "readOnly": false,
35 "profileId": 10000001,
36 "unauthorized": false,
37 "stage": {
38 "name": "PROCESSING_MASS_MODIFICATION",
39 "captionKey": "enum.massModificationStage.processingMassModification",
40 "caption": "Processing Mass Modification"
41 },
42 "inputFile": {
43 "templateFileStorageId": "template-file-uuid-12345",
44 "inputFileStorageId": "input-file-uuid-67890",
45 "generatingTemplateFile": false,
46 "startedGeneratingTemplateFileAt": "2024-01-15T10:30:00Z",
47 "finishedGeneratingTemplateFileAt": "2024-01-15T10:35:00Z",
48 "inputFileName": "mass_transfer_input_2024.xlsx",
49 "templateDocStoreId": 40000001,
50 "inputDocStoreId": 40000002
51 },
52 "filter": {
53 "id": 10000001,
54 "profileId": 10000001,
55 "jobId": 10000001,
56 "name": "Sample Name",
57 "principalPositionType": {
58 "name": "LESSEE",
59 "captionKey": "enum.principalpositiontype.lessee",
60 "caption": "Lessee"
61 },
62 "skipItemsWithOpenDraft": false,
63 "filterTypes": {
64 "erpSystemFilterType": {
65 "name": "ALL",
66 "captionKey": "enum.filterType.all",
67 "caption": "All"
68 },
69 "erpSystems": [],
70 "leaseAreaFilterType": {
71 "name": "ALL",
72 "captionKey": "enum.filterType.all",
73 "caption": "All"
74 },
75 "leaseAreas": [],
76 "businessUnitFilterType": {
77 "name": "ALL",
78 "captionKey": "enum.filterType.all",
79 "caption": "All"
80 },
81 "businessUnits": [],
82 "companyFilterType": {
83 "name": "ALL",
84 "captionKey": "enum.filterType.all",
85 "caption": "All"
86 },
87 "companies": [],
88 "leaseDepartmentFilterType": {
89 "name": "ALL",
90 "captionKey": "enum.filterType.all",
91 "caption": "All"
92 },
93 "leaseDepartments": [],
94 "leaseGroupFilterType": {
95 "name": "ALL",
96 "captionKey": "enum.filterType.all",
97 "caption": "All"
98 },
99 "leaseGroups": [],
100 "costCenterFilterType": {
101 "name": "ALL",
102 "captionKey": "enum.filterType.all",
103 "caption": "All"
104 },
105 "costCenters": [],
106 "profitCenterFilterType": {
107 "name": "ALL",
108 "captionKey": "enum.filterType.all",
109 "caption": "All"
110 },
111 "profitCenters": [],
112 "wbsFilterType": {
113 "name": "ALL",
114 "captionKey": "enum.filterType.all",
115 "caption": "All"
116 },
117 "wbses": [],
118 "businessAreaFilterType": {
119 "name": "ALL",
120 "captionKey": "enum.filterType.all",
121 "caption": "All"
122 },
123 "businessAreas": [],
124 "functionalAreaFilterType": {
125 "name": "ALL",
126 "captionKey": "enum.filterType.all",
127 "caption": "All"
128 },
129 "functionalAreas": []
130 },
131 "listObjectType": {
132 "name": "CONTRACT",
133 "captionKey": "enum.listObjectType.contract",
134 "caption": "Contract"
135 },
136 "objectList": []
137 },
138 "input": {
139 "id": 10000001,
140 "modificationTypes": {
141 "name": "LEASE_COMPONENT_MODIFICATION",
142 "captionKey": "enum.modificationType.leaseComponentModification",
143 "caption": "Lease Component Modification"
144 },
145 "applyGlobalOnEventName": false,
146 "leaseComponentEventName": "sample_leaseComponentEventName",
147 "activationGroupEventName": "sample_activationGroupEventName",
148 "applyGlobalOnEffectiveDates": false,
149 "effectiveDateType": {
150 "name": "JOB_DATE",
151 "captionKey": "enum.modificationDateType.jobDate",
152 "caption": "Job Date"
153 },
154 "effectiveDate": "2025-01-01",
155 "applyGlobalOnModificationDates": false,
156 "modificationDateType": {
157 "name": "JOB_DATE",
158 "captionKey": "enum.modificationDateType.jobDate",
159 "caption": "Job Date"
160 },
161 "modificationDate": "2025-01-01",
162 "activationDateType": {
163 "name": "JOB_DATE",
164 "captionKey": "enum.modificationDateType.jobDate",
165 "caption": "Job Date"
166 },
167 "postingDate": "2025-01-01",
168 "documentDate": "2025-01-01",
169 "translationDate": "2025-01-01",
170 "applyGlobalOnContractRate": false,
171 "useAutoRate": false,
172 "contractRate": 1000,
173 "applyGlobalOnTermFlags": false,
174 "exerciseTermType": {
175 "name": "APPLY_ON_ALL_TERMS",
176 "captionKey": "enum.termApplicationType.applyOnAllTerms",
177 "caption": "Apply On All Terms"
178 },
179 "applyIndexationTermType": {
180 "name": "APPLY_ON_ALL_TERMS",
181 "captionKey": "enum.termApplicationType.applyOnAllTerms",
182 "caption": "Apply On All Terms"
183 },
184 "migratedFilterType": {
185 "name": "ALL",
186 "captionKey": "enum.migratedFilterType.all",
187 "caption": "All"
188 }
189 },
190 "tasks": []
191 }
192}
Bulk Update Mass Modification Jobs¶
HTTP Request
PUT /api/v1/batch/mass-modification/jobs/bulk
📋 Description: Updates multiple lease-related records in the Nakisa Lease Accounting Suite, allowing users to efficiently modify contracts, financial obligations, and accounting entries in bulk. This operation streamlines the management of lease data, enhancing operational efficiency and accuracy.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
false |
Request body containing the bulk modification data for leases, contracts, and financial obligations, including relevant accounting entry details. |
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 "queueTime": "2025-01-01T10:00:00Z",
11 "startTime": "2025-01-01T10:00:00Z",
12 "endTime": "2025-01-01T10:00:00Z",
13 "status": {
14 "name": "PROCESSING",
15 "captionKey": "enum.batchJobStatus.processing",
16 "caption": "Processing"
17 },
18 "executor": {
19 "name": "MANUAL",
20 "captionKey": "enum.batchJobExecutor.manual",
21 "caption": "Manual"
22 },
23 "scheduleJobId": 10000001,
24 "batchSize": 100,
25 "totalObjectCount": 100,
26 "readOnly": false,
27 "profileId": 10000001,
28 "unauthorized": false,
29 "stage": {
30 "name": "PROCESSING_MASS_MODIFICATION",
31 "captionKey": "enum.massModificationStage.processingMassModification",
32 "caption": "Processing Mass Modification"
33 },
34 "inputFile": {
35 "templateFileStorageId": "template-file-uuid-12345",
36 "inputFileStorageId": "input-file-uuid-67890",
37 "generatingTemplateFile": false,
38 "startedGeneratingTemplateFileAt": "2024-01-15T10:30:00Z",
39 "finishedGeneratingTemplateFileAt": "2024-01-15T10:35:00Z",
40 "inputFileName": "mass_transfer_input_2024.xlsx",
41 "templateDocStoreId": 40000001,
42 "inputDocStoreId": 40000002
43 },
44 "filter": {
45 "id": 10000001,
46 "profileId": 10000001,
47 "jobId": 10000001,
48 "name": "Sample Name",
49 "principalPositionType": {
50 "name": "LESSEE",
51 "captionKey": "enum.principalpositiontype.lessee",
52 "caption": "Lessee"
53 },
54 "skipItemsWithOpenDraft": false,
55 "filterTypes": {
56 "erpSystemFilterType": {
57 "name": "ALL",
58 "captionKey": "enum.filterType.all",
59 "caption": "All"
60 },
61 "erpSystems": [],
62 "leaseAreaFilterType": {
63 "name": "ALL",
64 "captionKey": "enum.filterType.all",
65 "caption": "All"
66 },
67 "leaseAreas": [],
68 "businessUnitFilterType": {
69 "name": "ALL",
70 "captionKey": "enum.filterType.all",
71 "caption": "All"
72 },
73 "businessUnits": [],
74 "companyFilterType": {
75 "name": "ALL",
76 "captionKey": "enum.filterType.all",
77 "caption": "All"
78 },
79 "companies": [],
80 "leaseDepartmentFilterType": {
81 "name": "ALL",
82 "captionKey": "enum.filterType.all",
83 "caption": "All"
84 },
85 "leaseDepartments": [],
86 "leaseGroupFilterType": {
87 "name": "ALL",
88 "captionKey": "enum.filterType.all",
89 "caption": "All"
90 },
91 "leaseGroups": [],
92 "costCenterFilterType": {
93 "name": "ALL",
94 "captionKey": "enum.filterType.all",
95 "caption": "All"
96 },
97 "costCenters": [],
98 "profitCenterFilterType": {
99 "name": "ALL",
100 "captionKey": "enum.filterType.all",
101 "caption": "All"
102 },
103 "profitCenters": [],
104 "wbsFilterType": {
105 "name": "ALL",
106 "captionKey": "enum.filterType.all",
107 "caption": "All"
108 },
109 "wbses": [],
110 "businessAreaFilterType": {
111 "name": "ALL",
112 "captionKey": "enum.filterType.all",
113 "caption": "All"
114 },
115 "businessAreas": [],
116 "functionalAreaFilterType": {
117 "name": "ALL",
118 "captionKey": "enum.filterType.all",
119 "caption": "All"
120 },
121 "functionalAreas": []
122 },
123 "listObjectType": {
124 "name": "CONTRACT",
125 "captionKey": "enum.listObjectType.contract",
126 "caption": "Contract"
127 },
128 "objectList": []
129 },
130 "input": {
131 "id": 10000001,
132 "modificationTypes": {
133 "name": "LEASE_COMPONENT_MODIFICATION",
134 "captionKey": "enum.modificationType.leaseComponentModification",
135 "caption": "Lease Component Modification"
136 },
137 "applyGlobalOnEventName": false,
138 "leaseComponentEventName": "sample_leaseComponentEventName",
139 "activationGroupEventName": "sample_activationGroupEventName",
140 "applyGlobalOnEffectiveDates": false,
141 "effectiveDateType": {
142 "name": "JOB_DATE",
143 "captionKey": "enum.modificationDateType.jobDate",
144 "caption": "Job Date"
145 },
146 "effectiveDate": "2025-01-01",
147 "applyGlobalOnModificationDates": false,
148 "modificationDateType": {
149 "name": "JOB_DATE",
150 "captionKey": "enum.modificationDateType.jobDate",
151 "caption": "Job Date"
152 },
153 "modificationDate": "2025-01-01",
154 "activationDateType": {
155 "name": "JOB_DATE",
156 "captionKey": "enum.modificationDateType.jobDate",
157 "caption": "Job Date"
158 },
159 "postingDate": "2025-01-01",
160 "documentDate": "2025-01-01",
161 "translationDate": "2025-01-01",
162 "applyGlobalOnContractRate": false,
163 "useAutoRate": false,
164 "contractRate": 1000,
165 "applyGlobalOnTermFlags": false,
166 "exerciseTermType": {
167 "name": "APPLY_ON_ALL_TERMS",
168 "captionKey": "enum.termApplicationType.applyOnAllTerms",
169 "caption": "Apply On All Terms"
170 },
171 "applyIndexationTermType": {
172 "name": "APPLY_ON_ALL_TERMS",
173 "captionKey": "enum.termApplicationType.applyOnAllTerms",
174 "caption": "Apply On All Terms"
175 },
176 "migratedFilterType": {
177 "name": "ALL",
178 "captionKey": "enum.migratedFilterType.all",
179 "caption": "All"
180 }
181 },
182 "tasks": []
183 }
184]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
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 A New Upload Input File¶
HTTP Request
POST /api/v1/batch/mass-modification/jobs/upload-input-file/{id}
📋 Description: Uploads an input file for mass modification jobs identified by the specified ID, facilitating the batch processing of lease, contract, and financial obligation data within the Nakisa Lease Accounting Suite. This operation streamlines the management of accounting entries by enabling bulk updates efficiently.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer |
true |
Unique identifier for the resource |
body |
body |
object |
false |
Request body containing the lease and contract data necessary for processing financial obligations and accounting entries associated with the specified job ID. |
Body Parameters
1{}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Search Mass Modification Jobs¶
HTTP Request
POST /api/v1/batch/mass-modification/jobs/search
📋 Description: Submits a request to search for mass modification jobs related to leases, contracts, financial obligations, and accounting entries within the Nakisa Lease Accounting Suite. This operation enables users to efficiently locate and manage relevant job records.
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 |
false |
Request body containing search criteria and filters for identifying lease, contract, financial obligation, and accounting entry jobs for mass modification within the Nakisa Lease Accounting Suite. |
Default Values¶
Parameter |
Default |
Type |
|---|---|---|
sort |
|
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 "executorEqual": {
14 "name": "MANUAL",
15 "captionKey": "enum.batchJobExecutor.manual",
16 "caption": "Manual"
17 }
18}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
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 New Mass Modification Job (With Number Of Filtered Entities)¶
HTTP Request
POST /api/v1/batch/mass-modification/jobs/number-of-filtered-entities
📋 Description: Submits a request to calculate the number of filtered entities related to leases, contracts, and financial obligations within the Nakisa Lease Accounting Suite, facilitating efficient management of accounting entries.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
false |
Request body containing the criteria for filtering entities related to leases, contracts, financial obligations, and accounting entries for batch mass modification jobs. |
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 "queueTime": "2025-01-01T10:00:00Z",
10 "startTime": "2025-01-01T10:00:00Z",
11 "endTime": "2025-01-01T10:00:00Z",
12 "status": {
13 "name": "PROCESSING",
14 "captionKey": "enum.batchJobStatus.processing",
15 "caption": "Processing"
16 },
17 "executor": {
18 "name": "MANUAL",
19 "captionKey": "enum.batchJobExecutor.manual",
20 "caption": "Manual"
21 },
22 "scheduleJobId": 10000001,
23 "batchSize": 100,
24 "totalObjectCount": 100,
25 "readOnly": false,
26 "profileId": 10000001,
27 "unauthorized": false,
28 "stage": {
29 "name": "PROCESSING_MASS_MODIFICATION",
30 "captionKey": "enum.massModificationStage.processingMassModification",
31 "caption": "Processing Mass Modification"
32 },
33 "inputFile": {
34 "templateFileStorageId": "template-file-uuid-12345",
35 "inputFileStorageId": "input-file-uuid-67890",
36 "generatingTemplateFile": false,
37 "startedGeneratingTemplateFileAt": "2024-01-15T10:30:00Z",
38 "finishedGeneratingTemplateFileAt": "2024-01-15T10:35:00Z",
39 "inputFileName": "mass_transfer_input_2024.xlsx",
40 "templateDocStoreId": 40000001,
41 "inputDocStoreId": 40000002
42 },
43 "filter": {
44 "id": 10000001,
45 "profileId": 10000001,
46 "jobId": 10000001,
47 "name": "Sample Name",
48 "principalPositionType": {
49 "name": "LESSEE",
50 "captionKey": "enum.principalpositiontype.lessee",
51 "caption": "Lessee"
52 },
53 "skipItemsWithOpenDraft": false,
54 "filterTypes": {
55 "erpSystemFilterType": {
56 "name": "ALL",
57 "captionKey": "enum.filterType.all",
58 "caption": "All"
59 },
60 "erpSystems": [],
61 "leaseAreaFilterType": {
62 "name": "ALL",
63 "captionKey": "enum.filterType.all",
64 "caption": "All"
65 },
66 "leaseAreas": [],
67 "businessUnitFilterType": {
68 "name": "ALL",
69 "captionKey": "enum.filterType.all",
70 "caption": "All"
71 },
72 "businessUnits": [],
73 "companyFilterType": {
74 "name": "ALL",
75 "captionKey": "enum.filterType.all",
76 "caption": "All"
77 },
78 "companies": [],
79 "leaseDepartmentFilterType": {
80 "name": "ALL",
81 "captionKey": "enum.filterType.all",
82 "caption": "All"
83 },
84 "leaseDepartments": [],
85 "leaseGroupFilterType": {
86 "name": "ALL",
87 "captionKey": "enum.filterType.all",
88 "caption": "All"
89 },
90 "leaseGroups": [],
91 "costCenterFilterType": {
92 "name": "ALL",
93 "captionKey": "enum.filterType.all",
94 "caption": "All"
95 },
96 "costCenters": [],
97 "profitCenterFilterType": {
98 "name": "ALL",
99 "captionKey": "enum.filterType.all",
100 "caption": "All"
101 },
102 "profitCenters": [],
103 "wbsFilterType": {
104 "name": "ALL",
105 "captionKey": "enum.filterType.all",
106 "caption": "All"
107 },
108 "wbses": [],
109 "businessAreaFilterType": {
110 "name": "ALL",
111 "captionKey": "enum.filterType.all",
112 "caption": "All"
113 },
114 "businessAreas": [],
115 "functionalAreaFilterType": {
116 "name": "ALL",
117 "captionKey": "enum.filterType.all",
118 "caption": "All"
119 },
120 "functionalAreas": []
121 },
122 "listObjectType": {
123 "name": "CONTRACT",
124 "captionKey": "enum.listObjectType.contract",
125 "caption": "Contract"
126 },
127 "objectList": []
128 },
129 "input": {
130 "id": 10000001,
131 "modificationTypes": {
132 "name": "LEASE_COMPONENT_MODIFICATION",
133 "captionKey": "enum.modificationType.leaseComponentModification",
134 "caption": "Lease Component Modification"
135 },
136 "applyGlobalOnEventName": false,
137 "leaseComponentEventName": "sample_leaseComponentEventName",
138 "activationGroupEventName": "sample_activationGroupEventName",
139 "applyGlobalOnEffectiveDates": false,
140 "effectiveDateType": {
141 "name": "JOB_DATE",
142 "captionKey": "enum.modificationDateType.jobDate",
143 "caption": "Job Date"
144 },
145 "effectiveDate": "2025-01-01",
146 "applyGlobalOnModificationDates": false,
147 "modificationDateType": {
148 "name": "JOB_DATE",
149 "captionKey": "enum.modificationDateType.jobDate",
150 "caption": "Job Date"
151 },
152 "modificationDate": "2025-01-01",
153 "activationDateType": {
154 "name": "JOB_DATE",
155 "captionKey": "enum.modificationDateType.jobDate",
156 "caption": "Job Date"
157 },
158 "postingDate": "2025-01-01",
159 "documentDate": "2025-01-01",
160 "translationDate": "2025-01-01",
161 "applyGlobalOnContractRate": false,
162 "useAutoRate": false,
163 "contractRate": 1000,
164 "applyGlobalOnTermFlags": false,
165 "exerciseTermType": {
166 "name": "APPLY_ON_ALL_TERMS",
167 "captionKey": "enum.termApplicationType.applyOnAllTerms",
168 "caption": "Apply On All Terms"
169 },
170 "applyIndexationTermType": {
171 "name": "APPLY_ON_ALL_TERMS",
172 "captionKey": "enum.termApplicationType.applyOnAllTerms",
173 "caption": "Apply On All Terms"
174 },
175 "migratedFilterType": {
176 "name": "ALL",
177 "captionKey": "enum.migratedFilterType.all",
178 "caption": "All"
179 }
180 },
181 "tasks": []
182}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
integer |
Example Responses
10
Get Master Agreements For Mass Modification Job¶
HTTP Request
POST /api/v1/batch/mass-modification/jobs/master-agreements
📋 Description: Initiates the creation of mass modification jobs for master agreements within the Nakisa Lease Accounting Suite, enabling efficient management of lease contracts and associated financial obligations.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
page |
query |
integer |
false |
Page number (0-indexed) |
size |
query |
integer |
false |
Number of items per page |
sort |
query |
array[string] |
false |
Sorting criteria in format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported. |
body |
body |
false |
Request body containing the master agreement details, including lease terms, financial obligations, and associated accounting entries for batch processing in the Nakisa Lease Accounting Suite. |
Default Values¶
Parameter |
Default |
Type |
|---|---|---|
page |
|
query |
size |
|
query |
Parameter Constraints¶
Parameter |
Constraints |
|---|---|
page |
Min: 0 |
size |
Min: 1, Max: 100 |
Body Parameters
1{
2 "searchTerm": "sample_searchTerm",
3 "skipItemsWithOpenDraft": false,
4 "massModificationTypes": {
5 "name": "LEASE_COMPONENT_MODIFICATION",
6 "captionKey": "enum.modificationType.leaseComponentModification",
7 "caption": "Lease Component Modification"
8 },
9 "profile": {
10 "persistable": false,
11 "id": 10000001,
12 "createdBy": "john.doe@example.com",
13 "createdAt": "2025-01-01T10:00:00Z",
14 "modifiedBy": "john.doe@example.com",
15 "modifiedAt": "2025-01-01T10:00:00Z",
16 "profileId": 10000001,
17 "name": "Sample Name",
18 "principalPositionType": {
19 "name": "LESSEE",
20 "captionKey": "enum.principalpositiontype.lessee",
21 "caption": "Lessee"
22 },
23 "skipItemsWithOpenDraft": false,
24 "filterTypes": {
25 "erpSystemFilterType": {
26 "name": "ALL",
27 "captionKey": "enum.filterType.all",
28 "caption": "All"
29 },
30 "leaseAreaFilterType": {
31 "name": "ALL",
32 "captionKey": "enum.filterType.all",
33 "caption": "All"
34 },
35 "businessUnitFilterType": {
36 "name": "ALL",
37 "captionKey": "enum.filterType.all",
38 "caption": "All"
39 },
40 "companyFilterType": {
41 "name": "ALL",
42 "captionKey": "enum.filterType.all",
43 "caption": "All"
44 },
45 "leaseDepartmentFilterType": {
46 "name": "ALL",
47 "captionKey": "enum.filterType.all",
48 "caption": "All"
49 },
50 "leaseGroupFilterType": {
51 "name": "ALL",
52 "captionKey": "enum.filterType.all",
53 "caption": "All"
54 },
55 "costCenterFilterType": {
56 "name": "ALL",
57 "captionKey": "enum.filterType.all",
58 "caption": "All"
59 },
60 "profitCenterFilterType": {
61 "name": "ALL",
62 "captionKey": "enum.filterType.all",
63 "caption": "All"
64 },
65 "wbsFilterType": {
66 "name": "ALL",
67 "captionKey": "enum.filterType.all",
68 "caption": "All"
69 },
70 "businessAreaFilterType": {
71 "name": "ALL",
72 "captionKey": "enum.filterType.all",
73 "caption": "All"
74 },
75 "functionalAreaFilterType": {
76 "name": "ALL",
77 "captionKey": "enum.filterType.all",
78 "caption": "All"
79 }
80 },
81 "baseIdList": [],
82 "listObjectType": {
83 "name": "CONTRACT",
84 "captionKey": "enum.listObjectType.contract",
85 "caption": "Contract"
86 },
87 "objectList": [],
88 "new": false
89 },
90 "migratedFilterType": {
91 "name": "ALL",
92 "captionKey": "enum.migratedFilterType.all",
93 "caption": "All"
94 }
95}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
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 Mass Modification Job¶
HTTP Request
POST /api/v1/batch/mass-modification/jobs/lease-components
📋 Description: Creates new lease component modification jobs in bulk, facilitating efficient updates to lease contracts and financial obligations within the Nakisa Lease Accounting Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
page |
query |
integer |
false |
Page number (0-indexed) |
size |
query |
integer |
false |
Number of items per page |
sort |
query |
array[string] |
false |
Sorting criteria in format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported. |
body |
body |
false |
Request body containing the lease component modification details, including financial obligations and associated accounting entries for batch processing within the Nakisa Lease Accounting Suite. |
Default Values¶
Parameter |
Default |
Type |
|---|---|---|
page |
|
query |
size |
|
query |
Parameter Constraints¶
Parameter |
Constraints |
|---|---|
page |
Min: 0 |
size |
Min: 1, Max: 100 |
Body Parameters
1{
2 "searchTerm": "sample_searchTerm",
3 "skipItemsWithOpenDraft": false,
4 "massModificationTypes": {
5 "name": "LEASE_COMPONENT_MODIFICATION",
6 "captionKey": "enum.modificationType.leaseComponentModification",
7 "caption": "Lease Component Modification"
8 },
9 "profile": {
10 "persistable": false,
11 "id": 10000001,
12 "createdBy": "john.doe@example.com",
13 "createdAt": "2025-01-01T10:00:00Z",
14 "modifiedBy": "john.doe@example.com",
15 "modifiedAt": "2025-01-01T10:00:00Z",
16 "profileId": 10000001,
17 "name": "Sample Name",
18 "principalPositionType": {
19 "name": "LESSEE",
20 "captionKey": "enum.principalpositiontype.lessee",
21 "caption": "Lessee"
22 },
23 "skipItemsWithOpenDraft": false,
24 "filterTypes": {
25 "erpSystemFilterType": {
26 "name": "ALL",
27 "captionKey": "enum.filterType.all",
28 "caption": "All"
29 },
30 "leaseAreaFilterType": {
31 "name": "ALL",
32 "captionKey": "enum.filterType.all",
33 "caption": "All"
34 },
35 "businessUnitFilterType": {
36 "name": "ALL",
37 "captionKey": "enum.filterType.all",
38 "caption": "All"
39 },
40 "companyFilterType": {
41 "name": "ALL",
42 "captionKey": "enum.filterType.all",
43 "caption": "All"
44 },
45 "leaseDepartmentFilterType": {
46 "name": "ALL",
47 "captionKey": "enum.filterType.all",
48 "caption": "All"
49 },
50 "leaseGroupFilterType": {
51 "name": "ALL",
52 "captionKey": "enum.filterType.all",
53 "caption": "All"
54 },
55 "costCenterFilterType": {
56 "name": "ALL",
57 "captionKey": "enum.filterType.all",
58 "caption": "All"
59 },
60 "profitCenterFilterType": {
61 "name": "ALL",
62 "captionKey": "enum.filterType.all",
63 "caption": "All"
64 },
65 "wbsFilterType": {
66 "name": "ALL",
67 "captionKey": "enum.filterType.all",
68 "caption": "All"
69 },
70 "businessAreaFilterType": {
71 "name": "ALL",
72 "captionKey": "enum.filterType.all",
73 "caption": "All"
74 },
75 "functionalAreaFilterType": {
76 "name": "ALL",
77 "captionKey": "enum.filterType.all",
78 "caption": "All"
79 }
80 },
81 "baseIdList": [],
82 "listObjectType": {
83 "name": "CONTRACT",
84 "captionKey": "enum.listObjectType.contract",
85 "caption": "Contract"
86 },
87 "objectList": [],
88 "new": false
89 },
90 "migratedFilterType": {
91 "name": "ALL",
92 "captionKey": "enum.migratedFilterType.all",
93 "caption": "All"
94 }
95}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
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 Mass Modification Job¶
HTTP Request
POST /api/v1/batch/mass-modification/jobs/contracts
📋 Description: Submits a batch job for mass modification of lease contracts, enabling efficient updates to financial obligations and accounting entries within the Nakisa Lease Accounting Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
page |
query |
integer |
false |
Page number (0-indexed) |
size |
query |
integer |
false |
Number of items per page |
sort |
query |
array[string] |
false |
Sorting criteria in format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported. |
body |
body |
false |
Request body containing the contract modification details, including lease terms, financial obligations, and accounting entries for batch processing within the Nakisa Lease Accounting Suite. |
Default Values¶
Parameter |
Default |
Type |
|---|---|---|
page |
|
query |
size |
|
query |
Parameter Constraints¶
Parameter |
Constraints |
|---|---|
page |
Min: 0 |
size |
Min: 1, Max: 100 |
Body Parameters
1{
2 "searchTerm": "sample_searchTerm",
3 "skipItemsWithOpenDraft": false,
4 "massModificationTypes": {
5 "name": "LEASE_COMPONENT_MODIFICATION",
6 "captionKey": "enum.modificationType.leaseComponentModification",
7 "caption": "Lease Component Modification"
8 },
9 "profile": {
10 "persistable": false,
11 "id": 10000001,
12 "createdBy": "john.doe@example.com",
13 "createdAt": "2025-01-01T10:00:00Z",
14 "modifiedBy": "john.doe@example.com",
15 "modifiedAt": "2025-01-01T10:00:00Z",
16 "profileId": 10000001,
17 "name": "Sample Name",
18 "principalPositionType": {
19 "name": "LESSEE",
20 "captionKey": "enum.principalpositiontype.lessee",
21 "caption": "Lessee"
22 },
23 "skipItemsWithOpenDraft": false,
24 "filterTypes": {
25 "erpSystemFilterType": {
26 "name": "ALL",
27 "captionKey": "enum.filterType.all",
28 "caption": "All"
29 },
30 "leaseAreaFilterType": {
31 "name": "ALL",
32 "captionKey": "enum.filterType.all",
33 "caption": "All"
34 },
35 "businessUnitFilterType": {
36 "name": "ALL",
37 "captionKey": "enum.filterType.all",
38 "caption": "All"
39 },
40 "companyFilterType": {
41 "name": "ALL",
42 "captionKey": "enum.filterType.all",
43 "caption": "All"
44 },
45 "leaseDepartmentFilterType": {
46 "name": "ALL",
47 "captionKey": "enum.filterType.all",
48 "caption": "All"
49 },
50 "leaseGroupFilterType": {
51 "name": "ALL",
52 "captionKey": "enum.filterType.all",
53 "caption": "All"
54 },
55 "costCenterFilterType": {
56 "name": "ALL",
57 "captionKey": "enum.filterType.all",
58 "caption": "All"
59 },
60 "profitCenterFilterType": {
61 "name": "ALL",
62 "captionKey": "enum.filterType.all",
63 "caption": "All"
64 },
65 "wbsFilterType": {
66 "name": "ALL",
67 "captionKey": "enum.filterType.all",
68 "caption": "All"
69 },
70 "businessAreaFilterType": {
71 "name": "ALL",
72 "captionKey": "enum.filterType.all",
73 "caption": "All"
74 },
75 "functionalAreaFilterType": {
76 "name": "ALL",
77 "captionKey": "enum.filterType.all",
78 "caption": "All"
79 }
80 },
81 "baseIdList": [],
82 "listObjectType": {
83 "name": "CONTRACT",
84 "captionKey": "enum.listObjectType.contract",
85 "caption": "Contract"
86 },
87 "objectList": [],
88 "new": false
89 },
90 "migratedFilterType": {
91 "name": "ALL",
92 "captionKey": "enum.migratedFilterType.all",
93 "caption": "All"
94 }
95}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
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 "leaseType": "LEASE_CONTRACT_FIXED_PART_A",
134 "numberRangeIdentifierValue": "0001",
135 "numberRangeIdentifierType": {
136 "name": "COMPANY_CODE"
137 },
138 "numberRangeType": {
139 "name": "CONTRACT"
140 },
141 "allowsSystemGenerateNewId": true
142 },
143 "currency": {
144 "id": 840,
145 "displayId": "USD",
146 "status": {
147 "name": "ACTIVE",
148 "captionKey": "enum.objectStatus.active",
149 "active": true,
150 "caption": "Active"
151 },
152 "name": "United States Dollar",
153 "decimalPoints": 2
154 },
155 "companyCurrency": {
156 "id": 840,
157 "displayId": "USD",
158 "status": {
159 "name": "ACTIVE",
160 "captionKey": "enum.objectStatus.active",
161 "active": true,
162 "caption": "Active"
163 },
164 "name": "United States Dollar",
165 "decimalPoints": 2
166 },
167 "indexedCurrency": true,
168 "assetValueCurrencyType": "CONTRACT_CURRENCY",
169 "currencyLocked": true,
170 "leaseArea": {
171 "id": 10000001,
172 "displayId": "0001",
173 "status": {
174 "name": "ACTIVE",
175 "captionKey": "enum.objectStatus.active",
176 "active": true,
177 "caption": "Active"
178 },
179 "name": "Global Lease Area"
180 },
181 "businessUnit": {
182 "id": 10000001,
183 "displayId": "BU0001",
184 "status": {
185 "name": "ACTIVE",
186 "captionKey": "enum.objectStatus.active",
187 "active": true,
188 "caption": "Active"
189 },
190 "name": "North America Business Unit"
191 },
192 "businessUnitLocked": true,
193 "companyCode": {
194 "id": 10000006,
195 "displayId": "1005",
196 "status": {
197 "name": "ACTIVE",
198 "captionKey": "enum.objectStatus.active",
199 "active": true,
200 "caption": "Active"
201 },
202 "erpSystemId": 10000001,
203 "erpSystemDisplayId": "FINQ8S-300",
204 "countryId": 10000095,
205 "countryDisplayId": "CA",
206 "name": "string",
207 "postingPeriodVariantId": 0,
208 "fiscalVariantId": 0
209 },
210 "companyCodeLocked": true,
211 "department": {
212 "id": 300001,
213 "displayId": "DEP-01",
214 "status": {
215 "name": "ACTIVE",
216 "captionKey": "enum.objectStatus.active",
217 "active": true,
218 "caption": "Active"
219 },
220 "name": "Finance Department"
221 },
222 "departmentLocked": true,
223 "leaseGroup": {
224 "id": 60000001,
225 "displayId": "LG-001",
226 "status": {
227 "name": "ACTIVE",
228 "captionKey": "enum.objectStatus.active",
229 "active": true,
230 "caption": "Active"
231 },
232 "name": "Global Lease Group"
233 },
234 "leaseGroupLocked": true,
235 "subleasingInternalAssetClass": {
236 "id": 10000001,
237 "displayId": "IAC-001",
238 "status": {
239 "name": "ACTIVE",
240 "captionKey": "enum.objectStatus.active",
241 "active": true,
242 "caption": "Active"
243 },
244 "name": "Machinery and Equipment",
245 "assetClassType": "PROPERTY",
246 "infiniteUsefulLife": false
247 },
248 "contractGroup1": {
249 "id": 400001,
250 "displayId": "CG1-01",
251 "status": {
252 "name": "ACTIVE",
253 "captionKey": "enum.objectStatus.active",
254 "active": true,
255 "caption": "Active"
256 },
257 "name": "Real Estate Contracts"
258 },
259 "contractGroup2": {
260 "id": 500001,
261 "displayId": "CG2-01",
262 "status": {
263 "name": "ACTIVE",
264 "captionKey": "enum.objectStatus.active",
265 "active": true,
266 "caption": "Active"
267 },
268 "name": "Equipment Leasing Contracts"
269 },
270 "subleasing": false,
271 "subleasingContractRevisionInfo": {
272 "id": 50000001,
273 "contractId": 40000001,
274 "contractDisplayId": "CTR-0001",
275 "contractName": "Sublease Agreement for Office Space"
276 },
277 "subleasingLeaseComponentRevisionInfo": {
278 "id": 61000001,
279 "leaseComponentId": 80000001,
280 "leaseComponentDisplayId": "LC-0001",
281 "leaseComponentName": "Vehicle Lease Component"
282 },
283 "subleasingActivationGroupRevisionInfo": {
284 "id": 60000001,
285 "activationGroupId": 70000001,
286 "activationGroupDisplayId": "AG-001",
287 "activationGroupName": "Office Equipment Activation Group"
288 },
289 "notifications": [
290 {
291 "id": 10000001,
292 "topic": {
293 "enCaption": "Lease Component Updated",
294 "frCaption": "Composant de bail mis à jour",
295 "name": "LEASE_COMPONENT_UPDATED",
296 "priority": "HIGH"
297 },
298 "username": "super.admin@nakisa.com",
299 "contractId": 10000001,
300 "contractDisplayId": "CT-100000000",
301 "targetId": "CT-100000000",
302 "targetType": "CONTRACT"
303 }
304 ],
305 "masterAgreementId": 10000001,
306 "masterAgreementDisplayId": "string",
307 "allowsSystemGenerateNewId": true,
308 "transferInfo": {
309 "transferredFromDisplayId": "CTR-00012",
310 "transferredFromRevisionId": 20000001,
311 "transferredToDisplayId": "CTR-00015",
312 "transferredToRevisionId": 20000005
313 },
314 "numberRangeIdentifierValue": "",
315 "numberRangeIdentifierType": {
316 "name": "COMPANY_CODE"
317 },
318 "numberRangeType": {
319 "name": "CONTRACT"
320 }
321 }
322 ],
323 "number": 0,
324 "sort": {
325 "unsorted": false,
326 "sorted": true,
327 "empty": false
328 },
329 "first": true,
330 "last": true,
331 "empty": false
332}
Cancel Mass Modification Job¶
HTTP Request
POST /api/v1/batch/mass-modification/jobs/cancel/{jobId}
📋 Description: Cancels a specified mass modification job identified by the jobId, allowing users to halt processing of lease-related changes within the Nakisa Lease Accounting Suite, thereby ensuring accurate management of financial obligations and accounting entries.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
jobId |
path |
integer |
true |
Unique identifier for the job |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Get Activation Groups For Mass Modification Job¶
HTTP Request
POST /api/v1/batch/mass-modification/jobs/activation-groups
📋 Description: Creates activation groups for batch mass modifications within the Nakisa Lease Accounting Suite, enabling efficient management of leases, contracts, and associated financial obligations.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
page |
query |
integer |
false |
Page number (0-indexed) |
size |
query |
integer |
false |
Number of items per page |
sort |
query |
array[string] |
false |
Sorting criteria in format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported. |
body |
body |
false |
Request body containing the activation group data for mass modification of lease contracts, including relevant financial obligations and accounting entries. |
Default Values¶
Parameter |
Default |
Type |
|---|---|---|
page |
|
query |
size |
|
query |
Parameter Constraints¶
Parameter |
Constraints |
|---|---|
page |
Min: 0 |
size |
Min: 1, Max: 100 |
Body Parameters
1{
2 "searchTerm": "sample_searchTerm",
3 "skipItemsWithOpenDraft": false,
4 "massModificationTypes": {
5 "name": "LEASE_COMPONENT_MODIFICATION",
6 "captionKey": "enum.modificationType.leaseComponentModification",
7 "caption": "Lease Component Modification"
8 },
9 "profile": {
10 "persistable": false,
11 "id": 10000001,
12 "createdBy": "john.doe@example.com",
13 "createdAt": "2025-01-01T10:00:00Z",
14 "modifiedBy": "john.doe@example.com",
15 "modifiedAt": "2025-01-01T10:00:00Z",
16 "profileId": 10000001,
17 "name": "Sample Name",
18 "principalPositionType": {
19 "name": "LESSEE",
20 "captionKey": "enum.principalpositiontype.lessee",
21 "caption": "Lessee"
22 },
23 "skipItemsWithOpenDraft": false,
24 "filterTypes": {
25 "erpSystemFilterType": {
26 "name": "ALL",
27 "captionKey": "enum.filterType.all",
28 "caption": "All"
29 },
30 "leaseAreaFilterType": {
31 "name": "ALL",
32 "captionKey": "enum.filterType.all",
33 "caption": "All"
34 },
35 "businessUnitFilterType": {
36 "name": "ALL",
37 "captionKey": "enum.filterType.all",
38 "caption": "All"
39 },
40 "companyFilterType": {
41 "name": "ALL",
42 "captionKey": "enum.filterType.all",
43 "caption": "All"
44 },
45 "leaseDepartmentFilterType": {
46 "name": "ALL",
47 "captionKey": "enum.filterType.all",
48 "caption": "All"
49 },
50 "leaseGroupFilterType": {
51 "name": "ALL",
52 "captionKey": "enum.filterType.all",
53 "caption": "All"
54 },
55 "costCenterFilterType": {
56 "name": "ALL",
57 "captionKey": "enum.filterType.all",
58 "caption": "All"
59 },
60 "profitCenterFilterType": {
61 "name": "ALL",
62 "captionKey": "enum.filterType.all",
63 "caption": "All"
64 },
65 "wbsFilterType": {
66 "name": "ALL",
67 "captionKey": "enum.filterType.all",
68 "caption": "All"
69 },
70 "businessAreaFilterType": {
71 "name": "ALL",
72 "captionKey": "enum.filterType.all",
73 "caption": "All"
74 },
75 "functionalAreaFilterType": {
76 "name": "ALL",
77 "captionKey": "enum.filterType.all",
78 "caption": "All"
79 }
80 },
81 "baseIdList": [],
82 "listObjectType": {
83 "name": "CONTRACT",
84 "captionKey": "enum.listObjectType.contract",
85 "caption": "Contract"
86 },
87 "objectList": [],
88 "new": false
89 },
90 "migratedFilterType": {
91 "name": "ALL",
92 "captionKey": "enum.migratedFilterType.all",
93 "caption": "All"
94 }
95}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
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}
List All Mass Modification Jobs¶
HTTP Request
GET /api/v1/batch/mass-modification/jobs
📋 Description: Retrieves a list of mass modification jobs related to leases and contracts within the Nakisa Lease Accounting Suite, enabling users to track and manage financial obligations and accounting entries efficiently.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
Indicates whether the results of the mass modification jobs query should be returned in a paginated format, facilitating efficient data retrieval for lease and contract management within the Nakisa Lease Accounting Suite. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
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 New Mass Modification Job¶
HTTP Request
POST /api/v1/batch/mass-modification/jobs
📋 Description: Submits a batch job for mass modification of leases, contracts, and financial obligations within the Nakisa Lease Accounting Suite, facilitating efficient updates to accounting entries.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
false |
Request body containing the batch job details for mass modification of leases, contracts, and financial obligations, including relevant parameters for processing accounting entries. |
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 "queueTime": "2025-01-01T10:00:00Z",
10 "startTime": "2025-01-01T10:00:00Z",
11 "endTime": "2025-01-01T10:00:00Z",
12 "status": {
13 "name": "PROCESSING",
14 "captionKey": "enum.batchJobStatus.processing",
15 "caption": "Processing"
16 },
17 "executor": {
18 "name": "MANUAL",
19 "captionKey": "enum.batchJobExecutor.manual",
20 "caption": "Manual"
21 },
22 "scheduleJobId": 10000001,
23 "batchSize": 100,
24 "totalObjectCount": 100,
25 "readOnly": false,
26 "profileId": 10000001,
27 "unauthorized": false,
28 "stage": {
29 "name": "PROCESSING_MASS_MODIFICATION",
30 "captionKey": "enum.massModificationStage.processingMassModification",
31 "caption": "Processing Mass Modification"
32 },
33 "inputFile": {
34 "templateFileStorageId": "template-file-uuid-12345",
35 "inputFileStorageId": "input-file-uuid-67890",
36 "generatingTemplateFile": false,
37 "startedGeneratingTemplateFileAt": "2024-01-15T10:30:00Z",
38 "finishedGeneratingTemplateFileAt": "2024-01-15T10:35:00Z",
39 "inputFileName": "mass_transfer_input_2024.xlsx",
40 "templateDocStoreId": 40000001,
41 "inputDocStoreId": 40000002
42 },
43 "filter": {
44 "id": 10000001,
45 "profileId": 10000001,
46 "jobId": 10000001,
47 "name": "Sample Name",
48 "principalPositionType": {
49 "name": "LESSEE",
50 "captionKey": "enum.principalpositiontype.lessee",
51 "caption": "Lessee"
52 },
53 "skipItemsWithOpenDraft": false,
54 "filterTypes": {
55 "erpSystemFilterType": {
56 "name": "ALL",
57 "captionKey": "enum.filterType.all",
58 "caption": "All"
59 },
60 "erpSystems": [],
61 "leaseAreaFilterType": {
62 "name": "ALL",
63 "captionKey": "enum.filterType.all",
64 "caption": "All"
65 },
66 "leaseAreas": [],
67 "businessUnitFilterType": {
68 "name": "ALL",
69 "captionKey": "enum.filterType.all",
70 "caption": "All"
71 },
72 "businessUnits": [],
73 "companyFilterType": {
74 "name": "ALL",
75 "captionKey": "enum.filterType.all",
76 "caption": "All"
77 },
78 "companies": [],
79 "leaseDepartmentFilterType": {
80 "name": "ALL",
81 "captionKey": "enum.filterType.all",
82 "caption": "All"
83 },
84 "leaseDepartments": [],
85 "leaseGroupFilterType": {
86 "name": "ALL",
87 "captionKey": "enum.filterType.all",
88 "caption": "All"
89 },
90 "leaseGroups": [],
91 "costCenterFilterType": {
92 "name": "ALL",
93 "captionKey": "enum.filterType.all",
94 "caption": "All"
95 },
96 "costCenters": [],
97 "profitCenterFilterType": {
98 "name": "ALL",
99 "captionKey": "enum.filterType.all",
100 "caption": "All"
101 },
102 "profitCenters": [],
103 "wbsFilterType": {
104 "name": "ALL",
105 "captionKey": "enum.filterType.all",
106 "caption": "All"
107 },
108 "wbses": [],
109 "businessAreaFilterType": {
110 "name": "ALL",
111 "captionKey": "enum.filterType.all",
112 "caption": "All"
113 },
114 "businessAreas": [],
115 "functionalAreaFilterType": {
116 "name": "ALL",
117 "captionKey": "enum.filterType.all",
118 "caption": "All"
119 },
120 "functionalAreas": []
121 },
122 "listObjectType": {
123 "name": "CONTRACT",
124 "captionKey": "enum.listObjectType.contract",
125 "caption": "Contract"
126 },
127 "objectList": []
128 },
129 "input": {
130 "id": 10000001,
131 "modificationTypes": {
132 "name": "LEASE_COMPONENT_MODIFICATION",
133 "captionKey": "enum.modificationType.leaseComponentModification",
134 "caption": "Lease Component Modification"
135 },
136 "applyGlobalOnEventName": false,
137 "leaseComponentEventName": "sample_leaseComponentEventName",
138 "activationGroupEventName": "sample_activationGroupEventName",
139 "applyGlobalOnEffectiveDates": false,
140 "effectiveDateType": {
141 "name": "JOB_DATE",
142 "captionKey": "enum.modificationDateType.jobDate",
143 "caption": "Job Date"
144 },
145 "effectiveDate": "2025-01-01",
146 "applyGlobalOnModificationDates": false,
147 "modificationDateType": {
148 "name": "JOB_DATE",
149 "captionKey": "enum.modificationDateType.jobDate",
150 "caption": "Job Date"
151 },
152 "modificationDate": "2025-01-01",
153 "activationDateType": {
154 "name": "JOB_DATE",
155 "captionKey": "enum.modificationDateType.jobDate",
156 "caption": "Job Date"
157 },
158 "postingDate": "2025-01-01",
159 "documentDate": "2025-01-01",
160 "translationDate": "2025-01-01",
161 "applyGlobalOnContractRate": false,
162 "useAutoRate": false,
163 "contractRate": 1000,
164 "applyGlobalOnTermFlags": false,
165 "exerciseTermType": {
166 "name": "APPLY_ON_ALL_TERMS",
167 "captionKey": "enum.termApplicationType.applyOnAllTerms",
168 "caption": "Apply On All Terms"
169 },
170 "applyIndexationTermType": {
171 "name": "APPLY_ON_ALL_TERMS",
172 "captionKey": "enum.termApplicationType.applyOnAllTerms",
173 "caption": "Apply On All Terms"
174 },
175 "migratedFilterType": {
176 "name": "ALL",
177 "captionKey": "enum.migratedFilterType.all",
178 "caption": "All"
179 }
180 },
181 "tasks": []
182}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
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 "queueTime": "2025-01-01T10:00:00Z",
19 "startTime": "2025-01-01T10:00:00Z",
20 "endTime": "2025-01-01T10:00:00Z",
21 "status": {
22 "name": "PROCESSING",
23 "captionKey": "enum.batchJobStatus.processing",
24 "caption": "Processing"
25 },
26 "executor": {
27 "name": "MANUAL",
28 "captionKey": "enum.batchJobExecutor.manual",
29 "caption": "Manual"
30 },
31 "scheduleJobId": 10000001,
32 "batchSize": 100,
33 "totalObjectCount": 100,
34 "readOnly": false,
35 "profileId": 10000001,
36 "unauthorized": false,
37 "stage": {
38 "name": "PROCESSING_MASS_MODIFICATION",
39 "captionKey": "enum.massModificationStage.processingMassModification",
40 "caption": "Processing Mass Modification"
41 },
42 "inputFile": {
43 "templateFileStorageId": "template-file-uuid-12345",
44 "inputFileStorageId": "input-file-uuid-67890",
45 "generatingTemplateFile": false,
46 "startedGeneratingTemplateFileAt": "2024-01-15T10:30:00Z",
47 "finishedGeneratingTemplateFileAt": "2024-01-15T10:35:00Z",
48 "inputFileName": "mass_transfer_input_2024.xlsx",
49 "templateDocStoreId": 40000001,
50 "inputDocStoreId": 40000002
51 },
52 "filter": {
53 "id": 10000001,
54 "profileId": 10000001,
55 "jobId": 10000001,
56 "name": "Sample Name",
57 "principalPositionType": {
58 "name": "LESSEE",
59 "captionKey": "enum.principalpositiontype.lessee",
60 "caption": "Lessee"
61 },
62 "skipItemsWithOpenDraft": false,
63 "filterTypes": {
64 "erpSystemFilterType": {
65 "name": "ALL",
66 "captionKey": "enum.filterType.all",
67 "caption": "All"
68 },
69 "erpSystems": [],
70 "leaseAreaFilterType": {
71 "name": "ALL",
72 "captionKey": "enum.filterType.all",
73 "caption": "All"
74 },
75 "leaseAreas": [],
76 "businessUnitFilterType": {
77 "name": "ALL",
78 "captionKey": "enum.filterType.all",
79 "caption": "All"
80 },
81 "businessUnits": [],
82 "companyFilterType": {
83 "name": "ALL",
84 "captionKey": "enum.filterType.all",
85 "caption": "All"
86 },
87 "companies": [],
88 "leaseDepartmentFilterType": {
89 "name": "ALL",
90 "captionKey": "enum.filterType.all",
91 "caption": "All"
92 },
93 "leaseDepartments": [],
94 "leaseGroupFilterType": {
95 "name": "ALL",
96 "captionKey": "enum.filterType.all",
97 "caption": "All"
98 },
99 "leaseGroups": [],
100 "costCenterFilterType": {
101 "name": "ALL",
102 "captionKey": "enum.filterType.all",
103 "caption": "All"
104 },
105 "costCenters": [],
106 "profitCenterFilterType": {
107 "name": "ALL",
108 "captionKey": "enum.filterType.all",
109 "caption": "All"
110 },
111 "profitCenters": [],
112 "wbsFilterType": {
113 "name": "ALL",
114 "captionKey": "enum.filterType.all",
115 "caption": "All"
116 },
117 "wbses": [],
118 "businessAreaFilterType": {
119 "name": "ALL",
120 "captionKey": "enum.filterType.all",
121 "caption": "All"
122 },
123 "businessAreas": [],
124 "functionalAreaFilterType": {
125 "name": "ALL",
126 "captionKey": "enum.filterType.all",
127 "caption": "All"
128 },
129 "functionalAreas": []
130 },
131 "listObjectType": {
132 "name": "CONTRACT",
133 "captionKey": "enum.listObjectType.contract",
134 "caption": "Contract"
135 },
136 "objectList": []
137 },
138 "input": {
139 "id": 10000001,
140 "modificationTypes": {
141 "name": "LEASE_COMPONENT_MODIFICATION",
142 "captionKey": "enum.modificationType.leaseComponentModification",
143 "caption": "Lease Component Modification"
144 },
145 "applyGlobalOnEventName": false,
146 "leaseComponentEventName": "sample_leaseComponentEventName",
147 "activationGroupEventName": "sample_activationGroupEventName",
148 "applyGlobalOnEffectiveDates": false,
149 "effectiveDateType": {
150 "name": "JOB_DATE",
151 "captionKey": "enum.modificationDateType.jobDate",
152 "caption": "Job Date"
153 },
154 "effectiveDate": "2025-01-01",
155 "applyGlobalOnModificationDates": false,
156 "modificationDateType": {
157 "name": "JOB_DATE",
158 "captionKey": "enum.modificationDateType.jobDate",
159 "caption": "Job Date"
160 },
161 "modificationDate": "2025-01-01",
162 "activationDateType": {
163 "name": "JOB_DATE",
164 "captionKey": "enum.modificationDateType.jobDate",
165 "caption": "Job Date"
166 },
167 "postingDate": "2025-01-01",
168 "documentDate": "2025-01-01",
169 "translationDate": "2025-01-01",
170 "applyGlobalOnContractRate": false,
171 "useAutoRate": false,
172 "contractRate": 1000,
173 "applyGlobalOnTermFlags": false,
174 "exerciseTermType": {
175 "name": "APPLY_ON_ALL_TERMS",
176 "captionKey": "enum.termApplicationType.applyOnAllTerms",
177 "caption": "Apply On All Terms"
178 },
179 "applyIndexationTermType": {
180 "name": "APPLY_ON_ALL_TERMS",
181 "captionKey": "enum.termApplicationType.applyOnAllTerms",
182 "caption": "Apply On All Terms"
183 },
184 "migratedFilterType": {
185 "name": "ALL",
186 "captionKey": "enum.migratedFilterType.all",
187 "caption": "All"
188 }
189 },
190 "tasks": []
191 }
192}
List All Modification Typess¶
HTTP Request
GET /api/v1/batch/mass-modification/jobs/modification-types
📋 Description: Retrieves a list of available modification types for batch mass modification jobs within the Nakisa Lease Accounting Suite, facilitating efficient management of lease, contract, and financial obligation adjustments.
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 "string"
3]
Response Schema
List All Modification Date Typess¶
HTTP Request
GET /api/v1/batch/mass-modification/jobs/modification-date-types
📋 Description: Retrieves the available modification date types for batch mass modification jobs within the Nakisa Lease Accounting Suite, facilitating efficient management of lease, contract, and financial obligation adjustments.
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 "string"
3]
Response Schema
List Object Types For Mass Modification Job¶
HTTP Request
GET /api/v1/batch/mass-modification/jobs/list-object-types
📋 Description: Retrieves a list of object types related to mass modification jobs within the Nakisa Lease Accounting Suite, facilitating efficient management of leases, contracts, financial obligations, and accounting entries.
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 "string"
3]
Response Schema
Retrieve A Specific Generate Input Template¶
HTTP Request
GET /api/v1/batch/mass-modification/jobs/generate-input-template/{id}
📋 Description: Generates an input template for mass modification jobs associated with a specific lease or contract, 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 |
None |
List All Effective Date Typess¶
HTTP Request
GET /api/v1/batch/mass-modification/jobs/effective-date-types
📋 Description: Retrieves the effective date types associated with mass modification jobs within the Nakisa Lease Accounting Suite, facilitating the management of lease, contract, and financial obligation entries for accurate accounting practices.
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 "string"
3]
Response Schema
Retrieve A Specific Download User Input¶
HTTP Request
GET /api/v1/batch/mass-modification/jobs/download-user-input/{id}
📋 Description: Downloads user input data associated with a specific mass modification job identified by the provided ID, facilitating efficient management of lease and contract-related financial obligations 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 |
None |
Retrieve A Specific Download Input Template¶
HTTP Request
GET /api/v1/batch/mass-modification/jobs/download-input-template/{id}
📋 Description: Downloads the input template for a specified mass modification job, facilitating the preparation of lease and contract data for financial obligation and accounting entry processing 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 |
None |
List All Apply On Term Typess¶
HTTP Request
GET /api/v1/batch/mass-modification/jobs/apply-on-term-types
📋 Description: Retrieves mass modification job details for applying changes to specified term types within the Nakisa Lease Accounting Suite, facilitating efficient management of leases, contracts, and financial obligations.
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 "string"
3]
Response Schema
List All Activation Date Typess¶
HTTP Request
GET /api/v1/batch/mass-modification/jobs/activation-date-types
📋 Description: Retrieves the available activation date types for mass modification jobs within the Nakisa Lease Accounting Suite, facilitating efficient management of lease, contract, and financial obligation entries.
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 "string"
3]