Mass Workflow Job Controller¶
Get Mass Workflow Job By ID¶
HTTP Request
GET /api/v1/batch/mass-workflow/jobs/{id}
📋 Description: Fetches detailed information about a specific mass workflow job identified by the provided ID, facilitating oversight 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 |
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 "filter": {
38 "id": 10000001,
39 "profileId": 10000001,
40 "jobId": 10000001,
41 "name": "Sample Name",
42 "principalPositionType": {
43 "name": "LESSEE",
44 "captionKey": "enum.principalpositiontype.lessee",
45 "caption": "Lessee"
46 },
47 "filterTypes": {
48 "erpSystemFilterType": {
49 "name": "ALL",
50 "captionKey": "enum.filterType.all",
51 "caption": "All"
52 },
53 "erpSystems": [],
54 "leaseAreaFilterType": {
55 "name": "ALL",
56 "captionKey": "enum.filterType.all",
57 "caption": "All"
58 },
59 "leaseAreas": [],
60 "businessUnitFilterType": {
61 "name": "ALL",
62 "captionKey": "enum.filterType.all",
63 "caption": "All"
64 },
65 "businessUnits": [],
66 "companyFilterType": {
67 "name": "ALL",
68 "captionKey": "enum.filterType.all",
69 "caption": "All"
70 },
71 "companies": [],
72 "leaseDepartmentFilterType": {
73 "name": "ALL",
74 "captionKey": "enum.filterType.all",
75 "caption": "All"
76 },
77 "leaseDepartments": [],
78 "leaseGroupFilterType": {
79 "name": "ALL",
80 "captionKey": "enum.filterType.all",
81 "caption": "All"
82 },
83 "leaseGroups": [],
84 "costCenterFilterType": {
85 "name": "ALL",
86 "captionKey": "enum.filterType.all",
87 "caption": "All"
88 },
89 "costCenters": [],
90 "profitCenterFilterType": {
91 "name": "ALL",
92 "captionKey": "enum.filterType.all",
93 "caption": "All"
94 },
95 "profitCenters": [],
96 "wbsFilterType": {
97 "name": "ALL",
98 "captionKey": "enum.filterType.all",
99 "caption": "All"
100 },
101 "wbses": [],
102 "businessAreaFilterType": {
103 "name": "ALL",
104 "captionKey": "enum.filterType.all",
105 "caption": "All"
106 },
107 "businessAreas": [],
108 "functionalAreaFilterType": {
109 "name": "ALL",
110 "captionKey": "enum.filterType.all",
111 "caption": "All"
112 },
113 "functionalAreas": []
114 },
115 "bypassFiltering": false,
116 "listObjectType": {
117 "name": "CONTRACT",
118 "captionKey": "enum.listObjectType.contract",
119 "caption": "Contract"
120 },
121 "objectListDisplayIds": [],
122 "includeTransferred": true
123 },
124 "input": {
125 "id": 10000001,
126 "entityType": {
127 "name": "CONTRACT",
128 "captionKey": "enum.objectType.contract",
129 "caption": "Contract"
130 },
131 "migratedFilterType": {
132 "name": "ALL",
133 "captionKey": "enum.migratedFilterType.all",
134 "caption": "All"
135 },
136 "useDefaultWorkbookInput": false,
137 "initialState": {
138 "name": "AG_ACTIVE",
139 "captionKey": "enum.entityStatus.agActive",
140 "caption": "Active"
141 },
142 "terminalState": {
143 "name": "AG_ACTIVE",
144 "captionKey": "enum.entityStatus.agActive",
145 "caption": "Active"
146 },
147 "transitions": {
148 "name": "AG_DEFINE_TO_GENERATING",
149 "captionKey": "enum.workflowTransition.agDefineToGenerating",
150 "caption": "AG Define To Generating"
151 },
152 "intermediateStates": {
153 "name": "AG_ACTIVE",
154 "captionKey": "enum.entityStatus.agActive",
155 "caption": "Active"
156 },
157 "acceptsHitchhickers": false,
158 "dateType": {
159 "name": "AG_ROU_DATES",
160 "captionKey": "enum.agDateType.agRouDates",
161 "caption": "AG ROU Dates"
162 },
163 "postingDate": "2025-01-01",
164 "documentDate": "2025-01-01",
165 "cascadeParentClosure": true
166 },
167 "processingStage": {
168 "name": "PROCESSING_MASS_WORKFLOW",
169 "captionKey": "enum.massWorkflowStage.processingMassWorkflow",
170 "caption": "Processing Mass Workflow"
171 },
172 "generatingXSSFWorkbookInputTemplate": false,
173 "startedGeneratingXSSFWorkbookInputTemplateAt": "2025-01-01T10:00:00Z"
174 }
175}
Update Mass Workflow Job¶
HTTP Request
PUT /api/v1/batch/mass-workflow/jobs/{id}
📋 Description: Updates the specified job within the mass workflow in the Nakisa Lease Accounting Suite, enabling users to modify lease-related contract details and financial obligations associated with 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 job details, including lease and contract information, financial obligations, and accounting entry parameters for the specified mass workflow 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 "filter": {
29 "id": 10000001,
30 "profileId": 10000001,
31 "jobId": 10000001,
32 "name": "Sample Name",
33 "principalPositionType": {
34 "name": "LESSEE",
35 "captionKey": "enum.principalpositiontype.lessee",
36 "caption": "Lessee"
37 },
38 "filterTypes": {
39 "erpSystemFilterType": {
40 "name": "ALL",
41 "captionKey": "enum.filterType.all",
42 "caption": "All"
43 },
44 "erpSystems": [],
45 "leaseAreaFilterType": {
46 "name": "ALL",
47 "captionKey": "enum.filterType.all",
48 "caption": "All"
49 },
50 "leaseAreas": [],
51 "businessUnitFilterType": {
52 "name": "ALL",
53 "captionKey": "enum.filterType.all",
54 "caption": "All"
55 },
56 "businessUnits": [],
57 "companyFilterType": {
58 "name": "ALL",
59 "captionKey": "enum.filterType.all",
60 "caption": "All"
61 },
62 "companies": [],
63 "leaseDepartmentFilterType": {
64 "name": "ALL",
65 "captionKey": "enum.filterType.all",
66 "caption": "All"
67 },
68 "leaseDepartments": [],
69 "leaseGroupFilterType": {
70 "name": "ALL",
71 "captionKey": "enum.filterType.all",
72 "caption": "All"
73 },
74 "leaseGroups": [],
75 "costCenterFilterType": {
76 "name": "ALL",
77 "captionKey": "enum.filterType.all",
78 "caption": "All"
79 },
80 "costCenters": [],
81 "profitCenterFilterType": {
82 "name": "ALL",
83 "captionKey": "enum.filterType.all",
84 "caption": "All"
85 },
86 "profitCenters": [],
87 "wbsFilterType": {
88 "name": "ALL",
89 "captionKey": "enum.filterType.all",
90 "caption": "All"
91 },
92 "wbses": [],
93 "businessAreaFilterType": {
94 "name": "ALL",
95 "captionKey": "enum.filterType.all",
96 "caption": "All"
97 },
98 "businessAreas": [],
99 "functionalAreaFilterType": {
100 "name": "ALL",
101 "captionKey": "enum.filterType.all",
102 "caption": "All"
103 },
104 "functionalAreas": []
105 },
106 "bypassFiltering": false,
107 "listObjectType": {
108 "name": "CONTRACT",
109 "captionKey": "enum.listObjectType.contract",
110 "caption": "Contract"
111 },
112 "objectListDisplayIds": [],
113 "includeTransferred": true
114 },
115 "input": {
116 "id": 10000001,
117 "entityType": {
118 "name": "CONTRACT",
119 "captionKey": "enum.objectType.contract",
120 "caption": "Contract"
121 },
122 "migratedFilterType": {
123 "name": "ALL",
124 "captionKey": "enum.migratedFilterType.all",
125 "caption": "All"
126 },
127 "useDefaultWorkbookInput": false,
128 "initialState": {
129 "name": "AG_ACTIVE",
130 "captionKey": "enum.entityStatus.agActive",
131 "caption": "Active"
132 },
133 "terminalState": {
134 "name": "AG_ACTIVE",
135 "captionKey": "enum.entityStatus.agActive",
136 "caption": "Active"
137 },
138 "transitions": {
139 "name": "AG_DEFINE_TO_GENERATING",
140 "captionKey": "enum.workflowTransition.agDefineToGenerating",
141 "caption": "AG Define To Generating"
142 },
143 "intermediateStates": {
144 "name": "AG_ACTIVE",
145 "captionKey": "enum.entityStatus.agActive",
146 "caption": "Active"
147 },
148 "acceptsHitchhickers": false,
149 "dateType": {
150 "name": "AG_ROU_DATES",
151 "captionKey": "enum.agDateType.agRouDates",
152 "caption": "AG ROU Dates"
153 },
154 "postingDate": "2025-01-01",
155 "documentDate": "2025-01-01",
156 "cascadeParentClosure": true
157 },
158 "processingStage": {
159 "name": "PROCESSING_MASS_WORKFLOW",
160 "captionKey": "enum.massWorkflowStage.processingMassWorkflow",
161 "caption": "Processing Mass Workflow"
162 },
163 "generatingXSSFWorkbookInputTemplate": false,
164 "startedGeneratingXSSFWorkbookInputTemplateAt": "2025-01-01T10:00:00Z"
165}
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 "filter": {
38 "id": 10000001,
39 "profileId": 10000001,
40 "jobId": 10000001,
41 "name": "Sample Name",
42 "principalPositionType": {
43 "name": "LESSEE",
44 "captionKey": "enum.principalpositiontype.lessee",
45 "caption": "Lessee"
46 },
47 "filterTypes": {
48 "erpSystemFilterType": {
49 "name": "ALL",
50 "captionKey": "enum.filterType.all",
51 "caption": "All"
52 },
53 "erpSystems": [],
54 "leaseAreaFilterType": {
55 "name": "ALL",
56 "captionKey": "enum.filterType.all",
57 "caption": "All"
58 },
59 "leaseAreas": [],
60 "businessUnitFilterType": {
61 "name": "ALL",
62 "captionKey": "enum.filterType.all",
63 "caption": "All"
64 },
65 "businessUnits": [],
66 "companyFilterType": {
67 "name": "ALL",
68 "captionKey": "enum.filterType.all",
69 "caption": "All"
70 },
71 "companies": [],
72 "leaseDepartmentFilterType": {
73 "name": "ALL",
74 "captionKey": "enum.filterType.all",
75 "caption": "All"
76 },
77 "leaseDepartments": [],
78 "leaseGroupFilterType": {
79 "name": "ALL",
80 "captionKey": "enum.filterType.all",
81 "caption": "All"
82 },
83 "leaseGroups": [],
84 "costCenterFilterType": {
85 "name": "ALL",
86 "captionKey": "enum.filterType.all",
87 "caption": "All"
88 },
89 "costCenters": [],
90 "profitCenterFilterType": {
91 "name": "ALL",
92 "captionKey": "enum.filterType.all",
93 "caption": "All"
94 },
95 "profitCenters": [],
96 "wbsFilterType": {
97 "name": "ALL",
98 "captionKey": "enum.filterType.all",
99 "caption": "All"
100 },
101 "wbses": [],
102 "businessAreaFilterType": {
103 "name": "ALL",
104 "captionKey": "enum.filterType.all",
105 "caption": "All"
106 },
107 "businessAreas": [],
108 "functionalAreaFilterType": {
109 "name": "ALL",
110 "captionKey": "enum.filterType.all",
111 "caption": "All"
112 },
113 "functionalAreas": []
114 },
115 "bypassFiltering": false,
116 "listObjectType": {
117 "name": "CONTRACT",
118 "captionKey": "enum.listObjectType.contract",
119 "caption": "Contract"
120 },
121 "objectListDisplayIds": [],
122 "includeTransferred": true
123 },
124 "input": {
125 "id": 10000001,
126 "entityType": {
127 "name": "CONTRACT",
128 "captionKey": "enum.objectType.contract",
129 "caption": "Contract"
130 },
131 "migratedFilterType": {
132 "name": "ALL",
133 "captionKey": "enum.migratedFilterType.all",
134 "caption": "All"
135 },
136 "useDefaultWorkbookInput": false,
137 "initialState": {
138 "name": "AG_ACTIVE",
139 "captionKey": "enum.entityStatus.agActive",
140 "caption": "Active"
141 },
142 "terminalState": {
143 "name": "AG_ACTIVE",
144 "captionKey": "enum.entityStatus.agActive",
145 "caption": "Active"
146 },
147 "transitions": {
148 "name": "AG_DEFINE_TO_GENERATING",
149 "captionKey": "enum.workflowTransition.agDefineToGenerating",
150 "caption": "AG Define To Generating"
151 },
152 "intermediateStates": {
153 "name": "AG_ACTIVE",
154 "captionKey": "enum.entityStatus.agActive",
155 "caption": "Active"
156 },
157 "acceptsHitchhickers": false,
158 "dateType": {
159 "name": "AG_ROU_DATES",
160 "captionKey": "enum.agDateType.agRouDates",
161 "caption": "AG ROU Dates"
162 },
163 "postingDate": "2025-01-01",
164 "documentDate": "2025-01-01",
165 "cascadeParentClosure": true
166 },
167 "processingStage": {
168 "name": "PROCESSING_MASS_WORKFLOW",
169 "captionKey": "enum.massWorkflowStage.processingMassWorkflow",
170 "caption": "Processing Mass Workflow"
171 },
172 "generatingXSSFWorkbookInputTemplate": false,
173 "startedGeneratingXSSFWorkbookInputTemplateAt": "2025-01-01T10:00:00Z"
174 }
175}
Bulk Upsert Mass Workflow Jobs¶
HTTP Request
PUT /api/v1/batch/mass-workflow/jobs/createOrUpdate/bulk
📋 Description: Updates or creates multiple job entries in the Nakisa Lease Accounting Suite, facilitating efficient management of lease contracts and financial obligations within the accounting framework. This operation streamlines the process of maintaining accurate accounting entries for bulk job data.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
false |
Request body containing bulk data for creating or updating lease-related jobs, including contract details, financial obligations, and accounting entries. |
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 "filter": {
30 "id": 10000001,
31 "profileId": 10000001,
32 "jobId": 10000001,
33 "name": "Sample Name",
34 "principalPositionType": {
35 "name": "LESSEE",
36 "captionKey": "enum.principalpositiontype.lessee",
37 "caption": "Lessee"
38 },
39 "filterTypes": {
40 "erpSystemFilterType": {
41 "name": "ALL",
42 "captionKey": "enum.filterType.all",
43 "caption": "All"
44 },
45 "erpSystems": [],
46 "leaseAreaFilterType": {
47 "name": "ALL",
48 "captionKey": "enum.filterType.all",
49 "caption": "All"
50 },
51 "leaseAreas": [],
52 "businessUnitFilterType": {
53 "name": "ALL",
54 "captionKey": "enum.filterType.all",
55 "caption": "All"
56 },
57 "businessUnits": [],
58 "companyFilterType": {
59 "name": "ALL",
60 "captionKey": "enum.filterType.all",
61 "caption": "All"
62 },
63 "companies": [],
64 "leaseDepartmentFilterType": {
65 "name": "ALL",
66 "captionKey": "enum.filterType.all",
67 "caption": "All"
68 },
69 "leaseDepartments": [],
70 "leaseGroupFilterType": {
71 "name": "ALL",
72 "captionKey": "enum.filterType.all",
73 "caption": "All"
74 },
75 "leaseGroups": [],
76 "costCenterFilterType": {
77 "name": "ALL",
78 "captionKey": "enum.filterType.all",
79 "caption": "All"
80 },
81 "costCenters": [],
82 "profitCenterFilterType": {
83 "name": "ALL",
84 "captionKey": "enum.filterType.all",
85 "caption": "All"
86 },
87 "profitCenters": [],
88 "wbsFilterType": {
89 "name": "ALL",
90 "captionKey": "enum.filterType.all",
91 "caption": "All"
92 },
93 "wbses": [],
94 "businessAreaFilterType": {
95 "name": "ALL",
96 "captionKey": "enum.filterType.all",
97 "caption": "All"
98 },
99 "businessAreas": [],
100 "functionalAreaFilterType": {
101 "name": "ALL",
102 "captionKey": "enum.filterType.all",
103 "caption": "All"
104 },
105 "functionalAreas": []
106 },
107 "bypassFiltering": false,
108 "listObjectType": {
109 "name": "CONTRACT",
110 "captionKey": "enum.listObjectType.contract",
111 "caption": "Contract"
112 },
113 "objectListDisplayIds": [],
114 "includeTransferred": true
115 },
116 "input": {
117 "id": 10000001,
118 "entityType": {
119 "name": "CONTRACT",
120 "captionKey": "enum.objectType.contract",
121 "caption": "Contract"
122 },
123 "migratedFilterType": {
124 "name": "ALL",
125 "captionKey": "enum.migratedFilterType.all",
126 "caption": "All"
127 },
128 "useDefaultWorkbookInput": false,
129 "initialState": {
130 "name": "AG_ACTIVE",
131 "captionKey": "enum.entityStatus.agActive",
132 "caption": "Active"
133 },
134 "terminalState": {
135 "name": "AG_ACTIVE",
136 "captionKey": "enum.entityStatus.agActive",
137 "caption": "Active"
138 },
139 "transitions": {
140 "name": "AG_DEFINE_TO_GENERATING",
141 "captionKey": "enum.workflowTransition.agDefineToGenerating",
142 "caption": "AG Define To Generating"
143 },
144 "intermediateStates": {
145 "name": "AG_ACTIVE",
146 "captionKey": "enum.entityStatus.agActive",
147 "caption": "Active"
148 },
149 "acceptsHitchhickers": false,
150 "dateType": {
151 "name": "AG_ROU_DATES",
152 "captionKey": "enum.agDateType.agRouDates",
153 "caption": "AG ROU Dates"
154 },
155 "postingDate": "2025-01-01",
156 "documentDate": "2025-01-01",
157 "cascadeParentClosure": true
158 },
159 "processingStage": {
160 "name": "PROCESSING_MASS_WORKFLOW",
161 "captionKey": "enum.massWorkflowStage.processingMassWorkflow",
162 "caption": "Processing Mass Workflow"
163 },
164 "generatingXSSFWorkbookInputTemplate": false,
165 "startedGeneratingXSSFWorkbookInputTemplateAt": "2025-01-01T10:00:00Z"
166 }
167]
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 Workflow Job¶
HTTP Request
PUT /api/v1/batch/mass-workflow/jobs/createOrUpdate
📋 Description: Creates or updates multiple jobs within the Nakisa Lease Accounting Suite’s mass workflow, facilitating the management of leases, contracts, financial obligations, and accounting entries in a streamlined manner.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
false |
Request body containing the lease and contract details, including financial obligations and accounting entries, for creating or updating jobs within the mass workflow. |
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 "filter": {
29 "id": 10000001,
30 "profileId": 10000001,
31 "jobId": 10000001,
32 "name": "Sample Name",
33 "principalPositionType": {
34 "name": "LESSEE",
35 "captionKey": "enum.principalpositiontype.lessee",
36 "caption": "Lessee"
37 },
38 "filterTypes": {
39 "erpSystemFilterType": {
40 "name": "ALL",
41 "captionKey": "enum.filterType.all",
42 "caption": "All"
43 },
44 "erpSystems": [],
45 "leaseAreaFilterType": {
46 "name": "ALL",
47 "captionKey": "enum.filterType.all",
48 "caption": "All"
49 },
50 "leaseAreas": [],
51 "businessUnitFilterType": {
52 "name": "ALL",
53 "captionKey": "enum.filterType.all",
54 "caption": "All"
55 },
56 "businessUnits": [],
57 "companyFilterType": {
58 "name": "ALL",
59 "captionKey": "enum.filterType.all",
60 "caption": "All"
61 },
62 "companies": [],
63 "leaseDepartmentFilterType": {
64 "name": "ALL",
65 "captionKey": "enum.filterType.all",
66 "caption": "All"
67 },
68 "leaseDepartments": [],
69 "leaseGroupFilterType": {
70 "name": "ALL",
71 "captionKey": "enum.filterType.all",
72 "caption": "All"
73 },
74 "leaseGroups": [],
75 "costCenterFilterType": {
76 "name": "ALL",
77 "captionKey": "enum.filterType.all",
78 "caption": "All"
79 },
80 "costCenters": [],
81 "profitCenterFilterType": {
82 "name": "ALL",
83 "captionKey": "enum.filterType.all",
84 "caption": "All"
85 },
86 "profitCenters": [],
87 "wbsFilterType": {
88 "name": "ALL",
89 "captionKey": "enum.filterType.all",
90 "caption": "All"
91 },
92 "wbses": [],
93 "businessAreaFilterType": {
94 "name": "ALL",
95 "captionKey": "enum.filterType.all",
96 "caption": "All"
97 },
98 "businessAreas": [],
99 "functionalAreaFilterType": {
100 "name": "ALL",
101 "captionKey": "enum.filterType.all",
102 "caption": "All"
103 },
104 "functionalAreas": []
105 },
106 "bypassFiltering": false,
107 "listObjectType": {
108 "name": "CONTRACT",
109 "captionKey": "enum.listObjectType.contract",
110 "caption": "Contract"
111 },
112 "objectListDisplayIds": [],
113 "includeTransferred": true
114 },
115 "input": {
116 "id": 10000001,
117 "entityType": {
118 "name": "CONTRACT",
119 "captionKey": "enum.objectType.contract",
120 "caption": "Contract"
121 },
122 "migratedFilterType": {
123 "name": "ALL",
124 "captionKey": "enum.migratedFilterType.all",
125 "caption": "All"
126 },
127 "useDefaultWorkbookInput": false,
128 "initialState": {
129 "name": "AG_ACTIVE",
130 "captionKey": "enum.entityStatus.agActive",
131 "caption": "Active"
132 },
133 "terminalState": {
134 "name": "AG_ACTIVE",
135 "captionKey": "enum.entityStatus.agActive",
136 "caption": "Active"
137 },
138 "transitions": {
139 "name": "AG_DEFINE_TO_GENERATING",
140 "captionKey": "enum.workflowTransition.agDefineToGenerating",
141 "caption": "AG Define To Generating"
142 },
143 "intermediateStates": {
144 "name": "AG_ACTIVE",
145 "captionKey": "enum.entityStatus.agActive",
146 "caption": "Active"
147 },
148 "acceptsHitchhickers": false,
149 "dateType": {
150 "name": "AG_ROU_DATES",
151 "captionKey": "enum.agDateType.agRouDates",
152 "caption": "AG ROU Dates"
153 },
154 "postingDate": "2025-01-01",
155 "documentDate": "2025-01-01",
156 "cascadeParentClosure": true
157 },
158 "processingStage": {
159 "name": "PROCESSING_MASS_WORKFLOW",
160 "captionKey": "enum.massWorkflowStage.processingMassWorkflow",
161 "caption": "Processing Mass Workflow"
162 },
163 "generatingXSSFWorkbookInputTemplate": false,
164 "startedGeneratingXSSFWorkbookInputTemplateAt": "2025-01-01T10:00:00Z"
165}
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 "filter": {
38 "id": 10000001,
39 "profileId": 10000001,
40 "jobId": 10000001,
41 "name": "Sample Name",
42 "principalPositionType": {
43 "name": "LESSEE",
44 "captionKey": "enum.principalpositiontype.lessee",
45 "caption": "Lessee"
46 },
47 "filterTypes": {
48 "erpSystemFilterType": {
49 "name": "ALL",
50 "captionKey": "enum.filterType.all",
51 "caption": "All"
52 },
53 "erpSystems": [],
54 "leaseAreaFilterType": {
55 "name": "ALL",
56 "captionKey": "enum.filterType.all",
57 "caption": "All"
58 },
59 "leaseAreas": [],
60 "businessUnitFilterType": {
61 "name": "ALL",
62 "captionKey": "enum.filterType.all",
63 "caption": "All"
64 },
65 "businessUnits": [],
66 "companyFilterType": {
67 "name": "ALL",
68 "captionKey": "enum.filterType.all",
69 "caption": "All"
70 },
71 "companies": [],
72 "leaseDepartmentFilterType": {
73 "name": "ALL",
74 "captionKey": "enum.filterType.all",
75 "caption": "All"
76 },
77 "leaseDepartments": [],
78 "leaseGroupFilterType": {
79 "name": "ALL",
80 "captionKey": "enum.filterType.all",
81 "caption": "All"
82 },
83 "leaseGroups": [],
84 "costCenterFilterType": {
85 "name": "ALL",
86 "captionKey": "enum.filterType.all",
87 "caption": "All"
88 },
89 "costCenters": [],
90 "profitCenterFilterType": {
91 "name": "ALL",
92 "captionKey": "enum.filterType.all",
93 "caption": "All"
94 },
95 "profitCenters": [],
96 "wbsFilterType": {
97 "name": "ALL",
98 "captionKey": "enum.filterType.all",
99 "caption": "All"
100 },
101 "wbses": [],
102 "businessAreaFilterType": {
103 "name": "ALL",
104 "captionKey": "enum.filterType.all",
105 "caption": "All"
106 },
107 "businessAreas": [],
108 "functionalAreaFilterType": {
109 "name": "ALL",
110 "captionKey": "enum.filterType.all",
111 "caption": "All"
112 },
113 "functionalAreas": []
114 },
115 "bypassFiltering": false,
116 "listObjectType": {
117 "name": "CONTRACT",
118 "captionKey": "enum.listObjectType.contract",
119 "caption": "Contract"
120 },
121 "objectListDisplayIds": [],
122 "includeTransferred": true
123 },
124 "input": {
125 "id": 10000001,
126 "entityType": {
127 "name": "CONTRACT",
128 "captionKey": "enum.objectType.contract",
129 "caption": "Contract"
130 },
131 "migratedFilterType": {
132 "name": "ALL",
133 "captionKey": "enum.migratedFilterType.all",
134 "caption": "All"
135 },
136 "useDefaultWorkbookInput": false,
137 "initialState": {
138 "name": "AG_ACTIVE",
139 "captionKey": "enum.entityStatus.agActive",
140 "caption": "Active"
141 },
142 "terminalState": {
143 "name": "AG_ACTIVE",
144 "captionKey": "enum.entityStatus.agActive",
145 "caption": "Active"
146 },
147 "transitions": {
148 "name": "AG_DEFINE_TO_GENERATING",
149 "captionKey": "enum.workflowTransition.agDefineToGenerating",
150 "caption": "AG Define To Generating"
151 },
152 "intermediateStates": {
153 "name": "AG_ACTIVE",
154 "captionKey": "enum.entityStatus.agActive",
155 "caption": "Active"
156 },
157 "acceptsHitchhickers": false,
158 "dateType": {
159 "name": "AG_ROU_DATES",
160 "captionKey": "enum.agDateType.agRouDates",
161 "caption": "AG ROU Dates"
162 },
163 "postingDate": "2025-01-01",
164 "documentDate": "2025-01-01",
165 "cascadeParentClosure": true
166 },
167 "processingStage": {
168 "name": "PROCESSING_MASS_WORKFLOW",
169 "captionKey": "enum.massWorkflowStage.processingMassWorkflow",
170 "caption": "Processing Mass Workflow"
171 },
172 "generatingXSSFWorkbookInputTemplate": false,
173 "startedGeneratingXSSFWorkbookInputTemplateAt": "2025-01-01T10:00:00Z"
174 }
175}
Bulk Update Mass Workflow Jobs¶
HTTP Request
PUT /api/v1/batch/mass-workflow/jobs/bulk
📋 Description: Updates multiple jobs within the mass workflow for lease and contract management in the Nakisa Lease Accounting Suite, facilitating efficient handling of financial obligations and accounting entries.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
false |
Request body containing bulk job data for managing lease contracts and financial obligations within the Nakisa Lease Accounting Suite, including relevant accounting entries and associated metadata. |
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 "filter": {
30 "id": 10000001,
31 "profileId": 10000001,
32 "jobId": 10000001,
33 "name": "Sample Name",
34 "principalPositionType": {
35 "name": "LESSEE",
36 "captionKey": "enum.principalpositiontype.lessee",
37 "caption": "Lessee"
38 },
39 "filterTypes": {
40 "erpSystemFilterType": {
41 "name": "ALL",
42 "captionKey": "enum.filterType.all",
43 "caption": "All"
44 },
45 "erpSystems": [],
46 "leaseAreaFilterType": {
47 "name": "ALL",
48 "captionKey": "enum.filterType.all",
49 "caption": "All"
50 },
51 "leaseAreas": [],
52 "businessUnitFilterType": {
53 "name": "ALL",
54 "captionKey": "enum.filterType.all",
55 "caption": "All"
56 },
57 "businessUnits": [],
58 "companyFilterType": {
59 "name": "ALL",
60 "captionKey": "enum.filterType.all",
61 "caption": "All"
62 },
63 "companies": [],
64 "leaseDepartmentFilterType": {
65 "name": "ALL",
66 "captionKey": "enum.filterType.all",
67 "caption": "All"
68 },
69 "leaseDepartments": [],
70 "leaseGroupFilterType": {
71 "name": "ALL",
72 "captionKey": "enum.filterType.all",
73 "caption": "All"
74 },
75 "leaseGroups": [],
76 "costCenterFilterType": {
77 "name": "ALL",
78 "captionKey": "enum.filterType.all",
79 "caption": "All"
80 },
81 "costCenters": [],
82 "profitCenterFilterType": {
83 "name": "ALL",
84 "captionKey": "enum.filterType.all",
85 "caption": "All"
86 },
87 "profitCenters": [],
88 "wbsFilterType": {
89 "name": "ALL",
90 "captionKey": "enum.filterType.all",
91 "caption": "All"
92 },
93 "wbses": [],
94 "businessAreaFilterType": {
95 "name": "ALL",
96 "captionKey": "enum.filterType.all",
97 "caption": "All"
98 },
99 "businessAreas": [],
100 "functionalAreaFilterType": {
101 "name": "ALL",
102 "captionKey": "enum.filterType.all",
103 "caption": "All"
104 },
105 "functionalAreas": []
106 },
107 "bypassFiltering": false,
108 "listObjectType": {
109 "name": "CONTRACT",
110 "captionKey": "enum.listObjectType.contract",
111 "caption": "Contract"
112 },
113 "objectListDisplayIds": [],
114 "includeTransferred": true
115 },
116 "input": {
117 "id": 10000001,
118 "entityType": {
119 "name": "CONTRACT",
120 "captionKey": "enum.objectType.contract",
121 "caption": "Contract"
122 },
123 "migratedFilterType": {
124 "name": "ALL",
125 "captionKey": "enum.migratedFilterType.all",
126 "caption": "All"
127 },
128 "useDefaultWorkbookInput": false,
129 "initialState": {
130 "name": "AG_ACTIVE",
131 "captionKey": "enum.entityStatus.agActive",
132 "caption": "Active"
133 },
134 "terminalState": {
135 "name": "AG_ACTIVE",
136 "captionKey": "enum.entityStatus.agActive",
137 "caption": "Active"
138 },
139 "transitions": {
140 "name": "AG_DEFINE_TO_GENERATING",
141 "captionKey": "enum.workflowTransition.agDefineToGenerating",
142 "caption": "AG Define To Generating"
143 },
144 "intermediateStates": {
145 "name": "AG_ACTIVE",
146 "captionKey": "enum.entityStatus.agActive",
147 "caption": "Active"
148 },
149 "acceptsHitchhickers": false,
150 "dateType": {
151 "name": "AG_ROU_DATES",
152 "captionKey": "enum.agDateType.agRouDates",
153 "caption": "AG ROU Dates"
154 },
155 "postingDate": "2025-01-01",
156 "documentDate": "2025-01-01",
157 "cascadeParentClosure": true
158 },
159 "processingStage": {
160 "name": "PROCESSING_MASS_WORKFLOW",
161 "captionKey": "enum.massWorkflowStage.processingMassWorkflow",
162 "caption": "Processing Mass Workflow"
163 },
164 "generatingXSSFWorkbookInputTemplate": false,
165 "startedGeneratingXSSFWorkbookInputTemplateAt": "2025-01-01T10:00:00Z"
166 }
167]
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 Workbook Input¶
HTTP Request
POST /api/v1/batch/mass-workflow/jobs/upload-workbook-input/{job-id}
📋 Description: Uploads a workbook input for a specified job within the Nakisa Lease Accounting Suite, facilitating the integration of lease and contract data essential for managing financial obligations and generating accounting entries.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
job-id |
path |
integer |
true |
Unique identifier for the specific job associated with uploading workbook input for lease and contract management within the Nakisa Lease Accounting Suite. |
body |
body |
object |
false |
Request body containing the workbook input data for the specified job, including lease, contract, and financial obligation details necessary for accurate accounting entry processing. |
Body Parameters
1{}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Get Units For Mass Workflow Job¶
HTTP Request
POST /api/v1/batch/mass-workflow/jobs/units
📋 Description: Creates multiple units for mass workflow processing within the Nakisa Lease Accounting Suite, facilitating the 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 financial obligation details, including lease and contract information, necessary for processing batch workflow jobs 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 "migratedFilterType": {
4 "name": "ALL",
5 "captionKey": "enum.migratedFilterType.all",
6 "caption": "All"
7 },
8 "entityType": {
9 "name": "CONTRACT",
10 "captionKey": "enum.objectType.contract",
11 "caption": "Contract"
12 },
13 "initialState": {
14 "name": "AG_ACTIVE",
15 "captionKey": "enum.entityStatus.agActive",
16 "caption": "Active"
17 },
18 "transitions": {
19 "name": "AG_DEFINE_TO_GENERATING",
20 "captionKey": "enum.workflowTransition.agDefineToGenerating",
21 "caption": "AG Define To Generating"
22 },
23 "acceptsHitchhickers": false,
24 "includeTransferred": true,
25 "profile": {
26 "persistable": false,
27 "id": 10000001,
28 "createdBy": "john.doe@example.com",
29 "createdAt": "2025-01-01T10:00:00Z",
30 "modifiedBy": "john.doe@example.com",
31 "modifiedAt": "2025-01-01T10:00:00Z",
32 "profileId": 10000001,
33 "name": "Sample Name",
34 "principalPositionType": {
35 "name": "LESSEE",
36 "captionKey": "enum.principalpositiontype.lessee",
37 "caption": "Lessee"
38 },
39 "filterTypes": {
40 "erpSystemFilterType": {
41 "name": "ALL",
42 "captionKey": "enum.filterType.all",
43 "caption": "All"
44 },
45 "leaseAreaFilterType": {
46 "name": "ALL",
47 "captionKey": "enum.filterType.all",
48 "caption": "All"
49 },
50 "businessUnitFilterType": {
51 "name": "ALL",
52 "captionKey": "enum.filterType.all",
53 "caption": "All"
54 },
55 "companyFilterType": {
56 "name": "ALL",
57 "captionKey": "enum.filterType.all",
58 "caption": "All"
59 },
60 "leaseDepartmentFilterType": {
61 "name": "ALL",
62 "captionKey": "enum.filterType.all",
63 "caption": "All"
64 },
65 "leaseGroupFilterType": {
66 "name": "ALL",
67 "captionKey": "enum.filterType.all",
68 "caption": "All"
69 },
70 "costCenterFilterType": {
71 "name": "ALL",
72 "captionKey": "enum.filterType.all",
73 "caption": "All"
74 },
75 "profitCenterFilterType": {
76 "name": "ALL",
77 "captionKey": "enum.filterType.all",
78 "caption": "All"
79 },
80 "wbsFilterType": {
81 "name": "ALL",
82 "captionKey": "enum.filterType.all",
83 "caption": "All"
84 },
85 "businessAreaFilterType": {
86 "name": "ALL",
87 "captionKey": "enum.filterType.all",
88 "caption": "All"
89 },
90 "functionalAreaFilterType": {
91 "name": "ALL",
92 "captionKey": "enum.filterType.all",
93 "caption": "All"
94 }
95 },
96 "baseIdList": [],
97 "bypassFiltering": false,
98 "listObjectType": {
99 "name": "CONTRACT",
100 "captionKey": "enum.listObjectType.contract",
101 "caption": "Contract"
102 },
103 "objectListDisplayIds": [],
104 "includeTransferred": true,
105 "new": false
106 }
107}
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}
Search Mass Workflow Jobs¶
HTTP Request
POST /api/v1/batch/mass-workflow/jobs/search
📋 Description: Submits a search request for mass workflow jobs related to leases, contracts, and financial obligations within the Nakisa Lease Accounting Suite, enabling users to efficiently locate and manage accounting entries.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
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 retrieving job details related to leases, contracts, and financial obligations 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 "inputEntityTypeEqual": {
19 "name": "CONTRACT",
20 "captionKey": "enum.objectType.contract",
21 "caption": "Contract"
22 }
23}
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 Workflow Job (With Number Of Filtered Entities)¶
HTTP Request
POST /api/v1/batch/mass-workflow/jobs/number-of-filtered-entities
📋 Description: Submits a request to retrieve the count of filtered entities related to leases, contracts, financial obligations, and accounting entries within the Nakisa Lease Accounting Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
false |
Request body containing the criteria for filtering lease-related entities, including contract details and financial obligations, to facilitate accurate accounting entry processing. |
Body Parameters
1{
2 "id": 10000001,
3 "taskCount": 100,
4 "failedTaskCount": 100,
5 "doneTaskCount": 100,
6 "inProgressTaskCount": 100,
7 "cancelledTaskCount": 100,
8 "errorMessage": "sample_errorMessage",
9 "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 "filter": {
29 "id": 10000001,
30 "profileId": 10000001,
31 "jobId": 10000001,
32 "name": "Sample Name",
33 "principalPositionType": {
34 "name": "LESSEE",
35 "captionKey": "enum.principalpositiontype.lessee",
36 "caption": "Lessee"
37 },
38 "filterTypes": {
39 "erpSystemFilterType": {
40 "name": "ALL",
41 "captionKey": "enum.filterType.all",
42 "caption": "All"
43 },
44 "erpSystems": [],
45 "leaseAreaFilterType": {
46 "name": "ALL",
47 "captionKey": "enum.filterType.all",
48 "caption": "All"
49 },
50 "leaseAreas": [],
51 "businessUnitFilterType": {
52 "name": "ALL",
53 "captionKey": "enum.filterType.all",
54 "caption": "All"
55 },
56 "businessUnits": [],
57 "companyFilterType": {
58 "name": "ALL",
59 "captionKey": "enum.filterType.all",
60 "caption": "All"
61 },
62 "companies": [],
63 "leaseDepartmentFilterType": {
64 "name": "ALL",
65 "captionKey": "enum.filterType.all",
66 "caption": "All"
67 },
68 "leaseDepartments": [],
69 "leaseGroupFilterType": {
70 "name": "ALL",
71 "captionKey": "enum.filterType.all",
72 "caption": "All"
73 },
74 "leaseGroups": [],
75 "costCenterFilterType": {
76 "name": "ALL",
77 "captionKey": "enum.filterType.all",
78 "caption": "All"
79 },
80 "costCenters": [],
81 "profitCenterFilterType": {
82 "name": "ALL",
83 "captionKey": "enum.filterType.all",
84 "caption": "All"
85 },
86 "profitCenters": [],
87 "wbsFilterType": {
88 "name": "ALL",
89 "captionKey": "enum.filterType.all",
90 "caption": "All"
91 },
92 "wbses": [],
93 "businessAreaFilterType": {
94 "name": "ALL",
95 "captionKey": "enum.filterType.all",
96 "caption": "All"
97 },
98 "businessAreas": [],
99 "functionalAreaFilterType": {
100 "name": "ALL",
101 "captionKey": "enum.filterType.all",
102 "caption": "All"
103 },
104 "functionalAreas": []
105 },
106 "bypassFiltering": false,
107 "listObjectType": {
108 "name": "CONTRACT",
109 "captionKey": "enum.listObjectType.contract",
110 "caption": "Contract"
111 },
112 "objectListDisplayIds": [],
113 "includeTransferred": true
114 },
115 "input": {
116 "id": 10000001,
117 "entityType": {
118 "name": "CONTRACT",
119 "captionKey": "enum.objectType.contract",
120 "caption": "Contract"
121 },
122 "migratedFilterType": {
123 "name": "ALL",
124 "captionKey": "enum.migratedFilterType.all",
125 "caption": "All"
126 },
127 "useDefaultWorkbookInput": false,
128 "initialState": {
129 "name": "AG_ACTIVE",
130 "captionKey": "enum.entityStatus.agActive",
131 "caption": "Active"
132 },
133 "terminalState": {
134 "name": "AG_ACTIVE",
135 "captionKey": "enum.entityStatus.agActive",
136 "caption": "Active"
137 },
138 "transitions": {
139 "name": "AG_DEFINE_TO_GENERATING",
140 "captionKey": "enum.workflowTransition.agDefineToGenerating",
141 "caption": "AG Define To Generating"
142 },
143 "intermediateStates": {
144 "name": "AG_ACTIVE",
145 "captionKey": "enum.entityStatus.agActive",
146 "caption": "Active"
147 },
148 "acceptsHitchhickers": false,
149 "dateType": {
150 "name": "AG_ROU_DATES",
151 "captionKey": "enum.agDateType.agRouDates",
152 "caption": "AG ROU Dates"
153 },
154 "postingDate": "2025-01-01",
155 "documentDate": "2025-01-01",
156 "cascadeParentClosure": true
157 },
158 "processingStage": {
159 "name": "PROCESSING_MASS_WORKFLOW",
160 "captionKey": "enum.massWorkflowStage.processingMassWorkflow",
161 "caption": "Processing Mass Workflow"
162 },
163 "generatingXSSFWorkbookInputTemplate": false,
164 "startedGeneratingXSSFWorkbookInputTemplateAt": "2025-01-01T10:00:00Z"
165}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
integer |
Example Responses
10
Get Master Agreements For Mass Workflow Job¶
HTTP Request
POST /api/v1/batch/mass-workflow/jobs/master-agreements
📋 Description: Creates master agreements in bulk for lease and contract management within the Nakisa Lease Accounting Suite, facilitating streamlined financial obligation tracking and accounting entry generation.
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, contract identifiers, and associated financial obligations for 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 "migratedFilterType": {
4 "name": "ALL",
5 "captionKey": "enum.migratedFilterType.all",
6 "caption": "All"
7 },
8 "entityType": {
9 "name": "CONTRACT",
10 "captionKey": "enum.objectType.contract",
11 "caption": "Contract"
12 },
13 "initialState": {
14 "name": "AG_ACTIVE",
15 "captionKey": "enum.entityStatus.agActive",
16 "caption": "Active"
17 },
18 "transitions": {
19 "name": "AG_DEFINE_TO_GENERATING",
20 "captionKey": "enum.workflowTransition.agDefineToGenerating",
21 "caption": "AG Define To Generating"
22 },
23 "acceptsHitchhickers": false,
24 "includeTransferred": true,
25 "profile": {
26 "persistable": false,
27 "id": 10000001,
28 "createdBy": "john.doe@example.com",
29 "createdAt": "2025-01-01T10:00:00Z",
30 "modifiedBy": "john.doe@example.com",
31 "modifiedAt": "2025-01-01T10:00:00Z",
32 "profileId": 10000001,
33 "name": "Sample Name",
34 "principalPositionType": {
35 "name": "LESSEE",
36 "captionKey": "enum.principalpositiontype.lessee",
37 "caption": "Lessee"
38 },
39 "filterTypes": {
40 "erpSystemFilterType": {
41 "name": "ALL",
42 "captionKey": "enum.filterType.all",
43 "caption": "All"
44 },
45 "leaseAreaFilterType": {
46 "name": "ALL",
47 "captionKey": "enum.filterType.all",
48 "caption": "All"
49 },
50 "businessUnitFilterType": {
51 "name": "ALL",
52 "captionKey": "enum.filterType.all",
53 "caption": "All"
54 },
55 "companyFilterType": {
56 "name": "ALL",
57 "captionKey": "enum.filterType.all",
58 "caption": "All"
59 },
60 "leaseDepartmentFilterType": {
61 "name": "ALL",
62 "captionKey": "enum.filterType.all",
63 "caption": "All"
64 },
65 "leaseGroupFilterType": {
66 "name": "ALL",
67 "captionKey": "enum.filterType.all",
68 "caption": "All"
69 },
70 "costCenterFilterType": {
71 "name": "ALL",
72 "captionKey": "enum.filterType.all",
73 "caption": "All"
74 },
75 "profitCenterFilterType": {
76 "name": "ALL",
77 "captionKey": "enum.filterType.all",
78 "caption": "All"
79 },
80 "wbsFilterType": {
81 "name": "ALL",
82 "captionKey": "enum.filterType.all",
83 "caption": "All"
84 },
85 "businessAreaFilterType": {
86 "name": "ALL",
87 "captionKey": "enum.filterType.all",
88 "caption": "All"
89 },
90 "functionalAreaFilterType": {
91 "name": "ALL",
92 "captionKey": "enum.filterType.all",
93 "caption": "All"
94 }
95 },
96 "baseIdList": [],
97 "bypassFiltering": false,
98 "listObjectType": {
99 "name": "CONTRACT",
100 "captionKey": "enum.listObjectType.contract",
101 "caption": "Contract"
102 },
103 "objectListDisplayIds": [],
104 "includeTransferred": true,
105 "new": false
106 }
107}
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 Workflow Job¶
HTTP Request
POST /api/v1/batch/mass-workflow/jobs/lease-components
📋 Description: Creates multiple lease component entries in the Nakisa Lease Accounting Suite, facilitating the management of financial obligations and accounting entries associated with lease contracts.
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 details, including contract identifiers and financial obligations, necessary for processing mass workflow jobs 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 "migratedFilterType": {
4 "name": "ALL",
5 "captionKey": "enum.migratedFilterType.all",
6 "caption": "All"
7 },
8 "entityType": {
9 "name": "CONTRACT",
10 "captionKey": "enum.objectType.contract",
11 "caption": "Contract"
12 },
13 "initialState": {
14 "name": "AG_ACTIVE",
15 "captionKey": "enum.entityStatus.agActive",
16 "caption": "Active"
17 },
18 "transitions": {
19 "name": "AG_DEFINE_TO_GENERATING",
20 "captionKey": "enum.workflowTransition.agDefineToGenerating",
21 "caption": "AG Define To Generating"
22 },
23 "acceptsHitchhickers": false,
24 "includeTransferred": true,
25 "profile": {
26 "persistable": false,
27 "id": 10000001,
28 "createdBy": "john.doe@example.com",
29 "createdAt": "2025-01-01T10:00:00Z",
30 "modifiedBy": "john.doe@example.com",
31 "modifiedAt": "2025-01-01T10:00:00Z",
32 "profileId": 10000001,
33 "name": "Sample Name",
34 "principalPositionType": {
35 "name": "LESSEE",
36 "captionKey": "enum.principalpositiontype.lessee",
37 "caption": "Lessee"
38 },
39 "filterTypes": {
40 "erpSystemFilterType": {
41 "name": "ALL",
42 "captionKey": "enum.filterType.all",
43 "caption": "All"
44 },
45 "leaseAreaFilterType": {
46 "name": "ALL",
47 "captionKey": "enum.filterType.all",
48 "caption": "All"
49 },
50 "businessUnitFilterType": {
51 "name": "ALL",
52 "captionKey": "enum.filterType.all",
53 "caption": "All"
54 },
55 "companyFilterType": {
56 "name": "ALL",
57 "captionKey": "enum.filterType.all",
58 "caption": "All"
59 },
60 "leaseDepartmentFilterType": {
61 "name": "ALL",
62 "captionKey": "enum.filterType.all",
63 "caption": "All"
64 },
65 "leaseGroupFilterType": {
66 "name": "ALL",
67 "captionKey": "enum.filterType.all",
68 "caption": "All"
69 },
70 "costCenterFilterType": {
71 "name": "ALL",
72 "captionKey": "enum.filterType.all",
73 "caption": "All"
74 },
75 "profitCenterFilterType": {
76 "name": "ALL",
77 "captionKey": "enum.filterType.all",
78 "caption": "All"
79 },
80 "wbsFilterType": {
81 "name": "ALL",
82 "captionKey": "enum.filterType.all",
83 "caption": "All"
84 },
85 "businessAreaFilterType": {
86 "name": "ALL",
87 "captionKey": "enum.filterType.all",
88 "caption": "All"
89 },
90 "functionalAreaFilterType": {
91 "name": "ALL",
92 "captionKey": "enum.filterType.all",
93 "caption": "All"
94 }
95 },
96 "baseIdList": [],
97 "bypassFiltering": false,
98 "listObjectType": {
99 "name": "CONTRACT",
100 "captionKey": "enum.listObjectType.contract",
101 "caption": "Contract"
102 },
103 "objectListDisplayIds": [],
104 "includeTransferred": true,
105 "new": false
106 }
107}
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 Workflow Job¶
HTTP Request
POST /api/v1/batch/mass-workflow/jobs/contracts
📋 Description: Submits a batch of contract jobs for processing within the Nakisa Lease Accounting Suite, facilitating the management of leases and financial obligations through automated accounting entries.
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 details, including lease information and financial obligations, necessary for processing mass workflow jobs 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 "migratedFilterType": {
4 "name": "ALL",
5 "captionKey": "enum.migratedFilterType.all",
6 "caption": "All"
7 },
8 "entityType": {
9 "name": "CONTRACT",
10 "captionKey": "enum.objectType.contract",
11 "caption": "Contract"
12 },
13 "initialState": {
14 "name": "AG_ACTIVE",
15 "captionKey": "enum.entityStatus.agActive",
16 "caption": "Active"
17 },
18 "transitions": {
19 "name": "AG_DEFINE_TO_GENERATING",
20 "captionKey": "enum.workflowTransition.agDefineToGenerating",
21 "caption": "AG Define To Generating"
22 },
23 "acceptsHitchhickers": false,
24 "includeTransferred": true,
25 "profile": {
26 "persistable": false,
27 "id": 10000001,
28 "createdBy": "john.doe@example.com",
29 "createdAt": "2025-01-01T10:00:00Z",
30 "modifiedBy": "john.doe@example.com",
31 "modifiedAt": "2025-01-01T10:00:00Z",
32 "profileId": 10000001,
33 "name": "Sample Name",
34 "principalPositionType": {
35 "name": "LESSEE",
36 "captionKey": "enum.principalpositiontype.lessee",
37 "caption": "Lessee"
38 },
39 "filterTypes": {
40 "erpSystemFilterType": {
41 "name": "ALL",
42 "captionKey": "enum.filterType.all",
43 "caption": "All"
44 },
45 "leaseAreaFilterType": {
46 "name": "ALL",
47 "captionKey": "enum.filterType.all",
48 "caption": "All"
49 },
50 "businessUnitFilterType": {
51 "name": "ALL",
52 "captionKey": "enum.filterType.all",
53 "caption": "All"
54 },
55 "companyFilterType": {
56 "name": "ALL",
57 "captionKey": "enum.filterType.all",
58 "caption": "All"
59 },
60 "leaseDepartmentFilterType": {
61 "name": "ALL",
62 "captionKey": "enum.filterType.all",
63 "caption": "All"
64 },
65 "leaseGroupFilterType": {
66 "name": "ALL",
67 "captionKey": "enum.filterType.all",
68 "caption": "All"
69 },
70 "costCenterFilterType": {
71 "name": "ALL",
72 "captionKey": "enum.filterType.all",
73 "caption": "All"
74 },
75 "profitCenterFilterType": {
76 "name": "ALL",
77 "captionKey": "enum.filterType.all",
78 "caption": "All"
79 },
80 "wbsFilterType": {
81 "name": "ALL",
82 "captionKey": "enum.filterType.all",
83 "caption": "All"
84 },
85 "businessAreaFilterType": {
86 "name": "ALL",
87 "captionKey": "enum.filterType.all",
88 "caption": "All"
89 },
90 "functionalAreaFilterType": {
91 "name": "ALL",
92 "captionKey": "enum.filterType.all",
93 "caption": "All"
94 }
95 },
96 "baseIdList": [],
97 "bypassFiltering": false,
98 "listObjectType": {
99 "name": "CONTRACT",
100 "captionKey": "enum.listObjectType.contract",
101 "caption": "Contract"
102 },
103 "objectListDisplayIds": [],
104 "includeTransferred": true,
105 "new": false
106 }
107}
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 Workflow Job¶
HTTP Request
POST /api/v1/batch/mass-workflow/jobs/cancel/{jobId}
📋 Description: Cancels a specified job within the mass workflow process, allowing users to effectively manage lease and contract-related financial obligations in the Nakisa Lease Accounting Suite. This operation ensures timely updates to accounting entries by halting ongoing job executions.
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 Workflow Job¶
HTTP Request
POST /api/v1/batch/mass-workflow/jobs/activation-groups
📋 Description: Creates activation groups for mass workflow jobs within the Nakisa Lease Accounting Suite, enabling efficient management of lease, contract, and financial obligation processes.
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 managing lease-related workflows, including details on contracts, 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 "migratedFilterType": {
4 "name": "ALL",
5 "captionKey": "enum.migratedFilterType.all",
6 "caption": "All"
7 },
8 "entityType": {
9 "name": "CONTRACT",
10 "captionKey": "enum.objectType.contract",
11 "caption": "Contract"
12 },
13 "initialState": {
14 "name": "AG_ACTIVE",
15 "captionKey": "enum.entityStatus.agActive",
16 "caption": "Active"
17 },
18 "transitions": {
19 "name": "AG_DEFINE_TO_GENERATING",
20 "captionKey": "enum.workflowTransition.agDefineToGenerating",
21 "caption": "AG Define To Generating"
22 },
23 "acceptsHitchhickers": false,
24 "includeTransferred": true,
25 "profile": {
26 "persistable": false,
27 "id": 10000001,
28 "createdBy": "john.doe@example.com",
29 "createdAt": "2025-01-01T10:00:00Z",
30 "modifiedBy": "john.doe@example.com",
31 "modifiedAt": "2025-01-01T10:00:00Z",
32 "profileId": 10000001,
33 "name": "Sample Name",
34 "principalPositionType": {
35 "name": "LESSEE",
36 "captionKey": "enum.principalpositiontype.lessee",
37 "caption": "Lessee"
38 },
39 "filterTypes": {
40 "erpSystemFilterType": {
41 "name": "ALL",
42 "captionKey": "enum.filterType.all",
43 "caption": "All"
44 },
45 "leaseAreaFilterType": {
46 "name": "ALL",
47 "captionKey": "enum.filterType.all",
48 "caption": "All"
49 },
50 "businessUnitFilterType": {
51 "name": "ALL",
52 "captionKey": "enum.filterType.all",
53 "caption": "All"
54 },
55 "companyFilterType": {
56 "name": "ALL",
57 "captionKey": "enum.filterType.all",
58 "caption": "All"
59 },
60 "leaseDepartmentFilterType": {
61 "name": "ALL",
62 "captionKey": "enum.filterType.all",
63 "caption": "All"
64 },
65 "leaseGroupFilterType": {
66 "name": "ALL",
67 "captionKey": "enum.filterType.all",
68 "caption": "All"
69 },
70 "costCenterFilterType": {
71 "name": "ALL",
72 "captionKey": "enum.filterType.all",
73 "caption": "All"
74 },
75 "profitCenterFilterType": {
76 "name": "ALL",
77 "captionKey": "enum.filterType.all",
78 "caption": "All"
79 },
80 "wbsFilterType": {
81 "name": "ALL",
82 "captionKey": "enum.filterType.all",
83 "caption": "All"
84 },
85 "businessAreaFilterType": {
86 "name": "ALL",
87 "captionKey": "enum.filterType.all",
88 "caption": "All"
89 },
90 "functionalAreaFilterType": {
91 "name": "ALL",
92 "captionKey": "enum.filterType.all",
93 "caption": "All"
94 }
95 },
96 "baseIdList": [],
97 "bypassFiltering": false,
98 "listObjectType": {
99 "name": "CONTRACT",
100 "captionKey": "enum.listObjectType.contract",
101 "caption": "Contract"
102 },
103 "objectListDisplayIds": [],
104 "includeTransferred": true,
105 "new": false
106 }
107}
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 Workflow Jobs¶
HTTP Request
GET /api/v1/batch/mass-workflow/jobs
📋 Description: Retrieves a list of jobs associated with mass workflows in the Nakisa Lease Accounting Suite, enabling users to manage lease-related tasks, contracts, and financial obligations efficiently.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
Indicates whether the results of the mass workflow jobs query should be returned in a paginated format, facilitating efficient retrieval of lease and contract-related data 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 Workflow Job¶
HTTP Request
POST /api/v1/batch/mass-workflow/jobs
📋 Description: Creates multiple jobs for mass workflow processing within the Nakisa Lease Accounting Suite, enabling efficient management of leases, contracts, and related financial obligations.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
false |
Request body containing the batch job details for processing lease and contract-related financial obligations and 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 "filter": {
29 "id": 10000001,
30 "profileId": 10000001,
31 "jobId": 10000001,
32 "name": "Sample Name",
33 "principalPositionType": {
34 "name": "LESSEE",
35 "captionKey": "enum.principalpositiontype.lessee",
36 "caption": "Lessee"
37 },
38 "filterTypes": {
39 "erpSystemFilterType": {
40 "name": "ALL",
41 "captionKey": "enum.filterType.all",
42 "caption": "All"
43 },
44 "erpSystems": [],
45 "leaseAreaFilterType": {
46 "name": "ALL",
47 "captionKey": "enum.filterType.all",
48 "caption": "All"
49 },
50 "leaseAreas": [],
51 "businessUnitFilterType": {
52 "name": "ALL",
53 "captionKey": "enum.filterType.all",
54 "caption": "All"
55 },
56 "businessUnits": [],
57 "companyFilterType": {
58 "name": "ALL",
59 "captionKey": "enum.filterType.all",
60 "caption": "All"
61 },
62 "companies": [],
63 "leaseDepartmentFilterType": {
64 "name": "ALL",
65 "captionKey": "enum.filterType.all",
66 "caption": "All"
67 },
68 "leaseDepartments": [],
69 "leaseGroupFilterType": {
70 "name": "ALL",
71 "captionKey": "enum.filterType.all",
72 "caption": "All"
73 },
74 "leaseGroups": [],
75 "costCenterFilterType": {
76 "name": "ALL",
77 "captionKey": "enum.filterType.all",
78 "caption": "All"
79 },
80 "costCenters": [],
81 "profitCenterFilterType": {
82 "name": "ALL",
83 "captionKey": "enum.filterType.all",
84 "caption": "All"
85 },
86 "profitCenters": [],
87 "wbsFilterType": {
88 "name": "ALL",
89 "captionKey": "enum.filterType.all",
90 "caption": "All"
91 },
92 "wbses": [],
93 "businessAreaFilterType": {
94 "name": "ALL",
95 "captionKey": "enum.filterType.all",
96 "caption": "All"
97 },
98 "businessAreas": [],
99 "functionalAreaFilterType": {
100 "name": "ALL",
101 "captionKey": "enum.filterType.all",
102 "caption": "All"
103 },
104 "functionalAreas": []
105 },
106 "bypassFiltering": false,
107 "listObjectType": {
108 "name": "CONTRACT",
109 "captionKey": "enum.listObjectType.contract",
110 "caption": "Contract"
111 },
112 "objectListDisplayIds": [],
113 "includeTransferred": true
114 },
115 "input": {
116 "id": 10000001,
117 "entityType": {
118 "name": "CONTRACT",
119 "captionKey": "enum.objectType.contract",
120 "caption": "Contract"
121 },
122 "migratedFilterType": {
123 "name": "ALL",
124 "captionKey": "enum.migratedFilterType.all",
125 "caption": "All"
126 },
127 "useDefaultWorkbookInput": false,
128 "initialState": {
129 "name": "AG_ACTIVE",
130 "captionKey": "enum.entityStatus.agActive",
131 "caption": "Active"
132 },
133 "terminalState": {
134 "name": "AG_ACTIVE",
135 "captionKey": "enum.entityStatus.agActive",
136 "caption": "Active"
137 },
138 "transitions": {
139 "name": "AG_DEFINE_TO_GENERATING",
140 "captionKey": "enum.workflowTransition.agDefineToGenerating",
141 "caption": "AG Define To Generating"
142 },
143 "intermediateStates": {
144 "name": "AG_ACTIVE",
145 "captionKey": "enum.entityStatus.agActive",
146 "caption": "Active"
147 },
148 "acceptsHitchhickers": false,
149 "dateType": {
150 "name": "AG_ROU_DATES",
151 "captionKey": "enum.agDateType.agRouDates",
152 "caption": "AG ROU Dates"
153 },
154 "postingDate": "2025-01-01",
155 "documentDate": "2025-01-01",
156 "cascadeParentClosure": true
157 },
158 "processingStage": {
159 "name": "PROCESSING_MASS_WORKFLOW",
160 "captionKey": "enum.massWorkflowStage.processingMassWorkflow",
161 "caption": "Processing Mass Workflow"
162 },
163 "generatingXSSFWorkbookInputTemplate": false,
164 "startedGeneratingXSSFWorkbookInputTemplateAt": "2025-01-01T10:00:00Z"
165}
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 "filter": {
38 "id": 10000001,
39 "profileId": 10000001,
40 "jobId": 10000001,
41 "name": "Sample Name",
42 "principalPositionType": {
43 "name": "LESSEE",
44 "captionKey": "enum.principalpositiontype.lessee",
45 "caption": "Lessee"
46 },
47 "filterTypes": {
48 "erpSystemFilterType": {
49 "name": "ALL",
50 "captionKey": "enum.filterType.all",
51 "caption": "All"
52 },
53 "erpSystems": [],
54 "leaseAreaFilterType": {
55 "name": "ALL",
56 "captionKey": "enum.filterType.all",
57 "caption": "All"
58 },
59 "leaseAreas": [],
60 "businessUnitFilterType": {
61 "name": "ALL",
62 "captionKey": "enum.filterType.all",
63 "caption": "All"
64 },
65 "businessUnits": [],
66 "companyFilterType": {
67 "name": "ALL",
68 "captionKey": "enum.filterType.all",
69 "caption": "All"
70 },
71 "companies": [],
72 "leaseDepartmentFilterType": {
73 "name": "ALL",
74 "captionKey": "enum.filterType.all",
75 "caption": "All"
76 },
77 "leaseDepartments": [],
78 "leaseGroupFilterType": {
79 "name": "ALL",
80 "captionKey": "enum.filterType.all",
81 "caption": "All"
82 },
83 "leaseGroups": [],
84 "costCenterFilterType": {
85 "name": "ALL",
86 "captionKey": "enum.filterType.all",
87 "caption": "All"
88 },
89 "costCenters": [],
90 "profitCenterFilterType": {
91 "name": "ALL",
92 "captionKey": "enum.filterType.all",
93 "caption": "All"
94 },
95 "profitCenters": [],
96 "wbsFilterType": {
97 "name": "ALL",
98 "captionKey": "enum.filterType.all",
99 "caption": "All"
100 },
101 "wbses": [],
102 "businessAreaFilterType": {
103 "name": "ALL",
104 "captionKey": "enum.filterType.all",
105 "caption": "All"
106 },
107 "businessAreas": [],
108 "functionalAreaFilterType": {
109 "name": "ALL",
110 "captionKey": "enum.filterType.all",
111 "caption": "All"
112 },
113 "functionalAreas": []
114 },
115 "bypassFiltering": false,
116 "listObjectType": {
117 "name": "CONTRACT",
118 "captionKey": "enum.listObjectType.contract",
119 "caption": "Contract"
120 },
121 "objectListDisplayIds": [],
122 "includeTransferred": true
123 },
124 "input": {
125 "id": 10000001,
126 "entityType": {
127 "name": "CONTRACT",
128 "captionKey": "enum.objectType.contract",
129 "caption": "Contract"
130 },
131 "migratedFilterType": {
132 "name": "ALL",
133 "captionKey": "enum.migratedFilterType.all",
134 "caption": "All"
135 },
136 "useDefaultWorkbookInput": false,
137 "initialState": {
138 "name": "AG_ACTIVE",
139 "captionKey": "enum.entityStatus.agActive",
140 "caption": "Active"
141 },
142 "terminalState": {
143 "name": "AG_ACTIVE",
144 "captionKey": "enum.entityStatus.agActive",
145 "caption": "Active"
146 },
147 "transitions": {
148 "name": "AG_DEFINE_TO_GENERATING",
149 "captionKey": "enum.workflowTransition.agDefineToGenerating",
150 "caption": "AG Define To Generating"
151 },
152 "intermediateStates": {
153 "name": "AG_ACTIVE",
154 "captionKey": "enum.entityStatus.agActive",
155 "caption": "Active"
156 },
157 "acceptsHitchhickers": false,
158 "dateType": {
159 "name": "AG_ROU_DATES",
160 "captionKey": "enum.agDateType.agRouDates",
161 "caption": "AG ROU Dates"
162 },
163 "postingDate": "2025-01-01",
164 "documentDate": "2025-01-01",
165 "cascadeParentClosure": true
166 },
167 "processingStage": {
168 "name": "PROCESSING_MASS_WORKFLOW",
169 "captionKey": "enum.massWorkflowStage.processingMassWorkflow",
170 "caption": "Processing Mass Workflow"
171 },
172 "generatingXSSFWorkbookInputTemplate": false,
173 "startedGeneratingXSSFWorkbookInputTemplateAt": "2025-01-01T10:00:00Z"
174 }
175}
Retrieve A Specific Transitions Originating From State¶
HTTP Request
GET /api/v1/batch/mass-workflow/jobs/transitions-originating-from-state/{state_type_name}
📋 Description: Retrieves job transitions originating from a specified state within the Nakisa Lease Accounting Suite, facilitating insights into lease, contract, and financial obligation workflows. This operation supports effective management of accounting entries by providing visibility into the progression of jobs based on their current state.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
state_type_name |
path |
string |
true |
Specifies the name of the state type from which job transitions are originating, relevant for managing lease, contract, and financial obligation workflows within the Nakisa Lease Accounting Suite. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 "string"
3]
Response Schema
Retrieve A Specific Transitions Between States¶
HTTP Request
GET /api/v1/batch/mass-workflow/jobs/transitions-between-states/{initial_state}/{terminal_state}
📋 Description: Retrieves the transitions between specified initial and terminal states for jobs within the mass workflow of the Nakisa Lease Accounting Suite, facilitating effective management of lease contracts and financial obligations. This operation supports accounting entries by providing insights into job state changes.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
initial_state |
path |
string |
true |
Specifies the initial state of a job transition within the Nakisa Lease Accounting Suite, facilitating the tracking of lease, contract, and financial obligation workflows. |
terminal_state |
path |
string |
true |
Specifies the final state of a job transition within the lease accounting workflow, facilitating the tracking of lease, contract, and financial obligation statuses. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 "string"
3]
Response Schema
Retrieve A Specific Permissible Transitions Originating From State¶
HTTP Request
GET /api/v1/batch/mass-workflow/jobs/permissible-transitions-originating-from-state/{state_type_name}
📋 Description: Retrieves permissible transitions for jobs originating from a specified state within the Nakisa Lease Accounting Suite, facilitating effective management of lease, contract, and financial obligation workflows.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
state_type_name |
path |
string |
true |
Specifies the name of the state type from which permissible transitions are retrieved, relevant to lease, contract, financial obligation, and accounting entry processes within the Nakisa Lease Accounting Suite. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 "string"
3]
Response Schema
Retrieve A Specific Permissible Initial States¶
HTTP Request
GET /api/v1/batch/mass-workflow/jobs/permissible-initial-states/{entity_type}
📋 Description: Retrieves the permissible initial states for mass workflow jobs based on the specified entity type, facilitating efficient management of leases, contracts, financial obligations, and accounting entries within the Nakisa Lease Accounting Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
entity_type |
path |
string |
true |
Specifies the type of entity—such as lease, contract, financial obligation, or accounting entry—for which permissible initial states are being retrieved in the Nakisa Lease Accounting Suite. |
principalPositionType |
query |
string |
false |
Type of the principal position |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 "string"
3]
Response Schema
Get Mass Workflow Job By ID (with Permissible End States, Entity_Type and Init_State)¶
HTTP Request
GET /api/v1/batch/mass-workflow/jobs/permissible-end-states/{entity_type}/{init_state}
📋 Description: Fetches the permissible end states for jobs associated with a specified entity type and initial state within the Nakisa Lease Accounting Suite, facilitating effective management of leases, contracts, financial obligations, and accounting entries.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
entity_type |
path |
string |
true |
Specifies the type of entity—such as lease, contract, financial obligation, or accounting entry—related to the permissible end states in the mass workflow jobs. |
init_state |
path |
string |
true |
Specifies the initial state of the job within the permissible end states for the given entity type, relevant for managing leases, contracts, financial obligations, and accounting entries in the Nakisa Lease Accounting Suite. |
principalPositionType |
query |
string |
false |
Type of the principal position |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 "string"
3]
Response Schema
Get Mass Workflow Job By ID (with Ordered Possible Terminal States, Entity_Type and Init_State)¶
HTTP Request
GET /api/v1/batch/mass-workflow/jobs/ordered-possible-terminal-states/{entity_type}/{init_state}
📋 Description: Retrieves the ordered possible terminal states for jobs associated with a specified entity type and initial state within the Nakisa Lease Accounting Suite, facilitating effective management of leases, contracts, and financial obligations.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
entity_type |
path |
string |
true |
Specifies the type of entity—such as lease, contract, financial obligation, or accounting entry—related to the mass workflow job’s possible terminal states. |
init_state |
path |
string |
true |
Specifies the initial state of the job within the mass workflow, relevant to lease, contract, financial obligation, and accounting entry processes. |
principalPositionType |
query |
string |
false |
Type of the principal position |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 "string"
3]
Response Schema
List Object Types For Mass Workflow Job¶
HTTP Request
GET /api/v1/batch/mass-workflow/jobs/list-object-types
📋 Description: Retrieves a list of object types related to jobs within the Nakisa Lease Accounting Suite, facilitating the management of leases, contracts, financial obligations, and accounting entries. This operation supports users in identifying and categorizing relevant job types for streamlined workflow processes.
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 "string"
3]
Response Schema
Retrieve A Specific Download Workbook Template¶
HTTP Request
GET /api/v1/batch/mass-workflow/jobs/download-workbook-template/{job-id}
📋 Description: Downloads the workbook template associated with a specified job ID, facilitating the preparation of lease and contract data for financial obligation and accounting entry analysis within the Nakisa Lease Accounting Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
job-id |
path |
integer |
true |
Unique identifier for the specific job associated with downloading the workbook template within the Nakisa Lease Accounting Suite, relevant to lease and contract management. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Retrieve A Specific Download Workbook Input¶
HTTP Request
GET /api/v1/batch/mass-workflow/jobs/download-workbook-input/{job-id}
📋 Description: Downloads the input workbook associated with a specified job ID for mass workflow processing within the Nakisa Lease Accounting Suite, facilitating efficient management of lease and contract-related financial obligations.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
job-id |
path |
integer |
true |
Unique identifier for the specific job associated with downloading workbook input related to lease and contract financial obligations within the Nakisa Lease Accounting Suite. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |