Disclosure Report Schedule Job¶
Disclosure Report Schedule Job - Get¶
HTTP Request
GET /api/v1/disclosure_reports/schedule-jobs/{id}
📋 Description: Retrieves the scheduled job details for a specific disclosure report identified by the provided ID, facilitating the management of lease-related financial obligations and accounting entries within the Nakisa Lease Accounting Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": []
5 },
6 "object": {
7 "id": 0,
8 "cronExpression": "string",
9 "cronReadable": "string",
10 "active": true,
11 "unauthorized": true,
12 "nextExecution": "2019-08-24T14:15:22Z",
13 "previousSuccessfulExecution": "2019-08-24T14:15:22Z",
14 "previousExecution": "2019-08-24T14:15:22Z",
15 "previousExecutionMessage": "string",
16 "batchSize": 0,
17 "name": "string",
18 "profileId": 0,
19 "input": {
20 "id": 80000001,
21 "accountingStandardType": {
22 "name": "GAAP",
23 "captionKey": "enum.accountingStandardType.GAAP",
24 "caption": "IFRS 16"
25 },
26 "classifications": [
27 "NON_LEASE"
28 ],
29 "fromYear": 2024,
30 "fromPeriod": {
31 "id": 10000001,
32 "displayId": "FP-2024-Q1",
33 "status": {
34 "name": "ACTIVE",
35 "captionKey": "enum.objectStatus.active",
36 "active": true,
37 "caption": "Active"
38 },
39 "day": 15,
40 "year": 2024,
41 "month": 3,
42 "postingPeriod": 3,
43 "yearShift": 0
44 },
45 "toYear": 2025,
46 "toPeriod": {
47 "id": 10000001,
48 "displayId": "FP-2024-Q1",
49 "status": {
50 "name": "ACTIVE",
51 "captionKey": "enum.objectStatus.active",
52 "active": true,
53 "caption": "Active"
54 },
55 "day": 15,
56 "year": 2024,
57 "month": 3,
58 "postingPeriod": 3,
59 "yearShift": 0
60 },
61 "fromDate": "2024-01-01",
62 "toDate": "2025-12-31",
63 "fromDateType": "USER_DEFINED",
64 "toDateType": "USER_DEFINED",
65 "currencyDisplayId": "USD",
66 "currencyType": "TRANSACTION",
67 "currencyDefinitionType": {
68 "name": "COMPANY_CURRENCY",
69 "captionKey": "enum.currencyDefinitionType.companyCurrency",
70 "caption": "Company Currency"
71 },
72 "activationGroupStatus": {
73 "name": "AG_PENDING_ASSESSMENT",
74 "captionKey": "enum.ActivationGroup.StatusList",
75 "caption": "Activation Group Status"
76 },
77 "reportList": [
78 "NET_LEASE_INVESTMENT_REPORT"
79 ],
80 "listObjectType": {
81 "name": "CONTRACT",
82 "captionKey": "enum.objectType.contract",
83 "caption": "Contract"
84 },
85 "objectList": [
86 {
87 "id": 10000001,
88 "displayId": "ENT-001",
89 "name": "Entity Name"
90 }
91 ],
92 "migratedFilterType": {
93 "name": "ALL",
94 "captionKey": "enum.migratedFilterType.all",
95 "caption": "All"
96 },
97 "assetClassFilterType": {
98 "name": "ALL",
99 "captionKey": "enum.filterType.all",
100 "caption": "All"
101 },
102 "assetClasses": [
103 {
104 "id": 10000001,
105 "displayId": "IAC-001",
106 "status": {
107 "name": "ACTIVE",
108 "captionKey": "enum.objectStatus.active",
109 "active": true,
110 "caption": "Active"
111 },
112 "name": "Machinery and Equipment",
113 "assetClassType": "PROPERTY",
114 "infiniteUsefulLife": false
115 }
116 ],
117 "businessAreaFilterType": {
118 "name": "ALL",
119 "captionKey": "enum.filterType.all",
120 "caption": "All"
121 },
122 "businessAreas": [
123 {
124 "id": 3001,
125 "displayId": "BA-2025-001",
126 "status": {
127 "name": "ACTIVE",
128 "captionKey": "enum.objectStatus.active",
129 "active": true,
130 "caption": "Active"
131 },
132 "name": "North America Operations",
133 "erpSystemId": 0
134 }
135 ],
136 "vendorFilterType": {
137 "name": "ALL",
138 "captionKey": "enum.filterType.all",
139 "caption": "All"
140 },
141 "vendors": [
142 {
143 "id": 10000012,
144 "displayId": "0000100003",
145 "status": {
146 "name": "ACTIVE",
147 "captionKey": "enum.objectStatus.active",
148 "active": true,
149 "caption": "Active"
150 },
151 "name": "TEST VENDOR GB",
152 "erpSystemDisplayId": "FINQ8S-300"
153 }
154 ]
155 },
156 "profile": {
157 "id": 10000001,
158 "name": "Sample Name",
159 "principalPositionType": {
160 "name": "LESSEE",
161 "captionKey": "enum.principalpositiontype.lessee",
162 "caption": "Lessee"
163 },
164 "erpSystemFilterType": {
165 "name": "ALL",
166 "captionKey": "enum.filterType.all",
167 "caption": "All"
168 },
169 "erpSystems": [],
170 "leaseAreaFilterType": {
171 "name": "ALL",
172 "captionKey": "enum.filterType.all",
173 "caption": "All"
174 },
175 "leaseAreas": [],
176 "businessUnitFilterType": {
177 "name": "ALL",
178 "captionKey": "enum.filterType.all",
179 "caption": "All"
180 },
181 "businessUnits": [],
182 "companyFilterType": {
183 "name": "ALL",
184 "captionKey": "enum.filterType.all",
185 "caption": "All"
186 },
187 "companyCodes": [],
188 "departmentFilterType": {
189 "name": "ALL",
190 "captionKey": "enum.filterType.all",
191 "caption": "All"
192 },
193 "leaseDepartments": [],
194 "leaseGroupFilterType": {
195 "name": "ALL",
196 "captionKey": "enum.filterType.all",
197 "caption": "All"
198 },
199 "leaseGroups": [],
200 "costCenterFilterType": {
201 "name": "ALL",
202 "captionKey": "enum.filterType.all",
203 "caption": "All"
204 },
205 "costCenters": [],
206 "profitCenterFilterType": {
207 "name": "ALL",
208 "captionKey": "enum.filterType.all",
209 "caption": "All"
210 },
211 "profitCenters": [],
212 "workBreakdownStructureFilterType": {
213 "name": "ALL",
214 "captionKey": "enum.filterType.all",
215 "caption": "All"
216 },
217 "workBreakdownStructures": [],
218 "objectStatus": {
219 "name": "ACTIVE",
220 "captionKey": "enum.objectStatus.active",
221 "active": true,
222 "caption": "Active"
223 },
224 "securityProfileId": 10000001,
225 "calendarType": {
226 "name": "_360",
227 "captionKey": "enum.calendarType.360",
228 "caption": "360 Convention"
229 },
230 "fiscalVariant": {
231 "id": 10000001,
232 "displayId": "sample_displayId",
233 "status": {
234 "name": "ACTIVE",
235 "captionKey": "enum.objectStatus.active",
236 "active": true,
237 "caption": "Active"
238 },
239 "isCalendarYear": true,
240 "yearDependent": false,
241 "erpSystemDisplayId": "sample_erpSystemDisplayId"
242 },
243 "assetClassFilterType": {
244 "name": "ALL",
245 "captionKey": "enum.filterType.all",
246 "caption": "All"
247 },
248 "assetClasses": [],
249 "functionalAreaFilterType": {
250 "name": "ALL",
251 "captionKey": "enum.filterType.all",
252 "caption": "All"
253 },
254 "functionalAreas": [],
255 "businessAreaFilterType": {
256 "name": "ALL",
257 "captionKey": "enum.filterType.all",
258 "caption": "All"
259 },
260 "businessAreas": [],
261 "vendorFilterType": {
262 "name": "ALL",
263 "captionKey": "enum.filterType.all",
264 "caption": "All"
265 },
266 "vendors": [],
267 "leaseClassificationFilterType": {
268 "name": "ALL",
269 "captionKey": "enum.filterType.all",
270 "caption": "All"
271 },
272 "leaseClassifications": "sample_leaseClassifications",
273 "accountingStandardType": "TYPE_VALUE",
274 "filterObjectDto": {
275 "id": 10000001,
276 "profileId": 10000001,
277 "displayId": "sample_displayId",
278 "objectType": "TYPE_VALUE"
279 },
280 "scriptProfile": false
281 }
282 }
283}
Disclosure Report Schedule Job - Update¶
HTTP Request
PUT /api/v1/disclosure_reports/schedule-jobs/{id}
📋 Description: Updates the scheduling status of a disclosure report identified by the specified ID, enabling effective management of lease-related financial obligations and ensuring accurate accounting entries within the Nakisa Lease Accounting Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing the updated scheduling details for the disclosure report job, including lease and contract identifiers, to ensure accurate financial obligation tracking and accounting entry management. |
Body Parameters
1{
2 "id": 0,
3 "cronExpression": "string",
4 "cronReadable": "string",
5 "active": true,
6 "unauthorized": true,
7 "nextExecution": "2019-08-24T14:15:22Z",
8 "previousSuccessfulExecution": "2019-08-24T14:15:22Z",
9 "previousExecution": "2019-08-24T14:15:22Z",
10 "previousExecutionMessage": "string",
11 "batchSize": 0,
12 "name": "string",
13 "profileId": 0,
14 "input": {
15 "id": 80000001,
16 "accountingStandardType": {
17 "name": "GAAP",
18 "captionKey": "enum.accountingStandardType.GAAP",
19 "caption": "IFRS 16"
20 },
21 "classifications": [
22 "NON_LEASE"
23 ],
24 "fromYear": 2024,
25 "fromPeriod": {
26 "id": 10000001,
27 "displayId": "FP-2024-Q1",
28 "status": {
29 "name": "ACTIVE",
30 "captionKey": "enum.objectStatus.active",
31 "active": true,
32 "caption": "Active"
33 },
34 "day": 15,
35 "year": 2024,
36 "month": 3,
37 "postingPeriod": 3,
38 "yearShift": 0
39 },
40 "toYear": 2025,
41 "toPeriod": {
42 "id": 10000001,
43 "displayId": "FP-2024-Q1",
44 "status": {
45 "name": "ACTIVE",
46 "captionKey": "enum.objectStatus.active",
47 "active": true,
48 "caption": "Active"
49 },
50 "day": 15,
51 "year": 2024,
52 "month": 3,
53 "postingPeriod": 3,
54 "yearShift": 0
55 },
56 "fromDate": "2024-01-01",
57 "toDate": "2025-12-31",
58 "fromDateType": "USER_DEFINED",
59 "toDateType": "USER_DEFINED",
60 "currencyDisplayId": "USD",
61 "currencyType": "TRANSACTION",
62 "currencyDefinitionType": {
63 "name": "COMPANY_CURRENCY",
64 "captionKey": "enum.currencyDefinitionType.companyCurrency",
65 "caption": "Company Currency"
66 },
67 "activationGroupStatus": {
68 "name": "AG_PENDING_ASSESSMENT",
69 "captionKey": "enum.ActivationGroup.StatusList",
70 "caption": "Activation Group Status"
71 },
72 "reportList": [
73 "NET_LEASE_INVESTMENT_REPORT"
74 ],
75 "listObjectType": {
76 "name": "CONTRACT",
77 "captionKey": "enum.objectType.contract",
78 "caption": "Contract"
79 },
80 "objectList": [
81 {
82 "id": 10000001,
83 "displayId": "ENT-001",
84 "name": "Entity Name"
85 }
86 ],
87 "migratedFilterType": {
88 "name": "ALL",
89 "captionKey": "enum.migratedFilterType.all",
90 "caption": "All"
91 },
92 "assetClassFilterType": {
93 "name": "ALL",
94 "captionKey": "enum.filterType.all",
95 "caption": "All"
96 },
97 "assetClasses": [
98 {
99 "id": 10000001,
100 "displayId": "IAC-001",
101 "status": {
102 "name": "ACTIVE",
103 "captionKey": "enum.objectStatus.active",
104 "active": true,
105 "caption": "Active"
106 },
107 "name": "Machinery and Equipment",
108 "assetClassType": "PROPERTY",
109 "infiniteUsefulLife": false
110 }
111 ],
112 "businessAreaFilterType": {
113 "name": "ALL",
114 "captionKey": "enum.filterType.all",
115 "caption": "All"
116 },
117 "businessAreas": [
118 {
119 "id": 3001,
120 "displayId": "BA-2025-001",
121 "status": {
122 "name": "ACTIVE",
123 "captionKey": "enum.objectStatus.active",
124 "active": true,
125 "caption": "Active"
126 },
127 "name": "North America Operations",
128 "erpSystemId": 0
129 }
130 ],
131 "vendorFilterType": {
132 "name": "ALL",
133 "captionKey": "enum.filterType.all",
134 "caption": "All"
135 },
136 "vendors": [
137 {
138 "id": 10000012,
139 "displayId": "0000100003",
140 "status": {
141 "name": "ACTIVE",
142 "captionKey": "enum.objectStatus.active",
143 "active": true,
144 "caption": "Active"
145 },
146 "name": "TEST VENDOR GB",
147 "erpSystemDisplayId": "FINQ8S-300"
148 }
149 ]
150 },
151 "profile": {
152 "id": 10000001,
153 "name": "Sample Name",
154 "principalPositionType": {
155 "name": "LESSEE",
156 "captionKey": "enum.principalpositiontype.lessee",
157 "caption": "Lessee"
158 },
159 "erpSystemFilterType": {
160 "name": "ALL",
161 "captionKey": "enum.filterType.all",
162 "caption": "All"
163 },
164 "erpSystems": [],
165 "leaseAreaFilterType": {
166 "name": "ALL",
167 "captionKey": "enum.filterType.all",
168 "caption": "All"
169 },
170 "leaseAreas": [],
171 "businessUnitFilterType": {
172 "name": "ALL",
173 "captionKey": "enum.filterType.all",
174 "caption": "All"
175 },
176 "businessUnits": [],
177 "companyFilterType": {
178 "name": "ALL",
179 "captionKey": "enum.filterType.all",
180 "caption": "All"
181 },
182 "companyCodes": [],
183 "departmentFilterType": {
184 "name": "ALL",
185 "captionKey": "enum.filterType.all",
186 "caption": "All"
187 },
188 "leaseDepartments": [],
189 "leaseGroupFilterType": {
190 "name": "ALL",
191 "captionKey": "enum.filterType.all",
192 "caption": "All"
193 },
194 "leaseGroups": [],
195 "costCenterFilterType": {
196 "name": "ALL",
197 "captionKey": "enum.filterType.all",
198 "caption": "All"
199 },
200 "costCenters": [],
201 "profitCenterFilterType": {
202 "name": "ALL",
203 "captionKey": "enum.filterType.all",
204 "caption": "All"
205 },
206 "profitCenters": [],
207 "workBreakdownStructureFilterType": {
208 "name": "ALL",
209 "captionKey": "enum.filterType.all",
210 "caption": "All"
211 },
212 "workBreakdownStructures": [],
213 "objectStatus": {
214 "name": "ACTIVE",
215 "captionKey": "enum.objectStatus.active",
216 "active": true,
217 "caption": "Active"
218 },
219 "securityProfileId": 10000001,
220 "calendarType": {
221 "name": "_360",
222 "captionKey": "enum.calendarType.360",
223 "caption": "360 Convention"
224 },
225 "fiscalVariant": {
226 "id": 10000001,
227 "displayId": "sample_displayId",
228 "status": {
229 "name": "ACTIVE",
230 "captionKey": "enum.objectStatus.active",
231 "active": true,
232 "caption": "Active"
233 },
234 "isCalendarYear": true,
235 "yearDependent": false,
236 "erpSystemDisplayId": "sample_erpSystemDisplayId"
237 },
238 "assetClassFilterType": {
239 "name": "ALL",
240 "captionKey": "enum.filterType.all",
241 "caption": "All"
242 },
243 "assetClasses": [],
244 "functionalAreaFilterType": {
245 "name": "ALL",
246 "captionKey": "enum.filterType.all",
247 "caption": "All"
248 },
249 "functionalAreas": [],
250 "businessAreaFilterType": {
251 "name": "ALL",
252 "captionKey": "enum.filterType.all",
253 "caption": "All"
254 },
255 "businessAreas": [],
256 "vendorFilterType": {
257 "name": "ALL",
258 "captionKey": "enum.filterType.all",
259 "caption": "All"
260 },
261 "vendors": [],
262 "leaseClassificationFilterType": {
263 "name": "ALL",
264 "captionKey": "enum.filterType.all",
265 "caption": "All"
266 },
267 "leaseClassifications": "sample_leaseClassifications",
268 "accountingStandardType": "TYPE_VALUE",
269 "filterObjectDto": {
270 "id": 10000001,
271 "profileId": 10000001,
272 "displayId": "sample_displayId",
273 "objectType": "TYPE_VALUE"
274 },
275 "scriptProfile": false
276 }
277}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": []
5 },
6 "object": {
7 "id": 0,
8 "cronExpression": "string",
9 "cronReadable": "string",
10 "active": true,
11 "unauthorized": true,
12 "nextExecution": "2019-08-24T14:15:22Z",
13 "previousSuccessfulExecution": "2019-08-24T14:15:22Z",
14 "previousExecution": "2019-08-24T14:15:22Z",
15 "previousExecutionMessage": "string",
16 "batchSize": 0,
17 "name": "string",
18 "profileId": 0,
19 "input": {
20 "id": 80000001,
21 "accountingStandardType": {
22 "name": "GAAP",
23 "captionKey": "enum.accountingStandardType.GAAP",
24 "caption": "IFRS 16"
25 },
26 "classifications": [
27 "NON_LEASE"
28 ],
29 "fromYear": 2024,
30 "fromPeriod": {
31 "id": 10000001,
32 "displayId": "FP-2024-Q1",
33 "status": {
34 "name": "ACTIVE",
35 "captionKey": "enum.objectStatus.active",
36 "active": true,
37 "caption": "Active"
38 },
39 "day": 15,
40 "year": 2024,
41 "month": 3,
42 "postingPeriod": 3,
43 "yearShift": 0
44 },
45 "toYear": 2025,
46 "toPeriod": {
47 "id": 10000001,
48 "displayId": "FP-2024-Q1",
49 "status": {
50 "name": "ACTIVE",
51 "captionKey": "enum.objectStatus.active",
52 "active": true,
53 "caption": "Active"
54 },
55 "day": 15,
56 "year": 2024,
57 "month": 3,
58 "postingPeriod": 3,
59 "yearShift": 0
60 },
61 "fromDate": "2024-01-01",
62 "toDate": "2025-12-31",
63 "fromDateType": "USER_DEFINED",
64 "toDateType": "USER_DEFINED",
65 "currencyDisplayId": "USD",
66 "currencyType": "TRANSACTION",
67 "currencyDefinitionType": {
68 "name": "COMPANY_CURRENCY",
69 "captionKey": "enum.currencyDefinitionType.companyCurrency",
70 "caption": "Company Currency"
71 },
72 "activationGroupStatus": {
73 "name": "AG_PENDING_ASSESSMENT",
74 "captionKey": "enum.ActivationGroup.StatusList",
75 "caption": "Activation Group Status"
76 },
77 "reportList": [
78 "NET_LEASE_INVESTMENT_REPORT"
79 ],
80 "listObjectType": {
81 "name": "CONTRACT",
82 "captionKey": "enum.objectType.contract",
83 "caption": "Contract"
84 },
85 "objectList": [
86 {
87 "id": 10000001,
88 "displayId": "ENT-001",
89 "name": "Entity Name"
90 }
91 ],
92 "migratedFilterType": {
93 "name": "ALL",
94 "captionKey": "enum.migratedFilterType.all",
95 "caption": "All"
96 },
97 "assetClassFilterType": {
98 "name": "ALL",
99 "captionKey": "enum.filterType.all",
100 "caption": "All"
101 },
102 "assetClasses": [
103 {
104 "id": 10000001,
105 "displayId": "IAC-001",
106 "status": {
107 "name": "ACTIVE",
108 "captionKey": "enum.objectStatus.active",
109 "active": true,
110 "caption": "Active"
111 },
112 "name": "Machinery and Equipment",
113 "assetClassType": "PROPERTY",
114 "infiniteUsefulLife": false
115 }
116 ],
117 "businessAreaFilterType": {
118 "name": "ALL",
119 "captionKey": "enum.filterType.all",
120 "caption": "All"
121 },
122 "businessAreas": [
123 {
124 "id": 3001,
125 "displayId": "BA-2025-001",
126 "status": {
127 "name": "ACTIVE",
128 "captionKey": "enum.objectStatus.active",
129 "active": true,
130 "caption": "Active"
131 },
132 "name": "North America Operations",
133 "erpSystemId": 0
134 }
135 ],
136 "vendorFilterType": {
137 "name": "ALL",
138 "captionKey": "enum.filterType.all",
139 "caption": "All"
140 },
141 "vendors": [
142 {
143 "id": 10000012,
144 "displayId": "0000100003",
145 "status": {
146 "name": "ACTIVE",
147 "captionKey": "enum.objectStatus.active",
148 "active": true,
149 "caption": "Active"
150 },
151 "name": "TEST VENDOR GB",
152 "erpSystemDisplayId": "FINQ8S-300"
153 }
154 ]
155 },
156 "profile": {
157 "id": 10000001,
158 "name": "Sample Name",
159 "principalPositionType": {
160 "name": "LESSEE",
161 "captionKey": "enum.principalpositiontype.lessee",
162 "caption": "Lessee"
163 },
164 "erpSystemFilterType": {
165 "name": "ALL",
166 "captionKey": "enum.filterType.all",
167 "caption": "All"
168 },
169 "erpSystems": [],
170 "leaseAreaFilterType": {
171 "name": "ALL",
172 "captionKey": "enum.filterType.all",
173 "caption": "All"
174 },
175 "leaseAreas": [],
176 "businessUnitFilterType": {
177 "name": "ALL",
178 "captionKey": "enum.filterType.all",
179 "caption": "All"
180 },
181 "businessUnits": [],
182 "companyFilterType": {
183 "name": "ALL",
184 "captionKey": "enum.filterType.all",
185 "caption": "All"
186 },
187 "companyCodes": [],
188 "departmentFilterType": {
189 "name": "ALL",
190 "captionKey": "enum.filterType.all",
191 "caption": "All"
192 },
193 "leaseDepartments": [],
194 "leaseGroupFilterType": {
195 "name": "ALL",
196 "captionKey": "enum.filterType.all",
197 "caption": "All"
198 },
199 "leaseGroups": [],
200 "costCenterFilterType": {
201 "name": "ALL",
202 "captionKey": "enum.filterType.all",
203 "caption": "All"
204 },
205 "costCenters": [],
206 "profitCenterFilterType": {
207 "name": "ALL",
208 "captionKey": "enum.filterType.all",
209 "caption": "All"
210 },
211 "profitCenters": [],
212 "workBreakdownStructureFilterType": {
213 "name": "ALL",
214 "captionKey": "enum.filterType.all",
215 "caption": "All"
216 },
217 "workBreakdownStructures": [],
218 "objectStatus": {
219 "name": "ACTIVE",
220 "captionKey": "enum.objectStatus.active",
221 "active": true,
222 "caption": "Active"
223 },
224 "securityProfileId": 10000001,
225 "calendarType": {
226 "name": "_360",
227 "captionKey": "enum.calendarType.360",
228 "caption": "360 Convention"
229 },
230 "fiscalVariant": {
231 "id": 10000001,
232 "displayId": "sample_displayId",
233 "status": {
234 "name": "ACTIVE",
235 "captionKey": "enum.objectStatus.active",
236 "active": true,
237 "caption": "Active"
238 },
239 "isCalendarYear": true,
240 "yearDependent": false,
241 "erpSystemDisplayId": "sample_erpSystemDisplayId"
242 },
243 "assetClassFilterType": {
244 "name": "ALL",
245 "captionKey": "enum.filterType.all",
246 "caption": "All"
247 },
248 "assetClasses": [],
249 "functionalAreaFilterType": {
250 "name": "ALL",
251 "captionKey": "enum.filterType.all",
252 "caption": "All"
253 },
254 "functionalAreas": [],
255 "businessAreaFilterType": {
256 "name": "ALL",
257 "captionKey": "enum.filterType.all",
258 "caption": "All"
259 },
260 "businessAreas": [],
261 "vendorFilterType": {
262 "name": "ALL",
263 "captionKey": "enum.filterType.all",
264 "caption": "All"
265 },
266 "vendors": [],
267 "leaseClassificationFilterType": {
268 "name": "ALL",
269 "captionKey": "enum.filterType.all",
270 "caption": "All"
271 },
272 "leaseClassifications": "sample_leaseClassifications",
273 "accountingStandardType": "TYPE_VALUE",
274 "filterObjectDto": {
275 "id": 10000001,
276 "profileId": 10000001,
277 "displayId": "sample_displayId",
278 "objectType": "TYPE_VALUE"
279 },
280 "scriptProfile": false
281 }
282 }
283}
Disclosure Report Schedule Job - Delete¶
HTTP Request
DELETE /api/v1/disclosure_reports/schedule-jobs/{id}
📋 Description: Deletes a scheduled job associated with a disclosure report in the Nakisa Lease Accounting Suite, ensuring the timely management of lease-related financial obligations and accounting entries.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Disclosure Report Schedule Job - Create Or Update Bulk¶
HTTP Request
PUT /api/v1/disclosure_reports/schedule-jobs/createOrUpdate/bulk
📋 Description: Creates or updates multiple disclosure reports in bulk, facilitating efficient management of lease contracts and financial obligations within the Nakisa Lease Accounting Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing bulk data for creating or updating disclosure reports related to leases, contracts, financial obligations, and accounting entries. |
Body Parameters
1[
2 {
3 "id": 0,
4 "cronExpression": "string",
5 "cronReadable": "string",
6 "active": true,
7 "unauthorized": true,
8 "nextExecution": "2019-08-24T14:15:22Z",
9 "previousSuccessfulExecution": "2019-08-24T14:15:22Z",
10 "previousExecution": "2019-08-24T14:15:22Z",
11 "previousExecutionMessage": "string",
12 "batchSize": 0,
13 "name": "string",
14 "profileId": 0,
15 "input": {
16 "id": 80000001,
17 "accountingStandardType": {
18 "name": "GAAP",
19 "captionKey": "enum.accountingStandardType.GAAP",
20 "caption": "IFRS 16"
21 },
22 "classifications": [
23 "NON_LEASE"
24 ],
25 "fromYear": 2024,
26 "fromPeriod": {
27 "id": 10000001,
28 "displayId": "FP-2024-Q1",
29 "status": {
30 "name": "ACTIVE",
31 "captionKey": "enum.objectStatus.active",
32 "active": true,
33 "caption": "Active"
34 },
35 "day": 15,
36 "year": 2024,
37 "month": 3,
38 "postingPeriod": 3,
39 "yearShift": 0
40 },
41 "toYear": 2025,
42 "toPeriod": {
43 "id": 10000001,
44 "displayId": "FP-2024-Q1",
45 "status": {
46 "name": "ACTIVE",
47 "captionKey": "enum.objectStatus.active",
48 "active": true,
49 "caption": "Active"
50 },
51 "day": 15,
52 "year": 2024,
53 "month": 3,
54 "postingPeriod": 3,
55 "yearShift": 0
56 },
57 "fromDate": "2024-01-01",
58 "toDate": "2025-12-31",
59 "fromDateType": "USER_DEFINED",
60 "toDateType": "USER_DEFINED",
61 "currencyDisplayId": "USD",
62 "currencyType": "TRANSACTION",
63 "currencyDefinitionType": {
64 "name": "COMPANY_CURRENCY",
65 "captionKey": "enum.currencyDefinitionType.companyCurrency",
66 "caption": "Company Currency"
67 },
68 "activationGroupStatus": {
69 "name": "AG_PENDING_ASSESSMENT",
70 "captionKey": "enum.ActivationGroup.StatusList",
71 "caption": "Activation Group Status"
72 },
73 "reportList": [
74 "NET_LEASE_INVESTMENT_REPORT"
75 ],
76 "listObjectType": {
77 "name": "CONTRACT",
78 "captionKey": "enum.objectType.contract",
79 "caption": "Contract"
80 },
81 "objectList": [
82 {
83 "id": 10000001,
84 "displayId": "ENT-001",
85 "name": "Entity Name"
86 }
87 ],
88 "migratedFilterType": {
89 "name": "ALL",
90 "captionKey": "enum.migratedFilterType.all",
91 "caption": "All"
92 },
93 "assetClassFilterType": {
94 "name": "ALL",
95 "captionKey": "enum.filterType.all",
96 "caption": "All"
97 },
98 "assetClasses": [
99 {
100 "id": 10000001,
101 "displayId": "IAC-001",
102 "status": {
103 "name": "ACTIVE",
104 "captionKey": "enum.objectStatus.active",
105 "active": true,
106 "caption": "Active"
107 },
108 "name": "Machinery and Equipment",
109 "assetClassType": "PROPERTY",
110 "infiniteUsefulLife": false
111 }
112 ],
113 "businessAreaFilterType": {
114 "name": "ALL",
115 "captionKey": "enum.filterType.all",
116 "caption": "All"
117 },
118 "businessAreas": [
119 {
120 "id": 3001,
121 "displayId": "BA-2025-001",
122 "status": {
123 "name": "ACTIVE",
124 "captionKey": "enum.objectStatus.active",
125 "active": true,
126 "caption": "Active"
127 },
128 "name": "North America Operations",
129 "erpSystemId": 0
130 }
131 ],
132 "vendorFilterType": {
133 "name": "ALL",
134 "captionKey": "enum.filterType.all",
135 "caption": "All"
136 },
137 "vendors": [
138 {
139 "id": 10000012,
140 "displayId": "0000100003",
141 "status": {
142 "name": "ACTIVE",
143 "captionKey": "enum.objectStatus.active",
144 "active": true,
145 "caption": "Active"
146 },
147 "name": "TEST VENDOR GB",
148 "erpSystemDisplayId": "FINQ8S-300"
149 }
150 ]
151 },
152 "profile": {
153 "id": 10000001,
154 "name": "Sample Name",
155 "principalPositionType": {
156 "name": "LESSEE",
157 "captionKey": "enum.principalpositiontype.lessee",
158 "caption": "Lessee"
159 },
160 "erpSystemFilterType": {
161 "name": "ALL",
162 "captionKey": "enum.filterType.all",
163 "caption": "All"
164 },
165 "erpSystems": [],
166 "leaseAreaFilterType": {
167 "name": "ALL",
168 "captionKey": "enum.filterType.all",
169 "caption": "All"
170 },
171 "leaseAreas": [],
172 "businessUnitFilterType": {
173 "name": "ALL",
174 "captionKey": "enum.filterType.all",
175 "caption": "All"
176 },
177 "businessUnits": [],
178 "companyFilterType": {
179 "name": "ALL",
180 "captionKey": "enum.filterType.all",
181 "caption": "All"
182 },
183 "companyCodes": [],
184 "departmentFilterType": {
185 "name": "ALL",
186 "captionKey": "enum.filterType.all",
187 "caption": "All"
188 },
189 "leaseDepartments": [],
190 "leaseGroupFilterType": {
191 "name": "ALL",
192 "captionKey": "enum.filterType.all",
193 "caption": "All"
194 },
195 "leaseGroups": [],
196 "costCenterFilterType": {
197 "name": "ALL",
198 "captionKey": "enum.filterType.all",
199 "caption": "All"
200 },
201 "costCenters": [],
202 "profitCenterFilterType": {
203 "name": "ALL",
204 "captionKey": "enum.filterType.all",
205 "caption": "All"
206 },
207 "profitCenters": [],
208 "workBreakdownStructureFilterType": {
209 "name": "ALL",
210 "captionKey": "enum.filterType.all",
211 "caption": "All"
212 },
213 "workBreakdownStructures": [],
214 "objectStatus": {
215 "name": "ACTIVE",
216 "captionKey": "enum.objectStatus.active",
217 "active": true,
218 "caption": "Active"
219 },
220 "securityProfileId": 10000001,
221 "calendarType": {
222 "name": "_360",
223 "captionKey": "enum.calendarType.360",
224 "caption": "360 Convention"
225 },
226 "fiscalVariant": {
227 "id": 10000001,
228 "displayId": "sample_displayId",
229 "status": {
230 "name": "ACTIVE",
231 "captionKey": "enum.objectStatus.active",
232 "active": true,
233 "caption": "Active"
234 },
235 "isCalendarYear": true,
236 "yearDependent": false,
237 "erpSystemDisplayId": "sample_erpSystemDisplayId"
238 },
239 "assetClassFilterType": {
240 "name": "ALL",
241 "captionKey": "enum.filterType.all",
242 "caption": "All"
243 },
244 "assetClasses": [],
245 "functionalAreaFilterType": {
246 "name": "ALL",
247 "captionKey": "enum.filterType.all",
248 "caption": "All"
249 },
250 "functionalAreas": [],
251 "businessAreaFilterType": {
252 "name": "ALL",
253 "captionKey": "enum.filterType.all",
254 "caption": "All"
255 },
256 "businessAreas": [],
257 "vendorFilterType": {
258 "name": "ALL",
259 "captionKey": "enum.filterType.all",
260 "caption": "All"
261 },
262 "vendors": [],
263 "leaseClassificationFilterType": {
264 "name": "ALL",
265 "captionKey": "enum.filterType.all",
266 "caption": "All"
267 },
268 "leaseClassifications": "sample_leaseClassifications",
269 "accountingStandardType": "TYPE_VALUE",
270 "filterObjectDto": {
271 "id": 10000001,
272 "profileId": 10000001,
273 "displayId": "sample_displayId",
274 "objectType": "TYPE_VALUE"
275 },
276 "scriptProfile": false
277 }
278 }
279]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": []
5 },
6 "object": [
7 {
8 "id": 0,
9 "cronExpression": "string",
10 "cronReadable": "string",
11 "active": true,
12 "unauthorized": true,
13 "nextExecution": "2019-08-24T14:15:22Z",
14 "previousSuccessfulExecution": "2019-08-24T14:15:22Z",
15 "previousExecution": "2019-08-24T14:15:22Z",
16 "previousExecutionMessage": "string",
17 "batchSize": 0,
18 "name": "string",
19 "profileId": 0,
20 "input": {
21 "id": 80000001,
22 "accountingStandardType": {
23 "name": "GAAP",
24 "captionKey": "enum.accountingStandardType.GAAP",
25 "caption": "IFRS 16"
26 },
27 "classifications": [
28 "NON_LEASE"
29 ],
30 "fromYear": 2024,
31 "fromPeriod": {
32 "id": 10000001,
33 "displayId": "FP-2024-Q1",
34 "status": {
35 "name": "ACTIVE",
36 "captionKey": "enum.objectStatus.active",
37 "active": true,
38 "caption": "Active"
39 },
40 "day": 15,
41 "year": 2024,
42 "month": 3,
43 "postingPeriod": 3,
44 "yearShift": 0
45 },
46 "toYear": 2025,
47 "toPeriod": {
48 "id": 10000001,
49 "displayId": "FP-2024-Q1",
50 "status": {
51 "name": "ACTIVE",
52 "captionKey": "enum.objectStatus.active",
53 "active": true,
54 "caption": "Active"
55 },
56 "day": 15,
57 "year": 2024,
58 "month": 3,
59 "postingPeriod": 3,
60 "yearShift": 0
61 },
62 "fromDate": "2024-01-01",
63 "toDate": "2025-12-31",
64 "fromDateType": "USER_DEFINED",
65 "toDateType": "USER_DEFINED",
66 "currencyDisplayId": "USD",
67 "currencyType": "TRANSACTION",
68 "currencyDefinitionType": {
69 "name": "COMPANY_CURRENCY",
70 "captionKey": "enum.currencyDefinitionType.companyCurrency",
71 "caption": "Company Currency"
72 },
73 "activationGroupStatus": {
74 "name": "AG_PENDING_ASSESSMENT",
75 "captionKey": "enum.ActivationGroup.StatusList",
76 "caption": "Activation Group Status"
77 },
78 "reportList": [
79 "NET_LEASE_INVESTMENT_REPORT"
80 ],
81 "listObjectType": {
82 "name": "CONTRACT",
83 "captionKey": "enum.objectType.contract",
84 "caption": "Contract"
85 },
86 "objectList": [
87 {
88 "id": 10000001,
89 "displayId": "ENT-001",
90 "name": "Entity Name"
91 }
92 ],
93 "migratedFilterType": {
94 "name": "ALL",
95 "captionKey": "enum.migratedFilterType.all",
96 "caption": "All"
97 },
98 "assetClassFilterType": {
99 "name": "ALL",
100 "captionKey": "enum.filterType.all",
101 "caption": "All"
102 },
103 "assetClasses": [
104 {
105 "id": 10000001,
106 "displayId": "IAC-001",
107 "status": {
108 "name": "ACTIVE",
109 "captionKey": "enum.objectStatus.active",
110 "active": true,
111 "caption": "Active"
112 },
113 "name": "Machinery and Equipment",
114 "assetClassType": "PROPERTY",
115 "infiniteUsefulLife": false
116 }
117 ],
118 "businessAreaFilterType": {
119 "name": "ALL",
120 "captionKey": "enum.filterType.all",
121 "caption": "All"
122 },
123 "businessAreas": [
124 {
125 "id": 3001,
126 "displayId": "BA-2025-001",
127 "status": {
128 "name": "ACTIVE",
129 "captionKey": "enum.objectStatus.active",
130 "active": true,
131 "caption": "Active"
132 },
133 "name": "North America Operations",
134 "erpSystemId": 0
135 }
136 ],
137 "vendorFilterType": {
138 "name": "ALL",
139 "captionKey": "enum.filterType.all",
140 "caption": "All"
141 },
142 "vendors": [
143 {
144 "id": 10000012,
145 "displayId": "0000100003",
146 "status": {
147 "name": "ACTIVE",
148 "captionKey": "enum.objectStatus.active",
149 "active": true,
150 "caption": "Active"
151 },
152 "name": "TEST VENDOR GB",
153 "erpSystemDisplayId": "FINQ8S-300"
154 }
155 ]
156 },
157 "profile": {
158 "id": 10000001,
159 "name": "Sample Name",
160 "principalPositionType": {
161 "name": "LESSEE",
162 "captionKey": "enum.principalpositiontype.lessee",
163 "caption": "Lessee"
164 },
165 "erpSystemFilterType": {
166 "name": "ALL",
167 "captionKey": "enum.filterType.all",
168 "caption": "All"
169 },
170 "erpSystems": [],
171 "leaseAreaFilterType": {
172 "name": "ALL",
173 "captionKey": "enum.filterType.all",
174 "caption": "All"
175 },
176 "leaseAreas": [],
177 "businessUnitFilterType": {
178 "name": "ALL",
179 "captionKey": "enum.filterType.all",
180 "caption": "All"
181 },
182 "businessUnits": [],
183 "companyFilterType": {
184 "name": "ALL",
185 "captionKey": "enum.filterType.all",
186 "caption": "All"
187 },
188 "companyCodes": [],
189 "departmentFilterType": {
190 "name": "ALL",
191 "captionKey": "enum.filterType.all",
192 "caption": "All"
193 },
194 "leaseDepartments": [],
195 "leaseGroupFilterType": {
196 "name": "ALL",
197 "captionKey": "enum.filterType.all",
198 "caption": "All"
199 },
200 "leaseGroups": [],
201 "costCenterFilterType": {
202 "name": "ALL",
203 "captionKey": "enum.filterType.all",
204 "caption": "All"
205 },
206 "costCenters": [],
207 "profitCenterFilterType": {
208 "name": "ALL",
209 "captionKey": "enum.filterType.all",
210 "caption": "All"
211 },
212 "profitCenters": [],
213 "workBreakdownStructureFilterType": {
214 "name": "ALL",
215 "captionKey": "enum.filterType.all",
216 "caption": "All"
217 },
218 "workBreakdownStructures": [],
219 "objectStatus": {
220 "name": "ACTIVE",
221 "captionKey": "enum.objectStatus.active",
222 "active": true,
223 "caption": "Active"
224 },
225 "securityProfileId": 10000001,
226 "calendarType": {
227 "name": "_360",
228 "captionKey": "enum.calendarType.360",
229 "caption": "360 Convention"
230 },
231 "fiscalVariant": {
232 "id": 10000001,
233 "displayId": "sample_displayId",
234 "status": {
235 "name": "ACTIVE",
236 "captionKey": "enum.objectStatus.active",
237 "active": true,
238 "caption": "Active"
239 },
240 "isCalendarYear": true,
241 "yearDependent": false,
242 "erpSystemDisplayId": "sample_erpSystemDisplayId"
243 },
244 "assetClassFilterType": {
245 "name": "ALL",
246 "captionKey": "enum.filterType.all",
247 "caption": "All"
248 },
249 "assetClasses": [],
250 "functionalAreaFilterType": {
251 "name": "ALL",
252 "captionKey": "enum.filterType.all",
253 "caption": "All"
254 },
255 "functionalAreas": [],
256 "businessAreaFilterType": {
257 "name": "ALL",
258 "captionKey": "enum.filterType.all",
259 "caption": "All"
260 },
261 "businessAreas": [],
262 "vendorFilterType": {
263 "name": "ALL",
264 "captionKey": "enum.filterType.all",
265 "caption": "All"
266 },
267 "vendors": [],
268 "leaseClassificationFilterType": {
269 "name": "ALL",
270 "captionKey": "enum.filterType.all",
271 "caption": "All"
272 },
273 "leaseClassifications": "sample_leaseClassifications",
274 "accountingStandardType": "TYPE_VALUE",
275 "filterObjectDto": {
276 "id": 10000001,
277 "profileId": 10000001,
278 "displayId": "sample_displayId",
279 "objectType": "TYPE_VALUE"
280 },
281 "scriptProfile": false
282 }
283 }
284 ]
285}
Disclosure Report Schedule Job - Create Or Update¶
HTTP Request
PUT /api/v1/disclosure_reports/schedule-jobs/createOrUpdate
📋 Description: Creates or updates scheduled jobs for disclosure reports within the Nakisa Lease Accounting Suite, ensuring accurate management of lease, contract, and financial obligation data for streamlined accounting entries.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the lease and contract details necessary for creating or updating financial obligation schedules and accounting entries. |
Body Parameters
1{
2 "id": 0,
3 "cronExpression": "string",
4 "cronReadable": "string",
5 "active": true,
6 "unauthorized": true,
7 "nextExecution": "2019-08-24T14:15:22Z",
8 "previousSuccessfulExecution": "2019-08-24T14:15:22Z",
9 "previousExecution": "2019-08-24T14:15:22Z",
10 "previousExecutionMessage": "string",
11 "batchSize": 0,
12 "name": "string",
13 "profileId": 0,
14 "input": {
15 "id": 80000001,
16 "accountingStandardType": {
17 "name": "GAAP",
18 "captionKey": "enum.accountingStandardType.GAAP",
19 "caption": "IFRS 16"
20 },
21 "classifications": [
22 "NON_LEASE"
23 ],
24 "fromYear": 2024,
25 "fromPeriod": {
26 "id": 10000001,
27 "displayId": "FP-2024-Q1",
28 "status": {
29 "name": "ACTIVE",
30 "captionKey": "enum.objectStatus.active",
31 "active": true,
32 "caption": "Active"
33 },
34 "day": 15,
35 "year": 2024,
36 "month": 3,
37 "postingPeriod": 3,
38 "yearShift": 0
39 },
40 "toYear": 2025,
41 "toPeriod": {
42 "id": 10000001,
43 "displayId": "FP-2024-Q1",
44 "status": {
45 "name": "ACTIVE",
46 "captionKey": "enum.objectStatus.active",
47 "active": true,
48 "caption": "Active"
49 },
50 "day": 15,
51 "year": 2024,
52 "month": 3,
53 "postingPeriod": 3,
54 "yearShift": 0
55 },
56 "fromDate": "2024-01-01",
57 "toDate": "2025-12-31",
58 "fromDateType": "USER_DEFINED",
59 "toDateType": "USER_DEFINED",
60 "currencyDisplayId": "USD",
61 "currencyType": "TRANSACTION",
62 "currencyDefinitionType": {
63 "name": "COMPANY_CURRENCY",
64 "captionKey": "enum.currencyDefinitionType.companyCurrency",
65 "caption": "Company Currency"
66 },
67 "activationGroupStatus": {
68 "name": "AG_PENDING_ASSESSMENT",
69 "captionKey": "enum.ActivationGroup.StatusList",
70 "caption": "Activation Group Status"
71 },
72 "reportList": [
73 "NET_LEASE_INVESTMENT_REPORT"
74 ],
75 "listObjectType": {
76 "name": "CONTRACT",
77 "captionKey": "enum.objectType.contract",
78 "caption": "Contract"
79 },
80 "objectList": [
81 {
82 "id": 10000001,
83 "displayId": "ENT-001",
84 "name": "Entity Name"
85 }
86 ],
87 "migratedFilterType": {
88 "name": "ALL",
89 "captionKey": "enum.migratedFilterType.all",
90 "caption": "All"
91 },
92 "assetClassFilterType": {
93 "name": "ALL",
94 "captionKey": "enum.filterType.all",
95 "caption": "All"
96 },
97 "assetClasses": [
98 {
99 "id": 10000001,
100 "displayId": "IAC-001",
101 "status": {
102 "name": "ACTIVE",
103 "captionKey": "enum.objectStatus.active",
104 "active": true,
105 "caption": "Active"
106 },
107 "name": "Machinery and Equipment",
108 "assetClassType": "PROPERTY",
109 "infiniteUsefulLife": false
110 }
111 ],
112 "businessAreaFilterType": {
113 "name": "ALL",
114 "captionKey": "enum.filterType.all",
115 "caption": "All"
116 },
117 "businessAreas": [
118 {
119 "id": 3001,
120 "displayId": "BA-2025-001",
121 "status": {
122 "name": "ACTIVE",
123 "captionKey": "enum.objectStatus.active",
124 "active": true,
125 "caption": "Active"
126 },
127 "name": "North America Operations",
128 "erpSystemId": 0
129 }
130 ],
131 "vendorFilterType": {
132 "name": "ALL",
133 "captionKey": "enum.filterType.all",
134 "caption": "All"
135 },
136 "vendors": [
137 {
138 "id": 10000012,
139 "displayId": "0000100003",
140 "status": {
141 "name": "ACTIVE",
142 "captionKey": "enum.objectStatus.active",
143 "active": true,
144 "caption": "Active"
145 },
146 "name": "TEST VENDOR GB",
147 "erpSystemDisplayId": "FINQ8S-300"
148 }
149 ]
150 },
151 "profile": {
152 "id": 10000001,
153 "name": "Sample Name",
154 "principalPositionType": {
155 "name": "LESSEE",
156 "captionKey": "enum.principalpositiontype.lessee",
157 "caption": "Lessee"
158 },
159 "erpSystemFilterType": {
160 "name": "ALL",
161 "captionKey": "enum.filterType.all",
162 "caption": "All"
163 },
164 "erpSystems": [],
165 "leaseAreaFilterType": {
166 "name": "ALL",
167 "captionKey": "enum.filterType.all",
168 "caption": "All"
169 },
170 "leaseAreas": [],
171 "businessUnitFilterType": {
172 "name": "ALL",
173 "captionKey": "enum.filterType.all",
174 "caption": "All"
175 },
176 "businessUnits": [],
177 "companyFilterType": {
178 "name": "ALL",
179 "captionKey": "enum.filterType.all",
180 "caption": "All"
181 },
182 "companyCodes": [],
183 "departmentFilterType": {
184 "name": "ALL",
185 "captionKey": "enum.filterType.all",
186 "caption": "All"
187 },
188 "leaseDepartments": [],
189 "leaseGroupFilterType": {
190 "name": "ALL",
191 "captionKey": "enum.filterType.all",
192 "caption": "All"
193 },
194 "leaseGroups": [],
195 "costCenterFilterType": {
196 "name": "ALL",
197 "captionKey": "enum.filterType.all",
198 "caption": "All"
199 },
200 "costCenters": [],
201 "profitCenterFilterType": {
202 "name": "ALL",
203 "captionKey": "enum.filterType.all",
204 "caption": "All"
205 },
206 "profitCenters": [],
207 "workBreakdownStructureFilterType": {
208 "name": "ALL",
209 "captionKey": "enum.filterType.all",
210 "caption": "All"
211 },
212 "workBreakdownStructures": [],
213 "objectStatus": {
214 "name": "ACTIVE",
215 "captionKey": "enum.objectStatus.active",
216 "active": true,
217 "caption": "Active"
218 },
219 "securityProfileId": 10000001,
220 "calendarType": {
221 "name": "_360",
222 "captionKey": "enum.calendarType.360",
223 "caption": "360 Convention"
224 },
225 "fiscalVariant": {
226 "id": 10000001,
227 "displayId": "sample_displayId",
228 "status": {
229 "name": "ACTIVE",
230 "captionKey": "enum.objectStatus.active",
231 "active": true,
232 "caption": "Active"
233 },
234 "isCalendarYear": true,
235 "yearDependent": false,
236 "erpSystemDisplayId": "sample_erpSystemDisplayId"
237 },
238 "assetClassFilterType": {
239 "name": "ALL",
240 "captionKey": "enum.filterType.all",
241 "caption": "All"
242 },
243 "assetClasses": [],
244 "functionalAreaFilterType": {
245 "name": "ALL",
246 "captionKey": "enum.filterType.all",
247 "caption": "All"
248 },
249 "functionalAreas": [],
250 "businessAreaFilterType": {
251 "name": "ALL",
252 "captionKey": "enum.filterType.all",
253 "caption": "All"
254 },
255 "businessAreas": [],
256 "vendorFilterType": {
257 "name": "ALL",
258 "captionKey": "enum.filterType.all",
259 "caption": "All"
260 },
261 "vendors": [],
262 "leaseClassificationFilterType": {
263 "name": "ALL",
264 "captionKey": "enum.filterType.all",
265 "caption": "All"
266 },
267 "leaseClassifications": "sample_leaseClassifications",
268 "accountingStandardType": "TYPE_VALUE",
269 "filterObjectDto": {
270 "id": 10000001,
271 "profileId": 10000001,
272 "displayId": "sample_displayId",
273 "objectType": "TYPE_VALUE"
274 },
275 "scriptProfile": false
276 }
277}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": []
5 },
6 "object": {
7 "id": 0,
8 "cronExpression": "string",
9 "cronReadable": "string",
10 "active": true,
11 "unauthorized": true,
12 "nextExecution": "2019-08-24T14:15:22Z",
13 "previousSuccessfulExecution": "2019-08-24T14:15:22Z",
14 "previousExecution": "2019-08-24T14:15:22Z",
15 "previousExecutionMessage": "string",
16 "batchSize": 0,
17 "name": "string",
18 "profileId": 0,
19 "input": {
20 "id": 80000001,
21 "accountingStandardType": {
22 "name": "GAAP",
23 "captionKey": "enum.accountingStandardType.GAAP",
24 "caption": "IFRS 16"
25 },
26 "classifications": [
27 "NON_LEASE"
28 ],
29 "fromYear": 2024,
30 "fromPeriod": {
31 "id": 10000001,
32 "displayId": "FP-2024-Q1",
33 "status": {
34 "name": "ACTIVE",
35 "captionKey": "enum.objectStatus.active",
36 "active": true,
37 "caption": "Active"
38 },
39 "day": 15,
40 "year": 2024,
41 "month": 3,
42 "postingPeriod": 3,
43 "yearShift": 0
44 },
45 "toYear": 2025,
46 "toPeriod": {
47 "id": 10000001,
48 "displayId": "FP-2024-Q1",
49 "status": {
50 "name": "ACTIVE",
51 "captionKey": "enum.objectStatus.active",
52 "active": true,
53 "caption": "Active"
54 },
55 "day": 15,
56 "year": 2024,
57 "month": 3,
58 "postingPeriod": 3,
59 "yearShift": 0
60 },
61 "fromDate": "2024-01-01",
62 "toDate": "2025-12-31",
63 "fromDateType": "USER_DEFINED",
64 "toDateType": "USER_DEFINED",
65 "currencyDisplayId": "USD",
66 "currencyType": "TRANSACTION",
67 "currencyDefinitionType": {
68 "name": "COMPANY_CURRENCY",
69 "captionKey": "enum.currencyDefinitionType.companyCurrency",
70 "caption": "Company Currency"
71 },
72 "activationGroupStatus": {
73 "name": "AG_PENDING_ASSESSMENT",
74 "captionKey": "enum.ActivationGroup.StatusList",
75 "caption": "Activation Group Status"
76 },
77 "reportList": [
78 "NET_LEASE_INVESTMENT_REPORT"
79 ],
80 "listObjectType": {
81 "name": "CONTRACT",
82 "captionKey": "enum.objectType.contract",
83 "caption": "Contract"
84 },
85 "objectList": [
86 {
87 "id": 10000001,
88 "displayId": "ENT-001",
89 "name": "Entity Name"
90 }
91 ],
92 "migratedFilterType": {
93 "name": "ALL",
94 "captionKey": "enum.migratedFilterType.all",
95 "caption": "All"
96 },
97 "assetClassFilterType": {
98 "name": "ALL",
99 "captionKey": "enum.filterType.all",
100 "caption": "All"
101 },
102 "assetClasses": [
103 {
104 "id": 10000001,
105 "displayId": "IAC-001",
106 "status": {
107 "name": "ACTIVE",
108 "captionKey": "enum.objectStatus.active",
109 "active": true,
110 "caption": "Active"
111 },
112 "name": "Machinery and Equipment",
113 "assetClassType": "PROPERTY",
114 "infiniteUsefulLife": false
115 }
116 ],
117 "businessAreaFilterType": {
118 "name": "ALL",
119 "captionKey": "enum.filterType.all",
120 "caption": "All"
121 },
122 "businessAreas": [
123 {
124 "id": 3001,
125 "displayId": "BA-2025-001",
126 "status": {
127 "name": "ACTIVE",
128 "captionKey": "enum.objectStatus.active",
129 "active": true,
130 "caption": "Active"
131 },
132 "name": "North America Operations",
133 "erpSystemId": 0
134 }
135 ],
136 "vendorFilterType": {
137 "name": "ALL",
138 "captionKey": "enum.filterType.all",
139 "caption": "All"
140 },
141 "vendors": [
142 {
143 "id": 10000012,
144 "displayId": "0000100003",
145 "status": {
146 "name": "ACTIVE",
147 "captionKey": "enum.objectStatus.active",
148 "active": true,
149 "caption": "Active"
150 },
151 "name": "TEST VENDOR GB",
152 "erpSystemDisplayId": "FINQ8S-300"
153 }
154 ]
155 },
156 "profile": {
157 "id": 10000001,
158 "name": "Sample Name",
159 "principalPositionType": {
160 "name": "LESSEE",
161 "captionKey": "enum.principalpositiontype.lessee",
162 "caption": "Lessee"
163 },
164 "erpSystemFilterType": {
165 "name": "ALL",
166 "captionKey": "enum.filterType.all",
167 "caption": "All"
168 },
169 "erpSystems": [],
170 "leaseAreaFilterType": {
171 "name": "ALL",
172 "captionKey": "enum.filterType.all",
173 "caption": "All"
174 },
175 "leaseAreas": [],
176 "businessUnitFilterType": {
177 "name": "ALL",
178 "captionKey": "enum.filterType.all",
179 "caption": "All"
180 },
181 "businessUnits": [],
182 "companyFilterType": {
183 "name": "ALL",
184 "captionKey": "enum.filterType.all",
185 "caption": "All"
186 },
187 "companyCodes": [],
188 "departmentFilterType": {
189 "name": "ALL",
190 "captionKey": "enum.filterType.all",
191 "caption": "All"
192 },
193 "leaseDepartments": [],
194 "leaseGroupFilterType": {
195 "name": "ALL",
196 "captionKey": "enum.filterType.all",
197 "caption": "All"
198 },
199 "leaseGroups": [],
200 "costCenterFilterType": {
201 "name": "ALL",
202 "captionKey": "enum.filterType.all",
203 "caption": "All"
204 },
205 "costCenters": [],
206 "profitCenterFilterType": {
207 "name": "ALL",
208 "captionKey": "enum.filterType.all",
209 "caption": "All"
210 },
211 "profitCenters": [],
212 "workBreakdownStructureFilterType": {
213 "name": "ALL",
214 "captionKey": "enum.filterType.all",
215 "caption": "All"
216 },
217 "workBreakdownStructures": [],
218 "objectStatus": {
219 "name": "ACTIVE",
220 "captionKey": "enum.objectStatus.active",
221 "active": true,
222 "caption": "Active"
223 },
224 "securityProfileId": 10000001,
225 "calendarType": {
226 "name": "_360",
227 "captionKey": "enum.calendarType.360",
228 "caption": "360 Convention"
229 },
230 "fiscalVariant": {
231 "id": 10000001,
232 "displayId": "sample_displayId",
233 "status": {
234 "name": "ACTIVE",
235 "captionKey": "enum.objectStatus.active",
236 "active": true,
237 "caption": "Active"
238 },
239 "isCalendarYear": true,
240 "yearDependent": false,
241 "erpSystemDisplayId": "sample_erpSystemDisplayId"
242 },
243 "assetClassFilterType": {
244 "name": "ALL",
245 "captionKey": "enum.filterType.all",
246 "caption": "All"
247 },
248 "assetClasses": [],
249 "functionalAreaFilterType": {
250 "name": "ALL",
251 "captionKey": "enum.filterType.all",
252 "caption": "All"
253 },
254 "functionalAreas": [],
255 "businessAreaFilterType": {
256 "name": "ALL",
257 "captionKey": "enum.filterType.all",
258 "caption": "All"
259 },
260 "businessAreas": [],
261 "vendorFilterType": {
262 "name": "ALL",
263 "captionKey": "enum.filterType.all",
264 "caption": "All"
265 },
266 "vendors": [],
267 "leaseClassificationFilterType": {
268 "name": "ALL",
269 "captionKey": "enum.filterType.all",
270 "caption": "All"
271 },
272 "leaseClassifications": "sample_leaseClassifications",
273 "accountingStandardType": "TYPE_VALUE",
274 "filterObjectDto": {
275 "id": 10000001,
276 "profileId": 10000001,
277 "displayId": "sample_displayId",
278 "objectType": "TYPE_VALUE"
279 },
280 "scriptProfile": false
281 }
282 }
283}
Disclosure Report Schedule Job - Schedule¶
HTTP Request
POST /api/v1/disclosure_reports/schedule-jobs/createOrUpdate
📋 Description: Creates or updates disclosure report scheduling jobs within the Nakisa Lease Accounting Suite, facilitating the management of lease contracts and associated financial obligations for accurate accounting entries.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the lease and contract details necessary for creating or updating financial obligation and accounting entry records in the Nakisa Lease Accounting Suite. |
Body Parameters
1{
2 "id": 0,
3 "cronExpression": "string",
4 "cronReadable": "string",
5 "active": true,
6 "unauthorized": true,
7 "nextExecution": "2019-08-24T14:15:22Z",
8 "previousSuccessfulExecution": "2019-08-24T14:15:22Z",
9 "previousExecution": "2019-08-24T14:15:22Z",
10 "previousExecutionMessage": "string",
11 "batchSize": 0,
12 "name": "string",
13 "profileId": 0,
14 "input": {
15 "id": 80000001,
16 "accountingStandardType": {
17 "name": "GAAP",
18 "captionKey": "enum.accountingStandardType.GAAP",
19 "caption": "IFRS 16"
20 },
21 "classifications": [
22 "NON_LEASE"
23 ],
24 "fromYear": 2024,
25 "fromPeriod": {
26 "id": 10000001,
27 "displayId": "FP-2024-Q1",
28 "status": {
29 "name": "ACTIVE",
30 "captionKey": "enum.objectStatus.active",
31 "active": true,
32 "caption": "Active"
33 },
34 "day": 15,
35 "year": 2024,
36 "month": 3,
37 "postingPeriod": 3,
38 "yearShift": 0
39 },
40 "toYear": 2025,
41 "toPeriod": {
42 "id": 10000001,
43 "displayId": "FP-2024-Q1",
44 "status": {
45 "name": "ACTIVE",
46 "captionKey": "enum.objectStatus.active",
47 "active": true,
48 "caption": "Active"
49 },
50 "day": 15,
51 "year": 2024,
52 "month": 3,
53 "postingPeriod": 3,
54 "yearShift": 0
55 },
56 "fromDate": "2024-01-01",
57 "toDate": "2025-12-31",
58 "fromDateType": "USER_DEFINED",
59 "toDateType": "USER_DEFINED",
60 "currencyDisplayId": "USD",
61 "currencyType": "TRANSACTION",
62 "currencyDefinitionType": {
63 "name": "COMPANY_CURRENCY",
64 "captionKey": "enum.currencyDefinitionType.companyCurrency",
65 "caption": "Company Currency"
66 },
67 "activationGroupStatus": {
68 "name": "AG_PENDING_ASSESSMENT",
69 "captionKey": "enum.ActivationGroup.StatusList",
70 "caption": "Activation Group Status"
71 },
72 "reportList": [
73 "NET_LEASE_INVESTMENT_REPORT"
74 ],
75 "listObjectType": {
76 "name": "CONTRACT",
77 "captionKey": "enum.objectType.contract",
78 "caption": "Contract"
79 },
80 "objectList": [
81 {
82 "id": 10000001,
83 "displayId": "ENT-001",
84 "name": "Entity Name"
85 }
86 ],
87 "migratedFilterType": {
88 "name": "ALL",
89 "captionKey": "enum.migratedFilterType.all",
90 "caption": "All"
91 },
92 "assetClassFilterType": {
93 "name": "ALL",
94 "captionKey": "enum.filterType.all",
95 "caption": "All"
96 },
97 "assetClasses": [
98 {
99 "id": 10000001,
100 "displayId": "IAC-001",
101 "status": {
102 "name": "ACTIVE",
103 "captionKey": "enum.objectStatus.active",
104 "active": true,
105 "caption": "Active"
106 },
107 "name": "Machinery and Equipment",
108 "assetClassType": "PROPERTY",
109 "infiniteUsefulLife": false
110 }
111 ],
112 "businessAreaFilterType": {
113 "name": "ALL",
114 "captionKey": "enum.filterType.all",
115 "caption": "All"
116 },
117 "businessAreas": [
118 {
119 "id": 3001,
120 "displayId": "BA-2025-001",
121 "status": {
122 "name": "ACTIVE",
123 "captionKey": "enum.objectStatus.active",
124 "active": true,
125 "caption": "Active"
126 },
127 "name": "North America Operations",
128 "erpSystemId": 0
129 }
130 ],
131 "vendorFilterType": {
132 "name": "ALL",
133 "captionKey": "enum.filterType.all",
134 "caption": "All"
135 },
136 "vendors": [
137 {
138 "id": 10000012,
139 "displayId": "0000100003",
140 "status": {
141 "name": "ACTIVE",
142 "captionKey": "enum.objectStatus.active",
143 "active": true,
144 "caption": "Active"
145 },
146 "name": "TEST VENDOR GB",
147 "erpSystemDisplayId": "FINQ8S-300"
148 }
149 ]
150 },
151 "profile": {
152 "id": 10000001,
153 "name": "Sample Name",
154 "principalPositionType": {
155 "name": "LESSEE",
156 "captionKey": "enum.principalpositiontype.lessee",
157 "caption": "Lessee"
158 },
159 "erpSystemFilterType": {
160 "name": "ALL",
161 "captionKey": "enum.filterType.all",
162 "caption": "All"
163 },
164 "erpSystems": [],
165 "leaseAreaFilterType": {
166 "name": "ALL",
167 "captionKey": "enum.filterType.all",
168 "caption": "All"
169 },
170 "leaseAreas": [],
171 "businessUnitFilterType": {
172 "name": "ALL",
173 "captionKey": "enum.filterType.all",
174 "caption": "All"
175 },
176 "businessUnits": [],
177 "companyFilterType": {
178 "name": "ALL",
179 "captionKey": "enum.filterType.all",
180 "caption": "All"
181 },
182 "companyCodes": [],
183 "departmentFilterType": {
184 "name": "ALL",
185 "captionKey": "enum.filterType.all",
186 "caption": "All"
187 },
188 "leaseDepartments": [],
189 "leaseGroupFilterType": {
190 "name": "ALL",
191 "captionKey": "enum.filterType.all",
192 "caption": "All"
193 },
194 "leaseGroups": [],
195 "costCenterFilterType": {
196 "name": "ALL",
197 "captionKey": "enum.filterType.all",
198 "caption": "All"
199 },
200 "costCenters": [],
201 "profitCenterFilterType": {
202 "name": "ALL",
203 "captionKey": "enum.filterType.all",
204 "caption": "All"
205 },
206 "profitCenters": [],
207 "workBreakdownStructureFilterType": {
208 "name": "ALL",
209 "captionKey": "enum.filterType.all",
210 "caption": "All"
211 },
212 "workBreakdownStructures": [],
213 "objectStatus": {
214 "name": "ACTIVE",
215 "captionKey": "enum.objectStatus.active",
216 "active": true,
217 "caption": "Active"
218 },
219 "securityProfileId": 10000001,
220 "calendarType": {
221 "name": "_360",
222 "captionKey": "enum.calendarType.360",
223 "caption": "360 Convention"
224 },
225 "fiscalVariant": {
226 "id": 10000001,
227 "displayId": "sample_displayId",
228 "status": {
229 "name": "ACTIVE",
230 "captionKey": "enum.objectStatus.active",
231 "active": true,
232 "caption": "Active"
233 },
234 "isCalendarYear": true,
235 "yearDependent": false,
236 "erpSystemDisplayId": "sample_erpSystemDisplayId"
237 },
238 "assetClassFilterType": {
239 "name": "ALL",
240 "captionKey": "enum.filterType.all",
241 "caption": "All"
242 },
243 "assetClasses": [],
244 "functionalAreaFilterType": {
245 "name": "ALL",
246 "captionKey": "enum.filterType.all",
247 "caption": "All"
248 },
249 "functionalAreas": [],
250 "businessAreaFilterType": {
251 "name": "ALL",
252 "captionKey": "enum.filterType.all",
253 "caption": "All"
254 },
255 "businessAreas": [],
256 "vendorFilterType": {
257 "name": "ALL",
258 "captionKey": "enum.filterType.all",
259 "caption": "All"
260 },
261 "vendors": [],
262 "leaseClassificationFilterType": {
263 "name": "ALL",
264 "captionKey": "enum.filterType.all",
265 "caption": "All"
266 },
267 "leaseClassifications": "sample_leaseClassifications",
268 "accountingStandardType": "TYPE_VALUE",
269 "filterObjectDto": {
270 "id": 10000001,
271 "profileId": 10000001,
272 "displayId": "sample_displayId",
273 "objectType": "TYPE_VALUE"
274 },
275 "scriptProfile": false
276 }
277}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": []
5 },
6 "object": {
7 "id": 0,
8 "cronExpression": "string",
9 "cronReadable": "string",
10 "active": true,
11 "unauthorized": true,
12 "nextExecution": "2019-08-24T14:15:22Z",
13 "previousSuccessfulExecution": "2019-08-24T14:15:22Z",
14 "previousExecution": "2019-08-24T14:15:22Z",
15 "previousExecutionMessage": "string",
16 "batchSize": 0,
17 "name": "string",
18 "profileId": 0,
19 "input": {
20 "id": 80000001,
21 "accountingStandardType": {
22 "name": "GAAP",
23 "captionKey": "enum.accountingStandardType.GAAP",
24 "caption": "IFRS 16"
25 },
26 "classifications": [
27 "NON_LEASE"
28 ],
29 "fromYear": 2024,
30 "fromPeriod": {
31 "id": 10000001,
32 "displayId": "FP-2024-Q1",
33 "status": {
34 "name": "ACTIVE",
35 "captionKey": "enum.objectStatus.active",
36 "active": true,
37 "caption": "Active"
38 },
39 "day": 15,
40 "year": 2024,
41 "month": 3,
42 "postingPeriod": 3,
43 "yearShift": 0
44 },
45 "toYear": 2025,
46 "toPeriod": {
47 "id": 10000001,
48 "displayId": "FP-2024-Q1",
49 "status": {
50 "name": "ACTIVE",
51 "captionKey": "enum.objectStatus.active",
52 "active": true,
53 "caption": "Active"
54 },
55 "day": 15,
56 "year": 2024,
57 "month": 3,
58 "postingPeriod": 3,
59 "yearShift": 0
60 },
61 "fromDate": "2024-01-01",
62 "toDate": "2025-12-31",
63 "fromDateType": "USER_DEFINED",
64 "toDateType": "USER_DEFINED",
65 "currencyDisplayId": "USD",
66 "currencyType": "TRANSACTION",
67 "currencyDefinitionType": {
68 "name": "COMPANY_CURRENCY",
69 "captionKey": "enum.currencyDefinitionType.companyCurrency",
70 "caption": "Company Currency"
71 },
72 "activationGroupStatus": {
73 "name": "AG_PENDING_ASSESSMENT",
74 "captionKey": "enum.ActivationGroup.StatusList",
75 "caption": "Activation Group Status"
76 },
77 "reportList": [
78 "NET_LEASE_INVESTMENT_REPORT"
79 ],
80 "listObjectType": {
81 "name": "CONTRACT",
82 "captionKey": "enum.objectType.contract",
83 "caption": "Contract"
84 },
85 "objectList": [
86 {
87 "id": 10000001,
88 "displayId": "ENT-001",
89 "name": "Entity Name"
90 }
91 ],
92 "migratedFilterType": {
93 "name": "ALL",
94 "captionKey": "enum.migratedFilterType.all",
95 "caption": "All"
96 },
97 "assetClassFilterType": {
98 "name": "ALL",
99 "captionKey": "enum.filterType.all",
100 "caption": "All"
101 },
102 "assetClasses": [
103 {
104 "id": 10000001,
105 "displayId": "IAC-001",
106 "status": {
107 "name": "ACTIVE",
108 "captionKey": "enum.objectStatus.active",
109 "active": true,
110 "caption": "Active"
111 },
112 "name": "Machinery and Equipment",
113 "assetClassType": "PROPERTY",
114 "infiniteUsefulLife": false
115 }
116 ],
117 "businessAreaFilterType": {
118 "name": "ALL",
119 "captionKey": "enum.filterType.all",
120 "caption": "All"
121 },
122 "businessAreas": [
123 {
124 "id": 3001,
125 "displayId": "BA-2025-001",
126 "status": {
127 "name": "ACTIVE",
128 "captionKey": "enum.objectStatus.active",
129 "active": true,
130 "caption": "Active"
131 },
132 "name": "North America Operations",
133 "erpSystemId": 0
134 }
135 ],
136 "vendorFilterType": {
137 "name": "ALL",
138 "captionKey": "enum.filterType.all",
139 "caption": "All"
140 },
141 "vendors": [
142 {
143 "id": 10000012,
144 "displayId": "0000100003",
145 "status": {
146 "name": "ACTIVE",
147 "captionKey": "enum.objectStatus.active",
148 "active": true,
149 "caption": "Active"
150 },
151 "name": "TEST VENDOR GB",
152 "erpSystemDisplayId": "FINQ8S-300"
153 }
154 ]
155 },
156 "profile": {
157 "id": 10000001,
158 "name": "Sample Name",
159 "principalPositionType": {
160 "name": "LESSEE",
161 "captionKey": "enum.principalpositiontype.lessee",
162 "caption": "Lessee"
163 },
164 "erpSystemFilterType": {
165 "name": "ALL",
166 "captionKey": "enum.filterType.all",
167 "caption": "All"
168 },
169 "erpSystems": [],
170 "leaseAreaFilterType": {
171 "name": "ALL",
172 "captionKey": "enum.filterType.all",
173 "caption": "All"
174 },
175 "leaseAreas": [],
176 "businessUnitFilterType": {
177 "name": "ALL",
178 "captionKey": "enum.filterType.all",
179 "caption": "All"
180 },
181 "businessUnits": [],
182 "companyFilterType": {
183 "name": "ALL",
184 "captionKey": "enum.filterType.all",
185 "caption": "All"
186 },
187 "companyCodes": [],
188 "departmentFilterType": {
189 "name": "ALL",
190 "captionKey": "enum.filterType.all",
191 "caption": "All"
192 },
193 "leaseDepartments": [],
194 "leaseGroupFilterType": {
195 "name": "ALL",
196 "captionKey": "enum.filterType.all",
197 "caption": "All"
198 },
199 "leaseGroups": [],
200 "costCenterFilterType": {
201 "name": "ALL",
202 "captionKey": "enum.filterType.all",
203 "caption": "All"
204 },
205 "costCenters": [],
206 "profitCenterFilterType": {
207 "name": "ALL",
208 "captionKey": "enum.filterType.all",
209 "caption": "All"
210 },
211 "profitCenters": [],
212 "workBreakdownStructureFilterType": {
213 "name": "ALL",
214 "captionKey": "enum.filterType.all",
215 "caption": "All"
216 },
217 "workBreakdownStructures": [],
218 "objectStatus": {
219 "name": "ACTIVE",
220 "captionKey": "enum.objectStatus.active",
221 "active": true,
222 "caption": "Active"
223 },
224 "securityProfileId": 10000001,
225 "calendarType": {
226 "name": "_360",
227 "captionKey": "enum.calendarType.360",
228 "caption": "360 Convention"
229 },
230 "fiscalVariant": {
231 "id": 10000001,
232 "displayId": "sample_displayId",
233 "status": {
234 "name": "ACTIVE",
235 "captionKey": "enum.objectStatus.active",
236 "active": true,
237 "caption": "Active"
238 },
239 "isCalendarYear": true,
240 "yearDependent": false,
241 "erpSystemDisplayId": "sample_erpSystemDisplayId"
242 },
243 "assetClassFilterType": {
244 "name": "ALL",
245 "captionKey": "enum.filterType.all",
246 "caption": "All"
247 },
248 "assetClasses": [],
249 "functionalAreaFilterType": {
250 "name": "ALL",
251 "captionKey": "enum.filterType.all",
252 "caption": "All"
253 },
254 "functionalAreas": [],
255 "businessAreaFilterType": {
256 "name": "ALL",
257 "captionKey": "enum.filterType.all",
258 "caption": "All"
259 },
260 "businessAreas": [],
261 "vendorFilterType": {
262 "name": "ALL",
263 "captionKey": "enum.filterType.all",
264 "caption": "All"
265 },
266 "vendors": [],
267 "leaseClassificationFilterType": {
268 "name": "ALL",
269 "captionKey": "enum.filterType.all",
270 "caption": "All"
271 },
272 "leaseClassifications": "sample_leaseClassifications",
273 "accountingStandardType": "TYPE_VALUE",
274 "filterObjectDto": {
275 "id": 10000001,
276 "profileId": 10000001,
277 "displayId": "sample_displayId",
278 "objectType": "TYPE_VALUE"
279 },
280 "scriptProfile": false
281 }
282 }
283}
Disclosure Report Schedule Job - Bulk Update¶
HTTP Request
PUT /api/v1/disclosure_reports/schedule-jobs/bulk
📋 Description: Schedules multiple disclosure report generation jobs in bulk for lease and contract management, ensuring timely compliance with financial obligations and accurate accounting entries.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing bulk scheduling data for disclosure reports, including lease and contract details, financial obligations, and associated accounting entries. |
Body Parameters
1[
2 {
3 "id": 0,
4 "cronExpression": "string",
5 "cronReadable": "string",
6 "active": true,
7 "unauthorized": true,
8 "nextExecution": "2019-08-24T14:15:22Z",
9 "previousSuccessfulExecution": "2019-08-24T14:15:22Z",
10 "previousExecution": "2019-08-24T14:15:22Z",
11 "previousExecutionMessage": "string",
12 "batchSize": 0,
13 "name": "string",
14 "profileId": 0,
15 "input": {
16 "id": 80000001,
17 "accountingStandardType": {
18 "name": "GAAP",
19 "captionKey": "enum.accountingStandardType.GAAP",
20 "caption": "IFRS 16"
21 },
22 "classifications": [
23 "NON_LEASE"
24 ],
25 "fromYear": 2024,
26 "fromPeriod": {
27 "id": 10000001,
28 "displayId": "FP-2024-Q1",
29 "status": {
30 "name": "ACTIVE",
31 "captionKey": "enum.objectStatus.active",
32 "active": true,
33 "caption": "Active"
34 },
35 "day": 15,
36 "year": 2024,
37 "month": 3,
38 "postingPeriod": 3,
39 "yearShift": 0
40 },
41 "toYear": 2025,
42 "toPeriod": {
43 "id": 10000001,
44 "displayId": "FP-2024-Q1",
45 "status": {
46 "name": "ACTIVE",
47 "captionKey": "enum.objectStatus.active",
48 "active": true,
49 "caption": "Active"
50 },
51 "day": 15,
52 "year": 2024,
53 "month": 3,
54 "postingPeriod": 3,
55 "yearShift": 0
56 },
57 "fromDate": "2024-01-01",
58 "toDate": "2025-12-31",
59 "fromDateType": "USER_DEFINED",
60 "toDateType": "USER_DEFINED",
61 "currencyDisplayId": "USD",
62 "currencyType": "TRANSACTION",
63 "currencyDefinitionType": {
64 "name": "COMPANY_CURRENCY",
65 "captionKey": "enum.currencyDefinitionType.companyCurrency",
66 "caption": "Company Currency"
67 },
68 "activationGroupStatus": {
69 "name": "AG_PENDING_ASSESSMENT",
70 "captionKey": "enum.ActivationGroup.StatusList",
71 "caption": "Activation Group Status"
72 },
73 "reportList": [
74 "NET_LEASE_INVESTMENT_REPORT"
75 ],
76 "listObjectType": {
77 "name": "CONTRACT",
78 "captionKey": "enum.objectType.contract",
79 "caption": "Contract"
80 },
81 "objectList": [
82 {
83 "id": 10000001,
84 "displayId": "ENT-001",
85 "name": "Entity Name"
86 }
87 ],
88 "migratedFilterType": {
89 "name": "ALL",
90 "captionKey": "enum.migratedFilterType.all",
91 "caption": "All"
92 },
93 "assetClassFilterType": {
94 "name": "ALL",
95 "captionKey": "enum.filterType.all",
96 "caption": "All"
97 },
98 "assetClasses": [
99 {
100 "id": 10000001,
101 "displayId": "IAC-001",
102 "status": {
103 "name": "ACTIVE",
104 "captionKey": "enum.objectStatus.active",
105 "active": true,
106 "caption": "Active"
107 },
108 "name": "Machinery and Equipment",
109 "assetClassType": "PROPERTY",
110 "infiniteUsefulLife": false
111 }
112 ],
113 "businessAreaFilterType": {
114 "name": "ALL",
115 "captionKey": "enum.filterType.all",
116 "caption": "All"
117 },
118 "businessAreas": [
119 {
120 "id": 3001,
121 "displayId": "BA-2025-001",
122 "status": {
123 "name": "ACTIVE",
124 "captionKey": "enum.objectStatus.active",
125 "active": true,
126 "caption": "Active"
127 },
128 "name": "North America Operations",
129 "erpSystemId": 0
130 }
131 ],
132 "vendorFilterType": {
133 "name": "ALL",
134 "captionKey": "enum.filterType.all",
135 "caption": "All"
136 },
137 "vendors": [
138 {
139 "id": 10000012,
140 "displayId": "0000100003",
141 "status": {
142 "name": "ACTIVE",
143 "captionKey": "enum.objectStatus.active",
144 "active": true,
145 "caption": "Active"
146 },
147 "name": "TEST VENDOR GB",
148 "erpSystemDisplayId": "FINQ8S-300"
149 }
150 ]
151 },
152 "profile": {
153 "id": 10000001,
154 "name": "Sample Name",
155 "principalPositionType": {
156 "name": "LESSEE",
157 "captionKey": "enum.principalpositiontype.lessee",
158 "caption": "Lessee"
159 },
160 "erpSystemFilterType": {
161 "name": "ALL",
162 "captionKey": "enum.filterType.all",
163 "caption": "All"
164 },
165 "erpSystems": [],
166 "leaseAreaFilterType": {
167 "name": "ALL",
168 "captionKey": "enum.filterType.all",
169 "caption": "All"
170 },
171 "leaseAreas": [],
172 "businessUnitFilterType": {
173 "name": "ALL",
174 "captionKey": "enum.filterType.all",
175 "caption": "All"
176 },
177 "businessUnits": [],
178 "companyFilterType": {
179 "name": "ALL",
180 "captionKey": "enum.filterType.all",
181 "caption": "All"
182 },
183 "companyCodes": [],
184 "departmentFilterType": {
185 "name": "ALL",
186 "captionKey": "enum.filterType.all",
187 "caption": "All"
188 },
189 "leaseDepartments": [],
190 "leaseGroupFilterType": {
191 "name": "ALL",
192 "captionKey": "enum.filterType.all",
193 "caption": "All"
194 },
195 "leaseGroups": [],
196 "costCenterFilterType": {
197 "name": "ALL",
198 "captionKey": "enum.filterType.all",
199 "caption": "All"
200 },
201 "costCenters": [],
202 "profitCenterFilterType": {
203 "name": "ALL",
204 "captionKey": "enum.filterType.all",
205 "caption": "All"
206 },
207 "profitCenters": [],
208 "workBreakdownStructureFilterType": {
209 "name": "ALL",
210 "captionKey": "enum.filterType.all",
211 "caption": "All"
212 },
213 "workBreakdownStructures": [],
214 "objectStatus": {
215 "name": "ACTIVE",
216 "captionKey": "enum.objectStatus.active",
217 "active": true,
218 "caption": "Active"
219 },
220 "securityProfileId": 10000001,
221 "calendarType": {
222 "name": "_360",
223 "captionKey": "enum.calendarType.360",
224 "caption": "360 Convention"
225 },
226 "fiscalVariant": {
227 "id": 10000001,
228 "displayId": "sample_displayId",
229 "status": {
230 "name": "ACTIVE",
231 "captionKey": "enum.objectStatus.active",
232 "active": true,
233 "caption": "Active"
234 },
235 "isCalendarYear": true,
236 "yearDependent": false,
237 "erpSystemDisplayId": "sample_erpSystemDisplayId"
238 },
239 "assetClassFilterType": {
240 "name": "ALL",
241 "captionKey": "enum.filterType.all",
242 "caption": "All"
243 },
244 "assetClasses": [],
245 "functionalAreaFilterType": {
246 "name": "ALL",
247 "captionKey": "enum.filterType.all",
248 "caption": "All"
249 },
250 "functionalAreas": [],
251 "businessAreaFilterType": {
252 "name": "ALL",
253 "captionKey": "enum.filterType.all",
254 "caption": "All"
255 },
256 "businessAreas": [],
257 "vendorFilterType": {
258 "name": "ALL",
259 "captionKey": "enum.filterType.all",
260 "caption": "All"
261 },
262 "vendors": [],
263 "leaseClassificationFilterType": {
264 "name": "ALL",
265 "captionKey": "enum.filterType.all",
266 "caption": "All"
267 },
268 "leaseClassifications": "sample_leaseClassifications",
269 "accountingStandardType": "TYPE_VALUE",
270 "filterObjectDto": {
271 "id": 10000001,
272 "profileId": 10000001,
273 "displayId": "sample_displayId",
274 "objectType": "TYPE_VALUE"
275 },
276 "scriptProfile": false
277 }
278 }
279]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": []
5 },
6 "object": [
7 {
8 "id": 0,
9 "cronExpression": "string",
10 "cronReadable": "string",
11 "active": true,
12 "unauthorized": true,
13 "nextExecution": "2019-08-24T14:15:22Z",
14 "previousSuccessfulExecution": "2019-08-24T14:15:22Z",
15 "previousExecution": "2019-08-24T14:15:22Z",
16 "previousExecutionMessage": "string",
17 "batchSize": 0,
18 "name": "string",
19 "profileId": 0,
20 "input": {
21 "id": 80000001,
22 "accountingStandardType": {
23 "name": "GAAP",
24 "captionKey": "enum.accountingStandardType.GAAP",
25 "caption": "IFRS 16"
26 },
27 "classifications": [
28 "NON_LEASE"
29 ],
30 "fromYear": 2024,
31 "fromPeriod": {
32 "id": 10000001,
33 "displayId": "FP-2024-Q1",
34 "status": {
35 "name": "ACTIVE",
36 "captionKey": "enum.objectStatus.active",
37 "active": true,
38 "caption": "Active"
39 },
40 "day": 15,
41 "year": 2024,
42 "month": 3,
43 "postingPeriod": 3,
44 "yearShift": 0
45 },
46 "toYear": 2025,
47 "toPeriod": {
48 "id": 10000001,
49 "displayId": "FP-2024-Q1",
50 "status": {
51 "name": "ACTIVE",
52 "captionKey": "enum.objectStatus.active",
53 "active": true,
54 "caption": "Active"
55 },
56 "day": 15,
57 "year": 2024,
58 "month": 3,
59 "postingPeriod": 3,
60 "yearShift": 0
61 },
62 "fromDate": "2024-01-01",
63 "toDate": "2025-12-31",
64 "fromDateType": "USER_DEFINED",
65 "toDateType": "USER_DEFINED",
66 "currencyDisplayId": "USD",
67 "currencyType": "TRANSACTION",
68 "currencyDefinitionType": {
69 "name": "COMPANY_CURRENCY",
70 "captionKey": "enum.currencyDefinitionType.companyCurrency",
71 "caption": "Company Currency"
72 },
73 "activationGroupStatus": {
74 "name": "AG_PENDING_ASSESSMENT",
75 "captionKey": "enum.ActivationGroup.StatusList",
76 "caption": "Activation Group Status"
77 },
78 "reportList": [
79 "NET_LEASE_INVESTMENT_REPORT"
80 ],
81 "listObjectType": {
82 "name": "CONTRACT",
83 "captionKey": "enum.objectType.contract",
84 "caption": "Contract"
85 },
86 "objectList": [
87 {
88 "id": 10000001,
89 "displayId": "ENT-001",
90 "name": "Entity Name"
91 }
92 ],
93 "migratedFilterType": {
94 "name": "ALL",
95 "captionKey": "enum.migratedFilterType.all",
96 "caption": "All"
97 },
98 "assetClassFilterType": {
99 "name": "ALL",
100 "captionKey": "enum.filterType.all",
101 "caption": "All"
102 },
103 "assetClasses": [
104 {
105 "id": 10000001,
106 "displayId": "IAC-001",
107 "status": {
108 "name": "ACTIVE",
109 "captionKey": "enum.objectStatus.active",
110 "active": true,
111 "caption": "Active"
112 },
113 "name": "Machinery and Equipment",
114 "assetClassType": "PROPERTY",
115 "infiniteUsefulLife": false
116 }
117 ],
118 "businessAreaFilterType": {
119 "name": "ALL",
120 "captionKey": "enum.filterType.all",
121 "caption": "All"
122 },
123 "businessAreas": [
124 {
125 "id": 3001,
126 "displayId": "BA-2025-001",
127 "status": {
128 "name": "ACTIVE",
129 "captionKey": "enum.objectStatus.active",
130 "active": true,
131 "caption": "Active"
132 },
133 "name": "North America Operations",
134 "erpSystemId": 0
135 }
136 ],
137 "vendorFilterType": {
138 "name": "ALL",
139 "captionKey": "enum.filterType.all",
140 "caption": "All"
141 },
142 "vendors": [
143 {
144 "id": 10000012,
145 "displayId": "0000100003",
146 "status": {
147 "name": "ACTIVE",
148 "captionKey": "enum.objectStatus.active",
149 "active": true,
150 "caption": "Active"
151 },
152 "name": "TEST VENDOR GB",
153 "erpSystemDisplayId": "FINQ8S-300"
154 }
155 ]
156 },
157 "profile": {
158 "id": 10000001,
159 "name": "Sample Name",
160 "principalPositionType": {
161 "name": "LESSEE",
162 "captionKey": "enum.principalpositiontype.lessee",
163 "caption": "Lessee"
164 },
165 "erpSystemFilterType": {
166 "name": "ALL",
167 "captionKey": "enum.filterType.all",
168 "caption": "All"
169 },
170 "erpSystems": [],
171 "leaseAreaFilterType": {
172 "name": "ALL",
173 "captionKey": "enum.filterType.all",
174 "caption": "All"
175 },
176 "leaseAreas": [],
177 "businessUnitFilterType": {
178 "name": "ALL",
179 "captionKey": "enum.filterType.all",
180 "caption": "All"
181 },
182 "businessUnits": [],
183 "companyFilterType": {
184 "name": "ALL",
185 "captionKey": "enum.filterType.all",
186 "caption": "All"
187 },
188 "companyCodes": [],
189 "departmentFilterType": {
190 "name": "ALL",
191 "captionKey": "enum.filterType.all",
192 "caption": "All"
193 },
194 "leaseDepartments": [],
195 "leaseGroupFilterType": {
196 "name": "ALL",
197 "captionKey": "enum.filterType.all",
198 "caption": "All"
199 },
200 "leaseGroups": [],
201 "costCenterFilterType": {
202 "name": "ALL",
203 "captionKey": "enum.filterType.all",
204 "caption": "All"
205 },
206 "costCenters": [],
207 "profitCenterFilterType": {
208 "name": "ALL",
209 "captionKey": "enum.filterType.all",
210 "caption": "All"
211 },
212 "profitCenters": [],
213 "workBreakdownStructureFilterType": {
214 "name": "ALL",
215 "captionKey": "enum.filterType.all",
216 "caption": "All"
217 },
218 "workBreakdownStructures": [],
219 "objectStatus": {
220 "name": "ACTIVE",
221 "captionKey": "enum.objectStatus.active",
222 "active": true,
223 "caption": "Active"
224 },
225 "securityProfileId": 10000001,
226 "calendarType": {
227 "name": "_360",
228 "captionKey": "enum.calendarType.360",
229 "caption": "360 Convention"
230 },
231 "fiscalVariant": {
232 "id": 10000001,
233 "displayId": "sample_displayId",
234 "status": {
235 "name": "ACTIVE",
236 "captionKey": "enum.objectStatus.active",
237 "active": true,
238 "caption": "Active"
239 },
240 "isCalendarYear": true,
241 "yearDependent": false,
242 "erpSystemDisplayId": "sample_erpSystemDisplayId"
243 },
244 "assetClassFilterType": {
245 "name": "ALL",
246 "captionKey": "enum.filterType.all",
247 "caption": "All"
248 },
249 "assetClasses": [],
250 "functionalAreaFilterType": {
251 "name": "ALL",
252 "captionKey": "enum.filterType.all",
253 "caption": "All"
254 },
255 "functionalAreas": [],
256 "businessAreaFilterType": {
257 "name": "ALL",
258 "captionKey": "enum.filterType.all",
259 "caption": "All"
260 },
261 "businessAreas": [],
262 "vendorFilterType": {
263 "name": "ALL",
264 "captionKey": "enum.filterType.all",
265 "caption": "All"
266 },
267 "vendors": [],
268 "leaseClassificationFilterType": {
269 "name": "ALL",
270 "captionKey": "enum.filterType.all",
271 "caption": "All"
272 },
273 "leaseClassifications": "sample_leaseClassifications",
274 "accountingStandardType": "TYPE_VALUE",
275 "filterObjectDto": {
276 "id": 10000001,
277 "profileId": 10000001,
278 "displayId": "sample_displayId",
279 "objectType": "TYPE_VALUE"
280 },
281 "scriptProfile": false
282 }
283 }
284 ]
285}
Disclosure Report Schedule Job - Bulk Delete¶
HTTP Request
DELETE /api/v1/disclosure_reports/schedule-jobs/bulk
📋 Description: Deletes multiple scheduled jobs for disclosure reports within the Nakisa Lease Accounting Suite, streamlining the management of lease and contract-related financial obligations and accounting entries.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
array[integer] |
true |
Request body containing an array of identifiers for the lease and contract disclosure reports to be deleted in bulk, ensuring efficient management of financial obligations and accounting entries. |
Body Parameters
1[
2 0
3]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Disclosure Report Schedule Job - Change State¶
HTTP Request
POST /api/v1/disclosure_reports/schedule-jobs/{id}/enable/{state}
📋 Description: Enables or disables scheduled jobs for disclosure reports within the Nakisa Lease Accounting Suite, allowing users to manage the processing of lease and contract-related financial obligations and accounting entries effectively.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
state |
path |
boolean |
true |
Indicates whether to enable or disable the scheduled job for the specified disclosure report, impacting lease and contract management within the Nakisa Lease Accounting Suite. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Disclosure Report Schedule Job - Search¶
HTTP Request
POST /api/v1/disclosure_reports/schedule-jobs/search
📋 Description: Schedules jobs for generating disclosure reports related to leases, contracts, and financial obligations within the Nakisa Lease Accounting Suite, facilitating efficient accounting entry management.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
page |
query |
integer |
false |
Zero-based page index (0..N) |
size |
query |
integer |
false |
The size of the page to be returned |
sort |
query |
array[string] |
false |
Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. |
body |
body |
false |
Request body containing the search criteria and filters for retrieving scheduled jobs related to lease and contract financial obligations within the Nakisa Lease Accounting Suite. |
Default Values¶
Parameter |
Default |
Type |
|---|---|---|
page |
|
query |
size |
|
query |
sort |
|
query |
Parameter Constraints¶
Parameter |
Constraints |
|---|---|
page |
Min: 0 |
size |
Min: 1 |
Body Parameters
1{
2 "idIn": [
3 0
4 ],
5 "idEqual": 0,
6 "idLike": "string",
7 "createdAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
8 "createdAtLessThanOrEqual": "2019-08-24T14:15:22Z",
9 "createdByLike": "string",
10 "createdByEqual": "string",
11 "modifiedAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
12 "modifiedAtLessThanOrEqual": "2019-08-24T14:15:22Z",
13 "modifiedByLike": "string",
14 "modifiedByEqual": "string",
15 "activeEqual": true,
16 "nameLike": "string",
17 "profileIdEqual": 0,
18 "accountingStandardTypeEqual": "GAAP",
19 "classificationsLike": "string",
20 "fromYearEqual": 0,
21 "toYearEqual": 0,
22 "currencyDisplayIdEqual": "string",
23 "activationGroupStatusEqual": "AG_PENDING_ASSESSMENT"
24}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "totalElements": 0,
3 "totalPages": 0,
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": 0,
17 "size": 0,
18 "content": [
19 {
20 "id": 0,
21 "cronExpression": "string",
22 "cronReadable": "string",
23 "active": true,
24 "unauthorized": true,
25 "nextExecution": "2019-08-24T14:15:22Z",
26 "previousSuccessfulExecution": "2019-08-24T14:15:22Z",
27 "previousExecution": "2019-08-24T14:15:22Z",
28 "previousExecutionMessage": "string",
29 "batchSize": 0,
30 "name": "string",
31 "profileId": 0,
32 "input": {
33 "id": 80000001,
34 "accountingStandardType": {
35 "name": "GAAP",
36 "captionKey": "enum.accountingStandardType.GAAP",
37 "caption": "IFRS 16"
38 },
39 "classifications": [
40 "NON_LEASE"
41 ],
42 "fromYear": 2024,
43 "fromPeriod": {
44 "id": 10000001,
45 "displayId": "FP-2024-Q1",
46 "status": {
47 "name": "ACTIVE",
48 "captionKey": "enum.objectStatus.active",
49 "active": true,
50 "caption": "Active"
51 },
52 "day": 15,
53 "year": 2024,
54 "month": 3,
55 "postingPeriod": 3,
56 "yearShift": 0
57 },
58 "toYear": 2025,
59 "toPeriod": {
60 "id": 10000001,
61 "displayId": "FP-2024-Q1",
62 "status": {
63 "name": "ACTIVE",
64 "captionKey": "enum.objectStatus.active",
65 "active": true,
66 "caption": "Active"
67 },
68 "day": 15,
69 "year": 2024,
70 "month": 3,
71 "postingPeriod": 3,
72 "yearShift": 0
73 },
74 "fromDate": "2024-01-01",
75 "toDate": "2025-12-31",
76 "fromDateType": "USER_DEFINED",
77 "toDateType": "USER_DEFINED",
78 "currencyDisplayId": "USD",
79 "currencyType": "TRANSACTION",
80 "currencyDefinitionType": {
81 "name": "COMPANY_CURRENCY",
82 "captionKey": "enum.currencyDefinitionType.companyCurrency",
83 "caption": "Company Currency"
84 },
85 "activationGroupStatus": {
86 "name": "AG_PENDING_ASSESSMENT",
87 "captionKey": "enum.ActivationGroup.StatusList",
88 "caption": "Activation Group Status"
89 },
90 "reportList": [
91 "NET_LEASE_INVESTMENT_REPORT"
92 ],
93 "listObjectType": {
94 "name": "CONTRACT",
95 "captionKey": "enum.objectType.contract",
96 "caption": "Contract"
97 },
98 "objectList": [
99 {
100 "id": 10000001,
101 "displayId": "ENT-001",
102 "name": "Entity Name"
103 }
104 ],
105 "migratedFilterType": {
106 "name": "ALL",
107 "captionKey": "enum.migratedFilterType.all",
108 "caption": "All"
109 },
110 "assetClassFilterType": {
111 "name": "ALL",
112 "captionKey": "enum.filterType.all",
113 "caption": "All"
114 },
115 "assetClasses": [
116 {
117 "id": 10000001,
118 "displayId": "IAC-001",
119 "status": {
120 "name": "ACTIVE",
121 "captionKey": "enum.objectStatus.active",
122 "active": true,
123 "caption": "Active"
124 },
125 "name": "Machinery and Equipment",
126 "assetClassType": "PROPERTY",
127 "infiniteUsefulLife": false
128 }
129 ],
130 "businessAreaFilterType": {
131 "name": "ALL",
132 "captionKey": "enum.filterType.all",
133 "caption": "All"
134 },
135 "businessAreas": [
136 {
137 "id": 3001,
138 "displayId": "BA-2025-001",
139 "status": {
140 "name": "ACTIVE",
141 "captionKey": "enum.objectStatus.active",
142 "active": true,
143 "caption": "Active"
144 },
145 "name": "North America Operations",
146 "erpSystemId": 0
147 }
148 ],
149 "vendorFilterType": {
150 "name": "ALL",
151 "captionKey": "enum.filterType.all",
152 "caption": "All"
153 },
154 "vendors": [
155 {
156 "id": 10000012,
157 "displayId": "0000100003",
158 "status": {
159 "name": "ACTIVE",
160 "captionKey": "enum.objectStatus.active",
161 "active": true,
162 "caption": "Active"
163 },
164 "name": "TEST VENDOR GB",
165 "erpSystemDisplayId": "FINQ8S-300"
166 }
167 ]
168 },
169 "profile": {
170 "id": 10000001,
171 "name": "Sample Name",
172 "principalPositionType": {
173 "name": "LESSEE",
174 "captionKey": "enum.principalpositiontype.lessee",
175 "caption": "Lessee"
176 },
177 "erpSystemFilterType": {
178 "name": "ALL",
179 "captionKey": "enum.filterType.all",
180 "caption": "All"
181 },
182 "erpSystems": [],
183 "leaseAreaFilterType": {
184 "name": "ALL",
185 "captionKey": "enum.filterType.all",
186 "caption": "All"
187 },
188 "leaseAreas": [],
189 "businessUnitFilterType": {
190 "name": "ALL",
191 "captionKey": "enum.filterType.all",
192 "caption": "All"
193 },
194 "businessUnits": [],
195 "companyFilterType": {
196 "name": "ALL",
197 "captionKey": "enum.filterType.all",
198 "caption": "All"
199 },
200 "companyCodes": [],
201 "departmentFilterType": {
202 "name": "ALL",
203 "captionKey": "enum.filterType.all",
204 "caption": "All"
205 },
206 "leaseDepartments": [],
207 "leaseGroupFilterType": {
208 "name": "ALL",
209 "captionKey": "enum.filterType.all",
210 "caption": "All"
211 },
212 "leaseGroups": [],
213 "costCenterFilterType": {
214 "name": "ALL",
215 "captionKey": "enum.filterType.all",
216 "caption": "All"
217 },
218 "costCenters": [],
219 "profitCenterFilterType": {
220 "name": "ALL",
221 "captionKey": "enum.filterType.all",
222 "caption": "All"
223 },
224 "profitCenters": [],
225 "workBreakdownStructureFilterType": {
226 "name": "ALL",
227 "captionKey": "enum.filterType.all",
228 "caption": "All"
229 },
230 "workBreakdownStructures": [],
231 "objectStatus": {
232 "name": "ACTIVE",
233 "captionKey": "enum.objectStatus.active",
234 "active": true,
235 "caption": "Active"
236 },
237 "securityProfileId": 10000001,
238 "calendarType": {
239 "name": "_360",
240 "captionKey": "enum.calendarType.360",
241 "caption": "360 Convention"
242 },
243 "fiscalVariant": {
244 "id": 10000001,
245 "displayId": "sample_displayId",
246 "status": {
247 "name": "ACTIVE",
248 "captionKey": "enum.objectStatus.active",
249 "active": true,
250 "caption": "Active"
251 },
252 "isCalendarYear": true,
253 "yearDependent": false,
254 "erpSystemDisplayId": "sample_erpSystemDisplayId"
255 },
256 "assetClassFilterType": {
257 "name": "ALL",
258 "captionKey": "enum.filterType.all",
259 "caption": "All"
260 },
261 "assetClasses": [],
262 "functionalAreaFilterType": {
263 "name": "ALL",
264 "captionKey": "enum.filterType.all",
265 "caption": "All"
266 },
267 "functionalAreas": [],
268 "businessAreaFilterType": {
269 "name": "ALL",
270 "captionKey": "enum.filterType.all",
271 "caption": "All"
272 },
273 "businessAreas": [],
274 "vendorFilterType": {
275 "name": "ALL",
276 "captionKey": "enum.filterType.all",
277 "caption": "All"
278 },
279 "vendors": [],
280 "leaseClassificationFilterType": {
281 "name": "ALL",
282 "captionKey": "enum.filterType.all",
283 "caption": "All"
284 },
285 "leaseClassifications": "sample_leaseClassifications",
286 "accountingStandardType": "TYPE_VALUE",
287 "filterObjectDto": {
288 "id": 10000001,
289 "profileId": 10000001,
290 "displayId": "sample_displayId",
291 "objectType": "TYPE_VALUE"
292 },
293 "scriptProfile": false
294 }
295 }
296 ],
297 "number": 0,
298 "sort": {
299 "unsorted": false,
300 "sorted": true,
301 "empty": false
302 },
303 "first": true,
304 "last": true,
305 "empty": true
306}
Disclosure Report Schedule Job - Find All¶
HTTP Request
GET /api/v1/disclosure_reports/schedule-jobs
📋 Description: Retrieves scheduled jobs for disclosure reports within the Nakisa Lease Accounting Suite, enabling users to monitor and manage lease, contract, and financial obligation reporting processes effectively.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
Indicates whether the results of the scheduled jobs for lease and contract disclosures should be returned in a paginated format, facilitating efficient data retrieval and management. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "totalElements": 0,
3 "totalPages": 0,
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": 0,
17 "size": 0,
18 "content": [
19 {
20 "id": 0,
21 "cronExpression": "string",
22 "cronReadable": "string",
23 "active": true,
24 "unauthorized": true,
25 "nextExecution": "2019-08-24T14:15:22Z",
26 "previousSuccessfulExecution": "2019-08-24T14:15:22Z",
27 "previousExecution": "2019-08-24T14:15:22Z",
28 "previousExecutionMessage": "string",
29 "batchSize": 0,
30 "name": "string",
31 "profileId": 0,
32 "input": {
33 "id": 80000001,
34 "accountingStandardType": {
35 "name": "GAAP",
36 "captionKey": "enum.accountingStandardType.GAAP",
37 "caption": "IFRS 16"
38 },
39 "classifications": [
40 "NON_LEASE"
41 ],
42 "fromYear": 2024,
43 "fromPeriod": {
44 "id": 10000001,
45 "displayId": "FP-2024-Q1",
46 "status": {
47 "name": "ACTIVE",
48 "captionKey": "enum.objectStatus.active",
49 "active": true,
50 "caption": "Active"
51 },
52 "day": 15,
53 "year": 2024,
54 "month": 3,
55 "postingPeriod": 3,
56 "yearShift": 0
57 },
58 "toYear": 2025,
59 "toPeriod": {
60 "id": 10000001,
61 "displayId": "FP-2024-Q1",
62 "status": {
63 "name": "ACTIVE",
64 "captionKey": "enum.objectStatus.active",
65 "active": true,
66 "caption": "Active"
67 },
68 "day": 15,
69 "year": 2024,
70 "month": 3,
71 "postingPeriod": 3,
72 "yearShift": 0
73 },
74 "fromDate": "2024-01-01",
75 "toDate": "2025-12-31",
76 "fromDateType": "USER_DEFINED",
77 "toDateType": "USER_DEFINED",
78 "currencyDisplayId": "USD",
79 "currencyType": "TRANSACTION",
80 "currencyDefinitionType": {
81 "name": "COMPANY_CURRENCY",
82 "captionKey": "enum.currencyDefinitionType.companyCurrency",
83 "caption": "Company Currency"
84 },
85 "activationGroupStatus": {
86 "name": "AG_PENDING_ASSESSMENT",
87 "captionKey": "enum.ActivationGroup.StatusList",
88 "caption": "Activation Group Status"
89 },
90 "reportList": [
91 "NET_LEASE_INVESTMENT_REPORT"
92 ],
93 "listObjectType": {
94 "name": "CONTRACT",
95 "captionKey": "enum.objectType.contract",
96 "caption": "Contract"
97 },
98 "objectList": [
99 {
100 "id": 10000001,
101 "displayId": "ENT-001",
102 "name": "Entity Name"
103 }
104 ],
105 "migratedFilterType": {
106 "name": "ALL",
107 "captionKey": "enum.migratedFilterType.all",
108 "caption": "All"
109 },
110 "assetClassFilterType": {
111 "name": "ALL",
112 "captionKey": "enum.filterType.all",
113 "caption": "All"
114 },
115 "assetClasses": [
116 {
117 "id": 10000001,
118 "displayId": "IAC-001",
119 "status": {
120 "name": "ACTIVE",
121 "captionKey": "enum.objectStatus.active",
122 "active": true,
123 "caption": "Active"
124 },
125 "name": "Machinery and Equipment",
126 "assetClassType": "PROPERTY",
127 "infiniteUsefulLife": false
128 }
129 ],
130 "businessAreaFilterType": {
131 "name": "ALL",
132 "captionKey": "enum.filterType.all",
133 "caption": "All"
134 },
135 "businessAreas": [
136 {
137 "id": 3001,
138 "displayId": "BA-2025-001",
139 "status": {
140 "name": "ACTIVE",
141 "captionKey": "enum.objectStatus.active",
142 "active": true,
143 "caption": "Active"
144 },
145 "name": "North America Operations",
146 "erpSystemId": 0
147 }
148 ],
149 "vendorFilterType": {
150 "name": "ALL",
151 "captionKey": "enum.filterType.all",
152 "caption": "All"
153 },
154 "vendors": [
155 {
156 "id": 10000012,
157 "displayId": "0000100003",
158 "status": {
159 "name": "ACTIVE",
160 "captionKey": "enum.objectStatus.active",
161 "active": true,
162 "caption": "Active"
163 },
164 "name": "TEST VENDOR GB",
165 "erpSystemDisplayId": "FINQ8S-300"
166 }
167 ]
168 },
169 "profile": {
170 "id": 10000001,
171 "name": "Sample Name",
172 "principalPositionType": {
173 "name": "LESSEE",
174 "captionKey": "enum.principalpositiontype.lessee",
175 "caption": "Lessee"
176 },
177 "erpSystemFilterType": {
178 "name": "ALL",
179 "captionKey": "enum.filterType.all",
180 "caption": "All"
181 },
182 "erpSystems": [],
183 "leaseAreaFilterType": {
184 "name": "ALL",
185 "captionKey": "enum.filterType.all",
186 "caption": "All"
187 },
188 "leaseAreas": [],
189 "businessUnitFilterType": {
190 "name": "ALL",
191 "captionKey": "enum.filterType.all",
192 "caption": "All"
193 },
194 "businessUnits": [],
195 "companyFilterType": {
196 "name": "ALL",
197 "captionKey": "enum.filterType.all",
198 "caption": "All"
199 },
200 "companyCodes": [],
201 "departmentFilterType": {
202 "name": "ALL",
203 "captionKey": "enum.filterType.all",
204 "caption": "All"
205 },
206 "leaseDepartments": [],
207 "leaseGroupFilterType": {
208 "name": "ALL",
209 "captionKey": "enum.filterType.all",
210 "caption": "All"
211 },
212 "leaseGroups": [],
213 "costCenterFilterType": {
214 "name": "ALL",
215 "captionKey": "enum.filterType.all",
216 "caption": "All"
217 },
218 "costCenters": [],
219 "profitCenterFilterType": {
220 "name": "ALL",
221 "captionKey": "enum.filterType.all",
222 "caption": "All"
223 },
224 "profitCenters": [],
225 "workBreakdownStructureFilterType": {
226 "name": "ALL",
227 "captionKey": "enum.filterType.all",
228 "caption": "All"
229 },
230 "workBreakdownStructures": [],
231 "objectStatus": {
232 "name": "ACTIVE",
233 "captionKey": "enum.objectStatus.active",
234 "active": true,
235 "caption": "Active"
236 },
237 "securityProfileId": 10000001,
238 "calendarType": {
239 "name": "_360",
240 "captionKey": "enum.calendarType.360",
241 "caption": "360 Convention"
242 },
243 "fiscalVariant": {
244 "id": 10000001,
245 "displayId": "sample_displayId",
246 "status": {
247 "name": "ACTIVE",
248 "captionKey": "enum.objectStatus.active",
249 "active": true,
250 "caption": "Active"
251 },
252 "isCalendarYear": true,
253 "yearDependent": false,
254 "erpSystemDisplayId": "sample_erpSystemDisplayId"
255 },
256 "assetClassFilterType": {
257 "name": "ALL",
258 "captionKey": "enum.filterType.all",
259 "caption": "All"
260 },
261 "assetClasses": [],
262 "functionalAreaFilterType": {
263 "name": "ALL",
264 "captionKey": "enum.filterType.all",
265 "caption": "All"
266 },
267 "functionalAreas": [],
268 "businessAreaFilterType": {
269 "name": "ALL",
270 "captionKey": "enum.filterType.all",
271 "caption": "All"
272 },
273 "businessAreas": [],
274 "vendorFilterType": {
275 "name": "ALL",
276 "captionKey": "enum.filterType.all",
277 "caption": "All"
278 },
279 "vendors": [],
280 "leaseClassificationFilterType": {
281 "name": "ALL",
282 "captionKey": "enum.filterType.all",
283 "caption": "All"
284 },
285 "leaseClassifications": "sample_leaseClassifications",
286 "accountingStandardType": "TYPE_VALUE",
287 "filterObjectDto": {
288 "id": 10000001,
289 "profileId": 10000001,
290 "displayId": "sample_displayId",
291 "objectType": "TYPE_VALUE"
292 },
293 "scriptProfile": false
294 }
295 }
296 ],
297 "number": 0,
298 "sort": {
299 "unsorted": false,
300 "sorted": true,
301 "empty": false
302 },
303 "first": true,
304 "last": true,
305 "empty": true
306}