Disclosure Report Job¶
Get¶
HTTP Request
GET /api/v1/disclosure_reports/jobs/{id}
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
none |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "source": {},
8 "field": "string",
9 "errorKey": "string",
10 "errorMessage": "string"
11 }
12 ]
13 },
14 "object": {
15 "id": 0,
16 "taskCount": 0,
17 "failedTaskCount": 0,
18 "doneTaskCount": 0,
19 "inProgressTaskCount": 0,
20 "cancelledTaskCount": 0,
21 "errorMessage": "string",
22 "executor": "SCHEDULER",
23 "scheduleJobId": 0,
24 "batchSize": 1000,
25 "totalObjectCount": 0,
26 "profileId": 0,
27 "readOnly": true,
28 "input": {
29 "id": 0,
30 "accountingStandardType": "GAAP",
31 "classifications": [
32 "NON_LEASE"
33 ],
34 "fromYear": 0,
35 "fromPeriod": {
36 "id": 0,
37 "displayId": "string",
38 "status": "CREATED",
39 "day": 0,
40 "year": 0,
41 "month": 0,
42 "postingPeriod": 0,
43 "yearShift": 0
44 },
45 "toYear": 0,
46 "toPeriod": {
47 "id": 0,
48 "displayId": "string",
49 "status": "CREATED",
50 "day": 0,
51 "year": 0,
52 "month": 0,
53 "postingPeriod": 0,
54 "yearShift": 0
55 },
56 "fromDate": "2019-08-24",
57 "toDate": "2019-08-24",
58 "currencyDisplayId": "string",
59 "currencyType": "string",
60 "currencyDefinitionType": "CONTRACT_CURRENCY",
61 "activationGroupStatus": "AG_PENDING_ASSESSMENT",
62 "reportList": [
63 "NET_LEASE_INVESTMENT_REPORT"
64 ],
65 "listObjectType": "CONTRACT",
66 "objectList": [
67 {
68 "id": 0,
69 "displayId": "string",
70 "name": "string"
71 }
72 ],
73 "migratedFilterType": "MIGRATED",
74 "assetClassFilterType": "ALL",
75 "assetClasses": [
76 {
77 "id": 10000001,
78 "displayId": "IAC-001",
79 "status": {
80 "name": "ACTIVE",
81 "captionKey": "enum.objectStatus.active",
82 "active": true,
83 "caption": "Active"
84 },
85 "name": "Machinery and Equipment",
86 "assetClassType": "PROPERTY",
87 "infiniteUsefulLife": false
88 }
89 ],
90 "businessAreaFilterType": "ALL",
91 "businessAreas": [
92 {
93 "id": 3001,
94 "displayId": "BA-2025-001",
95 "status": {
96 "name": "ACTIVE",
97 "captionKey": "enum.objectStatus.active",
98 "active": true,
99 "caption": "Active"
100 },
101 "name": "North America Operations"
102 }
103 ],
104 "vendorFilterType": "ALL",
105 "vendors": [
106 {
107 "id": 10000012,
108 "displayId": "0000100003",
109 "status": {
110 "name": "ACTIVE",
111 "captionKey": "enum.objectStatus.active",
112 "active": true,
113 "caption": "Active"
114 },
115 "name": "TEST VENDOR GB",
116 "erpSystemDisplayId": "FINQ8S-300"
117 }
118 ]
119 },
120 "filter": {
121 "id": 0,
122 "name": "string",
123 "principalPositionType": "LESSEE",
124 "calendarType": "REGULAR_CALENDAR",
125 "fiscalYearVariant": {
126 "id": "string",
127 "displayId": "Euro"
128 },
129 "profileId": 0,
130 "jobId": 0,
131 "filterTypes": {
132 "erpSystemFilterType": "ALL",
133 "erpSystems": [
134 {
135 "id": 0,
136 "displayId": "string",
137 "status": "CREATED",
138 "name": "string",
139 "type": "NAKISA",
140 "sapVersion": "ECC_EHP5"
141 }
142 ],
143 "leaseAreaFilterType": "ALL",
144 "leaseAreas": [
145 {
146 "id": 10000001,
147 "displayId": "0001",
148 "status": {
149 "name": "ACTIVE",
150 "captionKey": "enum.objectStatus.active",
151 "active": true,
152 "caption": "Active"
153 },
154 "name": "Global Lease Area"
155 }
156 ],
157 "businessUnitFilterType": "ALL",
158 "businessUnits": [
159 {
160 "id": 10000001,
161 "displayId": "BU0001",
162 "status": {
163 "name": "ACTIVE",
164 "captionKey": "enum.objectStatus.active",
165 "active": true,
166 "caption": "Active"
167 },
168 "name": "North America Business Unit"
169 }
170 ],
171 "companyFilterType": "ALL",
172 "companies": [
173 {
174 "id": 10000006,
175 "displayId": "1005",
176 "status": {
177 "name": "ACTIVE",
178 "captionKey": "enum.objectStatus.active",
179 "active": true,
180 "caption": "Active"
181 },
182 "erpSystemId": 10000001,
183 "erpSystemDisplayId": "FINQ8S-300",
184 "countryId": 10000095,
185 "countryDisplayId": "CA",
186 "postingPeriodVariantId": 0,
187 "fiscalVariantId": 0
188 }
189 ],
190 "leaseDepartmentFilterType": "ALL",
191 "leaseDepartments": [
192 {
193 "id": 300001,
194 "displayId": "DEP-01",
195 "status": {
196 "name": "ACTIVE",
197 "captionKey": "enum.objectStatus.active",
198 "active": true,
199 "caption": "Active"
200 },
201 "name": "Finance Department"
202 }
203 ],
204 "leaseGroupFilterType": "ALL",
205 "leaseGroups": [
206 {
207 "id": 60000001,
208 "displayId": "LG-001",
209 "status": {
210 "name": "ACTIVE",
211 "captionKey": "enum.objectStatus.active",
212 "active": true,
213 "caption": "Active"
214 },
215 "name": "Global Lease Group"
216 }
217 ],
218 "costCenterFilterType": "ALL",
219 "costCenters": [
220 {
221 "id": 14001,
222 "displayId": "CC-001",
223 "status": {
224 "name": "ACTIVE",
225 "captionKey": "enum.objectStatus.active",
226 "active": true,
227 "caption": "Active"
228 },
229 "name": "Cost Center A"
230 }
231 ],
232 "profitCenterFilterType": "ALL",
233 "profitCenters": [
234 {
235 "id": 9001,
236 "displayId": "PC-001",
237 "status": {
238 "name": "ACTIVE",
239 "captionKey": "enum.objectStatus.active",
240 "active": true,
241 "caption": "Active"
242 },
243 "name": "North Region Profit Center",
244 "validTo": "2025-12-31",
245 "erpSystemId": 101,
246 "erpSystemDisplayId": "SAP-01"
247 }
248 ],
249 "wbsFilterType": "ALL",
250 "wbses": [
251 {
252 "id": 1001,
253 "displayId": "WBS-2025-001",
254 "status": {
255 "name": "ACTIVE",
256 "captionKey": "enum.objectStatus.active",
257 "active": true,
258 "caption": "Active"
259 },
260 "name": "Main Project WBS"
261 }
262 ],
263 "businessAreaFilterType": "ALL",
264 "businessAreas": [
265 {
266 "id": 3001,
267 "displayId": "BA-2025-001",
268 "status": {
269 "name": "ACTIVE",
270 "captionKey": "enum.objectStatus.active",
271 "active": true,
272 "caption": "Active"
273 },
274 "name": "North America Operations"
275 }
276 ],
277 "functionalAreaFilterType": "ALL",
278 "functionalAreas": [
279 {
280 "id": 2001,
281 "displayId": "FA-2025-001",
282 "status": {
283 "name": "ACTIVE",
284 "captionKey": "enum.objectStatus.active",
285 "active": true,
286 "caption": "Active"
287 },
288 "name": "Accounting Department"
289 }
290 ]
291 },
292 "baseIdList": [
293 {
294 "id": 0,
295 "displayId": "string",
296 "objectType": "LEASE_AREA"
297 }
298 ]
299 },
300 "tasks": [
301 {
302 "id": 0,
303 "queueTime": "2019-08-24T14:15:22Z",
304 "startTime": "2019-08-24T14:15:22Z",
305 "endTime": "2019-08-24T14:15:22Z",
306 "interruptedAt": "2019-08-24T14:15:22Z",
307 "recoveredAt": "2019-08-24T14:15:22Z",
308 "status": "CREATED",
309 "recover": true,
310 "interrupted": true,
311 "interruptionMessage": "string",
312 "errorMessage": "string",
313 "disclosureReportType": "NET_LEASE_INVESTMENT_REPORT",
314 "fileStorageId": "string",
315 "jsonFileStorageId": "string",
316 "generatingExportFile": true,
317 "startedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
318 "finishedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
319 "reportJobId": 0,
320 "version": 0,
321 "jsonDocStoreIds": [
322 0
323 ],
324 "docStoreId": 0
325 }
326 ]
327 }
328}
Update¶
HTTP Request
PUT /api/v1/disclosure_reports/jobs/{id}
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
none |
body |
body |
true |
none |
Body Parameters
1{
2 "id": 0,
3 "taskCount": 0,
4 "failedTaskCount": 0,
5 "doneTaskCount": 0,
6 "inProgressTaskCount": 0,
7 "cancelledTaskCount": 0,
8 "errorMessage": "string",
9 "executor": "SCHEDULER",
10 "scheduleJobId": 0,
11 "batchSize": 1000,
12 "totalObjectCount": 0,
13 "profileId": 0,
14 "readOnly": true,
15 "input": {
16 "id": 0,
17 "accountingStandardType": "GAAP",
18 "classifications": [
19 "NON_LEASE"
20 ],
21 "fromYear": 0,
22 "fromPeriod": {
23 "id": 0,
24 "displayId": "string",
25 "status": "CREATED",
26 "day": 0,
27 "year": 0,
28 "month": 0,
29 "postingPeriod": 0,
30 "yearShift": 0
31 },
32 "toYear": 0,
33 "toPeriod": {
34 "id": 0,
35 "displayId": "string",
36 "status": "CREATED",
37 "day": 0,
38 "year": 0,
39 "month": 0,
40 "postingPeriod": 0,
41 "yearShift": 0
42 },
43 "fromDate": "2019-08-24",
44 "toDate": "2019-08-24",
45 "currencyDisplayId": "string",
46 "currencyType": "string",
47 "currencyDefinitionType": "CONTRACT_CURRENCY",
48 "activationGroupStatus": "AG_PENDING_ASSESSMENT",
49 "reportList": [
50 "NET_LEASE_INVESTMENT_REPORT"
51 ],
52 "listObjectType": "CONTRACT",
53 "objectList": [
54 {
55 "id": 0,
56 "displayId": "string",
57 "name": "string"
58 }
59 ],
60 "migratedFilterType": "MIGRATED",
61 "assetClassFilterType": "ALL",
62 "assetClasses": [
63 {
64 "id": 10000001,
65 "displayId": "IAC-001",
66 "status": {
67 "name": "ACTIVE",
68 "captionKey": "enum.objectStatus.active",
69 "active": true,
70 "caption": "Active"
71 },
72 "name": "Machinery and Equipment",
73 "assetClassType": "PROPERTY",
74 "infiniteUsefulLife": false
75 }
76 ],
77 "businessAreaFilterType": "ALL",
78 "businessAreas": [
79 {
80 "id": 3001,
81 "displayId": "BA-2025-001",
82 "status": {
83 "name": "ACTIVE",
84 "captionKey": "enum.objectStatus.active",
85 "active": true,
86 "caption": "Active"
87 },
88 "name": "North America Operations"
89 }
90 ],
91 "vendorFilterType": "ALL",
92 "vendors": [
93 {
94 "id": 10000012,
95 "displayId": "0000100003",
96 "status": {
97 "name": "ACTIVE",
98 "captionKey": "enum.objectStatus.active",
99 "active": true,
100 "caption": "Active"
101 },
102 "name": "TEST VENDOR GB",
103 "erpSystemDisplayId": "FINQ8S-300"
104 }
105 ]
106 },
107 "filter": {
108 "id": 0,
109 "name": "string",
110 "principalPositionType": "LESSEE",
111 "calendarType": "REGULAR_CALENDAR",
112 "fiscalYearVariant": {
113 "id": "string",
114 "displayId": "Euro"
115 },
116 "profileId": 0,
117 "jobId": 0,
118 "filterTypes": {
119 "erpSystemFilterType": "ALL",
120 "erpSystems": [
121 {
122 "id": 0,
123 "displayId": "string",
124 "status": "CREATED",
125 "name": "string",
126 "type": "NAKISA",
127 "sapVersion": "ECC_EHP5"
128 }
129 ],
130 "leaseAreaFilterType": "ALL",
131 "leaseAreas": [
132 {
133 "id": 10000001,
134 "displayId": "0001",
135 "status": {
136 "name": "ACTIVE",
137 "captionKey": "enum.objectStatus.active",
138 "active": true,
139 "caption": "Active"
140 },
141 "name": "Global Lease Area"
142 }
143 ],
144 "businessUnitFilterType": "ALL",
145 "businessUnits": [
146 {
147 "id": 10000001,
148 "displayId": "BU0001",
149 "status": {
150 "name": "ACTIVE",
151 "captionKey": "enum.objectStatus.active",
152 "active": true,
153 "caption": "Active"
154 },
155 "name": "North America Business Unit"
156 }
157 ],
158 "companyFilterType": "ALL",
159 "companies": [
160 {
161 "id": 10000006,
162 "displayId": "1005",
163 "status": {
164 "name": "ACTIVE",
165 "captionKey": "enum.objectStatus.active",
166 "active": true,
167 "caption": "Active"
168 },
169 "erpSystemId": 10000001,
170 "erpSystemDisplayId": "FINQ8S-300",
171 "countryId": 10000095,
172 "countryDisplayId": "CA",
173 "postingPeriodVariantId": 0,
174 "fiscalVariantId": 0
175 }
176 ],
177 "leaseDepartmentFilterType": "ALL",
178 "leaseDepartments": [
179 {
180 "id": 300001,
181 "displayId": "DEP-01",
182 "status": {
183 "name": "ACTIVE",
184 "captionKey": "enum.objectStatus.active",
185 "active": true,
186 "caption": "Active"
187 },
188 "name": "Finance Department"
189 }
190 ],
191 "leaseGroupFilterType": "ALL",
192 "leaseGroups": [
193 {
194 "id": 60000001,
195 "displayId": "LG-001",
196 "status": {
197 "name": "ACTIVE",
198 "captionKey": "enum.objectStatus.active",
199 "active": true,
200 "caption": "Active"
201 },
202 "name": "Global Lease Group"
203 }
204 ],
205 "costCenterFilterType": "ALL",
206 "costCenters": [
207 {
208 "id": 14001,
209 "displayId": "CC-001",
210 "status": {
211 "name": "ACTIVE",
212 "captionKey": "enum.objectStatus.active",
213 "active": true,
214 "caption": "Active"
215 },
216 "name": "Cost Center A"
217 }
218 ],
219 "profitCenterFilterType": "ALL",
220 "profitCenters": [
221 {
222 "id": 9001,
223 "displayId": "PC-001",
224 "status": {
225 "name": "ACTIVE",
226 "captionKey": "enum.objectStatus.active",
227 "active": true,
228 "caption": "Active"
229 },
230 "name": "North Region Profit Center",
231 "validTo": "2025-12-31",
232 "erpSystemId": 101,
233 "erpSystemDisplayId": "SAP-01"
234 }
235 ],
236 "wbsFilterType": "ALL",
237 "wbses": [
238 {
239 "id": 1001,
240 "displayId": "WBS-2025-001",
241 "status": {
242 "name": "ACTIVE",
243 "captionKey": "enum.objectStatus.active",
244 "active": true,
245 "caption": "Active"
246 },
247 "name": "Main Project WBS"
248 }
249 ],
250 "businessAreaFilterType": "ALL",
251 "businessAreas": [
252 {
253 "id": 3001,
254 "displayId": "BA-2025-001",
255 "status": {
256 "name": "ACTIVE",
257 "captionKey": "enum.objectStatus.active",
258 "active": true,
259 "caption": "Active"
260 },
261 "name": "North America Operations"
262 }
263 ],
264 "functionalAreaFilterType": "ALL",
265 "functionalAreas": [
266 {
267 "id": 2001,
268 "displayId": "FA-2025-001",
269 "status": {
270 "name": "ACTIVE",
271 "captionKey": "enum.objectStatus.active",
272 "active": true,
273 "caption": "Active"
274 },
275 "name": "Accounting Department"
276 }
277 ]
278 },
279 "baseIdList": [
280 {
281 "id": 0,
282 "displayId": "string",
283 "objectType": "LEASE_AREA"
284 }
285 ]
286 },
287 "tasks": [
288 {
289 "id": 0,
290 "queueTime": "2019-08-24T14:15:22Z",
291 "startTime": "2019-08-24T14:15:22Z",
292 "endTime": "2019-08-24T14:15:22Z",
293 "interruptedAt": "2019-08-24T14:15:22Z",
294 "recoveredAt": "2019-08-24T14:15:22Z",
295 "status": "CREATED",
296 "recover": true,
297 "interrupted": true,
298 "interruptionMessage": "string",
299 "errorMessage": "string",
300 "disclosureReportType": "NET_LEASE_INVESTMENT_REPORT",
301 "fileStorageId": "string",
302 "jsonFileStorageId": "string",
303 "generatingExportFile": true,
304 "startedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
305 "finishedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
306 "reportJobId": 0,
307 "version": 0,
308 "jsonDocStoreIds": [
309 0
310 ],
311 "docStoreId": 0
312 }
313 ]
314}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "source": {},
8 "field": "string",
9 "errorKey": "string",
10 "errorMessage": "string"
11 }
12 ]
13 },
14 "object": {
15 "id": 0,
16 "taskCount": 0,
17 "failedTaskCount": 0,
18 "doneTaskCount": 0,
19 "inProgressTaskCount": 0,
20 "cancelledTaskCount": 0,
21 "errorMessage": "string",
22 "executor": "SCHEDULER",
23 "scheduleJobId": 0,
24 "batchSize": 1000,
25 "totalObjectCount": 0,
26 "profileId": 0,
27 "readOnly": true,
28 "input": {
29 "id": 0,
30 "accountingStandardType": "GAAP",
31 "classifications": [
32 "NON_LEASE"
33 ],
34 "fromYear": 0,
35 "fromPeriod": {
36 "id": 0,
37 "displayId": "string",
38 "status": "CREATED",
39 "day": 0,
40 "year": 0,
41 "month": 0,
42 "postingPeriod": 0,
43 "yearShift": 0
44 },
45 "toYear": 0,
46 "toPeriod": {
47 "id": 0,
48 "displayId": "string",
49 "status": "CREATED",
50 "day": 0,
51 "year": 0,
52 "month": 0,
53 "postingPeriod": 0,
54 "yearShift": 0
55 },
56 "fromDate": "2019-08-24",
57 "toDate": "2019-08-24",
58 "currencyDisplayId": "string",
59 "currencyType": "string",
60 "currencyDefinitionType": "CONTRACT_CURRENCY",
61 "activationGroupStatus": "AG_PENDING_ASSESSMENT",
62 "reportList": [
63 "NET_LEASE_INVESTMENT_REPORT"
64 ],
65 "listObjectType": "CONTRACT",
66 "objectList": [
67 {
68 "id": 0,
69 "displayId": "string",
70 "name": "string"
71 }
72 ],
73 "migratedFilterType": "MIGRATED",
74 "assetClassFilterType": "ALL",
75 "assetClasses": [
76 {
77 "id": 10000001,
78 "displayId": "IAC-001",
79 "status": {
80 "name": "ACTIVE",
81 "captionKey": "enum.objectStatus.active",
82 "active": true,
83 "caption": "Active"
84 },
85 "name": "Machinery and Equipment",
86 "assetClassType": "PROPERTY",
87 "infiniteUsefulLife": false
88 }
89 ],
90 "businessAreaFilterType": "ALL",
91 "businessAreas": [
92 {
93 "id": 3001,
94 "displayId": "BA-2025-001",
95 "status": {
96 "name": "ACTIVE",
97 "captionKey": "enum.objectStatus.active",
98 "active": true,
99 "caption": "Active"
100 },
101 "name": "North America Operations"
102 }
103 ],
104 "vendorFilterType": "ALL",
105 "vendors": [
106 {
107 "id": 10000012,
108 "displayId": "0000100003",
109 "status": {
110 "name": "ACTIVE",
111 "captionKey": "enum.objectStatus.active",
112 "active": true,
113 "caption": "Active"
114 },
115 "name": "TEST VENDOR GB",
116 "erpSystemDisplayId": "FINQ8S-300"
117 }
118 ]
119 },
120 "filter": {
121 "id": 0,
122 "name": "string",
123 "principalPositionType": "LESSEE",
124 "calendarType": "REGULAR_CALENDAR",
125 "fiscalYearVariant": {
126 "id": "string",
127 "displayId": "Euro"
128 },
129 "profileId": 0,
130 "jobId": 0,
131 "filterTypes": {
132 "erpSystemFilterType": "ALL",
133 "erpSystems": [
134 {
135 "id": 0,
136 "displayId": "string",
137 "status": "CREATED",
138 "name": "string",
139 "type": "NAKISA",
140 "sapVersion": "ECC_EHP5"
141 }
142 ],
143 "leaseAreaFilterType": "ALL",
144 "leaseAreas": [
145 {
146 "id": 10000001,
147 "displayId": "0001",
148 "status": {
149 "name": "ACTIVE",
150 "captionKey": "enum.objectStatus.active",
151 "active": true,
152 "caption": "Active"
153 },
154 "name": "Global Lease Area"
155 }
156 ],
157 "businessUnitFilterType": "ALL",
158 "businessUnits": [
159 {
160 "id": 10000001,
161 "displayId": "BU0001",
162 "status": {
163 "name": "ACTIVE",
164 "captionKey": "enum.objectStatus.active",
165 "active": true,
166 "caption": "Active"
167 },
168 "name": "North America Business Unit"
169 }
170 ],
171 "companyFilterType": "ALL",
172 "companies": [
173 {
174 "id": 10000006,
175 "displayId": "1005",
176 "status": {
177 "name": "ACTIVE",
178 "captionKey": "enum.objectStatus.active",
179 "active": true,
180 "caption": "Active"
181 },
182 "erpSystemId": 10000001,
183 "erpSystemDisplayId": "FINQ8S-300",
184 "countryId": 10000095,
185 "countryDisplayId": "CA",
186 "postingPeriodVariantId": 0,
187 "fiscalVariantId": 0
188 }
189 ],
190 "leaseDepartmentFilterType": "ALL",
191 "leaseDepartments": [
192 {
193 "id": 300001,
194 "displayId": "DEP-01",
195 "status": {
196 "name": "ACTIVE",
197 "captionKey": "enum.objectStatus.active",
198 "active": true,
199 "caption": "Active"
200 },
201 "name": "Finance Department"
202 }
203 ],
204 "leaseGroupFilterType": "ALL",
205 "leaseGroups": [
206 {
207 "id": 60000001,
208 "displayId": "LG-001",
209 "status": {
210 "name": "ACTIVE",
211 "captionKey": "enum.objectStatus.active",
212 "active": true,
213 "caption": "Active"
214 },
215 "name": "Global Lease Group"
216 }
217 ],
218 "costCenterFilterType": "ALL",
219 "costCenters": [
220 {
221 "id": 14001,
222 "displayId": "CC-001",
223 "status": {
224 "name": "ACTIVE",
225 "captionKey": "enum.objectStatus.active",
226 "active": true,
227 "caption": "Active"
228 },
229 "name": "Cost Center A"
230 }
231 ],
232 "profitCenterFilterType": "ALL",
233 "profitCenters": [
234 {
235 "id": 9001,
236 "displayId": "PC-001",
237 "status": {
238 "name": "ACTIVE",
239 "captionKey": "enum.objectStatus.active",
240 "active": true,
241 "caption": "Active"
242 },
243 "name": "North Region Profit Center",
244 "validTo": "2025-12-31",
245 "erpSystemId": 101,
246 "erpSystemDisplayId": "SAP-01"
247 }
248 ],
249 "wbsFilterType": "ALL",
250 "wbses": [
251 {
252 "id": 1001,
253 "displayId": "WBS-2025-001",
254 "status": {
255 "name": "ACTIVE",
256 "captionKey": "enum.objectStatus.active",
257 "active": true,
258 "caption": "Active"
259 },
260 "name": "Main Project WBS"
261 }
262 ],
263 "businessAreaFilterType": "ALL",
264 "businessAreas": [
265 {
266 "id": 3001,
267 "displayId": "BA-2025-001",
268 "status": {
269 "name": "ACTIVE",
270 "captionKey": "enum.objectStatus.active",
271 "active": true,
272 "caption": "Active"
273 },
274 "name": "North America Operations"
275 }
276 ],
277 "functionalAreaFilterType": "ALL",
278 "functionalAreas": [
279 {
280 "id": 2001,
281 "displayId": "FA-2025-001",
282 "status": {
283 "name": "ACTIVE",
284 "captionKey": "enum.objectStatus.active",
285 "active": true,
286 "caption": "Active"
287 },
288 "name": "Accounting Department"
289 }
290 ]
291 },
292 "baseIdList": [
293 {
294 "id": 0,
295 "displayId": "string",
296 "objectType": "LEASE_AREA"
297 }
298 ]
299 },
300 "tasks": [
301 {
302 "id": 0,
303 "queueTime": "2019-08-24T14:15:22Z",
304 "startTime": "2019-08-24T14:15:22Z",
305 "endTime": "2019-08-24T14:15:22Z",
306 "interruptedAt": "2019-08-24T14:15:22Z",
307 "recoveredAt": "2019-08-24T14:15:22Z",
308 "status": "CREATED",
309 "recover": true,
310 "interrupted": true,
311 "interruptionMessage": "string",
312 "errorMessage": "string",
313 "disclosureReportType": "NET_LEASE_INVESTMENT_REPORT",
314 "fileStorageId": "string",
315 "jsonFileStorageId": "string",
316 "generatingExportFile": true,
317 "startedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
318 "finishedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
319 "reportJobId": 0,
320 "version": 0,
321 "jsonDocStoreIds": [
322 0
323 ],
324 "docStoreId": 0
325 }
326 ]
327 }
328}
Delete¶
HTTP Request
DELETE /api/v1/disclosure_reports/jobs/{id}
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
none |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "OK",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "source": {},
8 "field": "string",
9 "errorKey": "string",
10 "errorMessage": "string"
11 }
12 ]
13 },
14 "object": {}
15}
Patch¶
HTTP Request
PATCH /api/v1/disclosure_reports/jobs/{id}
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
none |
body |
body |
true |
none |
Example Values¶
Parameter |
Example |
Type |
|---|---|---|
body |
|
body |
Body Parameters
1{
2 "op": "replace",
3 "path": "/name",
4 "value": "patched contract"
5}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "source": {},
8 "field": "string",
9 "errorKey": "string",
10 "errorMessage": "string"
11 }
12 ]
13 },
14 "object": {
15 "id": 0,
16 "taskCount": 0,
17 "failedTaskCount": 0,
18 "doneTaskCount": 0,
19 "inProgressTaskCount": 0,
20 "cancelledTaskCount": 0,
21 "errorMessage": "string",
22 "executor": "SCHEDULER",
23 "scheduleJobId": 0,
24 "batchSize": 1000,
25 "totalObjectCount": 0,
26 "profileId": 0,
27 "readOnly": true,
28 "input": {
29 "id": 0,
30 "accountingStandardType": "GAAP",
31 "classifications": [
32 "NON_LEASE"
33 ],
34 "fromYear": 0,
35 "fromPeriod": {
36 "id": 0,
37 "displayId": "string",
38 "status": "CREATED",
39 "day": 0,
40 "year": 0,
41 "month": 0,
42 "postingPeriod": 0,
43 "yearShift": 0
44 },
45 "toYear": 0,
46 "toPeriod": {
47 "id": 0,
48 "displayId": "string",
49 "status": "CREATED",
50 "day": 0,
51 "year": 0,
52 "month": 0,
53 "postingPeriod": 0,
54 "yearShift": 0
55 },
56 "fromDate": "2019-08-24",
57 "toDate": "2019-08-24",
58 "currencyDisplayId": "string",
59 "currencyType": "string",
60 "currencyDefinitionType": "CONTRACT_CURRENCY",
61 "activationGroupStatus": "AG_PENDING_ASSESSMENT",
62 "reportList": [
63 "NET_LEASE_INVESTMENT_REPORT"
64 ],
65 "listObjectType": "CONTRACT",
66 "objectList": [
67 {
68 "id": 0,
69 "displayId": "string",
70 "name": "string"
71 }
72 ],
73 "migratedFilterType": "MIGRATED",
74 "assetClassFilterType": "ALL",
75 "assetClasses": [
76 {
77 "id": 10000001,
78 "displayId": "IAC-001",
79 "status": {
80 "name": "ACTIVE",
81 "captionKey": "enum.objectStatus.active",
82 "active": true,
83 "caption": "Active"
84 },
85 "name": "Machinery and Equipment",
86 "assetClassType": "PROPERTY",
87 "infiniteUsefulLife": false
88 }
89 ],
90 "businessAreaFilterType": "ALL",
91 "businessAreas": [
92 {
93 "id": 3001,
94 "displayId": "BA-2025-001",
95 "status": {
96 "name": "ACTIVE",
97 "captionKey": "enum.objectStatus.active",
98 "active": true,
99 "caption": "Active"
100 },
101 "name": "North America Operations"
102 }
103 ],
104 "vendorFilterType": "ALL",
105 "vendors": [
106 {
107 "id": 10000012,
108 "displayId": "0000100003",
109 "status": {
110 "name": "ACTIVE",
111 "captionKey": "enum.objectStatus.active",
112 "active": true,
113 "caption": "Active"
114 },
115 "name": "TEST VENDOR GB",
116 "erpSystemDisplayId": "FINQ8S-300"
117 }
118 ]
119 },
120 "filter": {
121 "id": 0,
122 "name": "string",
123 "principalPositionType": "LESSEE",
124 "calendarType": "REGULAR_CALENDAR",
125 "fiscalYearVariant": {
126 "id": "string",
127 "displayId": "Euro"
128 },
129 "profileId": 0,
130 "jobId": 0,
131 "filterTypes": {
132 "erpSystemFilterType": "ALL",
133 "erpSystems": [
134 {
135 "id": 0,
136 "displayId": "string",
137 "status": "CREATED",
138 "name": "string",
139 "type": "NAKISA",
140 "sapVersion": "ECC_EHP5"
141 }
142 ],
143 "leaseAreaFilterType": "ALL",
144 "leaseAreas": [
145 {
146 "id": 10000001,
147 "displayId": "0001",
148 "status": {
149 "name": "ACTIVE",
150 "captionKey": "enum.objectStatus.active",
151 "active": true,
152 "caption": "Active"
153 },
154 "name": "Global Lease Area"
155 }
156 ],
157 "businessUnitFilterType": "ALL",
158 "businessUnits": [
159 {
160 "id": 10000001,
161 "displayId": "BU0001",
162 "status": {
163 "name": "ACTIVE",
164 "captionKey": "enum.objectStatus.active",
165 "active": true,
166 "caption": "Active"
167 },
168 "name": "North America Business Unit"
169 }
170 ],
171 "companyFilterType": "ALL",
172 "companies": [
173 {
174 "id": 10000006,
175 "displayId": "1005",
176 "status": {
177 "name": "ACTIVE",
178 "captionKey": "enum.objectStatus.active",
179 "active": true,
180 "caption": "Active"
181 },
182 "erpSystemId": 10000001,
183 "erpSystemDisplayId": "FINQ8S-300",
184 "countryId": 10000095,
185 "countryDisplayId": "CA",
186 "postingPeriodVariantId": 0,
187 "fiscalVariantId": 0
188 }
189 ],
190 "leaseDepartmentFilterType": "ALL",
191 "leaseDepartments": [
192 {
193 "id": 300001,
194 "displayId": "DEP-01",
195 "status": {
196 "name": "ACTIVE",
197 "captionKey": "enum.objectStatus.active",
198 "active": true,
199 "caption": "Active"
200 },
201 "name": "Finance Department"
202 }
203 ],
204 "leaseGroupFilterType": "ALL",
205 "leaseGroups": [
206 {
207 "id": 60000001,
208 "displayId": "LG-001",
209 "status": {
210 "name": "ACTIVE",
211 "captionKey": "enum.objectStatus.active",
212 "active": true,
213 "caption": "Active"
214 },
215 "name": "Global Lease Group"
216 }
217 ],
218 "costCenterFilterType": "ALL",
219 "costCenters": [
220 {
221 "id": 14001,
222 "displayId": "CC-001",
223 "status": {
224 "name": "ACTIVE",
225 "captionKey": "enum.objectStatus.active",
226 "active": true,
227 "caption": "Active"
228 },
229 "name": "Cost Center A"
230 }
231 ],
232 "profitCenterFilterType": "ALL",
233 "profitCenters": [
234 {
235 "id": 9001,
236 "displayId": "PC-001",
237 "status": {
238 "name": "ACTIVE",
239 "captionKey": "enum.objectStatus.active",
240 "active": true,
241 "caption": "Active"
242 },
243 "name": "North Region Profit Center",
244 "validTo": "2025-12-31",
245 "erpSystemId": 101,
246 "erpSystemDisplayId": "SAP-01"
247 }
248 ],
249 "wbsFilterType": "ALL",
250 "wbses": [
251 {
252 "id": 1001,
253 "displayId": "WBS-2025-001",
254 "status": {
255 "name": "ACTIVE",
256 "captionKey": "enum.objectStatus.active",
257 "active": true,
258 "caption": "Active"
259 },
260 "name": "Main Project WBS"
261 }
262 ],
263 "businessAreaFilterType": "ALL",
264 "businessAreas": [
265 {
266 "id": 3001,
267 "displayId": "BA-2025-001",
268 "status": {
269 "name": "ACTIVE",
270 "captionKey": "enum.objectStatus.active",
271 "active": true,
272 "caption": "Active"
273 },
274 "name": "North America Operations"
275 }
276 ],
277 "functionalAreaFilterType": "ALL",
278 "functionalAreas": [
279 {
280 "id": 2001,
281 "displayId": "FA-2025-001",
282 "status": {
283 "name": "ACTIVE",
284 "captionKey": "enum.objectStatus.active",
285 "active": true,
286 "caption": "Active"
287 },
288 "name": "Accounting Department"
289 }
290 ]
291 },
292 "baseIdList": [
293 {
294 "id": 0,
295 "displayId": "string",
296 "objectType": "LEASE_AREA"
297 }
298 ]
299 },
300 "tasks": [
301 {
302 "id": 0,
303 "queueTime": "2019-08-24T14:15:22Z",
304 "startTime": "2019-08-24T14:15:22Z",
305 "endTime": "2019-08-24T14:15:22Z",
306 "interruptedAt": "2019-08-24T14:15:22Z",
307 "recoveredAt": "2019-08-24T14:15:22Z",
308 "status": "CREATED",
309 "recover": true,
310 "interrupted": true,
311 "interruptionMessage": "string",
312 "errorMessage": "string",
313 "disclosureReportType": "NET_LEASE_INVESTMENT_REPORT",
314 "fileStorageId": "string",
315 "jsonFileStorageId": "string",
316 "generatingExportFile": true,
317 "startedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
318 "finishedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
319 "reportJobId": 0,
320 "version": 0,
321 "jsonDocStoreIds": [
322 0
323 ],
324 "docStoreId": 0
325 }
326 ]
327 }
328}
Create Or Update Bulk¶
HTTP Request
PUT /api/v1/disclosure_reports/jobs/createOrUpdate/bulk
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
none |
Body Parameters
1[
2 {
3 "id": 0,
4 "taskCount": 0,
5 "failedTaskCount": 0,
6 "doneTaskCount": 0,
7 "inProgressTaskCount": 0,
8 "cancelledTaskCount": 0,
9 "errorMessage": "string",
10 "executor": "SCHEDULER",
11 "scheduleJobId": 0,
12 "batchSize": 1000,
13 "totalObjectCount": 0,
14 "profileId": 0,
15 "readOnly": true,
16 "input": {
17 "id": 0,
18 "accountingStandardType": "GAAP",
19 "classifications": [
20 "NON_LEASE"
21 ],
22 "fromYear": 0,
23 "fromPeriod": {
24 "id": 0,
25 "displayId": "string",
26 "status": "CREATED",
27 "day": 0,
28 "year": 0,
29 "month": 0,
30 "postingPeriod": 0,
31 "yearShift": 0
32 },
33 "toYear": 0,
34 "toPeriod": {
35 "id": 0,
36 "displayId": "string",
37 "status": "CREATED",
38 "day": 0,
39 "year": 0,
40 "month": 0,
41 "postingPeriod": 0,
42 "yearShift": 0
43 },
44 "fromDate": "2019-08-24",
45 "toDate": "2019-08-24",
46 "currencyDisplayId": "string",
47 "currencyType": "string",
48 "currencyDefinitionType": "CONTRACT_CURRENCY",
49 "activationGroupStatus": "AG_PENDING_ASSESSMENT",
50 "reportList": [
51 "NET_LEASE_INVESTMENT_REPORT"
52 ],
53 "listObjectType": "CONTRACT",
54 "objectList": [
55 {
56 "id": 0,
57 "displayId": "string",
58 "name": "string"
59 }
60 ],
61 "migratedFilterType": "MIGRATED",
62 "assetClassFilterType": "ALL",
63 "assetClasses": [
64 {
65 "id": 10000001,
66 "displayId": "IAC-001",
67 "status": {
68 "name": "ACTIVE",
69 "captionKey": "enum.objectStatus.active",
70 "active": true,
71 "caption": "Active"
72 },
73 "name": "Machinery and Equipment",
74 "assetClassType": "PROPERTY",
75 "infiniteUsefulLife": false
76 }
77 ],
78 "businessAreaFilterType": "ALL",
79 "businessAreas": [
80 {
81 "id": 3001,
82 "displayId": "BA-2025-001",
83 "status": {
84 "name": "ACTIVE",
85 "captionKey": "enum.objectStatus.active",
86 "active": true,
87 "caption": "Active"
88 },
89 "name": "North America Operations"
90 }
91 ],
92 "vendorFilterType": "ALL",
93 "vendors": [
94 {
95 "id": 10000012,
96 "displayId": "0000100003",
97 "status": {
98 "name": "ACTIVE",
99 "captionKey": "enum.objectStatus.active",
100 "active": true,
101 "caption": "Active"
102 },
103 "name": "TEST VENDOR GB",
104 "erpSystemDisplayId": "FINQ8S-300"
105 }
106 ]
107 },
108 "filter": {
109 "id": 0,
110 "name": "string",
111 "principalPositionType": "LESSEE",
112 "calendarType": "REGULAR_CALENDAR",
113 "fiscalYearVariant": {
114 "id": "string",
115 "displayId": "Euro"
116 },
117 "profileId": 0,
118 "jobId": 0,
119 "filterTypes": {
120 "erpSystemFilterType": "ALL",
121 "erpSystems": [
122 {
123 "id": 0,
124 "displayId": "string",
125 "status": "CREATED",
126 "name": "string",
127 "type": "NAKISA",
128 "sapVersion": "ECC_EHP5"
129 }
130 ],
131 "leaseAreaFilterType": "ALL",
132 "leaseAreas": [
133 {
134 "id": 10000001,
135 "displayId": "0001",
136 "status": {
137 "name": "ACTIVE",
138 "captionKey": "enum.objectStatus.active",
139 "active": true,
140 "caption": "Active"
141 },
142 "name": "Global Lease Area"
143 }
144 ],
145 "businessUnitFilterType": "ALL",
146 "businessUnits": [
147 {
148 "id": 10000001,
149 "displayId": "BU0001",
150 "status": {
151 "name": "ACTIVE",
152 "captionKey": "enum.objectStatus.active",
153 "active": true,
154 "caption": "Active"
155 },
156 "name": "North America Business Unit"
157 }
158 ],
159 "companyFilterType": "ALL",
160 "companies": [
161 {
162 "id": 10000006,
163 "displayId": "1005",
164 "status": {
165 "name": "ACTIVE",
166 "captionKey": "enum.objectStatus.active",
167 "active": true,
168 "caption": "Active"
169 },
170 "erpSystemId": 10000001,
171 "erpSystemDisplayId": "FINQ8S-300",
172 "countryId": 10000095,
173 "countryDisplayId": "CA",
174 "postingPeriodVariantId": 0,
175 "fiscalVariantId": 0
176 }
177 ],
178 "leaseDepartmentFilterType": "ALL",
179 "leaseDepartments": [
180 {
181 "id": 300001,
182 "displayId": "DEP-01",
183 "status": {
184 "name": "ACTIVE",
185 "captionKey": "enum.objectStatus.active",
186 "active": true,
187 "caption": "Active"
188 },
189 "name": "Finance Department"
190 }
191 ],
192 "leaseGroupFilterType": "ALL",
193 "leaseGroups": [
194 {
195 "id": 60000001,
196 "displayId": "LG-001",
197 "status": {
198 "name": "ACTIVE",
199 "captionKey": "enum.objectStatus.active",
200 "active": true,
201 "caption": "Active"
202 },
203 "name": "Global Lease Group"
204 }
205 ],
206 "costCenterFilterType": "ALL",
207 "costCenters": [
208 {
209 "id": 14001,
210 "displayId": "CC-001",
211 "status": {
212 "name": "ACTIVE",
213 "captionKey": "enum.objectStatus.active",
214 "active": true,
215 "caption": "Active"
216 },
217 "name": "Cost Center A"
218 }
219 ],
220 "profitCenterFilterType": "ALL",
221 "profitCenters": [
222 {
223 "id": 9001,
224 "displayId": "PC-001",
225 "status": {
226 "name": "ACTIVE",
227 "captionKey": "enum.objectStatus.active",
228 "active": true,
229 "caption": "Active"
230 },
231 "name": "North Region Profit Center",
232 "validTo": "2025-12-31",
233 "erpSystemId": 101,
234 "erpSystemDisplayId": "SAP-01"
235 }
236 ],
237 "wbsFilterType": "ALL",
238 "wbses": [
239 {
240 "id": 1001,
241 "displayId": "WBS-2025-001",
242 "status": {
243 "name": "ACTIVE",
244 "captionKey": "enum.objectStatus.active",
245 "active": true,
246 "caption": "Active"
247 },
248 "name": "Main Project WBS"
249 }
250 ],
251 "businessAreaFilterType": "ALL",
252 "businessAreas": [
253 {
254 "id": 3001,
255 "displayId": "BA-2025-001",
256 "status": {
257 "name": "ACTIVE",
258 "captionKey": "enum.objectStatus.active",
259 "active": true,
260 "caption": "Active"
261 },
262 "name": "North America Operations"
263 }
264 ],
265 "functionalAreaFilterType": "ALL",
266 "functionalAreas": [
267 {
268 "id": 2001,
269 "displayId": "FA-2025-001",
270 "status": {
271 "name": "ACTIVE",
272 "captionKey": "enum.objectStatus.active",
273 "active": true,
274 "caption": "Active"
275 },
276 "name": "Accounting Department"
277 }
278 ]
279 },
280 "baseIdList": [
281 {
282 "id": 0,
283 "displayId": "string",
284 "objectType": "LEASE_AREA"
285 }
286 ]
287 },
288 "tasks": [
289 {
290 "id": 0,
291 "queueTime": "2019-08-24T14:15:22Z",
292 "startTime": "2019-08-24T14:15:22Z",
293 "endTime": "2019-08-24T14:15:22Z",
294 "interruptedAt": "2019-08-24T14:15:22Z",
295 "recoveredAt": "2019-08-24T14:15:22Z",
296 "status": "CREATED",
297 "recover": true,
298 "interrupted": true,
299 "interruptionMessage": "string",
300 "errorMessage": "string",
301 "disclosureReportType": "NET_LEASE_INVESTMENT_REPORT",
302 "fileStorageId": "string",
303 "jsonFileStorageId": "string",
304 "generatingExportFile": true,
305 "startedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
306 "finishedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
307 "reportJobId": 0,
308 "version": 0,
309 "jsonDocStoreIds": [
310 0
311 ],
312 "docStoreId": 0
313 }
314 ]
315 }
316]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "source": {},
8 "field": "string",
9 "errorKey": "string",
10 "errorMessage": "string"
11 }
12 ]
13 },
14 "object": [
15 {
16 "id": 0,
17 "taskCount": 0,
18 "failedTaskCount": 0,
19 "doneTaskCount": 0,
20 "inProgressTaskCount": 0,
21 "cancelledTaskCount": 0,
22 "errorMessage": "string",
23 "executor": "SCHEDULER",
24 "scheduleJobId": 0,
25 "batchSize": 1000,
26 "totalObjectCount": 0,
27 "profileId": 0,
28 "readOnly": true,
29 "input": {
30 "id": 0,
31 "accountingStandardType": "GAAP",
32 "classifications": [
33 "NON_LEASE"
34 ],
35 "fromYear": 0,
36 "fromPeriod": {
37 "id": 0,
38 "displayId": "string",
39 "status": "CREATED",
40 "day": 0,
41 "year": 0,
42 "month": 0,
43 "postingPeriod": 0,
44 "yearShift": 0
45 },
46 "toYear": 0,
47 "toPeriod": {
48 "id": 0,
49 "displayId": "string",
50 "status": "CREATED",
51 "day": 0,
52 "year": 0,
53 "month": 0,
54 "postingPeriod": 0,
55 "yearShift": 0
56 },
57 "fromDate": "2019-08-24",
58 "toDate": "2019-08-24",
59 "currencyDisplayId": "string",
60 "currencyType": "string",
61 "currencyDefinitionType": "CONTRACT_CURRENCY",
62 "activationGroupStatus": "AG_PENDING_ASSESSMENT",
63 "reportList": [
64 "NET_LEASE_INVESTMENT_REPORT"
65 ],
66 "listObjectType": "CONTRACT",
67 "objectList": [
68 {
69 "id": 0,
70 "displayId": "string",
71 "name": "string"
72 }
73 ],
74 "migratedFilterType": "MIGRATED",
75 "assetClassFilterType": "ALL",
76 "assetClasses": [
77 {
78 "id": 10000001,
79 "displayId": "IAC-001",
80 "status": {
81 "name": "ACTIVE",
82 "captionKey": "enum.objectStatus.active",
83 "active": true,
84 "caption": "Active"
85 },
86 "name": "Machinery and Equipment",
87 "assetClassType": "PROPERTY",
88 "infiniteUsefulLife": false
89 }
90 ],
91 "businessAreaFilterType": "ALL",
92 "businessAreas": [
93 {
94 "id": 3001,
95 "displayId": "BA-2025-001",
96 "status": {
97 "name": "ACTIVE",
98 "captionKey": "enum.objectStatus.active",
99 "active": true,
100 "caption": "Active"
101 },
102 "name": "North America Operations"
103 }
104 ],
105 "vendorFilterType": "ALL",
106 "vendors": [
107 {
108 "id": 10000012,
109 "displayId": "0000100003",
110 "status": {
111 "name": "ACTIVE",
112 "captionKey": "enum.objectStatus.active",
113 "active": true,
114 "caption": "Active"
115 },
116 "name": "TEST VENDOR GB",
117 "erpSystemDisplayId": "FINQ8S-300"
118 }
119 ]
120 },
121 "filter": {
122 "id": 0,
123 "name": "string",
124 "principalPositionType": "LESSEE",
125 "calendarType": "REGULAR_CALENDAR",
126 "fiscalYearVariant": {
127 "id": "string",
128 "displayId": "Euro"
129 },
130 "profileId": 0,
131 "jobId": 0,
132 "filterTypes": {
133 "erpSystemFilterType": "ALL",
134 "erpSystems": [
135 {
136 "id": 0,
137 "displayId": "string",
138 "status": "CREATED",
139 "name": "string",
140 "type": "NAKISA",
141 "sapVersion": "ECC_EHP5"
142 }
143 ],
144 "leaseAreaFilterType": "ALL",
145 "leaseAreas": [
146 {
147 "id": 10000001,
148 "displayId": "0001",
149 "status": {
150 "name": "ACTIVE",
151 "captionKey": "enum.objectStatus.active",
152 "active": true,
153 "caption": "Active"
154 },
155 "name": "Global Lease Area"
156 }
157 ],
158 "businessUnitFilterType": "ALL",
159 "businessUnits": [
160 {
161 "id": 10000001,
162 "displayId": "BU0001",
163 "status": {
164 "name": "ACTIVE",
165 "captionKey": "enum.objectStatus.active",
166 "active": true,
167 "caption": "Active"
168 },
169 "name": "North America Business Unit"
170 }
171 ],
172 "companyFilterType": "ALL",
173 "companies": [
174 {
175 "id": 10000006,
176 "displayId": "1005",
177 "status": {
178 "name": "ACTIVE",
179 "captionKey": "enum.objectStatus.active",
180 "active": true,
181 "caption": "Active"
182 },
183 "erpSystemId": 10000001,
184 "erpSystemDisplayId": "FINQ8S-300",
185 "countryId": 10000095,
186 "countryDisplayId": "CA",
187 "postingPeriodVariantId": 0,
188 "fiscalVariantId": 0
189 }
190 ],
191 "leaseDepartmentFilterType": "ALL",
192 "leaseDepartments": [
193 {
194 "id": 300001,
195 "displayId": "DEP-01",
196 "status": {
197 "name": "ACTIVE",
198 "captionKey": "enum.objectStatus.active",
199 "active": true,
200 "caption": "Active"
201 },
202 "name": "Finance Department"
203 }
204 ],
205 "leaseGroupFilterType": "ALL",
206 "leaseGroups": [
207 {
208 "id": 60000001,
209 "displayId": "LG-001",
210 "status": {
211 "name": "ACTIVE",
212 "captionKey": "enum.objectStatus.active",
213 "active": true,
214 "caption": "Active"
215 },
216 "name": "Global Lease Group"
217 }
218 ],
219 "costCenterFilterType": "ALL",
220 "costCenters": [
221 {
222 "id": 14001,
223 "displayId": "CC-001",
224 "status": {
225 "name": "ACTIVE",
226 "captionKey": "enum.objectStatus.active",
227 "active": true,
228 "caption": "Active"
229 },
230 "name": "Cost Center A"
231 }
232 ],
233 "profitCenterFilterType": "ALL",
234 "profitCenters": [
235 {
236 "id": 9001,
237 "displayId": "PC-001",
238 "status": {
239 "name": "ACTIVE",
240 "captionKey": "enum.objectStatus.active",
241 "active": true,
242 "caption": "Active"
243 },
244 "name": "North Region Profit Center",
245 "validTo": "2025-12-31",
246 "erpSystemId": 101,
247 "erpSystemDisplayId": "SAP-01"
248 }
249 ],
250 "wbsFilterType": "ALL",
251 "wbses": [
252 {
253 "id": 1001,
254 "displayId": "WBS-2025-001",
255 "status": {
256 "name": "ACTIVE",
257 "captionKey": "enum.objectStatus.active",
258 "active": true,
259 "caption": "Active"
260 },
261 "name": "Main Project WBS"
262 }
263 ],
264 "businessAreaFilterType": "ALL",
265 "businessAreas": [
266 {
267 "id": 3001,
268 "displayId": "BA-2025-001",
269 "status": {
270 "name": "ACTIVE",
271 "captionKey": "enum.objectStatus.active",
272 "active": true,
273 "caption": "Active"
274 },
275 "name": "North America Operations"
276 }
277 ],
278 "functionalAreaFilterType": "ALL",
279 "functionalAreas": [
280 {
281 "id": 2001,
282 "displayId": "FA-2025-001",
283 "status": {
284 "name": "ACTIVE",
285 "captionKey": "enum.objectStatus.active",
286 "active": true,
287 "caption": "Active"
288 },
289 "name": "Accounting Department"
290 }
291 ]
292 },
293 "baseIdList": [
294 {
295 "id": 0,
296 "displayId": "string",
297 "objectType": "LEASE_AREA"
298 }
299 ]
300 },
301 "tasks": [
302 {
303 "id": 0,
304 "queueTime": "2019-08-24T14:15:22Z",
305 "startTime": "2019-08-24T14:15:22Z",
306 "endTime": "2019-08-24T14:15:22Z",
307 "interruptedAt": "2019-08-24T14:15:22Z",
308 "recoveredAt": "2019-08-24T14:15:22Z",
309 "status": "CREATED",
310 "recover": true,
311 "interrupted": true,
312 "interruptionMessage": "string",
313 "errorMessage": "string",
314 "disclosureReportType": "NET_LEASE_INVESTMENT_REPORT",
315 "fileStorageId": "string",
316 "jsonFileStorageId": "string",
317 "generatingExportFile": true,
318 "startedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
319 "finishedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
320 "reportJobId": 0,
321 "version": 0,
322 "jsonDocStoreIds": [
323 0
324 ],
325 "docStoreId": 0
326 }
327 ]
328 }
329 ]
330}
Create Or Update¶
HTTP Request
PUT /api/v1/disclosure_reports/jobs/createOrUpdate
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
none |
Body Parameters
1{
2 "id": 0,
3 "taskCount": 0,
4 "failedTaskCount": 0,
5 "doneTaskCount": 0,
6 "inProgressTaskCount": 0,
7 "cancelledTaskCount": 0,
8 "errorMessage": "string",
9 "executor": "SCHEDULER",
10 "scheduleJobId": 0,
11 "batchSize": 1000,
12 "totalObjectCount": 0,
13 "profileId": 0,
14 "readOnly": true,
15 "input": {
16 "id": 0,
17 "accountingStandardType": "GAAP",
18 "classifications": [
19 "NON_LEASE"
20 ],
21 "fromYear": 0,
22 "fromPeriod": {
23 "id": 0,
24 "displayId": "string",
25 "status": "CREATED",
26 "day": 0,
27 "year": 0,
28 "month": 0,
29 "postingPeriod": 0,
30 "yearShift": 0
31 },
32 "toYear": 0,
33 "toPeriod": {
34 "id": 0,
35 "displayId": "string",
36 "status": "CREATED",
37 "day": 0,
38 "year": 0,
39 "month": 0,
40 "postingPeriod": 0,
41 "yearShift": 0
42 },
43 "fromDate": "2019-08-24",
44 "toDate": "2019-08-24",
45 "currencyDisplayId": "string",
46 "currencyType": "string",
47 "currencyDefinitionType": "CONTRACT_CURRENCY",
48 "activationGroupStatus": "AG_PENDING_ASSESSMENT",
49 "reportList": [
50 "NET_LEASE_INVESTMENT_REPORT"
51 ],
52 "listObjectType": "CONTRACT",
53 "objectList": [
54 {
55 "id": 0,
56 "displayId": "string",
57 "name": "string"
58 }
59 ],
60 "migratedFilterType": "MIGRATED",
61 "assetClassFilterType": "ALL",
62 "assetClasses": [
63 {
64 "id": 10000001,
65 "displayId": "IAC-001",
66 "status": {
67 "name": "ACTIVE",
68 "captionKey": "enum.objectStatus.active",
69 "active": true,
70 "caption": "Active"
71 },
72 "name": "Machinery and Equipment",
73 "assetClassType": "PROPERTY",
74 "infiniteUsefulLife": false
75 }
76 ],
77 "businessAreaFilterType": "ALL",
78 "businessAreas": [
79 {
80 "id": 3001,
81 "displayId": "BA-2025-001",
82 "status": {
83 "name": "ACTIVE",
84 "captionKey": "enum.objectStatus.active",
85 "active": true,
86 "caption": "Active"
87 },
88 "name": "North America Operations"
89 }
90 ],
91 "vendorFilterType": "ALL",
92 "vendors": [
93 {
94 "id": 10000012,
95 "displayId": "0000100003",
96 "status": {
97 "name": "ACTIVE",
98 "captionKey": "enum.objectStatus.active",
99 "active": true,
100 "caption": "Active"
101 },
102 "name": "TEST VENDOR GB",
103 "erpSystemDisplayId": "FINQ8S-300"
104 }
105 ]
106 },
107 "filter": {
108 "id": 0,
109 "name": "string",
110 "principalPositionType": "LESSEE",
111 "calendarType": "REGULAR_CALENDAR",
112 "fiscalYearVariant": {
113 "id": "string",
114 "displayId": "Euro"
115 },
116 "profileId": 0,
117 "jobId": 0,
118 "filterTypes": {
119 "erpSystemFilterType": "ALL",
120 "erpSystems": [
121 {
122 "id": 0,
123 "displayId": "string",
124 "status": "CREATED",
125 "name": "string",
126 "type": "NAKISA",
127 "sapVersion": "ECC_EHP5"
128 }
129 ],
130 "leaseAreaFilterType": "ALL",
131 "leaseAreas": [
132 {
133 "id": 10000001,
134 "displayId": "0001",
135 "status": {
136 "name": "ACTIVE",
137 "captionKey": "enum.objectStatus.active",
138 "active": true,
139 "caption": "Active"
140 },
141 "name": "Global Lease Area"
142 }
143 ],
144 "businessUnitFilterType": "ALL",
145 "businessUnits": [
146 {
147 "id": 10000001,
148 "displayId": "BU0001",
149 "status": {
150 "name": "ACTIVE",
151 "captionKey": "enum.objectStatus.active",
152 "active": true,
153 "caption": "Active"
154 },
155 "name": "North America Business Unit"
156 }
157 ],
158 "companyFilterType": "ALL",
159 "companies": [
160 {
161 "id": 10000006,
162 "displayId": "1005",
163 "status": {
164 "name": "ACTIVE",
165 "captionKey": "enum.objectStatus.active",
166 "active": true,
167 "caption": "Active"
168 },
169 "erpSystemId": 10000001,
170 "erpSystemDisplayId": "FINQ8S-300",
171 "countryId": 10000095,
172 "countryDisplayId": "CA",
173 "postingPeriodVariantId": 0,
174 "fiscalVariantId": 0
175 }
176 ],
177 "leaseDepartmentFilterType": "ALL",
178 "leaseDepartments": [
179 {
180 "id": 300001,
181 "displayId": "DEP-01",
182 "status": {
183 "name": "ACTIVE",
184 "captionKey": "enum.objectStatus.active",
185 "active": true,
186 "caption": "Active"
187 },
188 "name": "Finance Department"
189 }
190 ],
191 "leaseGroupFilterType": "ALL",
192 "leaseGroups": [
193 {
194 "id": 60000001,
195 "displayId": "LG-001",
196 "status": {
197 "name": "ACTIVE",
198 "captionKey": "enum.objectStatus.active",
199 "active": true,
200 "caption": "Active"
201 },
202 "name": "Global Lease Group"
203 }
204 ],
205 "costCenterFilterType": "ALL",
206 "costCenters": [
207 {
208 "id": 14001,
209 "displayId": "CC-001",
210 "status": {
211 "name": "ACTIVE",
212 "captionKey": "enum.objectStatus.active",
213 "active": true,
214 "caption": "Active"
215 },
216 "name": "Cost Center A"
217 }
218 ],
219 "profitCenterFilterType": "ALL",
220 "profitCenters": [
221 {
222 "id": 9001,
223 "displayId": "PC-001",
224 "status": {
225 "name": "ACTIVE",
226 "captionKey": "enum.objectStatus.active",
227 "active": true,
228 "caption": "Active"
229 },
230 "name": "North Region Profit Center",
231 "validTo": "2025-12-31",
232 "erpSystemId": 101,
233 "erpSystemDisplayId": "SAP-01"
234 }
235 ],
236 "wbsFilterType": "ALL",
237 "wbses": [
238 {
239 "id": 1001,
240 "displayId": "WBS-2025-001",
241 "status": {
242 "name": "ACTIVE",
243 "captionKey": "enum.objectStatus.active",
244 "active": true,
245 "caption": "Active"
246 },
247 "name": "Main Project WBS"
248 }
249 ],
250 "businessAreaFilterType": "ALL",
251 "businessAreas": [
252 {
253 "id": 3001,
254 "displayId": "BA-2025-001",
255 "status": {
256 "name": "ACTIVE",
257 "captionKey": "enum.objectStatus.active",
258 "active": true,
259 "caption": "Active"
260 },
261 "name": "North America Operations"
262 }
263 ],
264 "functionalAreaFilterType": "ALL",
265 "functionalAreas": [
266 {
267 "id": 2001,
268 "displayId": "FA-2025-001",
269 "status": {
270 "name": "ACTIVE",
271 "captionKey": "enum.objectStatus.active",
272 "active": true,
273 "caption": "Active"
274 },
275 "name": "Accounting Department"
276 }
277 ]
278 },
279 "baseIdList": [
280 {
281 "id": 0,
282 "displayId": "string",
283 "objectType": "LEASE_AREA"
284 }
285 ]
286 },
287 "tasks": [
288 {
289 "id": 0,
290 "queueTime": "2019-08-24T14:15:22Z",
291 "startTime": "2019-08-24T14:15:22Z",
292 "endTime": "2019-08-24T14:15:22Z",
293 "interruptedAt": "2019-08-24T14:15:22Z",
294 "recoveredAt": "2019-08-24T14:15:22Z",
295 "status": "CREATED",
296 "recover": true,
297 "interrupted": true,
298 "interruptionMessage": "string",
299 "errorMessage": "string",
300 "disclosureReportType": "NET_LEASE_INVESTMENT_REPORT",
301 "fileStorageId": "string",
302 "jsonFileStorageId": "string",
303 "generatingExportFile": true,
304 "startedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
305 "finishedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
306 "reportJobId": 0,
307 "version": 0,
308 "jsonDocStoreIds": [
309 0
310 ],
311 "docStoreId": 0
312 }
313 ]
314}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "source": {},
8 "field": "string",
9 "errorKey": "string",
10 "errorMessage": "string"
11 }
12 ]
13 },
14 "object": {
15 "id": 0,
16 "taskCount": 0,
17 "failedTaskCount": 0,
18 "doneTaskCount": 0,
19 "inProgressTaskCount": 0,
20 "cancelledTaskCount": 0,
21 "errorMessage": "string",
22 "executor": "SCHEDULER",
23 "scheduleJobId": 0,
24 "batchSize": 1000,
25 "totalObjectCount": 0,
26 "profileId": 0,
27 "readOnly": true,
28 "input": {
29 "id": 0,
30 "accountingStandardType": "GAAP",
31 "classifications": [
32 "NON_LEASE"
33 ],
34 "fromYear": 0,
35 "fromPeriod": {
36 "id": 0,
37 "displayId": "string",
38 "status": "CREATED",
39 "day": 0,
40 "year": 0,
41 "month": 0,
42 "postingPeriod": 0,
43 "yearShift": 0
44 },
45 "toYear": 0,
46 "toPeriod": {
47 "id": 0,
48 "displayId": "string",
49 "status": "CREATED",
50 "day": 0,
51 "year": 0,
52 "month": 0,
53 "postingPeriod": 0,
54 "yearShift": 0
55 },
56 "fromDate": "2019-08-24",
57 "toDate": "2019-08-24",
58 "currencyDisplayId": "string",
59 "currencyType": "string",
60 "currencyDefinitionType": "CONTRACT_CURRENCY",
61 "activationGroupStatus": "AG_PENDING_ASSESSMENT",
62 "reportList": [
63 "NET_LEASE_INVESTMENT_REPORT"
64 ],
65 "listObjectType": "CONTRACT",
66 "objectList": [
67 {
68 "id": 0,
69 "displayId": "string",
70 "name": "string"
71 }
72 ],
73 "migratedFilterType": "MIGRATED",
74 "assetClassFilterType": "ALL",
75 "assetClasses": [
76 {
77 "id": 10000001,
78 "displayId": "IAC-001",
79 "status": {
80 "name": "ACTIVE",
81 "captionKey": "enum.objectStatus.active",
82 "active": true,
83 "caption": "Active"
84 },
85 "name": "Machinery and Equipment",
86 "assetClassType": "PROPERTY",
87 "infiniteUsefulLife": false
88 }
89 ],
90 "businessAreaFilterType": "ALL",
91 "businessAreas": [
92 {
93 "id": 3001,
94 "displayId": "BA-2025-001",
95 "status": {
96 "name": "ACTIVE",
97 "captionKey": "enum.objectStatus.active",
98 "active": true,
99 "caption": "Active"
100 },
101 "name": "North America Operations"
102 }
103 ],
104 "vendorFilterType": "ALL",
105 "vendors": [
106 {
107 "id": 10000012,
108 "displayId": "0000100003",
109 "status": {
110 "name": "ACTIVE",
111 "captionKey": "enum.objectStatus.active",
112 "active": true,
113 "caption": "Active"
114 },
115 "name": "TEST VENDOR GB",
116 "erpSystemDisplayId": "FINQ8S-300"
117 }
118 ]
119 },
120 "filter": {
121 "id": 0,
122 "name": "string",
123 "principalPositionType": "LESSEE",
124 "calendarType": "REGULAR_CALENDAR",
125 "fiscalYearVariant": {
126 "id": "string",
127 "displayId": "Euro"
128 },
129 "profileId": 0,
130 "jobId": 0,
131 "filterTypes": {
132 "erpSystemFilterType": "ALL",
133 "erpSystems": [
134 {
135 "id": 0,
136 "displayId": "string",
137 "status": "CREATED",
138 "name": "string",
139 "type": "NAKISA",
140 "sapVersion": "ECC_EHP5"
141 }
142 ],
143 "leaseAreaFilterType": "ALL",
144 "leaseAreas": [
145 {
146 "id": 10000001,
147 "displayId": "0001",
148 "status": {
149 "name": "ACTIVE",
150 "captionKey": "enum.objectStatus.active",
151 "active": true,
152 "caption": "Active"
153 },
154 "name": "Global Lease Area"
155 }
156 ],
157 "businessUnitFilterType": "ALL",
158 "businessUnits": [
159 {
160 "id": 10000001,
161 "displayId": "BU0001",
162 "status": {
163 "name": "ACTIVE",
164 "captionKey": "enum.objectStatus.active",
165 "active": true,
166 "caption": "Active"
167 },
168 "name": "North America Business Unit"
169 }
170 ],
171 "companyFilterType": "ALL",
172 "companies": [
173 {
174 "id": 10000006,
175 "displayId": "1005",
176 "status": {
177 "name": "ACTIVE",
178 "captionKey": "enum.objectStatus.active",
179 "active": true,
180 "caption": "Active"
181 },
182 "erpSystemId": 10000001,
183 "erpSystemDisplayId": "FINQ8S-300",
184 "countryId": 10000095,
185 "countryDisplayId": "CA",
186 "postingPeriodVariantId": 0,
187 "fiscalVariantId": 0
188 }
189 ],
190 "leaseDepartmentFilterType": "ALL",
191 "leaseDepartments": [
192 {
193 "id": 300001,
194 "displayId": "DEP-01",
195 "status": {
196 "name": "ACTIVE",
197 "captionKey": "enum.objectStatus.active",
198 "active": true,
199 "caption": "Active"
200 },
201 "name": "Finance Department"
202 }
203 ],
204 "leaseGroupFilterType": "ALL",
205 "leaseGroups": [
206 {
207 "id": 60000001,
208 "displayId": "LG-001",
209 "status": {
210 "name": "ACTIVE",
211 "captionKey": "enum.objectStatus.active",
212 "active": true,
213 "caption": "Active"
214 },
215 "name": "Global Lease Group"
216 }
217 ],
218 "costCenterFilterType": "ALL",
219 "costCenters": [
220 {
221 "id": 14001,
222 "displayId": "CC-001",
223 "status": {
224 "name": "ACTIVE",
225 "captionKey": "enum.objectStatus.active",
226 "active": true,
227 "caption": "Active"
228 },
229 "name": "Cost Center A"
230 }
231 ],
232 "profitCenterFilterType": "ALL",
233 "profitCenters": [
234 {
235 "id": 9001,
236 "displayId": "PC-001",
237 "status": {
238 "name": "ACTIVE",
239 "captionKey": "enum.objectStatus.active",
240 "active": true,
241 "caption": "Active"
242 },
243 "name": "North Region Profit Center",
244 "validTo": "2025-12-31",
245 "erpSystemId": 101,
246 "erpSystemDisplayId": "SAP-01"
247 }
248 ],
249 "wbsFilterType": "ALL",
250 "wbses": [
251 {
252 "id": 1001,
253 "displayId": "WBS-2025-001",
254 "status": {
255 "name": "ACTIVE",
256 "captionKey": "enum.objectStatus.active",
257 "active": true,
258 "caption": "Active"
259 },
260 "name": "Main Project WBS"
261 }
262 ],
263 "businessAreaFilterType": "ALL",
264 "businessAreas": [
265 {
266 "id": 3001,
267 "displayId": "BA-2025-001",
268 "status": {
269 "name": "ACTIVE",
270 "captionKey": "enum.objectStatus.active",
271 "active": true,
272 "caption": "Active"
273 },
274 "name": "North America Operations"
275 }
276 ],
277 "functionalAreaFilterType": "ALL",
278 "functionalAreas": [
279 {
280 "id": 2001,
281 "displayId": "FA-2025-001",
282 "status": {
283 "name": "ACTIVE",
284 "captionKey": "enum.objectStatus.active",
285 "active": true,
286 "caption": "Active"
287 },
288 "name": "Accounting Department"
289 }
290 ]
291 },
292 "baseIdList": [
293 {
294 "id": 0,
295 "displayId": "string",
296 "objectType": "LEASE_AREA"
297 }
298 ]
299 },
300 "tasks": [
301 {
302 "id": 0,
303 "queueTime": "2019-08-24T14:15:22Z",
304 "startTime": "2019-08-24T14:15:22Z",
305 "endTime": "2019-08-24T14:15:22Z",
306 "interruptedAt": "2019-08-24T14:15:22Z",
307 "recoveredAt": "2019-08-24T14:15:22Z",
308 "status": "CREATED",
309 "recover": true,
310 "interrupted": true,
311 "interruptionMessage": "string",
312 "errorMessage": "string",
313 "disclosureReportType": "NET_LEASE_INVESTMENT_REPORT",
314 "fileStorageId": "string",
315 "jsonFileStorageId": "string",
316 "generatingExportFile": true,
317 "startedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
318 "finishedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
319 "reportJobId": 0,
320 "version": 0,
321 "jsonDocStoreIds": [
322 0
323 ],
324 "docStoreId": 0
325 }
326 ]
327 }
328}
Bulk Update¶
HTTP Request
PUT /api/v1/disclosure_reports/jobs/bulk
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
none |
Body Parameters
1[
2 {
3 "id": 0,
4 "taskCount": 0,
5 "failedTaskCount": 0,
6 "doneTaskCount": 0,
7 "inProgressTaskCount": 0,
8 "cancelledTaskCount": 0,
9 "errorMessage": "string",
10 "executor": "SCHEDULER",
11 "scheduleJobId": 0,
12 "batchSize": 1000,
13 "totalObjectCount": 0,
14 "profileId": 0,
15 "readOnly": true,
16 "input": {
17 "id": 0,
18 "accountingStandardType": "GAAP",
19 "classifications": [
20 "NON_LEASE"
21 ],
22 "fromYear": 0,
23 "fromPeriod": {
24 "id": 0,
25 "displayId": "string",
26 "status": "CREATED",
27 "day": 0,
28 "year": 0,
29 "month": 0,
30 "postingPeriod": 0,
31 "yearShift": 0
32 },
33 "toYear": 0,
34 "toPeriod": {
35 "id": 0,
36 "displayId": "string",
37 "status": "CREATED",
38 "day": 0,
39 "year": 0,
40 "month": 0,
41 "postingPeriod": 0,
42 "yearShift": 0
43 },
44 "fromDate": "2019-08-24",
45 "toDate": "2019-08-24",
46 "currencyDisplayId": "string",
47 "currencyType": "string",
48 "currencyDefinitionType": "CONTRACT_CURRENCY",
49 "activationGroupStatus": "AG_PENDING_ASSESSMENT",
50 "reportList": [
51 "NET_LEASE_INVESTMENT_REPORT"
52 ],
53 "listObjectType": "CONTRACT",
54 "objectList": [
55 {
56 "id": 0,
57 "displayId": "string",
58 "name": "string"
59 }
60 ],
61 "migratedFilterType": "MIGRATED",
62 "assetClassFilterType": "ALL",
63 "assetClasses": [
64 {
65 "id": 10000001,
66 "displayId": "IAC-001",
67 "status": {
68 "name": "ACTIVE",
69 "captionKey": "enum.objectStatus.active",
70 "active": true,
71 "caption": "Active"
72 },
73 "name": "Machinery and Equipment",
74 "assetClassType": "PROPERTY",
75 "infiniteUsefulLife": false
76 }
77 ],
78 "businessAreaFilterType": "ALL",
79 "businessAreas": [
80 {
81 "id": 3001,
82 "displayId": "BA-2025-001",
83 "status": {
84 "name": "ACTIVE",
85 "captionKey": "enum.objectStatus.active",
86 "active": true,
87 "caption": "Active"
88 },
89 "name": "North America Operations"
90 }
91 ],
92 "vendorFilterType": "ALL",
93 "vendors": [
94 {
95 "id": 10000012,
96 "displayId": "0000100003",
97 "status": {
98 "name": "ACTIVE",
99 "captionKey": "enum.objectStatus.active",
100 "active": true,
101 "caption": "Active"
102 },
103 "name": "TEST VENDOR GB",
104 "erpSystemDisplayId": "FINQ8S-300"
105 }
106 ]
107 },
108 "filter": {
109 "id": 0,
110 "name": "string",
111 "principalPositionType": "LESSEE",
112 "calendarType": "REGULAR_CALENDAR",
113 "fiscalYearVariant": {
114 "id": "string",
115 "displayId": "Euro"
116 },
117 "profileId": 0,
118 "jobId": 0,
119 "filterTypes": {
120 "erpSystemFilterType": "ALL",
121 "erpSystems": [
122 {
123 "id": 0,
124 "displayId": "string",
125 "status": "CREATED",
126 "name": "string",
127 "type": "NAKISA",
128 "sapVersion": "ECC_EHP5"
129 }
130 ],
131 "leaseAreaFilterType": "ALL",
132 "leaseAreas": [
133 {
134 "id": 10000001,
135 "displayId": "0001",
136 "status": {
137 "name": "ACTIVE",
138 "captionKey": "enum.objectStatus.active",
139 "active": true,
140 "caption": "Active"
141 },
142 "name": "Global Lease Area"
143 }
144 ],
145 "businessUnitFilterType": "ALL",
146 "businessUnits": [
147 {
148 "id": 10000001,
149 "displayId": "BU0001",
150 "status": {
151 "name": "ACTIVE",
152 "captionKey": "enum.objectStatus.active",
153 "active": true,
154 "caption": "Active"
155 },
156 "name": "North America Business Unit"
157 }
158 ],
159 "companyFilterType": "ALL",
160 "companies": [
161 {
162 "id": 10000006,
163 "displayId": "1005",
164 "status": {
165 "name": "ACTIVE",
166 "captionKey": "enum.objectStatus.active",
167 "active": true,
168 "caption": "Active"
169 },
170 "erpSystemId": 10000001,
171 "erpSystemDisplayId": "FINQ8S-300",
172 "countryId": 10000095,
173 "countryDisplayId": "CA",
174 "postingPeriodVariantId": 0,
175 "fiscalVariantId": 0
176 }
177 ],
178 "leaseDepartmentFilterType": "ALL",
179 "leaseDepartments": [
180 {
181 "id": 300001,
182 "displayId": "DEP-01",
183 "status": {
184 "name": "ACTIVE",
185 "captionKey": "enum.objectStatus.active",
186 "active": true,
187 "caption": "Active"
188 },
189 "name": "Finance Department"
190 }
191 ],
192 "leaseGroupFilterType": "ALL",
193 "leaseGroups": [
194 {
195 "id": 60000001,
196 "displayId": "LG-001",
197 "status": {
198 "name": "ACTIVE",
199 "captionKey": "enum.objectStatus.active",
200 "active": true,
201 "caption": "Active"
202 },
203 "name": "Global Lease Group"
204 }
205 ],
206 "costCenterFilterType": "ALL",
207 "costCenters": [
208 {
209 "id": 14001,
210 "displayId": "CC-001",
211 "status": {
212 "name": "ACTIVE",
213 "captionKey": "enum.objectStatus.active",
214 "active": true,
215 "caption": "Active"
216 },
217 "name": "Cost Center A"
218 }
219 ],
220 "profitCenterFilterType": "ALL",
221 "profitCenters": [
222 {
223 "id": 9001,
224 "displayId": "PC-001",
225 "status": {
226 "name": "ACTIVE",
227 "captionKey": "enum.objectStatus.active",
228 "active": true,
229 "caption": "Active"
230 },
231 "name": "North Region Profit Center",
232 "validTo": "2025-12-31",
233 "erpSystemId": 101,
234 "erpSystemDisplayId": "SAP-01"
235 }
236 ],
237 "wbsFilterType": "ALL",
238 "wbses": [
239 {
240 "id": 1001,
241 "displayId": "WBS-2025-001",
242 "status": {
243 "name": "ACTIVE",
244 "captionKey": "enum.objectStatus.active",
245 "active": true,
246 "caption": "Active"
247 },
248 "name": "Main Project WBS"
249 }
250 ],
251 "businessAreaFilterType": "ALL",
252 "businessAreas": [
253 {
254 "id": 3001,
255 "displayId": "BA-2025-001",
256 "status": {
257 "name": "ACTIVE",
258 "captionKey": "enum.objectStatus.active",
259 "active": true,
260 "caption": "Active"
261 },
262 "name": "North America Operations"
263 }
264 ],
265 "functionalAreaFilterType": "ALL",
266 "functionalAreas": [
267 {
268 "id": 2001,
269 "displayId": "FA-2025-001",
270 "status": {
271 "name": "ACTIVE",
272 "captionKey": "enum.objectStatus.active",
273 "active": true,
274 "caption": "Active"
275 },
276 "name": "Accounting Department"
277 }
278 ]
279 },
280 "baseIdList": [
281 {
282 "id": 0,
283 "displayId": "string",
284 "objectType": "LEASE_AREA"
285 }
286 ]
287 },
288 "tasks": [
289 {
290 "id": 0,
291 "queueTime": "2019-08-24T14:15:22Z",
292 "startTime": "2019-08-24T14:15:22Z",
293 "endTime": "2019-08-24T14:15:22Z",
294 "interruptedAt": "2019-08-24T14:15:22Z",
295 "recoveredAt": "2019-08-24T14:15:22Z",
296 "status": "CREATED",
297 "recover": true,
298 "interrupted": true,
299 "interruptionMessage": "string",
300 "errorMessage": "string",
301 "disclosureReportType": "NET_LEASE_INVESTMENT_REPORT",
302 "fileStorageId": "string",
303 "jsonFileStorageId": "string",
304 "generatingExportFile": true,
305 "startedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
306 "finishedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
307 "reportJobId": 0,
308 "version": 0,
309 "jsonDocStoreIds": [
310 0
311 ],
312 "docStoreId": 0
313 }
314 ]
315 }
316]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "source": {},
8 "field": "string",
9 "errorKey": "string",
10 "errorMessage": "string"
11 }
12 ]
13 },
14 "object": [
15 {
16 "id": 0,
17 "taskCount": 0,
18 "failedTaskCount": 0,
19 "doneTaskCount": 0,
20 "inProgressTaskCount": 0,
21 "cancelledTaskCount": 0,
22 "errorMessage": "string",
23 "executor": "SCHEDULER",
24 "scheduleJobId": 0,
25 "batchSize": 1000,
26 "totalObjectCount": 0,
27 "profileId": 0,
28 "readOnly": true,
29 "input": {
30 "id": 0,
31 "accountingStandardType": "GAAP",
32 "classifications": [
33 "NON_LEASE"
34 ],
35 "fromYear": 0,
36 "fromPeriod": {
37 "id": 0,
38 "displayId": "string",
39 "status": "CREATED",
40 "day": 0,
41 "year": 0,
42 "month": 0,
43 "postingPeriod": 0,
44 "yearShift": 0
45 },
46 "toYear": 0,
47 "toPeriod": {
48 "id": 0,
49 "displayId": "string",
50 "status": "CREATED",
51 "day": 0,
52 "year": 0,
53 "month": 0,
54 "postingPeriod": 0,
55 "yearShift": 0
56 },
57 "fromDate": "2019-08-24",
58 "toDate": "2019-08-24",
59 "currencyDisplayId": "string",
60 "currencyType": "string",
61 "currencyDefinitionType": "CONTRACT_CURRENCY",
62 "activationGroupStatus": "AG_PENDING_ASSESSMENT",
63 "reportList": [
64 "NET_LEASE_INVESTMENT_REPORT"
65 ],
66 "listObjectType": "CONTRACT",
67 "objectList": [
68 {
69 "id": 0,
70 "displayId": "string",
71 "name": "string"
72 }
73 ],
74 "migratedFilterType": "MIGRATED",
75 "assetClassFilterType": "ALL",
76 "assetClasses": [
77 {
78 "id": 10000001,
79 "displayId": "IAC-001",
80 "status": {
81 "name": "ACTIVE",
82 "captionKey": "enum.objectStatus.active",
83 "active": true,
84 "caption": "Active"
85 },
86 "name": "Machinery and Equipment",
87 "assetClassType": "PROPERTY",
88 "infiniteUsefulLife": false
89 }
90 ],
91 "businessAreaFilterType": "ALL",
92 "businessAreas": [
93 {
94 "id": 3001,
95 "displayId": "BA-2025-001",
96 "status": {
97 "name": "ACTIVE",
98 "captionKey": "enum.objectStatus.active",
99 "active": true,
100 "caption": "Active"
101 },
102 "name": "North America Operations"
103 }
104 ],
105 "vendorFilterType": "ALL",
106 "vendors": [
107 {
108 "id": 10000012,
109 "displayId": "0000100003",
110 "status": {
111 "name": "ACTIVE",
112 "captionKey": "enum.objectStatus.active",
113 "active": true,
114 "caption": "Active"
115 },
116 "name": "TEST VENDOR GB",
117 "erpSystemDisplayId": "FINQ8S-300"
118 }
119 ]
120 },
121 "filter": {
122 "id": 0,
123 "name": "string",
124 "principalPositionType": "LESSEE",
125 "calendarType": "REGULAR_CALENDAR",
126 "fiscalYearVariant": {
127 "id": "string",
128 "displayId": "Euro"
129 },
130 "profileId": 0,
131 "jobId": 0,
132 "filterTypes": {
133 "erpSystemFilterType": "ALL",
134 "erpSystems": [
135 {
136 "id": 0,
137 "displayId": "string",
138 "status": "CREATED",
139 "name": "string",
140 "type": "NAKISA",
141 "sapVersion": "ECC_EHP5"
142 }
143 ],
144 "leaseAreaFilterType": "ALL",
145 "leaseAreas": [
146 {
147 "id": 10000001,
148 "displayId": "0001",
149 "status": {
150 "name": "ACTIVE",
151 "captionKey": "enum.objectStatus.active",
152 "active": true,
153 "caption": "Active"
154 },
155 "name": "Global Lease Area"
156 }
157 ],
158 "businessUnitFilterType": "ALL",
159 "businessUnits": [
160 {
161 "id": 10000001,
162 "displayId": "BU0001",
163 "status": {
164 "name": "ACTIVE",
165 "captionKey": "enum.objectStatus.active",
166 "active": true,
167 "caption": "Active"
168 },
169 "name": "North America Business Unit"
170 }
171 ],
172 "companyFilterType": "ALL",
173 "companies": [
174 {
175 "id": 10000006,
176 "displayId": "1005",
177 "status": {
178 "name": "ACTIVE",
179 "captionKey": "enum.objectStatus.active",
180 "active": true,
181 "caption": "Active"
182 },
183 "erpSystemId": 10000001,
184 "erpSystemDisplayId": "FINQ8S-300",
185 "countryId": 10000095,
186 "countryDisplayId": "CA",
187 "postingPeriodVariantId": 0,
188 "fiscalVariantId": 0
189 }
190 ],
191 "leaseDepartmentFilterType": "ALL",
192 "leaseDepartments": [
193 {
194 "id": 300001,
195 "displayId": "DEP-01",
196 "status": {
197 "name": "ACTIVE",
198 "captionKey": "enum.objectStatus.active",
199 "active": true,
200 "caption": "Active"
201 },
202 "name": "Finance Department"
203 }
204 ],
205 "leaseGroupFilterType": "ALL",
206 "leaseGroups": [
207 {
208 "id": 60000001,
209 "displayId": "LG-001",
210 "status": {
211 "name": "ACTIVE",
212 "captionKey": "enum.objectStatus.active",
213 "active": true,
214 "caption": "Active"
215 },
216 "name": "Global Lease Group"
217 }
218 ],
219 "costCenterFilterType": "ALL",
220 "costCenters": [
221 {
222 "id": 14001,
223 "displayId": "CC-001",
224 "status": {
225 "name": "ACTIVE",
226 "captionKey": "enum.objectStatus.active",
227 "active": true,
228 "caption": "Active"
229 },
230 "name": "Cost Center A"
231 }
232 ],
233 "profitCenterFilterType": "ALL",
234 "profitCenters": [
235 {
236 "id": 9001,
237 "displayId": "PC-001",
238 "status": {
239 "name": "ACTIVE",
240 "captionKey": "enum.objectStatus.active",
241 "active": true,
242 "caption": "Active"
243 },
244 "name": "North Region Profit Center",
245 "validTo": "2025-12-31",
246 "erpSystemId": 101,
247 "erpSystemDisplayId": "SAP-01"
248 }
249 ],
250 "wbsFilterType": "ALL",
251 "wbses": [
252 {
253 "id": 1001,
254 "displayId": "WBS-2025-001",
255 "status": {
256 "name": "ACTIVE",
257 "captionKey": "enum.objectStatus.active",
258 "active": true,
259 "caption": "Active"
260 },
261 "name": "Main Project WBS"
262 }
263 ],
264 "businessAreaFilterType": "ALL",
265 "businessAreas": [
266 {
267 "id": 3001,
268 "displayId": "BA-2025-001",
269 "status": {
270 "name": "ACTIVE",
271 "captionKey": "enum.objectStatus.active",
272 "active": true,
273 "caption": "Active"
274 },
275 "name": "North America Operations"
276 }
277 ],
278 "functionalAreaFilterType": "ALL",
279 "functionalAreas": [
280 {
281 "id": 2001,
282 "displayId": "FA-2025-001",
283 "status": {
284 "name": "ACTIVE",
285 "captionKey": "enum.objectStatus.active",
286 "active": true,
287 "caption": "Active"
288 },
289 "name": "Accounting Department"
290 }
291 ]
292 },
293 "baseIdList": [
294 {
295 "id": 0,
296 "displayId": "string",
297 "objectType": "LEASE_AREA"
298 }
299 ]
300 },
301 "tasks": [
302 {
303 "id": 0,
304 "queueTime": "2019-08-24T14:15:22Z",
305 "startTime": "2019-08-24T14:15:22Z",
306 "endTime": "2019-08-24T14:15:22Z",
307 "interruptedAt": "2019-08-24T14:15:22Z",
308 "recoveredAt": "2019-08-24T14:15:22Z",
309 "status": "CREATED",
310 "recover": true,
311 "interrupted": true,
312 "interruptionMessage": "string",
313 "errorMessage": "string",
314 "disclosureReportType": "NET_LEASE_INVESTMENT_REPORT",
315 "fileStorageId": "string",
316 "jsonFileStorageId": "string",
317 "generatingExportFile": true,
318 "startedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
319 "finishedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
320 "reportJobId": 0,
321 "version": 0,
322 "jsonDocStoreIds": [
323 0
324 ],
325 "docStoreId": 0
326 }
327 ]
328 }
329 ]
330}
Bulk Create¶
HTTP Request
POST /api/v1/disclosure_reports/jobs/bulk
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
none |
Body Parameters
1[
2 {
3 "id": 0,
4 "taskCount": 0,
5 "failedTaskCount": 0,
6 "doneTaskCount": 0,
7 "inProgressTaskCount": 0,
8 "cancelledTaskCount": 0,
9 "errorMessage": "string",
10 "executor": "SCHEDULER",
11 "scheduleJobId": 0,
12 "batchSize": 1000,
13 "totalObjectCount": 0,
14 "profileId": 0,
15 "readOnly": true,
16 "input": {
17 "id": 0,
18 "accountingStandardType": "GAAP",
19 "classifications": [
20 "NON_LEASE"
21 ],
22 "fromYear": 0,
23 "fromPeriod": {
24 "id": 0,
25 "displayId": "string",
26 "status": "CREATED",
27 "day": 0,
28 "year": 0,
29 "month": 0,
30 "postingPeriod": 0,
31 "yearShift": 0
32 },
33 "toYear": 0,
34 "toPeriod": {
35 "id": 0,
36 "displayId": "string",
37 "status": "CREATED",
38 "day": 0,
39 "year": 0,
40 "month": 0,
41 "postingPeriod": 0,
42 "yearShift": 0
43 },
44 "fromDate": "2019-08-24",
45 "toDate": "2019-08-24",
46 "currencyDisplayId": "string",
47 "currencyType": "string",
48 "currencyDefinitionType": "CONTRACT_CURRENCY",
49 "activationGroupStatus": "AG_PENDING_ASSESSMENT",
50 "reportList": [
51 "NET_LEASE_INVESTMENT_REPORT"
52 ],
53 "listObjectType": "CONTRACT",
54 "objectList": [
55 {
56 "id": 0,
57 "displayId": "string",
58 "name": "string"
59 }
60 ],
61 "migratedFilterType": "MIGRATED",
62 "assetClassFilterType": "ALL",
63 "assetClasses": [
64 {
65 "id": 10000001,
66 "displayId": "IAC-001",
67 "status": {
68 "name": "ACTIVE",
69 "captionKey": "enum.objectStatus.active",
70 "active": true,
71 "caption": "Active"
72 },
73 "name": "Machinery and Equipment",
74 "assetClassType": "PROPERTY",
75 "infiniteUsefulLife": false
76 }
77 ],
78 "businessAreaFilterType": "ALL",
79 "businessAreas": [
80 {
81 "id": 3001,
82 "displayId": "BA-2025-001",
83 "status": {
84 "name": "ACTIVE",
85 "captionKey": "enum.objectStatus.active",
86 "active": true,
87 "caption": "Active"
88 },
89 "name": "North America Operations"
90 }
91 ],
92 "vendorFilterType": "ALL",
93 "vendors": [
94 {
95 "id": 10000012,
96 "displayId": "0000100003",
97 "status": {
98 "name": "ACTIVE",
99 "captionKey": "enum.objectStatus.active",
100 "active": true,
101 "caption": "Active"
102 },
103 "name": "TEST VENDOR GB",
104 "erpSystemDisplayId": "FINQ8S-300"
105 }
106 ]
107 },
108 "filter": {
109 "id": 0,
110 "name": "string",
111 "principalPositionType": "LESSEE",
112 "calendarType": "REGULAR_CALENDAR",
113 "fiscalYearVariant": {
114 "id": "string",
115 "displayId": "Euro"
116 },
117 "profileId": 0,
118 "jobId": 0,
119 "filterTypes": {
120 "erpSystemFilterType": "ALL",
121 "erpSystems": [
122 {
123 "id": 0,
124 "displayId": "string",
125 "status": "CREATED",
126 "name": "string",
127 "type": "NAKISA",
128 "sapVersion": "ECC_EHP5"
129 }
130 ],
131 "leaseAreaFilterType": "ALL",
132 "leaseAreas": [
133 {
134 "id": 10000001,
135 "displayId": "0001",
136 "status": {
137 "name": "ACTIVE",
138 "captionKey": "enum.objectStatus.active",
139 "active": true,
140 "caption": "Active"
141 },
142 "name": "Global Lease Area"
143 }
144 ],
145 "businessUnitFilterType": "ALL",
146 "businessUnits": [
147 {
148 "id": 10000001,
149 "displayId": "BU0001",
150 "status": {
151 "name": "ACTIVE",
152 "captionKey": "enum.objectStatus.active",
153 "active": true,
154 "caption": "Active"
155 },
156 "name": "North America Business Unit"
157 }
158 ],
159 "companyFilterType": "ALL",
160 "companies": [
161 {
162 "id": 10000006,
163 "displayId": "1005",
164 "status": {
165 "name": "ACTIVE",
166 "captionKey": "enum.objectStatus.active",
167 "active": true,
168 "caption": "Active"
169 },
170 "erpSystemId": 10000001,
171 "erpSystemDisplayId": "FINQ8S-300",
172 "countryId": 10000095,
173 "countryDisplayId": "CA",
174 "postingPeriodVariantId": 0,
175 "fiscalVariantId": 0
176 }
177 ],
178 "leaseDepartmentFilterType": "ALL",
179 "leaseDepartments": [
180 {
181 "id": 300001,
182 "displayId": "DEP-01",
183 "status": {
184 "name": "ACTIVE",
185 "captionKey": "enum.objectStatus.active",
186 "active": true,
187 "caption": "Active"
188 },
189 "name": "Finance Department"
190 }
191 ],
192 "leaseGroupFilterType": "ALL",
193 "leaseGroups": [
194 {
195 "id": 60000001,
196 "displayId": "LG-001",
197 "status": {
198 "name": "ACTIVE",
199 "captionKey": "enum.objectStatus.active",
200 "active": true,
201 "caption": "Active"
202 },
203 "name": "Global Lease Group"
204 }
205 ],
206 "costCenterFilterType": "ALL",
207 "costCenters": [
208 {
209 "id": 14001,
210 "displayId": "CC-001",
211 "status": {
212 "name": "ACTIVE",
213 "captionKey": "enum.objectStatus.active",
214 "active": true,
215 "caption": "Active"
216 },
217 "name": "Cost Center A"
218 }
219 ],
220 "profitCenterFilterType": "ALL",
221 "profitCenters": [
222 {
223 "id": 9001,
224 "displayId": "PC-001",
225 "status": {
226 "name": "ACTIVE",
227 "captionKey": "enum.objectStatus.active",
228 "active": true,
229 "caption": "Active"
230 },
231 "name": "North Region Profit Center",
232 "validTo": "2025-12-31",
233 "erpSystemId": 101,
234 "erpSystemDisplayId": "SAP-01"
235 }
236 ],
237 "wbsFilterType": "ALL",
238 "wbses": [
239 {
240 "id": 1001,
241 "displayId": "WBS-2025-001",
242 "status": {
243 "name": "ACTIVE",
244 "captionKey": "enum.objectStatus.active",
245 "active": true,
246 "caption": "Active"
247 },
248 "name": "Main Project WBS"
249 }
250 ],
251 "businessAreaFilterType": "ALL",
252 "businessAreas": [
253 {
254 "id": 3001,
255 "displayId": "BA-2025-001",
256 "status": {
257 "name": "ACTIVE",
258 "captionKey": "enum.objectStatus.active",
259 "active": true,
260 "caption": "Active"
261 },
262 "name": "North America Operations"
263 }
264 ],
265 "functionalAreaFilterType": "ALL",
266 "functionalAreas": [
267 {
268 "id": 2001,
269 "displayId": "FA-2025-001",
270 "status": {
271 "name": "ACTIVE",
272 "captionKey": "enum.objectStatus.active",
273 "active": true,
274 "caption": "Active"
275 },
276 "name": "Accounting Department"
277 }
278 ]
279 },
280 "baseIdList": [
281 {
282 "id": 0,
283 "displayId": "string",
284 "objectType": "LEASE_AREA"
285 }
286 ]
287 },
288 "tasks": [
289 {
290 "id": 0,
291 "queueTime": "2019-08-24T14:15:22Z",
292 "startTime": "2019-08-24T14:15:22Z",
293 "endTime": "2019-08-24T14:15:22Z",
294 "interruptedAt": "2019-08-24T14:15:22Z",
295 "recoveredAt": "2019-08-24T14:15:22Z",
296 "status": "CREATED",
297 "recover": true,
298 "interrupted": true,
299 "interruptionMessage": "string",
300 "errorMessage": "string",
301 "disclosureReportType": "NET_LEASE_INVESTMENT_REPORT",
302 "fileStorageId": "string",
303 "jsonFileStorageId": "string",
304 "generatingExportFile": true,
305 "startedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
306 "finishedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
307 "reportJobId": 0,
308 "version": 0,
309 "jsonDocStoreIds": [
310 0
311 ],
312 "docStoreId": 0
313 }
314 ]
315 }
316]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "source": {},
8 "field": "string",
9 "errorKey": "string",
10 "errorMessage": "string"
11 }
12 ]
13 },
14 "object": [
15 {
16 "id": 0,
17 "taskCount": 0,
18 "failedTaskCount": 0,
19 "doneTaskCount": 0,
20 "inProgressTaskCount": 0,
21 "cancelledTaskCount": 0,
22 "errorMessage": "string",
23 "executor": "SCHEDULER",
24 "scheduleJobId": 0,
25 "batchSize": 1000,
26 "totalObjectCount": 0,
27 "profileId": 0,
28 "readOnly": true,
29 "input": {
30 "id": 0,
31 "accountingStandardType": "GAAP",
32 "classifications": [
33 "NON_LEASE"
34 ],
35 "fromYear": 0,
36 "fromPeriod": {
37 "id": 0,
38 "displayId": "string",
39 "status": "CREATED",
40 "day": 0,
41 "year": 0,
42 "month": 0,
43 "postingPeriod": 0,
44 "yearShift": 0
45 },
46 "toYear": 0,
47 "toPeriod": {
48 "id": 0,
49 "displayId": "string",
50 "status": "CREATED",
51 "day": 0,
52 "year": 0,
53 "month": 0,
54 "postingPeriod": 0,
55 "yearShift": 0
56 },
57 "fromDate": "2019-08-24",
58 "toDate": "2019-08-24",
59 "currencyDisplayId": "string",
60 "currencyType": "string",
61 "currencyDefinitionType": "CONTRACT_CURRENCY",
62 "activationGroupStatus": "AG_PENDING_ASSESSMENT",
63 "reportList": [
64 "NET_LEASE_INVESTMENT_REPORT"
65 ],
66 "listObjectType": "CONTRACT",
67 "objectList": [
68 {
69 "id": 0,
70 "displayId": "string",
71 "name": "string"
72 }
73 ],
74 "migratedFilterType": "MIGRATED",
75 "assetClassFilterType": "ALL",
76 "assetClasses": [
77 {
78 "id": 10000001,
79 "displayId": "IAC-001",
80 "status": {
81 "name": "ACTIVE",
82 "captionKey": "enum.objectStatus.active",
83 "active": true,
84 "caption": "Active"
85 },
86 "name": "Machinery and Equipment",
87 "assetClassType": "PROPERTY",
88 "infiniteUsefulLife": false
89 }
90 ],
91 "businessAreaFilterType": "ALL",
92 "businessAreas": [
93 {
94 "id": 3001,
95 "displayId": "BA-2025-001",
96 "status": {
97 "name": "ACTIVE",
98 "captionKey": "enum.objectStatus.active",
99 "active": true,
100 "caption": "Active"
101 },
102 "name": "North America Operations"
103 }
104 ],
105 "vendorFilterType": "ALL",
106 "vendors": [
107 {
108 "id": 10000012,
109 "displayId": "0000100003",
110 "status": {
111 "name": "ACTIVE",
112 "captionKey": "enum.objectStatus.active",
113 "active": true,
114 "caption": "Active"
115 },
116 "name": "TEST VENDOR GB",
117 "erpSystemDisplayId": "FINQ8S-300"
118 }
119 ]
120 },
121 "filter": {
122 "id": 0,
123 "name": "string",
124 "principalPositionType": "LESSEE",
125 "calendarType": "REGULAR_CALENDAR",
126 "fiscalYearVariant": {
127 "id": "string",
128 "displayId": "Euro"
129 },
130 "profileId": 0,
131 "jobId": 0,
132 "filterTypes": {
133 "erpSystemFilterType": "ALL",
134 "erpSystems": [
135 {
136 "id": 0,
137 "displayId": "string",
138 "status": "CREATED",
139 "name": "string",
140 "type": "NAKISA",
141 "sapVersion": "ECC_EHP5"
142 }
143 ],
144 "leaseAreaFilterType": "ALL",
145 "leaseAreas": [
146 {
147 "id": 10000001,
148 "displayId": "0001",
149 "status": {
150 "name": "ACTIVE",
151 "captionKey": "enum.objectStatus.active",
152 "active": true,
153 "caption": "Active"
154 },
155 "name": "Global Lease Area"
156 }
157 ],
158 "businessUnitFilterType": "ALL",
159 "businessUnits": [
160 {
161 "id": 10000001,
162 "displayId": "BU0001",
163 "status": {
164 "name": "ACTIVE",
165 "captionKey": "enum.objectStatus.active",
166 "active": true,
167 "caption": "Active"
168 },
169 "name": "North America Business Unit"
170 }
171 ],
172 "companyFilterType": "ALL",
173 "companies": [
174 {
175 "id": 10000006,
176 "displayId": "1005",
177 "status": {
178 "name": "ACTIVE",
179 "captionKey": "enum.objectStatus.active",
180 "active": true,
181 "caption": "Active"
182 },
183 "erpSystemId": 10000001,
184 "erpSystemDisplayId": "FINQ8S-300",
185 "countryId": 10000095,
186 "countryDisplayId": "CA",
187 "postingPeriodVariantId": 0,
188 "fiscalVariantId": 0
189 }
190 ],
191 "leaseDepartmentFilterType": "ALL",
192 "leaseDepartments": [
193 {
194 "id": 300001,
195 "displayId": "DEP-01",
196 "status": {
197 "name": "ACTIVE",
198 "captionKey": "enum.objectStatus.active",
199 "active": true,
200 "caption": "Active"
201 },
202 "name": "Finance Department"
203 }
204 ],
205 "leaseGroupFilterType": "ALL",
206 "leaseGroups": [
207 {
208 "id": 60000001,
209 "displayId": "LG-001",
210 "status": {
211 "name": "ACTIVE",
212 "captionKey": "enum.objectStatus.active",
213 "active": true,
214 "caption": "Active"
215 },
216 "name": "Global Lease Group"
217 }
218 ],
219 "costCenterFilterType": "ALL",
220 "costCenters": [
221 {
222 "id": 14001,
223 "displayId": "CC-001",
224 "status": {
225 "name": "ACTIVE",
226 "captionKey": "enum.objectStatus.active",
227 "active": true,
228 "caption": "Active"
229 },
230 "name": "Cost Center A"
231 }
232 ],
233 "profitCenterFilterType": "ALL",
234 "profitCenters": [
235 {
236 "id": 9001,
237 "displayId": "PC-001",
238 "status": {
239 "name": "ACTIVE",
240 "captionKey": "enum.objectStatus.active",
241 "active": true,
242 "caption": "Active"
243 },
244 "name": "North Region Profit Center",
245 "validTo": "2025-12-31",
246 "erpSystemId": 101,
247 "erpSystemDisplayId": "SAP-01"
248 }
249 ],
250 "wbsFilterType": "ALL",
251 "wbses": [
252 {
253 "id": 1001,
254 "displayId": "WBS-2025-001",
255 "status": {
256 "name": "ACTIVE",
257 "captionKey": "enum.objectStatus.active",
258 "active": true,
259 "caption": "Active"
260 },
261 "name": "Main Project WBS"
262 }
263 ],
264 "businessAreaFilterType": "ALL",
265 "businessAreas": [
266 {
267 "id": 3001,
268 "displayId": "BA-2025-001",
269 "status": {
270 "name": "ACTIVE",
271 "captionKey": "enum.objectStatus.active",
272 "active": true,
273 "caption": "Active"
274 },
275 "name": "North America Operations"
276 }
277 ],
278 "functionalAreaFilterType": "ALL",
279 "functionalAreas": [
280 {
281 "id": 2001,
282 "displayId": "FA-2025-001",
283 "status": {
284 "name": "ACTIVE",
285 "captionKey": "enum.objectStatus.active",
286 "active": true,
287 "caption": "Active"
288 },
289 "name": "Accounting Department"
290 }
291 ]
292 },
293 "baseIdList": [
294 {
295 "id": 0,
296 "displayId": "string",
297 "objectType": "LEASE_AREA"
298 }
299 ]
300 },
301 "tasks": [
302 {
303 "id": 0,
304 "queueTime": "2019-08-24T14:15:22Z",
305 "startTime": "2019-08-24T14:15:22Z",
306 "endTime": "2019-08-24T14:15:22Z",
307 "interruptedAt": "2019-08-24T14:15:22Z",
308 "recoveredAt": "2019-08-24T14:15:22Z",
309 "status": "CREATED",
310 "recover": true,
311 "interrupted": true,
312 "interruptionMessage": "string",
313 "errorMessage": "string",
314 "disclosureReportType": "NET_LEASE_INVESTMENT_REPORT",
315 "fileStorageId": "string",
316 "jsonFileStorageId": "string",
317 "generatingExportFile": true,
318 "startedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
319 "finishedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
320 "reportJobId": 0,
321 "version": 0,
322 "jsonDocStoreIds": [
323 0
324 ],
325 "docStoreId": 0
326 }
327 ]
328 }
329 ]
330}
Search¶
HTTP Request
POST /api/v1/disclosure_reports/jobs/search
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 |
body |
body |
false |
none |
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 "executorEqual": "SCHEDULER",
16 "accountingStandardTypeEqual": "GAAP",
17 "classificationsLike": "string",
18 "fromYearEqual": 0,
19 "toYearEqual": 0,
20 "currencyDisplayIdEqual": "string",
21 "activationGroupStatusEqual": "AG_PENDING_ASSESSMENT",
22 "companyCodesIn": [
23 {
24 "id": "string",
25 "displayId": "Euro"
26 }
27 ],
28 "fromDateGreaterThanOrEqual": "2019-08-24",
29 "fromDateLessThanOrEqual": "2019-08-24",
30 "toDateGreaterThanOrEqual": "2019-08-24",
31 "toDateLessThanOrEqual": "2019-08-24",
32 "toPostingPeriodLike": "string",
33 "fromPostingPeriodLike": "string"
34}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "totalPages": 0,
3 "totalElements": 0,
4 "pageable": {
5 "unpaged": false,
6 "paged": true,
7 "pageSize": 100,
8 "pageNumber": 0,
9 "offset": 0,
10 "sort": {
11 "unsorted": false,
12 "sorted": true,
13 "empty": false
14 }
15 },
16 "numberOfElements": 0,
17 "first": true,
18 "last": true,
19 "size": 0,
20 "content": [
21 {
22 "id": 0,
23 "taskCount": 0,
24 "failedTaskCount": 0,
25 "doneTaskCount": 0,
26 "inProgressTaskCount": 0,
27 "cancelledTaskCount": 0,
28 "errorMessage": "string",
29 "executor": "SCHEDULER",
30 "scheduleJobId": 0,
31 "batchSize": 1000,
32 "totalObjectCount": 0,
33 "profileId": 0,
34 "readOnly": true,
35 "input": {
36 "id": 0,
37 "accountingStandardType": "GAAP",
38 "classifications": [
39 "NON_LEASE"
40 ],
41 "fromYear": 0,
42 "fromPeriod": {
43 "id": 0,
44 "displayId": "string",
45 "status": "CREATED",
46 "day": 0,
47 "year": 0,
48 "month": 0,
49 "postingPeriod": 0,
50 "yearShift": 0
51 },
52 "toYear": 0,
53 "toPeriod": {
54 "id": 0,
55 "displayId": "string",
56 "status": "CREATED",
57 "day": 0,
58 "year": 0,
59 "month": 0,
60 "postingPeriod": 0,
61 "yearShift": 0
62 },
63 "fromDate": "2019-08-24",
64 "toDate": "2019-08-24",
65 "currencyDisplayId": "string",
66 "currencyType": "string",
67 "currencyDefinitionType": "CONTRACT_CURRENCY",
68 "activationGroupStatus": "AG_PENDING_ASSESSMENT",
69 "reportList": [
70 "NET_LEASE_INVESTMENT_REPORT"
71 ],
72 "listObjectType": "CONTRACT",
73 "objectList": [
74 {
75 "id": 0,
76 "displayId": "string",
77 "name": "string"
78 }
79 ],
80 "migratedFilterType": "MIGRATED",
81 "assetClassFilterType": "ALL",
82 "assetClasses": [
83 {
84 "id": 10000001,
85 "displayId": "IAC-001",
86 "status": {
87 "name": "ACTIVE",
88 "captionKey": "enum.objectStatus.active",
89 "active": true,
90 "caption": "Active"
91 },
92 "name": "Machinery and Equipment",
93 "assetClassType": "PROPERTY",
94 "infiniteUsefulLife": false
95 }
96 ],
97 "businessAreaFilterType": "ALL",
98 "businessAreas": [
99 {
100 "id": 3001,
101 "displayId": "BA-2025-001",
102 "status": {
103 "name": "ACTIVE",
104 "captionKey": "enum.objectStatus.active",
105 "active": true,
106 "caption": "Active"
107 },
108 "name": "North America Operations"
109 }
110 ],
111 "vendorFilterType": "ALL",
112 "vendors": [
113 {
114 "id": 10000012,
115 "displayId": "0000100003",
116 "status": {
117 "name": "ACTIVE",
118 "captionKey": "enum.objectStatus.active",
119 "active": true,
120 "caption": "Active"
121 },
122 "name": "TEST VENDOR GB",
123 "erpSystemDisplayId": "FINQ8S-300"
124 }
125 ]
126 },
127 "filter": {
128 "id": 0,
129 "name": "string",
130 "principalPositionType": "LESSEE",
131 "calendarType": "REGULAR_CALENDAR",
132 "fiscalYearVariant": {
133 "id": "string",
134 "displayId": "Euro"
135 },
136 "profileId": 0,
137 "jobId": 0,
138 "filterTypes": {
139 "erpSystemFilterType": "ALL",
140 "erpSystems": [
141 {
142 "id": 0,
143 "displayId": "string",
144 "status": "CREATED",
145 "name": "string",
146 "type": "NAKISA",
147 "sapVersion": "ECC_EHP5"
148 }
149 ],
150 "leaseAreaFilterType": "ALL",
151 "leaseAreas": [
152 {
153 "id": 10000001,
154 "displayId": "0001",
155 "status": {
156 "name": "ACTIVE",
157 "captionKey": "enum.objectStatus.active",
158 "active": true,
159 "caption": "Active"
160 },
161 "name": "Global Lease Area"
162 }
163 ],
164 "businessUnitFilterType": "ALL",
165 "businessUnits": [
166 {
167 "id": 10000001,
168 "displayId": "BU0001",
169 "status": {
170 "name": "ACTIVE",
171 "captionKey": "enum.objectStatus.active",
172 "active": true,
173 "caption": "Active"
174 },
175 "name": "North America Business Unit"
176 }
177 ],
178 "companyFilterType": "ALL",
179 "companies": [
180 {
181 "id": 10000006,
182 "displayId": "1005",
183 "status": {
184 "name": "ACTIVE",
185 "captionKey": "enum.objectStatus.active",
186 "active": true,
187 "caption": "Active"
188 },
189 "erpSystemId": 10000001,
190 "erpSystemDisplayId": "FINQ8S-300",
191 "countryId": 10000095,
192 "countryDisplayId": "CA",
193 "postingPeriodVariantId": 0,
194 "fiscalVariantId": 0
195 }
196 ],
197 "leaseDepartmentFilterType": "ALL",
198 "leaseDepartments": [
199 {
200 "id": 300001,
201 "displayId": "DEP-01",
202 "status": {
203 "name": "ACTIVE",
204 "captionKey": "enum.objectStatus.active",
205 "active": true,
206 "caption": "Active"
207 },
208 "name": "Finance Department"
209 }
210 ],
211 "leaseGroupFilterType": "ALL",
212 "leaseGroups": [
213 {
214 "id": 60000001,
215 "displayId": "LG-001",
216 "status": {
217 "name": "ACTIVE",
218 "captionKey": "enum.objectStatus.active",
219 "active": true,
220 "caption": "Active"
221 },
222 "name": "Global Lease Group"
223 }
224 ],
225 "costCenterFilterType": "ALL",
226 "costCenters": [
227 {
228 "id": 14001,
229 "displayId": "CC-001",
230 "status": {
231 "name": "ACTIVE",
232 "captionKey": "enum.objectStatus.active",
233 "active": true,
234 "caption": "Active"
235 },
236 "name": "Cost Center A"
237 }
238 ],
239 "profitCenterFilterType": "ALL",
240 "profitCenters": [
241 {
242 "id": 9001,
243 "displayId": "PC-001",
244 "status": {
245 "name": "ACTIVE",
246 "captionKey": "enum.objectStatus.active",
247 "active": true,
248 "caption": "Active"
249 },
250 "name": "North Region Profit Center",
251 "validTo": "2025-12-31",
252 "erpSystemId": 101,
253 "erpSystemDisplayId": "SAP-01"
254 }
255 ],
256 "wbsFilterType": "ALL",
257 "wbses": [
258 {
259 "id": 1001,
260 "displayId": "WBS-2025-001",
261 "status": {
262 "name": "ACTIVE",
263 "captionKey": "enum.objectStatus.active",
264 "active": true,
265 "caption": "Active"
266 },
267 "name": "Main Project WBS"
268 }
269 ],
270 "businessAreaFilterType": "ALL",
271 "businessAreas": [
272 {
273 "id": 3001,
274 "displayId": "BA-2025-001",
275 "status": {
276 "name": "ACTIVE",
277 "captionKey": "enum.objectStatus.active",
278 "active": true,
279 "caption": "Active"
280 },
281 "name": "North America Operations"
282 }
283 ],
284 "functionalAreaFilterType": "ALL",
285 "functionalAreas": [
286 {
287 "id": 2001,
288 "displayId": "FA-2025-001",
289 "status": {
290 "name": "ACTIVE",
291 "captionKey": "enum.objectStatus.active",
292 "active": true,
293 "caption": "Active"
294 },
295 "name": "Accounting Department"
296 }
297 ]
298 },
299 "baseIdList": [
300 {
301 "id": 0,
302 "displayId": "string",
303 "objectType": "LEASE_AREA"
304 }
305 ]
306 },
307 "tasks": [
308 {
309 "id": 0,
310 "queueTime": "2019-08-24T14:15:22Z",
311 "startTime": "2019-08-24T14:15:22Z",
312 "endTime": "2019-08-24T14:15:22Z",
313 "interruptedAt": "2019-08-24T14:15:22Z",
314 "recoveredAt": "2019-08-24T14:15:22Z",
315 "status": "CREATED",
316 "recover": true,
317 "interrupted": true,
318 "interruptionMessage": "string",
319 "errorMessage": "string",
320 "disclosureReportType": "NET_LEASE_INVESTMENT_REPORT",
321 "fileStorageId": "string",
322 "jsonFileStorageId": "string",
323 "generatingExportFile": true,
324 "startedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
325 "finishedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
326 "reportJobId": 0,
327 "version": 0,
328 "jsonDocStoreIds": [
329 0
330 ],
331 "docStoreId": 0
332 }
333 ]
334 }
335 ],
336 "number": 0,
337 "sort": {
338 "unsorted": false,
339 "sorted": true,
340 "empty": false
341 },
342 "empty": true
343}
Get All Disclosure Reports¶
HTTP Request
GET /api/v1/disclosure_reports/jobs/report_types
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 "ASSET_ROLL_FORWARD_REPORT"
3]
Response Schema
Get Eligible Disclosure Reports¶
HTTP Request
POST /api/v1/disclosure_reports/jobs/report_types
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
none |
Body Parameters
1{
2 "id": 0,
3 "accountingStandardType": "GAAP",
4 "classifications": [
5 "NON_LEASE"
6 ],
7 "fromYear": 0,
8 "fromPeriod": {
9 "id": 0,
10 "displayId": "string",
11 "status": "CREATED",
12 "day": 0,
13 "year": 0,
14 "month": 0,
15 "postingPeriod": 0,
16 "yearShift": 0
17 },
18 "toYear": 0,
19 "toPeriod": {
20 "id": 0,
21 "displayId": "string",
22 "status": "CREATED",
23 "day": 0,
24 "year": 0,
25 "month": 0,
26 "postingPeriod": 0,
27 "yearShift": 0
28 },
29 "fromDate": "2019-08-24",
30 "toDate": "2019-08-24",
31 "currencyDisplayId": "string",
32 "currencyType": "string",
33 "currencyDefinitionType": "CONTRACT_CURRENCY",
34 "activationGroupStatus": "AG_PENDING_ASSESSMENT",
35 "reportList": [
36 "NET_LEASE_INVESTMENT_REPORT"
37 ],
38 "listObjectType": "CONTRACT",
39 "objectList": [
40 {
41 "id": 0,
42 "displayId": "string",
43 "name": "string"
44 }
45 ],
46 "migratedFilterType": "MIGRATED",
47 "assetClassFilterType": "ALL",
48 "assetClasses": [
49 {
50 "id": 10000001,
51 "displayId": "IAC-001",
52 "status": {
53 "name": "ACTIVE",
54 "captionKey": "enum.objectStatus.active",
55 "active": true,
56 "caption": "Active"
57 },
58 "name": "Machinery and Equipment",
59 "assetClassType": "PROPERTY",
60 "infiniteUsefulLife": false
61 }
62 ],
63 "businessAreaFilterType": "ALL",
64 "businessAreas": [
65 {
66 "id": 3001,
67 "displayId": "BA-2025-001",
68 "status": {
69 "name": "ACTIVE",
70 "captionKey": "enum.objectStatus.active",
71 "active": true,
72 "caption": "Active"
73 },
74 "name": "North America Operations"
75 }
76 ],
77 "vendorFilterType": "ALL",
78 "vendors": [
79 {
80 "id": 10000012,
81 "displayId": "0000100003",
82 "status": {
83 "name": "ACTIVE",
84 "captionKey": "enum.objectStatus.active",
85 "active": true,
86 "caption": "Active"
87 },
88 "name": "TEST VENDOR GB",
89 "erpSystemDisplayId": "FINQ8S-300"
90 }
91 ]
92}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 "ASSET_ROLL_FORWARD_REPORT"
3]
Response Schema
Search Contracts¶
HTTP Request
POST /api/v1/disclosure_reports/jobs/contracts
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
object |
true |
none |
» request |
body |
false |
none |
|
»» searchTerm |
body |
string |
false |
none |
»» profile |
body |
true |
none |
|
»»» id |
body |
integer(int64) |
false |
none |
»»» name |
body |
string |
false |
none |
»»» principalPositionType |
body |
string |
false |
none |
»»» calendarType |
body |
string |
false |
none |
»»» fiscalYearVariant |
body |
false |
Basic identifier object containing ID and display information. |
|
»»»» id |
body |
string(int64) |
false |
Unique identifier of the entity. |
»»»» displayId |
body |
string |
false |
Display identifier of the entity. |
»»» profileId |
body |
integer(int64) |
false |
none |
»»» jobId |
body |
integer(int64) |
false |
none |
»»» filterTypes |
body |
false |
none |
|
»»»» erpSystemFilterType |
body |
string |
false |
none |
»»»» erpSystems |
body |
false |
none |
|
»»»»» id |
body |
integer(int64) |
false |
none |
»»»»» displayId |
body |
string |
false |
none |
»»»»» status |
body |
string |
false |
none |
»»»»» name |
body |
string |
false |
none |
»»»»» type |
body |
string |
false |
none |
»»»»» sapVersion |
body |
string |
false |
none |
»»»» leaseAreaFilterType |
body |
string |
false |
none |
»»»» leaseAreas |
body |
false |
[Represents a Lease Area entity containing organizational and status information.] |
|
»»»»» id |
body |
integer(int64) |
true |
Unique identifier of the lease area. |
»»»»» displayId |
body |
string |
false |
Display-friendly identifier of the lease area. |
»»»»» status |
body |
false |
Represents the object status with localized captions and activity state. |
|
»»»»»» name |
body |
string |
false |
Enum name representing the object status. |
»»»»»» captionKey |
body |
string |
false |
Localization key for the object status caption. |
»»»»»» active |
body |
boolean |
false |
Indicates whether the status is active. |
»»»»»» caption |
body |
string |
false |
Localized caption of the object status. |
»»»»» name |
body |
string |
false |
Name of the lease area. |
»»»» businessUnitFilterType |
body |
string |
false |
none |
»»»» businessUnits |
body |
false |
[Represents a Business Unit entity containing organizational and status information.] |
|
»»»»» id |
body |
integer(int64) |
true |
Unique identifier of the business unit. |
»»»»» displayId |
body |
string |
false |
Display-friendly identifier of the business unit. |
»»»»» status |
body |
false |
Represents the object status with localized captions and activity state. |
|
»»»»» name |
body |
string |
false |
Name of the business unit. |
»»»» companyFilterType |
body |
string |
false |
none |
»»»» companies |
body |
false |
[Represents a Company entity containing organizational, ERP, and status information.] |
|
»»»»» id |
body |
integer(int64) |
true |
Unique identifier of the company. |
»»»»» displayId |
body |
string |
false |
Display-friendly identifier of the company. |
»»»»» status |
body |
false |
Represents the object status with localized captions and activity state. |
|
»»»»» erpSystemId |
body |
integer(int64) |
false |
Unique identifier of the ERP system associated with the company. |
»»»»» erpSystemDisplayId |
body |
string |
false |
Display-friendly identifier of the ERP system associated with the company. |
»»»»» countryId |
body |
integer(int64) |
false |
Unique identifier of the country associated with the company. |
»»»»» countryDisplayId |
body |
string |
false |
Display-friendly identifier of the country associated with the company. |
»»»»» postingPeriodVariantId |
body |
integer(int64) |
false |
none |
»»»»» fiscalVariantId |
body |
integer(int64) |
false |
none |
»»»» leaseDepartmentFilterType |
body |
string |
false |
none |
»»»» leaseDepartments |
body |
false |
[Represents a Department entity with organizational and status information.] |
|
»»»»» id |
body |
integer(int64) |
true |
Unique identifier of the department. |
»»»»» displayId |
body |
string |
false |
Display-friendly identifier of the department. |
»»»»» status |
body |
false |
Represents the object status with localized captions and activity state. |
|
»»»»» name |
body |
string |
true |
Name of the department. |
»»»» leaseGroupFilterType |
body |
string |
false |
none |
»»»» leaseGroups |
body |
false |
[Represents a Lease Group entity containing organizational and status information.] |
|
»»»»» id |
body |
integer(int64) |
true |
Unique identifier of the lease group. |
»»»»» displayId |
body |
string |
false |
Display-friendly identifier of the lease group. |
»»»»» status |
body |
false |
Represents the object status with localized captions and activity state. |
|
»»»»» name |
body |
string |
false |
Name of the lease group. |
»»»» costCenterFilterType |
body |
string |
false |
none |
»»»» costCenters |
body |
false |
[Represents a simplified Cost Center entity.] |
|
»»»»» id |
body |
integer(int64) |
false |
Unique identifier of the cost center. |
»»»»» displayId |
body |
string |
false |
Display identifier for the cost center. |
»»»»» status |
body |
false |
Represents the object status with localized captions and activity state. |
|
»»»»» name |
body |
string |
false |
Name of the cost center. |
»»»» profitCenterFilterType |
body |
string |
false |
none |
»»»» profitCenters |
body |
false |
[Represents a simplified Profit Center entity.] |
|
»»»»» id |
body |
integer(int64) |
false |
Unique identifier of the profit center. |
»»»»» displayId |
body |
string |
false |
Display identifier for the profit center. |
»»»»» status |
body |
false |
Represents the object status with localized captions and activity state. |
|
»»»»» name |
body |
string |
false |
Name of the profit center. |
»»»»» validTo |
body |
string(date) |
false |
Expiration date for the profit center. |
»»»»» erpSystemId |
body |
integer(int64) |
false |
ERP system identifier associated with the profit center. |
»»»»» erpSystemDisplayId |
body |
string |
false |
ERP system display identifier. |
»»»» wbsFilterType |
body |
string |
false |
none |
»»»» wbses |
body |
false |
[Represents a simplified Work Breakdown Structure (WBS) entity with basic identifiers and status.] |
|
»»»»» id |
body |
integer(int64) |
false |
Unique identifier of the WBS. |
»»»»» displayId |
body |
string |
false |
Display identifier for the WBS. |
»»»»» status |
body |
false |
Represents the object status with localized captions and activity state. |
|
»»»»» name |
body |
string |
false |
Name of the WBS. |
»»»» businessAreaFilterType |
body |
string |
false |
none |
»»»» businessAreas |
body |
false |
[Represents a simplified Business Area entity with basic identifiers and status.] |
|
»»»»» id |
body |
integer(int64) |
false |
Unique identifier of the business area. |
»»»»» displayId |
body |
string |
false |
Display identifier for the business area. |
»»»»» status |
body |
false |
Represents the object status with localized captions and activity state. |
|
»»»»» name |
body |
string |
false |
Name of the business area. |
»»»» functionalAreaFilterType |
body |
string |
false |
none |
»»»» functionalAreas |
body |
false |
[Represents a simplified Functional Area entity with basic identifiers and status.] |
|
»»»»» id |
body |
integer(int64) |
false |
Unique identifier of the functional area. |
»»»»» displayId |
body |
string |
false |
Display identifier for the functional area. |
»»»»» status |
body |
false |
Represents the object status with localized captions and activity state. |
|
»»»»» name |
body |
string |
false |
Name of the functional area. |
»»» baseIdList |
body |
false |
none |
|
»»»» id |
body |
integer(int64) |
false |
none |
»»»» displayId |
body |
string |
false |
none |
»»»» objectType |
body |
string |
true |
none |
»» migratedFilterType |
body |
string |
true |
none |
» pageable |
body |
false |
Represents pagination request parameters including page number, page size, and sorting options. |
|
»» page |
body |
integer(int32) |
true |
The requested page number (0-based). |
»» size |
body |
integer(int32) |
true |
The number of elements to be returned per page. |
»» sort |
body |
[string] |
false |
Sorting criteria in the format: property,(asc |
Example Values¶
Parameter |
Example |
Type |
|---|---|---|
»»»» displayId |
|
body |
»»»»» id |
|
body |
»»»»» displayId |
|
body |
»»»»»» name |
|
body |
»»»»»» captionKey |
|
body |
»»»»»» active |
|
body |
»»»»»» caption |
|
body |
»»»»» name |
|
body |
»»»»» id |
|
body |
»»»»» displayId |
|
body |
»»»»» name |
|
body |
»»»»» id |
|
body |
»»»»» displayId |
|
body |
»»»»» erpSystemId |
|
body |
»»»»» erpSystemDisplayId |
|
body |
»»»»» countryId |
|
body |
»»»»» countryDisplayId |
|
body |
»»»»» id |
|
body |
»»»»» displayId |
|
body |
»»»»» name |
|
body |
»»»»» id |
|
body |
»»»»» displayId |
|
body |
»»»»» name |
|
body |
»»»»» id |
|
body |
»»»»» displayId |
|
body |
»»»»» name |
|
body |
»»»»» id |
|
body |
»»»»» displayId |
|
body |
»»»»» name |
|
body |
»»»»» validTo |
|
body |
»»»»» erpSystemId |
|
body |
»»»»» erpSystemDisplayId |
|
body |
»»»»» id |
|
body |
»»»»» displayId |
|
body |
»»»»» name |
|
body |
»»»»» id |
|
body |
»»»»» displayId |
|
body |
»»»»» name |
|
body |
»»»»» id |
|
body |
»»»»» displayId |
|
body |
»»»»» name |
|
body |
»» page |
|
body |
»» size |
|
body |
»» sort |
|
body |
Enumerated Values
Attribute |
Value |
|---|---|
»» migratedFilterType |
ALL, MIGRATED, NON_MIGRATED |
»»» calendarType |
FISCAL_VARIANT, REGULAR_CALENDAR, _360 |
»»» principalPositionType |
LESSEE, LESSOR |
»»»» businessAreaFilterType |
ALL, LIST |
»»»» businessUnitFilterType |
ALL, LIST |
»»»» companyFilterType |
ALL, LIST |
»»»» costCenterFilterType |
ALL, LIST |
»»»» erpSystemFilterType |
ALL, LIST |
»»»» functionalAreaFilterType |
ALL, LIST |
»»»» leaseAreaFilterType |
ALL, LIST |
»»»» leaseDepartmentFilterType |
ALL, LIST |
»»»» leaseGroupFilterType |
ALL, LIST |
»»»» objectType |
ASSET_CLASS, BUSINESS_AREA, BUSINESS_UNIT, COMPANY, CONSUMER_PRICE_INDEX_CATEGORY, COST_CENTER, ERP_SYSTEM, FUNCTIONAL_AREA, LEASE_AREA, LEASE_DEPARTMENT, LEASE_GROUP, PROFIT_CENTER, WORK_BREAKDOWN_STRUCTURE |
»»»» profitCenterFilterType |
ALL, LIST |
»»»» wbsFilterType |
ALL, LIST |
»»»»» sapVersion |
ECC_EHP5, ECC_EHP6, ECC_EHP7, ECC_EHP8, S4_1503, S4_1610, S4_1709, S4_1809, S4_1909 |
»»»»» status |
ACTIVE, CREATED, DECOMMISSIONED, DISABLED |
»»»»» type |
NAKISA, SAP |
»»»»»» name |
ACTIVE, CREATED, DECOMMISSIONED, DISABLED |
Parameter Constraints¶
Parameter |
Constraints |
|---|---|
»» page |
Min: 0 |
»» size |
Min: 1 |
Body Parameters
1{
2 "request": {
3 "searchTerm": "string",
4 "profile": {
5 "id": 0,
6 "name": "string",
7 "principalPositionType": "LESSEE",
8 "calendarType": "REGULAR_CALENDAR",
9 "fiscalYearVariant": {
10 "id": "string",
11 "displayId": "Euro"
12 },
13 "profileId": 0,
14 "jobId": 0,
15 "filterTypes": {
16 "erpSystemFilterType": "ALL",
17 "erpSystems": [
18 {
19 "id": 0,
20 "displayId": "string",
21 "status": "CREATED",
22 "name": "string",
23 "type": "NAKISA",
24 "sapVersion": "ECC_EHP5"
25 }
26 ],
27 "leaseAreaFilterType": "ALL",
28 "leaseAreas": [
29 {
30 "id": 10000001,
31 "displayId": "0001",
32 "status": {
33 "name": "ACTIVE",
34 "captionKey": "enum.objectStatus.active",
35 "active": true,
36 "caption": "Active"
37 },
38 "name": "Global Lease Area"
39 }
40 ],
41 "businessUnitFilterType": "ALL",
42 "businessUnits": [
43 {
44 "id": 10000001,
45 "displayId": "BU0001",
46 "status": {
47 "name": "ACTIVE",
48 "captionKey": "enum.objectStatus.active",
49 "active": true,
50 "caption": "Active"
51 },
52 "name": "North America Business Unit"
53 }
54 ],
55 "companyFilterType": "ALL",
56 "companies": [
57 {
58 "id": 10000006,
59 "displayId": "1005",
60 "status": {
61 "name": "ACTIVE",
62 "captionKey": "enum.objectStatus.active",
63 "active": true,
64 "caption": "Active"
65 },
66 "erpSystemId": 10000001,
67 "erpSystemDisplayId": "FINQ8S-300",
68 "countryId": 10000095,
69 "countryDisplayId": "CA",
70 "postingPeriodVariantId": 0,
71 "fiscalVariantId": 0
72 }
73 ],
74 "leaseDepartmentFilterType": "ALL",
75 "leaseDepartments": [
76 {
77 "id": 300001,
78 "displayId": "DEP-01",
79 "status": {
80 "name": "ACTIVE",
81 "captionKey": "enum.objectStatus.active",
82 "active": true,
83 "caption": "Active"
84 },
85 "name": "Finance Department"
86 }
87 ],
88 "leaseGroupFilterType": "ALL",
89 "leaseGroups": [
90 {
91 "id": 60000001,
92 "displayId": "LG-001",
93 "status": {
94 "name": "ACTIVE",
95 "captionKey": "enum.objectStatus.active",
96 "active": true,
97 "caption": "Active"
98 },
99 "name": "Global Lease Group"
100 }
101 ],
102 "costCenterFilterType": "ALL",
103 "costCenters": [
104 {
105 "id": 14001,
106 "displayId": "CC-001",
107 "status": {
108 "name": "ACTIVE",
109 "captionKey": "enum.objectStatus.active",
110 "active": true,
111 "caption": "Active"
112 },
113 "name": "Cost Center A"
114 }
115 ],
116 "profitCenterFilterType": "ALL",
117 "profitCenters": [
118 {
119 "id": 9001,
120 "displayId": "PC-001",
121 "status": {
122 "name": "ACTIVE",
123 "captionKey": "enum.objectStatus.active",
124 "active": true,
125 "caption": "Active"
126 },
127 "name": "North Region Profit Center",
128 "validTo": "2025-12-31",
129 "erpSystemId": 101,
130 "erpSystemDisplayId": "SAP-01"
131 }
132 ],
133 "wbsFilterType": "ALL",
134 "wbses": [
135 {
136 "id": 1001,
137 "displayId": "WBS-2025-001",
138 "status": {
139 "name": "ACTIVE",
140 "captionKey": "enum.objectStatus.active",
141 "active": true,
142 "caption": "Active"
143 },
144 "name": "Main Project WBS"
145 }
146 ],
147 "businessAreaFilterType": "ALL",
148 "businessAreas": [
149 {
150 "id": 3001,
151 "displayId": "BA-2025-001",
152 "status": {
153 "name": "ACTIVE",
154 "captionKey": "enum.objectStatus.active",
155 "active": true,
156 "caption": "Active"
157 },
158 "name": "North America Operations"
159 }
160 ],
161 "functionalAreaFilterType": "ALL",
162 "functionalAreas": [
163 {
164 "id": 2001,
165 "displayId": "FA-2025-001",
166 "status": {
167 "name": "ACTIVE",
168 "captionKey": "enum.objectStatus.active",
169 "active": true,
170 "caption": "Active"
171 },
172 "name": "Accounting Department"
173 }
174 ]
175 },
176 "baseIdList": [
177 {
178 "id": 0,
179 "displayId": "string",
180 "objectType": "LEASE_AREA"
181 }
182 ]
183 },
184 "migratedFilterType": "MIGRATED"
185 },
186 "pageable": {
187 "page": 0,
188 "size": 10,
189 "sort": [
190 "id,asc",
191 "name,desc"
192 ]
193 }
194}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "totalPages": 1,
3 "totalElements": 76,
4 "pageable": {
5 "unpaged": false,
6 "paged": true,
7 "pageSize": 100,
8 "pageNumber": 0,
9 "offset": 0,
10 "sort": {
11 "unsorted": false,
12 "sorted": true,
13 "empty": false
14 }
15 },
16 "numberOfElements": 76,
17 "first": true,
18 "last": true,
19 "size": 100,
20 "content": [
21 {
22 "id": 10000018,
23 "displayId": "CT-100001000",
24 "name": "Testtt Contract",
25 "principalPositionType": {
26 "name": "LESSEE",
27 "captionKey": "enum.principalpositiontype.lessee",
28 "caption": "Lessee"
29 },
30 "validFrom": "2019-08-24",
31 "validTo": "2019-08-24",
32 "amendmentDate": "2019-08-24",
33 "approverComment": "string",
34 "contractPhase": "INITIAL",
35 "dataCreationInfo": {
36 "id": 0,
37 "idGenerationType": "AUTO",
38 "source": "string",
39 "type": "MIGRATION",
40 "startDateTime": "2019-08-24T14:15:22Z",
41 "endDateTime": "2019-08-24T14:15:22Z"
42 },
43 "leaseType": {
44 "name": "LEASE_CONTRACT_FIX",
45 "captionKey": "enum.leaseType.fix",
46 "principalPositionType": "LESSEE",
47 "caption": "Fixed Lease Contract"
48 },
49 "revision": {
50 "id": 10000008,
51 "displayId": "CR-0001",
52 "name": "Initial Revision",
53 "inception": "2019-08-24",
54 "revisionType": "ACTIVE",
55 "state": "LC_DEFINE",
56 "approvedBy": "manager.user@company.com",
57 "approvedAt": "2019-08-24T14:15:22Z",
58 "parentRevisionId": 10000010,
59 "approverComment": "Approved with changes.",
60 "contractId": 20000001,
61 "contractDisplayId": "C-0001",
62 "contractName": "Office Lease Contract",
63 "principalPositionType": {
64 "name": "LESSEE",
65 "captionKey": "enum.principalpositiontype.lessee",
66 "caption": "Lessee"
67 },
68 "mlaId": 30000001,
69 "companyId": 40000001,
70 "description": "Revision to adjust payment terms.",
71 "externalReference": "EXT-REF-001",
72 "internalReference": "INT-REF-001",
73 "formOfLease": "FULL",
74 "jointVentureLeaseType": "GROSS_LEASE",
75 "businessPlace": "New York Office",
76 "tradingPartner": {
77 "id": 50000001,
78 "displayId": "TP-0001",
79 "status": {
80 "name": "ACTIVE",
81 "captionKey": "enum.objectStatus.active",
82 "active": true,
83 "caption": "Active"
84 },
85 "name": "ABC Real Estate Partners",
86 "erpSystemId": 60000001,
87 "erpSystemDisplayId": "ERP-SYS-01"
88 },
89 "contractCategoryGroup": {
90 "id": 0,
91 "displayId": "string",
92 "status": "CREATED",
93 "name": "string"
94 },
95 "contractGroup1": {
96 "id": 400001,
97 "displayId": "CG1-01",
98 "status": {
99 "name": "ACTIVE",
100 "captionKey": "enum.objectStatus.active",
101 "active": true,
102 "caption": "Active"
103 },
104 "name": "Real Estate Contracts"
105 },
106 "contractGroup2": {
107 "id": 500001,
108 "displayId": "CG2-01",
109 "status": {
110 "name": "ACTIVE",
111 "captionKey": "enum.objectStatus.active",
112 "active": true,
113 "caption": "Active"
114 },
115 "name": "Equipment Leasing Contracts"
116 },
117 "group3": "Group3-Value",
118 "group4": "Group4-Value",
119 "signingPerson": "John Doe",
120 "placeOfSignature": "Montreal, Canada",
121 "dateOfSignature": "2019-08-24T14:15:22Z",
122 "numberRangeIdentifierType": {
123 "name": "COMPANY_CODE"
124 },
125 "numberRangeIdentifierValue": "0001",
126 "numberRangeType": {
127 "name": "CONTRACT"
128 },
129 "allowsSystemGenerateNewId": true
130 },
131 "currency": {
132 "id": 840,
133 "displayId": "USD",
134 "status": {
135 "name": "ACTIVE",
136 "captionKey": "enum.objectStatus.active",
137 "active": true,
138 "caption": "Active"
139 },
140 "name": "United States Dollar",
141 "decimalPoints": 2
142 },
143 "companyCurrency": {
144 "id": 840,
145 "displayId": "USD",
146 "status": {
147 "name": "ACTIVE",
148 "captionKey": "enum.objectStatus.active",
149 "active": true,
150 "caption": "Active"
151 },
152 "name": "United States Dollar",
153 "decimalPoints": 2
154 },
155 "indexedCurrency": true,
156 "assetValueCurrencyType": "CONTRACT_CURRENCY",
157 "currencyLocked": true,
158 "leaseArea": {
159 "id": 10000001,
160 "displayId": "0001",
161 "status": {
162 "name": "ACTIVE",
163 "captionKey": "enum.objectStatus.active",
164 "active": true,
165 "caption": "Active"
166 },
167 "name": "Global Lease Area"
168 },
169 "businessUnit": {
170 "id": 10000001,
171 "displayId": "BU0001",
172 "status": {
173 "name": "ACTIVE",
174 "captionKey": "enum.objectStatus.active",
175 "active": true,
176 "caption": "Active"
177 },
178 "name": "North America Business Unit"
179 },
180 "businessUnitLocked": true,
181 "companyCode": {
182 "id": 10000006,
183 "displayId": "1005",
184 "status": {
185 "name": "ACTIVE",
186 "captionKey": "enum.objectStatus.active",
187 "active": true,
188 "caption": "Active"
189 },
190 "erpSystemId": 10000001,
191 "erpSystemDisplayId": "FINQ8S-300",
192 "countryId": 10000095,
193 "countryDisplayId": "CA",
194 "postingPeriodVariantId": 0,
195 "fiscalVariantId": 0
196 },
197 "companyCodeLocked": true,
198 "department": {
199 "id": 300001,
200 "displayId": "DEP-01",
201 "status": {
202 "name": "ACTIVE",
203 "captionKey": "enum.objectStatus.active",
204 "active": true,
205 "caption": "Active"
206 },
207 "name": "Finance Department"
208 },
209 "departmentLocked": true,
210 "leaseGroup": {
211 "id": 60000001,
212 "displayId": "LG-001",
213 "status": {
214 "name": "ACTIVE",
215 "captionKey": "enum.objectStatus.active",
216 "active": true,
217 "caption": "Active"
218 },
219 "name": "Global Lease Group"
220 },
221 "leaseGroupLocked": true,
222 "subleasingInternalAssetClass": {
223 "id": 10000001,
224 "displayId": "IAC-001",
225 "status": {
226 "name": "ACTIVE",
227 "captionKey": "enum.objectStatus.active",
228 "active": true,
229 "caption": "Active"
230 },
231 "name": "Machinery and Equipment",
232 "assetClassType": "PROPERTY",
233 "infiniteUsefulLife": false
234 },
235 "contractGroup1": {
236 "id": 400001,
237 "displayId": "CG1-01",
238 "status": {
239 "name": "ACTIVE",
240 "captionKey": "enum.objectStatus.active",
241 "active": true,
242 "caption": "Active"
243 },
244 "name": "Real Estate Contracts"
245 },
246 "contractGroup2": {
247 "id": 500001,
248 "displayId": "CG2-01",
249 "status": {
250 "name": "ACTIVE",
251 "captionKey": "enum.objectStatus.active",
252 "active": true,
253 "caption": "Active"
254 },
255 "name": "Equipment Leasing Contracts"
256 },
257 "subleasing": false,
258 "subleasingContractRevisionInfo": {
259 "id": 50000001,
260 "contractId": 40000001,
261 "contractDisplayId": "CTR-0001",
262 "contractName": "Sublease Agreement for Office Space"
263 },
264 "subleasingLeaseComponentRevisionInfo": {
265 "id": 61000001,
266 "leaseComponentId": 80000001,
267 "leaseComponentDisplayId": "LC-0001",
268 "leaseComponentName": "Vehicle Lease Component"
269 },
270 "subleasingActivationGroupRevisionInfo": {
271 "id": 60000001,
272 "activationGroupId": 70000001,
273 "activationGroupDisplayId": "AG-001",
274 "activationGroupName": "Office Equipment Activation Group"
275 },
276 "notifications": [
277 {
278 "id": 10000001,
279 "topic": {
280 "enCaption": "Lease Component Updated",
281 "frCaption": "Composant de bail mis à jour",
282 "name": "LEASE_COMPONENT_UPDATED",
283 "priority": "HIGH"
284 },
285 "username": "super.admin@nakisa.com",
286 "contractId": 10000001,
287 "contractDisplayId": "CT-100000000",
288 "targetId": "CT-100000000",
289 "targetType": "CONTRACT"
290 }
291 ],
292 "masterAgreementId": 10000001,
293 "masterAgreementDisplayId": "string",
294 "allowsSystemGenerateNewId": true,
295 "transferInfo": {
296 "transferredFromDisplayId": "CTR-00012",
297 "transferredFromRevisionId": 20000001,
298 "transferredToDisplayId": "CTR-00015",
299 "transferredToRevisionId": 20000005
300 },
301 "numberRangeIdentifierType": {
302 "name": "COMPANY_CODE"
303 },
304 "numberRangeIdentifierValue": "",
305 "numberRangeType": {
306 "name": "CONTRACT"
307 }
308 }
309 ],
310 "number": 0,
311 "sort": {
312 "unsorted": false,
313 "sorted": true,
314 "empty": false
315 },
316 "empty": false
317}
Cancel¶
HTTP Request
POST /api/v1/disclosure_reports/jobs/cancel/{id}
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
none |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "id": 0,
3 "queueTime": "2019-08-24T14:15:22Z",
4 "startTime": "2019-08-24T14:15:22Z",
5 "endTime": "2019-08-24T14:15:22Z",
6 "interruptedAt": "2019-08-24T14:15:22Z",
7 "recoveredAt": "2019-08-24T14:15:22Z",
8 "status": "CREATED",
9 "recover": true,
10 "interrupted": true,
11 "interruptionMessage": "string",
12 "errorMessage": "string",
13 "disclosureReportType": "NET_LEASE_INVESTMENT_REPORT",
14 "fileStorageId": "string",
15 "jsonFileStorageId": "string",
16 "generatingExportFile": true,
17 "startedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
18 "finishedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
19 "reportJobId": 0,
20 "version": 0,
21 "jsonDocStoreIds": [
22 0
23 ],
24 "docStoreId": 0
25}
Find All¶
HTTP Request
GET /api/v1/disclosure_reports/jobs
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
none |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "totalPages": 0,
3 "totalElements": 0,
4 "pageable": {
5 "unpaged": false,
6 "paged": true,
7 "pageSize": 100,
8 "pageNumber": 0,
9 "offset": 0,
10 "sort": {
11 "unsorted": false,
12 "sorted": true,
13 "empty": false
14 }
15 },
16 "numberOfElements": 0,
17 "first": true,
18 "last": true,
19 "size": 0,
20 "content": [
21 {
22 "id": 0,
23 "taskCount": 0,
24 "failedTaskCount": 0,
25 "doneTaskCount": 0,
26 "inProgressTaskCount": 0,
27 "cancelledTaskCount": 0,
28 "errorMessage": "string",
29 "executor": "SCHEDULER",
30 "scheduleJobId": 0,
31 "batchSize": 1000,
32 "totalObjectCount": 0,
33 "profileId": 0,
34 "readOnly": true,
35 "input": {
36 "id": 0,
37 "accountingStandardType": "GAAP",
38 "classifications": [
39 "NON_LEASE"
40 ],
41 "fromYear": 0,
42 "fromPeriod": {
43 "id": 0,
44 "displayId": "string",
45 "status": "CREATED",
46 "day": 0,
47 "year": 0,
48 "month": 0,
49 "postingPeriod": 0,
50 "yearShift": 0
51 },
52 "toYear": 0,
53 "toPeriod": {
54 "id": 0,
55 "displayId": "string",
56 "status": "CREATED",
57 "day": 0,
58 "year": 0,
59 "month": 0,
60 "postingPeriod": 0,
61 "yearShift": 0
62 },
63 "fromDate": "2019-08-24",
64 "toDate": "2019-08-24",
65 "currencyDisplayId": "string",
66 "currencyType": "string",
67 "currencyDefinitionType": "CONTRACT_CURRENCY",
68 "activationGroupStatus": "AG_PENDING_ASSESSMENT",
69 "reportList": [
70 "NET_LEASE_INVESTMENT_REPORT"
71 ],
72 "listObjectType": "CONTRACT",
73 "objectList": [
74 {
75 "id": 0,
76 "displayId": "string",
77 "name": "string"
78 }
79 ],
80 "migratedFilterType": "MIGRATED",
81 "assetClassFilterType": "ALL",
82 "assetClasses": [
83 {
84 "id": 10000001,
85 "displayId": "IAC-001",
86 "status": {
87 "name": "ACTIVE",
88 "captionKey": "enum.objectStatus.active",
89 "active": true,
90 "caption": "Active"
91 },
92 "name": "Machinery and Equipment",
93 "assetClassType": "PROPERTY",
94 "infiniteUsefulLife": false
95 }
96 ],
97 "businessAreaFilterType": "ALL",
98 "businessAreas": [
99 {
100 "id": 3001,
101 "displayId": "BA-2025-001",
102 "status": {
103 "name": "ACTIVE",
104 "captionKey": "enum.objectStatus.active",
105 "active": true,
106 "caption": "Active"
107 },
108 "name": "North America Operations"
109 }
110 ],
111 "vendorFilterType": "ALL",
112 "vendors": [
113 {
114 "id": 10000012,
115 "displayId": "0000100003",
116 "status": {
117 "name": "ACTIVE",
118 "captionKey": "enum.objectStatus.active",
119 "active": true,
120 "caption": "Active"
121 },
122 "name": "TEST VENDOR GB",
123 "erpSystemDisplayId": "FINQ8S-300"
124 }
125 ]
126 },
127 "filter": {
128 "id": 0,
129 "name": "string",
130 "principalPositionType": "LESSEE",
131 "calendarType": "REGULAR_CALENDAR",
132 "fiscalYearVariant": {
133 "id": "string",
134 "displayId": "Euro"
135 },
136 "profileId": 0,
137 "jobId": 0,
138 "filterTypes": {
139 "erpSystemFilterType": "ALL",
140 "erpSystems": [
141 {
142 "id": 0,
143 "displayId": "string",
144 "status": "CREATED",
145 "name": "string",
146 "type": "NAKISA",
147 "sapVersion": "ECC_EHP5"
148 }
149 ],
150 "leaseAreaFilterType": "ALL",
151 "leaseAreas": [
152 {
153 "id": 10000001,
154 "displayId": "0001",
155 "status": {
156 "name": "ACTIVE",
157 "captionKey": "enum.objectStatus.active",
158 "active": true,
159 "caption": "Active"
160 },
161 "name": "Global Lease Area"
162 }
163 ],
164 "businessUnitFilterType": "ALL",
165 "businessUnits": [
166 {
167 "id": 10000001,
168 "displayId": "BU0001",
169 "status": {
170 "name": "ACTIVE",
171 "captionKey": "enum.objectStatus.active",
172 "active": true,
173 "caption": "Active"
174 },
175 "name": "North America Business Unit"
176 }
177 ],
178 "companyFilterType": "ALL",
179 "companies": [
180 {
181 "id": 10000006,
182 "displayId": "1005",
183 "status": {
184 "name": "ACTIVE",
185 "captionKey": "enum.objectStatus.active",
186 "active": true,
187 "caption": "Active"
188 },
189 "erpSystemId": 10000001,
190 "erpSystemDisplayId": "FINQ8S-300",
191 "countryId": 10000095,
192 "countryDisplayId": "CA",
193 "postingPeriodVariantId": 0,
194 "fiscalVariantId": 0
195 }
196 ],
197 "leaseDepartmentFilterType": "ALL",
198 "leaseDepartments": [
199 {
200 "id": 300001,
201 "displayId": "DEP-01",
202 "status": {
203 "name": "ACTIVE",
204 "captionKey": "enum.objectStatus.active",
205 "active": true,
206 "caption": "Active"
207 },
208 "name": "Finance Department"
209 }
210 ],
211 "leaseGroupFilterType": "ALL",
212 "leaseGroups": [
213 {
214 "id": 60000001,
215 "displayId": "LG-001",
216 "status": {
217 "name": "ACTIVE",
218 "captionKey": "enum.objectStatus.active",
219 "active": true,
220 "caption": "Active"
221 },
222 "name": "Global Lease Group"
223 }
224 ],
225 "costCenterFilterType": "ALL",
226 "costCenters": [
227 {
228 "id": 14001,
229 "displayId": "CC-001",
230 "status": {
231 "name": "ACTIVE",
232 "captionKey": "enum.objectStatus.active",
233 "active": true,
234 "caption": "Active"
235 },
236 "name": "Cost Center A"
237 }
238 ],
239 "profitCenterFilterType": "ALL",
240 "profitCenters": [
241 {
242 "id": 9001,
243 "displayId": "PC-001",
244 "status": {
245 "name": "ACTIVE",
246 "captionKey": "enum.objectStatus.active",
247 "active": true,
248 "caption": "Active"
249 },
250 "name": "North Region Profit Center",
251 "validTo": "2025-12-31",
252 "erpSystemId": 101,
253 "erpSystemDisplayId": "SAP-01"
254 }
255 ],
256 "wbsFilterType": "ALL",
257 "wbses": [
258 {
259 "id": 1001,
260 "displayId": "WBS-2025-001",
261 "status": {
262 "name": "ACTIVE",
263 "captionKey": "enum.objectStatus.active",
264 "active": true,
265 "caption": "Active"
266 },
267 "name": "Main Project WBS"
268 }
269 ],
270 "businessAreaFilterType": "ALL",
271 "businessAreas": [
272 {
273 "id": 3001,
274 "displayId": "BA-2025-001",
275 "status": {
276 "name": "ACTIVE",
277 "captionKey": "enum.objectStatus.active",
278 "active": true,
279 "caption": "Active"
280 },
281 "name": "North America Operations"
282 }
283 ],
284 "functionalAreaFilterType": "ALL",
285 "functionalAreas": [
286 {
287 "id": 2001,
288 "displayId": "FA-2025-001",
289 "status": {
290 "name": "ACTIVE",
291 "captionKey": "enum.objectStatus.active",
292 "active": true,
293 "caption": "Active"
294 },
295 "name": "Accounting Department"
296 }
297 ]
298 },
299 "baseIdList": [
300 {
301 "id": 0,
302 "displayId": "string",
303 "objectType": "LEASE_AREA"
304 }
305 ]
306 },
307 "tasks": [
308 {
309 "id": 0,
310 "queueTime": "2019-08-24T14:15:22Z",
311 "startTime": "2019-08-24T14:15:22Z",
312 "endTime": "2019-08-24T14:15:22Z",
313 "interruptedAt": "2019-08-24T14:15:22Z",
314 "recoveredAt": "2019-08-24T14:15:22Z",
315 "status": "CREATED",
316 "recover": true,
317 "interrupted": true,
318 "interruptionMessage": "string",
319 "errorMessage": "string",
320 "disclosureReportType": "NET_LEASE_INVESTMENT_REPORT",
321 "fileStorageId": "string",
322 "jsonFileStorageId": "string",
323 "generatingExportFile": true,
324 "startedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
325 "finishedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
326 "reportJobId": 0,
327 "version": 0,
328 "jsonDocStoreIds": [
329 0
330 ],
331 "docStoreId": 0
332 }
333 ]
334 }
335 ],
336 "number": 0,
337 "sort": {
338 "unsorted": false,
339 "sorted": true,
340 "empty": false
341 },
342 "empty": true
343}
Create¶
HTTP Request
POST /api/v1/disclosure_reports/jobs
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
none |
Body Parameters
1{
2 "id": 0,
3 "taskCount": 0,
4 "failedTaskCount": 0,
5 "doneTaskCount": 0,
6 "inProgressTaskCount": 0,
7 "cancelledTaskCount": 0,
8 "errorMessage": "string",
9 "executor": "SCHEDULER",
10 "scheduleJobId": 0,
11 "batchSize": 1000,
12 "totalObjectCount": 0,
13 "profileId": 0,
14 "readOnly": true,
15 "input": {
16 "id": 0,
17 "accountingStandardType": "GAAP",
18 "classifications": [
19 "NON_LEASE"
20 ],
21 "fromYear": 0,
22 "fromPeriod": {
23 "id": 0,
24 "displayId": "string",
25 "status": "CREATED",
26 "day": 0,
27 "year": 0,
28 "month": 0,
29 "postingPeriod": 0,
30 "yearShift": 0
31 },
32 "toYear": 0,
33 "toPeriod": {
34 "id": 0,
35 "displayId": "string",
36 "status": "CREATED",
37 "day": 0,
38 "year": 0,
39 "month": 0,
40 "postingPeriod": 0,
41 "yearShift": 0
42 },
43 "fromDate": "2019-08-24",
44 "toDate": "2019-08-24",
45 "currencyDisplayId": "string",
46 "currencyType": "string",
47 "currencyDefinitionType": "CONTRACT_CURRENCY",
48 "activationGroupStatus": "AG_PENDING_ASSESSMENT",
49 "reportList": [
50 "NET_LEASE_INVESTMENT_REPORT"
51 ],
52 "listObjectType": "CONTRACT",
53 "objectList": [
54 {
55 "id": 0,
56 "displayId": "string",
57 "name": "string"
58 }
59 ],
60 "migratedFilterType": "MIGRATED",
61 "assetClassFilterType": "ALL",
62 "assetClasses": [
63 {
64 "id": 10000001,
65 "displayId": "IAC-001",
66 "status": {
67 "name": "ACTIVE",
68 "captionKey": "enum.objectStatus.active",
69 "active": true,
70 "caption": "Active"
71 },
72 "name": "Machinery and Equipment",
73 "assetClassType": "PROPERTY",
74 "infiniteUsefulLife": false
75 }
76 ],
77 "businessAreaFilterType": "ALL",
78 "businessAreas": [
79 {
80 "id": 3001,
81 "displayId": "BA-2025-001",
82 "status": {
83 "name": "ACTIVE",
84 "captionKey": "enum.objectStatus.active",
85 "active": true,
86 "caption": "Active"
87 },
88 "name": "North America Operations"
89 }
90 ],
91 "vendorFilterType": "ALL",
92 "vendors": [
93 {
94 "id": 10000012,
95 "displayId": "0000100003",
96 "status": {
97 "name": "ACTIVE",
98 "captionKey": "enum.objectStatus.active",
99 "active": true,
100 "caption": "Active"
101 },
102 "name": "TEST VENDOR GB",
103 "erpSystemDisplayId": "FINQ8S-300"
104 }
105 ]
106 },
107 "filter": {
108 "id": 0,
109 "name": "string",
110 "principalPositionType": "LESSEE",
111 "calendarType": "REGULAR_CALENDAR",
112 "fiscalYearVariant": {
113 "id": "string",
114 "displayId": "Euro"
115 },
116 "profileId": 0,
117 "jobId": 0,
118 "filterTypes": {
119 "erpSystemFilterType": "ALL",
120 "erpSystems": [
121 {
122 "id": 0,
123 "displayId": "string",
124 "status": "CREATED",
125 "name": "string",
126 "type": "NAKISA",
127 "sapVersion": "ECC_EHP5"
128 }
129 ],
130 "leaseAreaFilterType": "ALL",
131 "leaseAreas": [
132 {
133 "id": 10000001,
134 "displayId": "0001",
135 "status": {
136 "name": "ACTIVE",
137 "captionKey": "enum.objectStatus.active",
138 "active": true,
139 "caption": "Active"
140 },
141 "name": "Global Lease Area"
142 }
143 ],
144 "businessUnitFilterType": "ALL",
145 "businessUnits": [
146 {
147 "id": 10000001,
148 "displayId": "BU0001",
149 "status": {
150 "name": "ACTIVE",
151 "captionKey": "enum.objectStatus.active",
152 "active": true,
153 "caption": "Active"
154 },
155 "name": "North America Business Unit"
156 }
157 ],
158 "companyFilterType": "ALL",
159 "companies": [
160 {
161 "id": 10000006,
162 "displayId": "1005",
163 "status": {
164 "name": "ACTIVE",
165 "captionKey": "enum.objectStatus.active",
166 "active": true,
167 "caption": "Active"
168 },
169 "erpSystemId": 10000001,
170 "erpSystemDisplayId": "FINQ8S-300",
171 "countryId": 10000095,
172 "countryDisplayId": "CA",
173 "postingPeriodVariantId": 0,
174 "fiscalVariantId": 0
175 }
176 ],
177 "leaseDepartmentFilterType": "ALL",
178 "leaseDepartments": [
179 {
180 "id": 300001,
181 "displayId": "DEP-01",
182 "status": {
183 "name": "ACTIVE",
184 "captionKey": "enum.objectStatus.active",
185 "active": true,
186 "caption": "Active"
187 },
188 "name": "Finance Department"
189 }
190 ],
191 "leaseGroupFilterType": "ALL",
192 "leaseGroups": [
193 {
194 "id": 60000001,
195 "displayId": "LG-001",
196 "status": {
197 "name": "ACTIVE",
198 "captionKey": "enum.objectStatus.active",
199 "active": true,
200 "caption": "Active"
201 },
202 "name": "Global Lease Group"
203 }
204 ],
205 "costCenterFilterType": "ALL",
206 "costCenters": [
207 {
208 "id": 14001,
209 "displayId": "CC-001",
210 "status": {
211 "name": "ACTIVE",
212 "captionKey": "enum.objectStatus.active",
213 "active": true,
214 "caption": "Active"
215 },
216 "name": "Cost Center A"
217 }
218 ],
219 "profitCenterFilterType": "ALL",
220 "profitCenters": [
221 {
222 "id": 9001,
223 "displayId": "PC-001",
224 "status": {
225 "name": "ACTIVE",
226 "captionKey": "enum.objectStatus.active",
227 "active": true,
228 "caption": "Active"
229 },
230 "name": "North Region Profit Center",
231 "validTo": "2025-12-31",
232 "erpSystemId": 101,
233 "erpSystemDisplayId": "SAP-01"
234 }
235 ],
236 "wbsFilterType": "ALL",
237 "wbses": [
238 {
239 "id": 1001,
240 "displayId": "WBS-2025-001",
241 "status": {
242 "name": "ACTIVE",
243 "captionKey": "enum.objectStatus.active",
244 "active": true,
245 "caption": "Active"
246 },
247 "name": "Main Project WBS"
248 }
249 ],
250 "businessAreaFilterType": "ALL",
251 "businessAreas": [
252 {
253 "id": 3001,
254 "displayId": "BA-2025-001",
255 "status": {
256 "name": "ACTIVE",
257 "captionKey": "enum.objectStatus.active",
258 "active": true,
259 "caption": "Active"
260 },
261 "name": "North America Operations"
262 }
263 ],
264 "functionalAreaFilterType": "ALL",
265 "functionalAreas": [
266 {
267 "id": 2001,
268 "displayId": "FA-2025-001",
269 "status": {
270 "name": "ACTIVE",
271 "captionKey": "enum.objectStatus.active",
272 "active": true,
273 "caption": "Active"
274 },
275 "name": "Accounting Department"
276 }
277 ]
278 },
279 "baseIdList": [
280 {
281 "id": 0,
282 "displayId": "string",
283 "objectType": "LEASE_AREA"
284 }
285 ]
286 },
287 "tasks": [
288 {
289 "id": 0,
290 "queueTime": "2019-08-24T14:15:22Z",
291 "startTime": "2019-08-24T14:15:22Z",
292 "endTime": "2019-08-24T14:15:22Z",
293 "interruptedAt": "2019-08-24T14:15:22Z",
294 "recoveredAt": "2019-08-24T14:15:22Z",
295 "status": "CREATED",
296 "recover": true,
297 "interrupted": true,
298 "interruptionMessage": "string",
299 "errorMessage": "string",
300 "disclosureReportType": "NET_LEASE_INVESTMENT_REPORT",
301 "fileStorageId": "string",
302 "jsonFileStorageId": "string",
303 "generatingExportFile": true,
304 "startedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
305 "finishedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
306 "reportJobId": 0,
307 "version": 0,
308 "jsonDocStoreIds": [
309 0
310 ],
311 "docStoreId": 0
312 }
313 ]
314}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "source": {},
8 "field": "string",
9 "errorKey": "string",
10 "errorMessage": "string"
11 }
12 ]
13 },
14 "object": {
15 "id": 0,
16 "taskCount": 0,
17 "failedTaskCount": 0,
18 "doneTaskCount": 0,
19 "inProgressTaskCount": 0,
20 "cancelledTaskCount": 0,
21 "errorMessage": "string",
22 "executor": "SCHEDULER",
23 "scheduleJobId": 0,
24 "batchSize": 1000,
25 "totalObjectCount": 0,
26 "profileId": 0,
27 "readOnly": true,
28 "input": {
29 "id": 0,
30 "accountingStandardType": "GAAP",
31 "classifications": [
32 "NON_LEASE"
33 ],
34 "fromYear": 0,
35 "fromPeriod": {
36 "id": 0,
37 "displayId": "string",
38 "status": "CREATED",
39 "day": 0,
40 "year": 0,
41 "month": 0,
42 "postingPeriod": 0,
43 "yearShift": 0
44 },
45 "toYear": 0,
46 "toPeriod": {
47 "id": 0,
48 "displayId": "string",
49 "status": "CREATED",
50 "day": 0,
51 "year": 0,
52 "month": 0,
53 "postingPeriod": 0,
54 "yearShift": 0
55 },
56 "fromDate": "2019-08-24",
57 "toDate": "2019-08-24",
58 "currencyDisplayId": "string",
59 "currencyType": "string",
60 "currencyDefinitionType": "CONTRACT_CURRENCY",
61 "activationGroupStatus": "AG_PENDING_ASSESSMENT",
62 "reportList": [
63 "NET_LEASE_INVESTMENT_REPORT"
64 ],
65 "listObjectType": "CONTRACT",
66 "objectList": [
67 {
68 "id": 0,
69 "displayId": "string",
70 "name": "string"
71 }
72 ],
73 "migratedFilterType": "MIGRATED",
74 "assetClassFilterType": "ALL",
75 "assetClasses": [
76 {
77 "id": 10000001,
78 "displayId": "IAC-001",
79 "status": {
80 "name": "ACTIVE",
81 "captionKey": "enum.objectStatus.active",
82 "active": true,
83 "caption": "Active"
84 },
85 "name": "Machinery and Equipment",
86 "assetClassType": "PROPERTY",
87 "infiniteUsefulLife": false
88 }
89 ],
90 "businessAreaFilterType": "ALL",
91 "businessAreas": [
92 {
93 "id": 3001,
94 "displayId": "BA-2025-001",
95 "status": {
96 "name": "ACTIVE",
97 "captionKey": "enum.objectStatus.active",
98 "active": true,
99 "caption": "Active"
100 },
101 "name": "North America Operations"
102 }
103 ],
104 "vendorFilterType": "ALL",
105 "vendors": [
106 {
107 "id": 10000012,
108 "displayId": "0000100003",
109 "status": {
110 "name": "ACTIVE",
111 "captionKey": "enum.objectStatus.active",
112 "active": true,
113 "caption": "Active"
114 },
115 "name": "TEST VENDOR GB",
116 "erpSystemDisplayId": "FINQ8S-300"
117 }
118 ]
119 },
120 "filter": {
121 "id": 0,
122 "name": "string",
123 "principalPositionType": "LESSEE",
124 "calendarType": "REGULAR_CALENDAR",
125 "fiscalYearVariant": {
126 "id": "string",
127 "displayId": "Euro"
128 },
129 "profileId": 0,
130 "jobId": 0,
131 "filterTypes": {
132 "erpSystemFilterType": "ALL",
133 "erpSystems": [
134 {
135 "id": 0,
136 "displayId": "string",
137 "status": "CREATED",
138 "name": "string",
139 "type": "NAKISA",
140 "sapVersion": "ECC_EHP5"
141 }
142 ],
143 "leaseAreaFilterType": "ALL",
144 "leaseAreas": [
145 {
146 "id": 10000001,
147 "displayId": "0001",
148 "status": {
149 "name": "ACTIVE",
150 "captionKey": "enum.objectStatus.active",
151 "active": true,
152 "caption": "Active"
153 },
154 "name": "Global Lease Area"
155 }
156 ],
157 "businessUnitFilterType": "ALL",
158 "businessUnits": [
159 {
160 "id": 10000001,
161 "displayId": "BU0001",
162 "status": {
163 "name": "ACTIVE",
164 "captionKey": "enum.objectStatus.active",
165 "active": true,
166 "caption": "Active"
167 },
168 "name": "North America Business Unit"
169 }
170 ],
171 "companyFilterType": "ALL",
172 "companies": [
173 {
174 "id": 10000006,
175 "displayId": "1005",
176 "status": {
177 "name": "ACTIVE",
178 "captionKey": "enum.objectStatus.active",
179 "active": true,
180 "caption": "Active"
181 },
182 "erpSystemId": 10000001,
183 "erpSystemDisplayId": "FINQ8S-300",
184 "countryId": 10000095,
185 "countryDisplayId": "CA",
186 "postingPeriodVariantId": 0,
187 "fiscalVariantId": 0
188 }
189 ],
190 "leaseDepartmentFilterType": "ALL",
191 "leaseDepartments": [
192 {
193 "id": 300001,
194 "displayId": "DEP-01",
195 "status": {
196 "name": "ACTIVE",
197 "captionKey": "enum.objectStatus.active",
198 "active": true,
199 "caption": "Active"
200 },
201 "name": "Finance Department"
202 }
203 ],
204 "leaseGroupFilterType": "ALL",
205 "leaseGroups": [
206 {
207 "id": 60000001,
208 "displayId": "LG-001",
209 "status": {
210 "name": "ACTIVE",
211 "captionKey": "enum.objectStatus.active",
212 "active": true,
213 "caption": "Active"
214 },
215 "name": "Global Lease Group"
216 }
217 ],
218 "costCenterFilterType": "ALL",
219 "costCenters": [
220 {
221 "id": 14001,
222 "displayId": "CC-001",
223 "status": {
224 "name": "ACTIVE",
225 "captionKey": "enum.objectStatus.active",
226 "active": true,
227 "caption": "Active"
228 },
229 "name": "Cost Center A"
230 }
231 ],
232 "profitCenterFilterType": "ALL",
233 "profitCenters": [
234 {
235 "id": 9001,
236 "displayId": "PC-001",
237 "status": {
238 "name": "ACTIVE",
239 "captionKey": "enum.objectStatus.active",
240 "active": true,
241 "caption": "Active"
242 },
243 "name": "North Region Profit Center",
244 "validTo": "2025-12-31",
245 "erpSystemId": 101,
246 "erpSystemDisplayId": "SAP-01"
247 }
248 ],
249 "wbsFilterType": "ALL",
250 "wbses": [
251 {
252 "id": 1001,
253 "displayId": "WBS-2025-001",
254 "status": {
255 "name": "ACTIVE",
256 "captionKey": "enum.objectStatus.active",
257 "active": true,
258 "caption": "Active"
259 },
260 "name": "Main Project WBS"
261 }
262 ],
263 "businessAreaFilterType": "ALL",
264 "businessAreas": [
265 {
266 "id": 3001,
267 "displayId": "BA-2025-001",
268 "status": {
269 "name": "ACTIVE",
270 "captionKey": "enum.objectStatus.active",
271 "active": true,
272 "caption": "Active"
273 },
274 "name": "North America Operations"
275 }
276 ],
277 "functionalAreaFilterType": "ALL",
278 "functionalAreas": [
279 {
280 "id": 2001,
281 "displayId": "FA-2025-001",
282 "status": {
283 "name": "ACTIVE",
284 "captionKey": "enum.objectStatus.active",
285 "active": true,
286 "caption": "Active"
287 },
288 "name": "Accounting Department"
289 }
290 ]
291 },
292 "baseIdList": [
293 {
294 "id": 0,
295 "displayId": "string",
296 "objectType": "LEASE_AREA"
297 }
298 ]
299 },
300 "tasks": [
301 {
302 "id": 0,
303 "queueTime": "2019-08-24T14:15:22Z",
304 "startTime": "2019-08-24T14:15:22Z",
305 "endTime": "2019-08-24T14:15:22Z",
306 "interruptedAt": "2019-08-24T14:15:22Z",
307 "recoveredAt": "2019-08-24T14:15:22Z",
308 "status": "CREATED",
309 "recover": true,
310 "interrupted": true,
311 "interruptionMessage": "string",
312 "errorMessage": "string",
313 "disclosureReportType": "NET_LEASE_INVESTMENT_REPORT",
314 "fileStorageId": "string",
315 "jsonFileStorageId": "string",
316 "generatingExportFile": true,
317 "startedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
318 "finishedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
319 "reportJobId": 0,
320 "version": 0,
321 "jsonDocStoreIds": [
322 0
323 ],
324 "docStoreId": 0
325 }
326 ]
327 }
328}
Bulk Delete¶
HTTP Request
DELETE /api/v1/disclosure_reports/jobs
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
array[integer] |
true |
none |
Body Parameters
1[
2 0
3]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "OK",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "source": {},
8 "field": "string",
9 "errorKey": "string",
10 "errorMessage": "string"
11 }
12 ]
13 },
14 "object": {}
15}
Get Disclosure Report List Object Type¶
HTTP Request
GET /api/v1/disclosure_reports/jobs/list_types
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 "CONTRACT"
3]
Response Schema
Generate Report Excel¶
HTTP Request
GET /api/v1/disclosure_reports/jobs/generate_report/{taskId}
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
taskId |
path |
integer(int64) |
true |
none |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Generate Disclosure Report¶
HTTP Request
GET /api/v1/disclosure_reports/jobs/generate_all_reports/{jobId}
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
jobId |
path |
integer(int64) |
true |
none |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Download Report To Excel¶
HTTP Request
GET /api/v1/disclosure_reports/jobs/download_report/{taskId}
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
taskId |
path |
integer(int64) |
true |
none |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Get Calendar Types¶
HTTP Request
GET /api/v1/disclosure_reports/jobs/calendar_types
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 "REGULAR_CALENDAR"
3]
Response Schema
Get Accounting Group Status¶
HTTP Request
GET /api/v1/disclosure_reports/jobs/activation_group_status_list
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 "AG_PENDING_ASSESSMENT"
3]