Location¶
Update Operating Cost Period¶
HTTP Request
PUT /api/locations/{locationId}/operating-cost-periods/{id}
📋 Description: Updates the operating cost period for a specified location within the Nakisa Portfolio Management Suite, enabling accurate financial analytics and portfolio management for real estate assets.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
locationId |
path |
integer(int64) |
true |
Unique identifier for the location |
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing the updated operating cost period details, including financial metrics and relevant metadata for effective portfolio and asset management. |
Body Parameters
1{
2 "createdBy": "string",
3 "lastModifiedBy": "string",
4 "createdDate": "2019-08-24T14:15:22Z",
5 "lastModifiedDate": "2019-08-24T14:15:22Z",
6 "archived": true,
7 "externalId": "string",
8 "id": 0,
9 "year": 1950,
10 "statusId": 0,
11 "expenses": [
12 {
13 "createdBy": "string",
14 "lastModifiedBy": "string",
15 "createdDate": "2019-08-24T14:15:22Z",
16 "lastModifiedDate": "2019-08-24T14:15:22Z",
17 "archived": true,
18 "externalId": "string",
19 "id": 0,
20 "operatingCostExpenseTypeId": 0,
21 "amount": 0,
22 "revisedAmount": 0,
23 "considerRevisedAmount": true,
24 "operatingCostExpenseType": {
25 "createdBy": "string",
26 "lastModifiedBy": "string",
27 "createdDate": "2019-08-24T14:15:22Z",
28 "lastModifiedDate": "2019-08-24T14:15:22Z",
29 "archived": true,
30 "externalId": "string",
31 "id": 0,
32 "priority": 0,
33 "internalId": 0,
34 "pickListCode": "string",
35 "pickListLabel": "string",
36 "label": "string",
37 "cultureId": 0,
38 "labelDtos": [
39 {
40 "createdBy": "string",
41 "lastModifiedBy": "string",
42 "createdDate": "2019-08-24T14:15:22Z",
43 "lastModifiedDate": "2019-08-24T14:15:22Z",
44 "archived": true,
45 "externalId": "string",
46 "id": 0,
47 "cultureId": 0,
48 "value": "string"
49 }
50 ]
51 },
52 "expenseGroup": {
53 "createdBy": "string",
54 "lastModifiedBy": "string",
55 "createdDate": "2019-08-24T14:15:22Z",
56 "lastModifiedDate": "2019-08-24T14:15:22Z",
57 "archived": true,
58 "externalId": "string",
59 "id": 0,
60 "priority": 0,
61 "internalId": 0,
62 "pickListCode": "string",
63 "pickListLabel": "string",
64 "label": "string",
65 "cultureId": 0,
66 "labelDtos": [
67 {
68 "createdBy": "string",
69 "lastModifiedBy": "string",
70 "createdDate": "2019-08-24T14:15:22Z",
71 "lastModifiedDate": "2019-08-24T14:15:22Z",
72 "archived": true,
73 "externalId": "string",
74 "id": 0,
75 "cultureId": 0,
76 "value": "string"
77 }
78 ]
79 }
80 }
81 ],
82 "status": {
83 "createdBy": "string",
84 "lastModifiedBy": "string",
85 "createdDate": "2019-08-24T14:15:22Z",
86 "lastModifiedDate": "2019-08-24T14:15:22Z",
87 "archived": true,
88 "externalId": "string",
89 "id": 0,
90 "priority": 0,
91 "internalId": 0,
92 "pickListCode": "string",
93 "pickListLabel": "string",
94 "label": "string",
95 "cultureId": 0,
96 "labelDtos": [
97 {
98 "createdBy": "string",
99 "lastModifiedBy": "string",
100 "createdDate": "2019-08-24T14:15:22Z",
101 "lastModifiedDate": "2019-08-24T14:15:22Z",
102 "archived": true,
103 "externalId": "string",
104 "id": 0,
105 "cultureId": 0,
106 "value": "string"
107 }
108 ]
109 },
110 "leaseReconciliationPeriods": [
111 {
112 "createdBy": "string",
113 "lastModifiedBy": "string",
114 "createdDate": "2019-08-24T14:15:22Z",
115 "lastModifiedDate": "2019-08-24T14:15:22Z",
116 "archived": true,
117 "externalId": "string",
118 "id": 0,
119 "startDate": "2019-08-24",
120 "endDate": "2019-08-24",
121 "statusId": 0,
122 "invoiceAmount": 0,
123 "receivedDate": "2019-08-24",
124 "acceptedAmount": 0,
125 "reviewedBy": "string",
126 "reviewedDate": "2019-08-24",
127 "fullReconciliation": true,
128 "status": {
129 "createdBy": "string",
130 "lastModifiedBy": "string",
131 "createdDate": "2019-08-24T14:15:22Z",
132 "lastModifiedDate": "2019-08-24T14:15:22Z",
133 "archived": true,
134 "externalId": "string",
135 "id": 0,
136 "priority": 0,
137 "internalId": 0,
138 "pickListCode": "string",
139 "pickListLabel": "string",
140 "label": "string",
141 "cultureId": 0,
142 "labelDtos": [
143 {
144 "createdBy": "string",
145 "lastModifiedBy": "string",
146 "createdDate": "2019-08-24T14:15:22Z",
147 "lastModifiedDate": "2019-08-24T14:15:22Z",
148 "archived": true,
149 "externalId": "string",
150 "id": 0,
151 "cultureId": 0,
152 "value": "string"
153 }
154 ]
155 },
156 "operatingCostPeriodId": 0,
157 "reconciledExpenseCategoryDtos": [
158 {
159 "createdBy": "string",
160 "lastModifiedBy": "string",
161 "createdDate": "2019-08-24T14:15:22Z",
162 "lastModifiedDate": "2019-08-24T14:15:22Z",
163 "archived": true,
164 "externalId": "string",
165 "id": 0,
166 "expenseGroupId": 0,
167 "totalCost": 0,
168 "accrualAmount": 0,
169 "balance": 0,
170 "expenseGroup": {
171 "createdBy": "string",
172 "lastModifiedBy": "string",
173 "createdDate": "2019-08-24T14:15:22Z",
174 "lastModifiedDate": "2019-08-24T14:15:22Z",
175 "archived": true,
176 "externalId": "string",
177 "id": 0,
178 "priority": 0,
179 "internalId": 0,
180 "pickListCode": "string",
181 "pickListLabel": "string",
182 "label": "string",
183 "cultureId": 0,
184 "labelDtos": [
185 {
186 "createdBy": "string",
187 "lastModifiedBy": "string",
188 "createdDate": "2019-08-24T14:15:22Z",
189 "lastModifiedDate": "2019-08-24T14:15:22Z",
190 "archived": true,
191 "externalId": "string",
192 "id": 0,
193 "cultureId": 0,
194 "value": "string"
195 }
196 ]
197 },
198 "reconciledExpenseDtos": [
199 {
200 "createdBy": "string",
201 "lastModifiedBy": "string",
202 "createdDate": "2019-08-24T14:15:22Z",
203 "lastModifiedDate": "2019-08-24T14:15:22Z",
204 "archived": true,
205 "externalId": "string",
206 "id": 0,
207 "totalCost": 0,
208 "operatingCostExpenseTypeId": 0,
209 "operatingCostExpenseType": {
210 "createdBy": "string",
211 "lastModifiedBy": "string",
212 "createdDate": "2019-08-24T14:15:22Z",
213 "lastModifiedDate": "2019-08-24T14:15:22Z",
214 "archived": true,
215 "externalId": "string",
216 "id": 0,
217 "priority": 0,
218 "internalId": 0,
219 "pickListCode": "string",
220 "pickListLabel": "string",
221 "label": "string",
222 "cultureId": 0,
223 "labelDtos": [
224 {
225 "createdBy": "string",
226 "lastModifiedBy": "string",
227 "createdDate": "2019-08-24T14:15:22Z",
228 "lastModifiedDate": "2019-08-24T14:15:22Z",
229 "archived": true,
230 "externalId": "string",
231 "id": 0,
232 "cultureId": 0,
233 "value": "string"
234 }
235 ]
236 },
237 "reconciledExpenseSegmentDtos": [
238 {
239 "createdBy": "string",
240 "lastModifiedBy": "string",
241 "createdDate": "2019-08-24T14:15:22Z",
242 "lastModifiedDate": "2019-08-24T14:15:22Z",
243 "archived": true,
244 "externalId": "string",
245 "id": 0,
246 "startDate": "2019-08-24",
247 "endDate": "2019-08-24",
248 "adjustedLocationCost": 0,
249 "proSharePercentage": 0,
250 "proShareCost": 0,
251 "cap": 0,
252 "subtotalCost": 0,
253 "adminFees": 0,
254 "totalCost": 0,
255 "conditionDto": {
256 "createdBy": "string",
257 "lastModifiedBy": "string",
258 "createdDate": "2019-08-24T14:15:22Z",
259 "lastModifiedDate": "2019-08-24T14:15:22Z",
260 "archived": true,
261 "externalId": "string",
262 "id": 0,
263 "typeId": 0,
264 "startDate": "2019-08-24",
265 "endDate": "2019-08-24",
266 "replaceById": 0,
267 "managedById": 0,
268 "payById": 0,
269 "adminFee": 0,
270 "fixedIncreasePercentage": 0,
271 "note": "string",
272 "pageNumber": "string",
273 "section": "string",
274 "type": {},
275 "replaceBy": {},
276 "managedBy": {},
277 "payBy": {},
278 "proShareDto": {},
279 "capDto": {}
280 }
281 }
282 ]
283 }
284 ],
285 "hasWarning": true
286 }
287 ]
288 }
289 ]
290}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "createdBy": "string",
3 "lastModifiedBy": "string",
4 "createdDate": "2019-08-24T14:15:22Z",
5 "lastModifiedDate": "2019-08-24T14:15:22Z",
6 "archived": true,
7 "externalId": "string",
8 "id": 0,
9 "year": 1950,
10 "statusId": 0,
11 "expenses": [
12 {
13 "createdBy": "string",
14 "lastModifiedBy": "string",
15 "createdDate": "2019-08-24T14:15:22Z",
16 "lastModifiedDate": "2019-08-24T14:15:22Z",
17 "archived": true,
18 "externalId": "string",
19 "id": 0,
20 "operatingCostExpenseTypeId": 0,
21 "amount": 0,
22 "revisedAmount": 0,
23 "considerRevisedAmount": true,
24 "operatingCostExpenseType": {
25 "createdBy": "string",
26 "lastModifiedBy": "string",
27 "createdDate": "2019-08-24T14:15:22Z",
28 "lastModifiedDate": "2019-08-24T14:15:22Z",
29 "archived": true,
30 "externalId": "string",
31 "id": 0,
32 "priority": 0,
33 "internalId": 0,
34 "pickListCode": "string",
35 "pickListLabel": "string",
36 "label": "string",
37 "cultureId": 0,
38 "labelDtos": [
39 {
40 "createdBy": "string",
41 "lastModifiedBy": "string",
42 "createdDate": "2019-08-24T14:15:22Z",
43 "lastModifiedDate": "2019-08-24T14:15:22Z",
44 "archived": true,
45 "externalId": "string",
46 "id": 0,
47 "cultureId": 0,
48 "value": "string"
49 }
50 ]
51 },
52 "expenseGroup": {
53 "createdBy": "string",
54 "lastModifiedBy": "string",
55 "createdDate": "2019-08-24T14:15:22Z",
56 "lastModifiedDate": "2019-08-24T14:15:22Z",
57 "archived": true,
58 "externalId": "string",
59 "id": 0,
60 "priority": 0,
61 "internalId": 0,
62 "pickListCode": "string",
63 "pickListLabel": "string",
64 "label": "string",
65 "cultureId": 0,
66 "labelDtos": [
67 {
68 "createdBy": "string",
69 "lastModifiedBy": "string",
70 "createdDate": "2019-08-24T14:15:22Z",
71 "lastModifiedDate": "2019-08-24T14:15:22Z",
72 "archived": true,
73 "externalId": "string",
74 "id": 0,
75 "cultureId": 0,
76 "value": "string"
77 }
78 ]
79 }
80 }
81 ],
82 "status": {
83 "createdBy": "string",
84 "lastModifiedBy": "string",
85 "createdDate": "2019-08-24T14:15:22Z",
86 "lastModifiedDate": "2019-08-24T14:15:22Z",
87 "archived": true,
88 "externalId": "string",
89 "id": 0,
90 "priority": 0,
91 "internalId": 0,
92 "pickListCode": "string",
93 "pickListLabel": "string",
94 "label": "string",
95 "cultureId": 0,
96 "labelDtos": [
97 {
98 "createdBy": "string",
99 "lastModifiedBy": "string",
100 "createdDate": "2019-08-24T14:15:22Z",
101 "lastModifiedDate": "2019-08-24T14:15:22Z",
102 "archived": true,
103 "externalId": "string",
104 "id": 0,
105 "cultureId": 0,
106 "value": "string"
107 }
108 ]
109 },
110 "leaseReconciliationPeriods": [
111 {
112 "createdBy": "string",
113 "lastModifiedBy": "string",
114 "createdDate": "2019-08-24T14:15:22Z",
115 "lastModifiedDate": "2019-08-24T14:15:22Z",
116 "archived": true,
117 "externalId": "string",
118 "id": 0,
119 "startDate": "2019-08-24",
120 "endDate": "2019-08-24",
121 "statusId": 0,
122 "invoiceAmount": 0,
123 "receivedDate": "2019-08-24",
124 "acceptedAmount": 0,
125 "reviewedBy": "string",
126 "reviewedDate": "2019-08-24",
127 "fullReconciliation": true,
128 "status": {
129 "createdBy": "string",
130 "lastModifiedBy": "string",
131 "createdDate": "2019-08-24T14:15:22Z",
132 "lastModifiedDate": "2019-08-24T14:15:22Z",
133 "archived": true,
134 "externalId": "string",
135 "id": 0,
136 "priority": 0,
137 "internalId": 0,
138 "pickListCode": "string",
139 "pickListLabel": "string",
140 "label": "string",
141 "cultureId": 0,
142 "labelDtos": [
143 {
144 "createdBy": "string",
145 "lastModifiedBy": "string",
146 "createdDate": "2019-08-24T14:15:22Z",
147 "lastModifiedDate": "2019-08-24T14:15:22Z",
148 "archived": true,
149 "externalId": "string",
150 "id": 0,
151 "cultureId": 0,
152 "value": "string"
153 }
154 ]
155 },
156 "operatingCostPeriodId": 0,
157 "reconciledExpenseCategoryDtos": [
158 {
159 "createdBy": "string",
160 "lastModifiedBy": "string",
161 "createdDate": "2019-08-24T14:15:22Z",
162 "lastModifiedDate": "2019-08-24T14:15:22Z",
163 "archived": true,
164 "externalId": "string",
165 "id": 0,
166 "expenseGroupId": 0,
167 "totalCost": 0,
168 "accrualAmount": 0,
169 "balance": 0,
170 "expenseGroup": {
171 "createdBy": "string",
172 "lastModifiedBy": "string",
173 "createdDate": "2019-08-24T14:15:22Z",
174 "lastModifiedDate": "2019-08-24T14:15:22Z",
175 "archived": true,
176 "externalId": "string",
177 "id": 0,
178 "priority": 0,
179 "internalId": 0,
180 "pickListCode": "string",
181 "pickListLabel": "string",
182 "label": "string",
183 "cultureId": 0,
184 "labelDtos": [
185 {
186 "createdBy": "string",
187 "lastModifiedBy": "string",
188 "createdDate": "2019-08-24T14:15:22Z",
189 "lastModifiedDate": "2019-08-24T14:15:22Z",
190 "archived": true,
191 "externalId": "string",
192 "id": 0,
193 "cultureId": 0,
194 "value": "string"
195 }
196 ]
197 },
198 "reconciledExpenseDtos": [
199 {
200 "createdBy": "string",
201 "lastModifiedBy": "string",
202 "createdDate": "2019-08-24T14:15:22Z",
203 "lastModifiedDate": "2019-08-24T14:15:22Z",
204 "archived": true,
205 "externalId": "string",
206 "id": 0,
207 "totalCost": 0,
208 "operatingCostExpenseTypeId": 0,
209 "operatingCostExpenseType": {
210 "createdBy": "string",
211 "lastModifiedBy": "string",
212 "createdDate": "2019-08-24T14:15:22Z",
213 "lastModifiedDate": "2019-08-24T14:15:22Z",
214 "archived": true,
215 "externalId": "string",
216 "id": 0,
217 "priority": 0,
218 "internalId": 0,
219 "pickListCode": "string",
220 "pickListLabel": "string",
221 "label": "string",
222 "cultureId": 0,
223 "labelDtos": [
224 {
225 "createdBy": "string",
226 "lastModifiedBy": "string",
227 "createdDate": "2019-08-24T14:15:22Z",
228 "lastModifiedDate": "2019-08-24T14:15:22Z",
229 "archived": true,
230 "externalId": "string",
231 "id": 0,
232 "cultureId": 0,
233 "value": "string"
234 }
235 ]
236 },
237 "reconciledExpenseSegmentDtos": [
238 {
239 "createdBy": "string",
240 "lastModifiedBy": "string",
241 "createdDate": "2019-08-24T14:15:22Z",
242 "lastModifiedDate": "2019-08-24T14:15:22Z",
243 "archived": true,
244 "externalId": "string",
245 "id": 0,
246 "startDate": "2019-08-24",
247 "endDate": "2019-08-24",
248 "adjustedLocationCost": 0,
249 "proSharePercentage": 0,
250 "proShareCost": 0,
251 "cap": 0,
252 "subtotalCost": 0,
253 "adminFees": 0,
254 "totalCost": 0,
255 "conditionDto": {
256 "createdBy": "string",
257 "lastModifiedBy": "string",
258 "createdDate": "2019-08-24T14:15:22Z",
259 "lastModifiedDate": "2019-08-24T14:15:22Z",
260 "archived": true,
261 "externalId": "string",
262 "id": 0,
263 "typeId": 0,
264 "startDate": "2019-08-24",
265 "endDate": "2019-08-24",
266 "replaceById": 0,
267 "managedById": 0,
268 "payById": 0,
269 "adminFee": 0,
270 "fixedIncreasePercentage": 0,
271 "note": "string",
272 "pageNumber": "string",
273 "section": "string",
274 "type": {},
275 "replaceBy": {},
276 "managedBy": {},
277 "payBy": {},
278 "proShareDto": {},
279 "capDto": {}
280 }
281 }
282 ]
283 }
284 ],
285 "hasWarning": true
286 }
287 ]
288 }
289 ]
290}
Get Location¶
HTTP Request
GET /api/locations/{id}
📋 Description: Retrieves detailed information about a specific location within the Nakisa Portfolio Management Suite, enabling users to analyze portfolio and asset data related to real estate properties.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "createdBy": "string",
3 "lastModifiedBy": "string",
4 "createdDate": "2019-08-24T14:15:22Z",
5 "lastModifiedDate": "2019-08-24T14:15:22Z",
6 "archived": true,
7 "externalId": "string",
8 "id": 0,
9 "number": "string",
10 "name": "string",
11 "storeNumber": "string",
12 "defaultCurrencyId": 0,
13 "defaultMeasureId": 0,
14 "typeId": 0,
15 "qualityId": 0,
16 "propertyTypeId": 0,
17 "categoryId": 0,
18 "statusId": 0,
19 "businessUnitId": 0,
20 "groupIds": [
21 0
22 ],
23 "legalEntityIds": [
24 0
25 ],
26 "defaultCurrency": {
27 "id": 0,
28 "status": "CREATED",
29 "displayId": "string",
30 "erpSystemId": 0,
31 "erpSystemDisplayId": "string",
32 "name": "string",
33 "decimalPoints": 0,
34 "depreciationAreaId": 0
35 },
36 "defaultUnitValue": {
37 "createdBy": "string",
38 "lastModifiedBy": "string",
39 "createdDate": "2019-08-24T14:15:22Z",
40 "lastModifiedDate": "2019-08-24T14:15:22Z",
41 "archived": true,
42 "externalId": "string",
43 "id": 0,
44 "unitId": 0,
45 "unitOfMeasureId": 0,
46 "erpSystemId": 0,
47 "unit": {
48 "createdBy": "string",
49 "lastModifiedBy": "string",
50 "createdDate": "2019-08-24T14:15:22Z",
51 "lastModifiedDate": "2019-08-24T14:15:22Z",
52 "archived": true,
53 "externalId": "string",
54 "id": 0,
55 "priority": 0,
56 "internalId": 0,
57 "pickListCode": "string",
58 "pickListLabel": "string",
59 "label": "string",
60 "cultureId": 0,
61 "labelDtos": [
62 {
63 "createdBy": "string",
64 "lastModifiedBy": "string",
65 "createdDate": "2019-08-24T14:15:22Z",
66 "lastModifiedDate": "2019-08-24T14:15:22Z",
67 "archived": true,
68 "externalId": "string",
69 "id": 0,
70 "cultureId": 0,
71 "value": "string"
72 }
73 ]
74 },
75 "unitOfMeasure": {
76 "id": 0,
77 "status": "CREATED",
78 "displayId": "string",
79 "erpSystemId": 0,
80 "erpSystemDisplayId": "string",
81 "name": "string"
82 }
83 },
84 "type": {
85 "createdBy": "string",
86 "lastModifiedBy": "string",
87 "createdDate": "2019-08-24T14:15:22Z",
88 "lastModifiedDate": "2019-08-24T14:15:22Z",
89 "archived": true,
90 "externalId": "string",
91 "id": 0,
92 "priority": 0,
93 "internalId": 0,
94 "pickListCode": "string",
95 "pickListLabel": "string",
96 "label": "string",
97 "cultureId": 0,
98 "labelDtos": [
99 {
100 "createdBy": "string",
101 "lastModifiedBy": "string",
102 "createdDate": "2019-08-24T14:15:22Z",
103 "lastModifiedDate": "2019-08-24T14:15:22Z",
104 "archived": true,
105 "externalId": "string",
106 "id": 0,
107 "cultureId": 0,
108 "value": "string"
109 }
110 ]
111 },
112 "quality": {
113 "createdBy": "string",
114 "lastModifiedBy": "string",
115 "createdDate": "2019-08-24T14:15:22Z",
116 "lastModifiedDate": "2019-08-24T14:15:22Z",
117 "archived": true,
118 "externalId": "string",
119 "id": 0,
120 "priority": 0,
121 "internalId": 0,
122 "pickListCode": "string",
123 "pickListLabel": "string",
124 "label": "string",
125 "cultureId": 0,
126 "labelDtos": [
127 {
128 "createdBy": "string",
129 "lastModifiedBy": "string",
130 "createdDate": "2019-08-24T14:15:22Z",
131 "lastModifiedDate": "2019-08-24T14:15:22Z",
132 "archived": true,
133 "externalId": "string",
134 "id": 0,
135 "cultureId": 0,
136 "value": "string"
137 }
138 ]
139 },
140 "propertyType": {
141 "createdBy": "string",
142 "lastModifiedBy": "string",
143 "createdDate": "2019-08-24T14:15:22Z",
144 "lastModifiedDate": "2019-08-24T14:15:22Z",
145 "archived": true,
146 "externalId": "string",
147 "id": 0,
148 "priority": 0,
149 "internalId": 0,
150 "pickListCode": "string",
151 "pickListLabel": "string",
152 "label": "string",
153 "cultureId": 0,
154 "labelDtos": [
155 {
156 "createdBy": "string",
157 "lastModifiedBy": "string",
158 "createdDate": "2019-08-24T14:15:22Z",
159 "lastModifiedDate": "2019-08-24T14:15:22Z",
160 "archived": true,
161 "externalId": "string",
162 "id": 0,
163 "cultureId": 0,
164 "value": "string"
165 }
166 ]
167 },
168 "category": {
169 "createdBy": "string",
170 "lastModifiedBy": "string",
171 "createdDate": "2019-08-24T14:15:22Z",
172 "lastModifiedDate": "2019-08-24T14:15:22Z",
173 "archived": true,
174 "externalId": "string",
175 "id": 0,
176 "priority": 0,
177 "internalId": 0,
178 "pickListCode": "string",
179 "pickListLabel": "string",
180 "label": "string",
181 "cultureId": 0,
182 "labelDtos": [
183 {
184 "createdBy": "string",
185 "lastModifiedBy": "string",
186 "createdDate": "2019-08-24T14:15:22Z",
187 "lastModifiedDate": "2019-08-24T14:15:22Z",
188 "archived": true,
189 "externalId": "string",
190 "id": 0,
191 "cultureId": 0,
192 "value": "string"
193 }
194 ]
195 },
196 "status": {
197 "createdBy": "string",
198 "lastModifiedBy": "string",
199 "createdDate": "2019-08-24T14:15:22Z",
200 "lastModifiedDate": "2019-08-24T14:15:22Z",
201 "archived": true,
202 "externalId": "string",
203 "id": 0,
204 "priority": 0,
205 "internalId": 0,
206 "pickListCode": "string",
207 "pickListLabel": "string",
208 "label": "string",
209 "cultureId": 0,
210 "labelDtos": [
211 {
212 "createdBy": "string",
213 "lastModifiedBy": "string",
214 "createdDate": "2019-08-24T14:15:22Z",
215 "lastModifiedDate": "2019-08-24T14:15:22Z",
216 "archived": true,
217 "externalId": "string",
218 "id": 0,
219 "cultureId": 0,
220 "value": "string"
221 }
222 ]
223 },
224 "addressDto": {
225 "createdBy": "string",
226 "lastModifiedBy": "string",
227 "createdDate": "2019-08-24T14:15:22Z",
228 "lastModifiedDate": "2019-08-24T14:15:22Z",
229 "archived": true,
230 "externalId": "string",
231 "id": 0,
232 "street": "string",
233 "civicNumber": "string",
234 "suite": "string",
235 "postalCode": "string",
236 "lon": 0.1,
237 "lat": 0.1,
238 "city": {
239 "createdBy": "string",
240 "lastModifiedBy": "string",
241 "createdDate": "2019-08-24T14:15:22Z",
242 "lastModifiedDate": "2019-08-24T14:15:22Z",
243 "archived": true,
244 "externalId": "string",
245 "id": 0,
246 "name": "string",
247 "province": {
248 "createdBy": "string",
249 "lastModifiedBy": "string",
250 "createdDate": "2019-08-24T14:15:22Z",
251 "lastModifiedDate": "2019-08-24T14:15:22Z",
252 "archived": true,
253 "externalId": "string",
254 "id": 0,
255 "name": "string",
256 "code": "string",
257 "country": {
258 "createdBy": "string",
259 "lastModifiedBy": "string",
260 "createdDate": "2019-08-24T14:15:22Z",
261 "lastModifiedDate": "2019-08-24T14:15:22Z",
262 "archived": true,
263 "externalId": "string",
264 "id": 0,
265 "name": "string",
266 "code": "string"
267 }
268 }
269 },
270 "district": {
271 "createdBy": "string",
272 "lastModifiedBy": "string",
273 "createdDate": "2019-08-24T14:15:22Z",
274 "lastModifiedDate": "2019-08-24T14:15:22Z",
275 "archived": true,
276 "externalId": "string",
277 "id": 0,
278 "name": "string",
279 "city": {
280 "createdBy": "string",
281 "lastModifiedBy": "string",
282 "createdDate": "2019-08-24T14:15:22Z",
283 "lastModifiedDate": "2019-08-24T14:15:22Z",
284 "archived": true,
285 "externalId": "string",
286 "id": 0,
287 "name": "string",
288 "province": {
289 "createdBy": "string",
290 "lastModifiedBy": "string",
291 "createdDate": "2019-08-24T14:15:22Z",
292 "lastModifiedDate": "2019-08-24T14:15:22Z",
293 "archived": true,
294 "externalId": "string",
295 "id": 0,
296 "name": "string",
297 "code": "string",
298 "country": {
299 "createdBy": "string",
300 "lastModifiedBy": "string",
301 "createdDate": "2019-08-24T14:15:22Z",
302 "lastModifiedDate": "2019-08-24T14:15:22Z",
303 "archived": true,
304 "externalId": "string",
305 "id": 0,
306 "name": "string",
307 "code": "string"
308 }
309 }
310 }
311 },
312 "cityId": 0,
313 "districtId": 0
314 },
315 "secondAddressDto": {
316 "createdBy": "string",
317 "lastModifiedBy": "string",
318 "createdDate": "2019-08-24T14:15:22Z",
319 "lastModifiedDate": "2019-08-24T14:15:22Z",
320 "archived": true,
321 "externalId": "string",
322 "id": 0,
323 "street": "string",
324 "civicNumber": "string",
325 "suite": "string",
326 "postalCode": "string",
327 "lon": 0.1,
328 "lat": 0.1,
329 "city": {
330 "createdBy": "string",
331 "lastModifiedBy": "string",
332 "createdDate": "2019-08-24T14:15:22Z",
333 "lastModifiedDate": "2019-08-24T14:15:22Z",
334 "archived": true,
335 "externalId": "string",
336 "id": 0,
337 "name": "string",
338 "province": {
339 "createdBy": "string",
340 "lastModifiedBy": "string",
341 "createdDate": "2019-08-24T14:15:22Z",
342 "lastModifiedDate": "2019-08-24T14:15:22Z",
343 "archived": true,
344 "externalId": "string",
345 "id": 0,
346 "name": "string",
347 "code": "string",
348 "country": {
349 "createdBy": "string",
350 "lastModifiedBy": "string",
351 "createdDate": "2019-08-24T14:15:22Z",
352 "lastModifiedDate": "2019-08-24T14:15:22Z",
353 "archived": true,
354 "externalId": "string",
355 "id": 0,
356 "name": "string",
357 "code": "string"
358 }
359 }
360 },
361 "district": {
362 "createdBy": "string",
363 "lastModifiedBy": "string",
364 "createdDate": "2019-08-24T14:15:22Z",
365 "lastModifiedDate": "2019-08-24T14:15:22Z",
366 "archived": true,
367 "externalId": "string",
368 "id": 0,
369 "name": "string",
370 "city": {
371 "createdBy": "string",
372 "lastModifiedBy": "string",
373 "createdDate": "2019-08-24T14:15:22Z",
374 "lastModifiedDate": "2019-08-24T14:15:22Z",
375 "archived": true,
376 "externalId": "string",
377 "id": 0,
378 "name": "string",
379 "province": {
380 "createdBy": "string",
381 "lastModifiedBy": "string",
382 "createdDate": "2019-08-24T14:15:22Z",
383 "lastModifiedDate": "2019-08-24T14:15:22Z",
384 "archived": true,
385 "externalId": "string",
386 "id": 0,
387 "name": "string",
388 "code": "string",
389 "country": {
390 "createdBy": "string",
391 "lastModifiedBy": "string",
392 "createdDate": "2019-08-24T14:15:22Z",
393 "lastModifiedDate": "2019-08-24T14:15:22Z",
394 "archived": true,
395 "externalId": "string",
396 "id": 0,
397 "name": "string",
398 "code": "string"
399 }
400 }
401 }
402 },
403 "cityId": 0,
404 "districtId": 0
405 }
406}
Update Location¶
HTTP Request
PUT /api/locations/{id}
📋 Description: Updates the details of a specified location within the Nakisa Portfolio Management Suite, enabling users to maintain accurate information related to portfolio assets and real estate properties.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing updated location details, including address, asset allocation, and portfolio assignment, to enhance real estate property management within the Nakisa Portfolio Management Suite. |
Body Parameters
1{
2 "createdBy": "string",
3 "lastModifiedBy": "string",
4 "createdDate": "2019-08-24T14:15:22Z",
5 "lastModifiedDate": "2019-08-24T14:15:22Z",
6 "archived": true,
7 "externalId": "string",
8 "id": 0,
9 "number": "string",
10 "name": "string",
11 "storeNumber": "string",
12 "defaultCurrencyId": 0,
13 "defaultMeasureId": 0,
14 "typeId": 0,
15 "qualityId": 0,
16 "propertyTypeId": 0,
17 "categoryId": 0,
18 "statusId": 0,
19 "businessUnitId": 0,
20 "groupIds": [
21 0
22 ],
23 "legalEntityIds": [
24 0
25 ],
26 "defaultCurrency": {
27 "id": 0,
28 "status": "CREATED",
29 "displayId": "string",
30 "erpSystemId": 0,
31 "erpSystemDisplayId": "string",
32 "name": "string",
33 "decimalPoints": 0,
34 "depreciationAreaId": 0
35 },
36 "defaultUnitValue": {
37 "createdBy": "string",
38 "lastModifiedBy": "string",
39 "createdDate": "2019-08-24T14:15:22Z",
40 "lastModifiedDate": "2019-08-24T14:15:22Z",
41 "archived": true,
42 "externalId": "string",
43 "id": 0,
44 "unitId": 0,
45 "unitOfMeasureId": 0,
46 "erpSystemId": 0,
47 "unit": {
48 "createdBy": "string",
49 "lastModifiedBy": "string",
50 "createdDate": "2019-08-24T14:15:22Z",
51 "lastModifiedDate": "2019-08-24T14:15:22Z",
52 "archived": true,
53 "externalId": "string",
54 "id": 0,
55 "priority": 0,
56 "internalId": 0,
57 "pickListCode": "string",
58 "pickListLabel": "string",
59 "label": "string",
60 "cultureId": 0,
61 "labelDtos": [
62 {
63 "createdBy": "string",
64 "lastModifiedBy": "string",
65 "createdDate": "2019-08-24T14:15:22Z",
66 "lastModifiedDate": "2019-08-24T14:15:22Z",
67 "archived": true,
68 "externalId": "string",
69 "id": 0,
70 "cultureId": 0,
71 "value": "string"
72 }
73 ]
74 },
75 "unitOfMeasure": {
76 "id": 0,
77 "status": "CREATED",
78 "displayId": "string",
79 "erpSystemId": 0,
80 "erpSystemDisplayId": "string",
81 "name": "string"
82 }
83 },
84 "type": {
85 "createdBy": "string",
86 "lastModifiedBy": "string",
87 "createdDate": "2019-08-24T14:15:22Z",
88 "lastModifiedDate": "2019-08-24T14:15:22Z",
89 "archived": true,
90 "externalId": "string",
91 "id": 0,
92 "priority": 0,
93 "internalId": 0,
94 "pickListCode": "string",
95 "pickListLabel": "string",
96 "label": "string",
97 "cultureId": 0,
98 "labelDtos": [
99 {
100 "createdBy": "string",
101 "lastModifiedBy": "string",
102 "createdDate": "2019-08-24T14:15:22Z",
103 "lastModifiedDate": "2019-08-24T14:15:22Z",
104 "archived": true,
105 "externalId": "string",
106 "id": 0,
107 "cultureId": 0,
108 "value": "string"
109 }
110 ]
111 },
112 "quality": {
113 "createdBy": "string",
114 "lastModifiedBy": "string",
115 "createdDate": "2019-08-24T14:15:22Z",
116 "lastModifiedDate": "2019-08-24T14:15:22Z",
117 "archived": true,
118 "externalId": "string",
119 "id": 0,
120 "priority": 0,
121 "internalId": 0,
122 "pickListCode": "string",
123 "pickListLabel": "string",
124 "label": "string",
125 "cultureId": 0,
126 "labelDtos": [
127 {
128 "createdBy": "string",
129 "lastModifiedBy": "string",
130 "createdDate": "2019-08-24T14:15:22Z",
131 "lastModifiedDate": "2019-08-24T14:15:22Z",
132 "archived": true,
133 "externalId": "string",
134 "id": 0,
135 "cultureId": 0,
136 "value": "string"
137 }
138 ]
139 },
140 "propertyType": {
141 "createdBy": "string",
142 "lastModifiedBy": "string",
143 "createdDate": "2019-08-24T14:15:22Z",
144 "lastModifiedDate": "2019-08-24T14:15:22Z",
145 "archived": true,
146 "externalId": "string",
147 "id": 0,
148 "priority": 0,
149 "internalId": 0,
150 "pickListCode": "string",
151 "pickListLabel": "string",
152 "label": "string",
153 "cultureId": 0,
154 "labelDtos": [
155 {
156 "createdBy": "string",
157 "lastModifiedBy": "string",
158 "createdDate": "2019-08-24T14:15:22Z",
159 "lastModifiedDate": "2019-08-24T14:15:22Z",
160 "archived": true,
161 "externalId": "string",
162 "id": 0,
163 "cultureId": 0,
164 "value": "string"
165 }
166 ]
167 },
168 "category": {
169 "createdBy": "string",
170 "lastModifiedBy": "string",
171 "createdDate": "2019-08-24T14:15:22Z",
172 "lastModifiedDate": "2019-08-24T14:15:22Z",
173 "archived": true,
174 "externalId": "string",
175 "id": 0,
176 "priority": 0,
177 "internalId": 0,
178 "pickListCode": "string",
179 "pickListLabel": "string",
180 "label": "string",
181 "cultureId": 0,
182 "labelDtos": [
183 {
184 "createdBy": "string",
185 "lastModifiedBy": "string",
186 "createdDate": "2019-08-24T14:15:22Z",
187 "lastModifiedDate": "2019-08-24T14:15:22Z",
188 "archived": true,
189 "externalId": "string",
190 "id": 0,
191 "cultureId": 0,
192 "value": "string"
193 }
194 ]
195 },
196 "status": {
197 "createdBy": "string",
198 "lastModifiedBy": "string",
199 "createdDate": "2019-08-24T14:15:22Z",
200 "lastModifiedDate": "2019-08-24T14:15:22Z",
201 "archived": true,
202 "externalId": "string",
203 "id": 0,
204 "priority": 0,
205 "internalId": 0,
206 "pickListCode": "string",
207 "pickListLabel": "string",
208 "label": "string",
209 "cultureId": 0,
210 "labelDtos": [
211 {
212 "createdBy": "string",
213 "lastModifiedBy": "string",
214 "createdDate": "2019-08-24T14:15:22Z",
215 "lastModifiedDate": "2019-08-24T14:15:22Z",
216 "archived": true,
217 "externalId": "string",
218 "id": 0,
219 "cultureId": 0,
220 "value": "string"
221 }
222 ]
223 },
224 "addressDto": {
225 "createdBy": "string",
226 "lastModifiedBy": "string",
227 "createdDate": "2019-08-24T14:15:22Z",
228 "lastModifiedDate": "2019-08-24T14:15:22Z",
229 "archived": true,
230 "externalId": "string",
231 "id": 0,
232 "street": "string",
233 "civicNumber": "string",
234 "suite": "string",
235 "postalCode": "string",
236 "lon": 0.1,
237 "lat": 0.1,
238 "city": {
239 "createdBy": "string",
240 "lastModifiedBy": "string",
241 "createdDate": "2019-08-24T14:15:22Z",
242 "lastModifiedDate": "2019-08-24T14:15:22Z",
243 "archived": true,
244 "externalId": "string",
245 "id": 0,
246 "name": "string",
247 "province": {
248 "createdBy": "string",
249 "lastModifiedBy": "string",
250 "createdDate": "2019-08-24T14:15:22Z",
251 "lastModifiedDate": "2019-08-24T14:15:22Z",
252 "archived": true,
253 "externalId": "string",
254 "id": 0,
255 "name": "string",
256 "code": "string",
257 "country": {
258 "createdBy": "string",
259 "lastModifiedBy": "string",
260 "createdDate": "2019-08-24T14:15:22Z",
261 "lastModifiedDate": "2019-08-24T14:15:22Z",
262 "archived": true,
263 "externalId": "string",
264 "id": 0,
265 "name": "string",
266 "code": "string"
267 }
268 }
269 },
270 "district": {
271 "createdBy": "string",
272 "lastModifiedBy": "string",
273 "createdDate": "2019-08-24T14:15:22Z",
274 "lastModifiedDate": "2019-08-24T14:15:22Z",
275 "archived": true,
276 "externalId": "string",
277 "id": 0,
278 "name": "string",
279 "city": {
280 "createdBy": "string",
281 "lastModifiedBy": "string",
282 "createdDate": "2019-08-24T14:15:22Z",
283 "lastModifiedDate": "2019-08-24T14:15:22Z",
284 "archived": true,
285 "externalId": "string",
286 "id": 0,
287 "name": "string",
288 "province": {
289 "createdBy": "string",
290 "lastModifiedBy": "string",
291 "createdDate": "2019-08-24T14:15:22Z",
292 "lastModifiedDate": "2019-08-24T14:15:22Z",
293 "archived": true,
294 "externalId": "string",
295 "id": 0,
296 "name": "string",
297 "code": "string",
298 "country": {
299 "createdBy": "string",
300 "lastModifiedBy": "string",
301 "createdDate": "2019-08-24T14:15:22Z",
302 "lastModifiedDate": "2019-08-24T14:15:22Z",
303 "archived": true,
304 "externalId": "string",
305 "id": 0,
306 "name": "string",
307 "code": "string"
308 }
309 }
310 }
311 },
312 "cityId": 0,
313 "districtId": 0
314 },
315 "secondAddressDto": {
316 "createdBy": "string",
317 "lastModifiedBy": "string",
318 "createdDate": "2019-08-24T14:15:22Z",
319 "lastModifiedDate": "2019-08-24T14:15:22Z",
320 "archived": true,
321 "externalId": "string",
322 "id": 0,
323 "street": "string",
324 "civicNumber": "string",
325 "suite": "string",
326 "postalCode": "string",
327 "lon": 0.1,
328 "lat": 0.1,
329 "city": {
330 "createdBy": "string",
331 "lastModifiedBy": "string",
332 "createdDate": "2019-08-24T14:15:22Z",
333 "lastModifiedDate": "2019-08-24T14:15:22Z",
334 "archived": true,
335 "externalId": "string",
336 "id": 0,
337 "name": "string",
338 "province": {
339 "createdBy": "string",
340 "lastModifiedBy": "string",
341 "createdDate": "2019-08-24T14:15:22Z",
342 "lastModifiedDate": "2019-08-24T14:15:22Z",
343 "archived": true,
344 "externalId": "string",
345 "id": 0,
346 "name": "string",
347 "code": "string",
348 "country": {
349 "createdBy": "string",
350 "lastModifiedBy": "string",
351 "createdDate": "2019-08-24T14:15:22Z",
352 "lastModifiedDate": "2019-08-24T14:15:22Z",
353 "archived": true,
354 "externalId": "string",
355 "id": 0,
356 "name": "string",
357 "code": "string"
358 }
359 }
360 },
361 "district": {
362 "createdBy": "string",
363 "lastModifiedBy": "string",
364 "createdDate": "2019-08-24T14:15:22Z",
365 "lastModifiedDate": "2019-08-24T14:15:22Z",
366 "archived": true,
367 "externalId": "string",
368 "id": 0,
369 "name": "string",
370 "city": {
371 "createdBy": "string",
372 "lastModifiedBy": "string",
373 "createdDate": "2019-08-24T14:15:22Z",
374 "lastModifiedDate": "2019-08-24T14:15:22Z",
375 "archived": true,
376 "externalId": "string",
377 "id": 0,
378 "name": "string",
379 "province": {
380 "createdBy": "string",
381 "lastModifiedBy": "string",
382 "createdDate": "2019-08-24T14:15:22Z",
383 "lastModifiedDate": "2019-08-24T14:15:22Z",
384 "archived": true,
385 "externalId": "string",
386 "id": 0,
387 "name": "string",
388 "code": "string",
389 "country": {
390 "createdBy": "string",
391 "lastModifiedBy": "string",
392 "createdDate": "2019-08-24T14:15:22Z",
393 "lastModifiedDate": "2019-08-24T14:15:22Z",
394 "archived": true,
395 "externalId": "string",
396 "id": 0,
397 "name": "string",
398 "code": "string"
399 }
400 }
401 }
402 },
403 "cityId": 0,
404 "districtId": 0
405 }
406}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "createdBy": "string",
3 "lastModifiedBy": "string",
4 "createdDate": "2019-08-24T14:15:22Z",
5 "lastModifiedDate": "2019-08-24T14:15:22Z",
6 "archived": true,
7 "externalId": "string",
8 "id": 0,
9 "number": "string",
10 "name": "string",
11 "storeNumber": "string",
12 "defaultCurrencyId": 0,
13 "defaultMeasureId": 0,
14 "typeId": 0,
15 "qualityId": 0,
16 "propertyTypeId": 0,
17 "categoryId": 0,
18 "statusId": 0,
19 "businessUnitId": 0,
20 "groupIds": [
21 0
22 ],
23 "legalEntityIds": [
24 0
25 ],
26 "defaultCurrency": {
27 "id": 0,
28 "status": "CREATED",
29 "displayId": "string",
30 "erpSystemId": 0,
31 "erpSystemDisplayId": "string",
32 "name": "string",
33 "decimalPoints": 0,
34 "depreciationAreaId": 0
35 },
36 "defaultUnitValue": {
37 "createdBy": "string",
38 "lastModifiedBy": "string",
39 "createdDate": "2019-08-24T14:15:22Z",
40 "lastModifiedDate": "2019-08-24T14:15:22Z",
41 "archived": true,
42 "externalId": "string",
43 "id": 0,
44 "unitId": 0,
45 "unitOfMeasureId": 0,
46 "erpSystemId": 0,
47 "unit": {
48 "createdBy": "string",
49 "lastModifiedBy": "string",
50 "createdDate": "2019-08-24T14:15:22Z",
51 "lastModifiedDate": "2019-08-24T14:15:22Z",
52 "archived": true,
53 "externalId": "string",
54 "id": 0,
55 "priority": 0,
56 "internalId": 0,
57 "pickListCode": "string",
58 "pickListLabel": "string",
59 "label": "string",
60 "cultureId": 0,
61 "labelDtos": [
62 {
63 "createdBy": "string",
64 "lastModifiedBy": "string",
65 "createdDate": "2019-08-24T14:15:22Z",
66 "lastModifiedDate": "2019-08-24T14:15:22Z",
67 "archived": true,
68 "externalId": "string",
69 "id": 0,
70 "cultureId": 0,
71 "value": "string"
72 }
73 ]
74 },
75 "unitOfMeasure": {
76 "id": 0,
77 "status": "CREATED",
78 "displayId": "string",
79 "erpSystemId": 0,
80 "erpSystemDisplayId": "string",
81 "name": "string"
82 }
83 },
84 "type": {
85 "createdBy": "string",
86 "lastModifiedBy": "string",
87 "createdDate": "2019-08-24T14:15:22Z",
88 "lastModifiedDate": "2019-08-24T14:15:22Z",
89 "archived": true,
90 "externalId": "string",
91 "id": 0,
92 "priority": 0,
93 "internalId": 0,
94 "pickListCode": "string",
95 "pickListLabel": "string",
96 "label": "string",
97 "cultureId": 0,
98 "labelDtos": [
99 {
100 "createdBy": "string",
101 "lastModifiedBy": "string",
102 "createdDate": "2019-08-24T14:15:22Z",
103 "lastModifiedDate": "2019-08-24T14:15:22Z",
104 "archived": true,
105 "externalId": "string",
106 "id": 0,
107 "cultureId": 0,
108 "value": "string"
109 }
110 ]
111 },
112 "quality": {
113 "createdBy": "string",
114 "lastModifiedBy": "string",
115 "createdDate": "2019-08-24T14:15:22Z",
116 "lastModifiedDate": "2019-08-24T14:15:22Z",
117 "archived": true,
118 "externalId": "string",
119 "id": 0,
120 "priority": 0,
121 "internalId": 0,
122 "pickListCode": "string",
123 "pickListLabel": "string",
124 "label": "string",
125 "cultureId": 0,
126 "labelDtos": [
127 {
128 "createdBy": "string",
129 "lastModifiedBy": "string",
130 "createdDate": "2019-08-24T14:15:22Z",
131 "lastModifiedDate": "2019-08-24T14:15:22Z",
132 "archived": true,
133 "externalId": "string",
134 "id": 0,
135 "cultureId": 0,
136 "value": "string"
137 }
138 ]
139 },
140 "propertyType": {
141 "createdBy": "string",
142 "lastModifiedBy": "string",
143 "createdDate": "2019-08-24T14:15:22Z",
144 "lastModifiedDate": "2019-08-24T14:15:22Z",
145 "archived": true,
146 "externalId": "string",
147 "id": 0,
148 "priority": 0,
149 "internalId": 0,
150 "pickListCode": "string",
151 "pickListLabel": "string",
152 "label": "string",
153 "cultureId": 0,
154 "labelDtos": [
155 {
156 "createdBy": "string",
157 "lastModifiedBy": "string",
158 "createdDate": "2019-08-24T14:15:22Z",
159 "lastModifiedDate": "2019-08-24T14:15:22Z",
160 "archived": true,
161 "externalId": "string",
162 "id": 0,
163 "cultureId": 0,
164 "value": "string"
165 }
166 ]
167 },
168 "category": {
169 "createdBy": "string",
170 "lastModifiedBy": "string",
171 "createdDate": "2019-08-24T14:15:22Z",
172 "lastModifiedDate": "2019-08-24T14:15:22Z",
173 "archived": true,
174 "externalId": "string",
175 "id": 0,
176 "priority": 0,
177 "internalId": 0,
178 "pickListCode": "string",
179 "pickListLabel": "string",
180 "label": "string",
181 "cultureId": 0,
182 "labelDtos": [
183 {
184 "createdBy": "string",
185 "lastModifiedBy": "string",
186 "createdDate": "2019-08-24T14:15:22Z",
187 "lastModifiedDate": "2019-08-24T14:15:22Z",
188 "archived": true,
189 "externalId": "string",
190 "id": 0,
191 "cultureId": 0,
192 "value": "string"
193 }
194 ]
195 },
196 "status": {
197 "createdBy": "string",
198 "lastModifiedBy": "string",
199 "createdDate": "2019-08-24T14:15:22Z",
200 "lastModifiedDate": "2019-08-24T14:15:22Z",
201 "archived": true,
202 "externalId": "string",
203 "id": 0,
204 "priority": 0,
205 "internalId": 0,
206 "pickListCode": "string",
207 "pickListLabel": "string",
208 "label": "string",
209 "cultureId": 0,
210 "labelDtos": [
211 {
212 "createdBy": "string",
213 "lastModifiedBy": "string",
214 "createdDate": "2019-08-24T14:15:22Z",
215 "lastModifiedDate": "2019-08-24T14:15:22Z",
216 "archived": true,
217 "externalId": "string",
218 "id": 0,
219 "cultureId": 0,
220 "value": "string"
221 }
222 ]
223 },
224 "addressDto": {
225 "createdBy": "string",
226 "lastModifiedBy": "string",
227 "createdDate": "2019-08-24T14:15:22Z",
228 "lastModifiedDate": "2019-08-24T14:15:22Z",
229 "archived": true,
230 "externalId": "string",
231 "id": 0,
232 "street": "string",
233 "civicNumber": "string",
234 "suite": "string",
235 "postalCode": "string",
236 "lon": 0.1,
237 "lat": 0.1,
238 "city": {
239 "createdBy": "string",
240 "lastModifiedBy": "string",
241 "createdDate": "2019-08-24T14:15:22Z",
242 "lastModifiedDate": "2019-08-24T14:15:22Z",
243 "archived": true,
244 "externalId": "string",
245 "id": 0,
246 "name": "string",
247 "province": {
248 "createdBy": "string",
249 "lastModifiedBy": "string",
250 "createdDate": "2019-08-24T14:15:22Z",
251 "lastModifiedDate": "2019-08-24T14:15:22Z",
252 "archived": true,
253 "externalId": "string",
254 "id": 0,
255 "name": "string",
256 "code": "string",
257 "country": {
258 "createdBy": "string",
259 "lastModifiedBy": "string",
260 "createdDate": "2019-08-24T14:15:22Z",
261 "lastModifiedDate": "2019-08-24T14:15:22Z",
262 "archived": true,
263 "externalId": "string",
264 "id": 0,
265 "name": "string",
266 "code": "string"
267 }
268 }
269 },
270 "district": {
271 "createdBy": "string",
272 "lastModifiedBy": "string",
273 "createdDate": "2019-08-24T14:15:22Z",
274 "lastModifiedDate": "2019-08-24T14:15:22Z",
275 "archived": true,
276 "externalId": "string",
277 "id": 0,
278 "name": "string",
279 "city": {
280 "createdBy": "string",
281 "lastModifiedBy": "string",
282 "createdDate": "2019-08-24T14:15:22Z",
283 "lastModifiedDate": "2019-08-24T14:15:22Z",
284 "archived": true,
285 "externalId": "string",
286 "id": 0,
287 "name": "string",
288 "province": {
289 "createdBy": "string",
290 "lastModifiedBy": "string",
291 "createdDate": "2019-08-24T14:15:22Z",
292 "lastModifiedDate": "2019-08-24T14:15:22Z",
293 "archived": true,
294 "externalId": "string",
295 "id": 0,
296 "name": "string",
297 "code": "string",
298 "country": {
299 "createdBy": "string",
300 "lastModifiedBy": "string",
301 "createdDate": "2019-08-24T14:15:22Z",
302 "lastModifiedDate": "2019-08-24T14:15:22Z",
303 "archived": true,
304 "externalId": "string",
305 "id": 0,
306 "name": "string",
307 "code": "string"
308 }
309 }
310 }
311 },
312 "cityId": 0,
313 "districtId": 0
314 },
315 "secondAddressDto": {
316 "createdBy": "string",
317 "lastModifiedBy": "string",
318 "createdDate": "2019-08-24T14:15:22Z",
319 "lastModifiedDate": "2019-08-24T14:15:22Z",
320 "archived": true,
321 "externalId": "string",
322 "id": 0,
323 "street": "string",
324 "civicNumber": "string",
325 "suite": "string",
326 "postalCode": "string",
327 "lon": 0.1,
328 "lat": 0.1,
329 "city": {
330 "createdBy": "string",
331 "lastModifiedBy": "string",
332 "createdDate": "2019-08-24T14:15:22Z",
333 "lastModifiedDate": "2019-08-24T14:15:22Z",
334 "archived": true,
335 "externalId": "string",
336 "id": 0,
337 "name": "string",
338 "province": {
339 "createdBy": "string",
340 "lastModifiedBy": "string",
341 "createdDate": "2019-08-24T14:15:22Z",
342 "lastModifiedDate": "2019-08-24T14:15:22Z",
343 "archived": true,
344 "externalId": "string",
345 "id": 0,
346 "name": "string",
347 "code": "string",
348 "country": {
349 "createdBy": "string",
350 "lastModifiedBy": "string",
351 "createdDate": "2019-08-24T14:15:22Z",
352 "lastModifiedDate": "2019-08-24T14:15:22Z",
353 "archived": true,
354 "externalId": "string",
355 "id": 0,
356 "name": "string",
357 "code": "string"
358 }
359 }
360 },
361 "district": {
362 "createdBy": "string",
363 "lastModifiedBy": "string",
364 "createdDate": "2019-08-24T14:15:22Z",
365 "lastModifiedDate": "2019-08-24T14:15:22Z",
366 "archived": true,
367 "externalId": "string",
368 "id": 0,
369 "name": "string",
370 "city": {
371 "createdBy": "string",
372 "lastModifiedBy": "string",
373 "createdDate": "2019-08-24T14:15:22Z",
374 "lastModifiedDate": "2019-08-24T14:15:22Z",
375 "archived": true,
376 "externalId": "string",
377 "id": 0,
378 "name": "string",
379 "province": {
380 "createdBy": "string",
381 "lastModifiedBy": "string",
382 "createdDate": "2019-08-24T14:15:22Z",
383 "lastModifiedDate": "2019-08-24T14:15:22Z",
384 "archived": true,
385 "externalId": "string",
386 "id": 0,
387 "name": "string",
388 "code": "string",
389 "country": {
390 "createdBy": "string",
391 "lastModifiedBy": "string",
392 "createdDate": "2019-08-24T14:15:22Z",
393 "lastModifiedDate": "2019-08-24T14:15:22Z",
394 "archived": true,
395 "externalId": "string",
396 "id": 0,
397 "name": "string",
398 "code": "string"
399 }
400 }
401 }
402 },
403 "cityId": 0,
404 "districtId": 0
405 }
406}
Delete Location¶
HTTP Request
DELETE /api/locations/{id}
📋 Description: Deletes a specified location from the Nakisa Portfolio Management Suite, ensuring the removal of associated portfolio and asset data for accurate real estate property analytics.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
204 |
No Content |
None |
Get Location Groups¶
HTTP Request
GET /api/locations/{id}/groups
📋 Description: Retrieves the groups associated with a specific location within the Nakisa Portfolio Management Suite, enabling users to analyze asset distribution and portfolio performance in real estate management.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 {
3 "createdBy": "string",
4 "lastModifiedBy": "string",
5 "createdDate": "2019-08-24T14:15:22Z",
6 "lastModifiedDate": "2019-08-24T14:15:22Z",
7 "archived": true,
8 "externalId": "string",
9 "id": 0,
10 "priority": 0,
11 "internalId": 0,
12 "pickListCode": "string",
13 "pickListLabel": "string",
14 "label": "string",
15 "cultureId": 0,
16 "labelDtos": [
17 {
18 "createdBy": "string",
19 "lastModifiedBy": "string",
20 "createdDate": "2019-08-24T14:15:22Z",
21 "lastModifiedDate": "2019-08-24T14:15:22Z",
22 "archived": true,
23 "externalId": "string",
24 "id": 0,
25 "cultureId": 0,
26 "value": "string"
27 }
28 ]
29 }
30]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing an option within a pick list, utilized for categorizing and managing portfolio assets and analytics in the Nakisa Portfolio Management Suite, particularly in the context of real estate property management.] |
|
» createdBy |
string |
false |
none |
Username of who created this resource |
» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
» createdDate |
string(date-time) |
false |
none |
Date of the created |
» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
» archived |
boolean |
false |
none |
Boolean flag indicating archived status |
» externalId |
string |
false |
none |
Unique identifier for the external |
» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
» priority |
integer(int64) |
false |
none |
Priority of the resource |
» internalId |
integer(int64) |
false |
none |
Unique identifier for the internal |
» pickListCode |
string |
false |
none |
Code for the pick list |
» pickListLabel |
string |
false |
none |
Label for the pick list |
» label |
string |
false |
none |
Label for the resource |
» cultureId |
integer(int64) |
false |
none |
Unique identifier for the culture |
» labelDtos |
false |
none |
List of labelDtos items |
|
»» createdBy |
string |
false |
none |
Username of who created this resource |
»» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
»» createdDate |
string(date-time) |
false |
none |
Date of the created |
»» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
»» archived |
boolean |
false |
none |
Boolean flag indicating archived status |
»» externalId |
string |
false |
none |
Unique identifier for the external |
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» cultureId |
integer(int64) |
false |
none |
Unique identifier for the culture |
»» value |
string |
true |
none |
Text value for value in LabelDto |
Create Or Update Location Groups¶
HTTP Request
PUT /api/locations/{id}/groups
📋 Description: Updates the group associations for a specified location within the Nakisa Portfolio Management Suite, enabling enhanced portfolio analytics and asset management for real estate properties.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing the group assignment details for the specified location, including portfolio identifiers and asset allocation metrics relevant to real estate property management. |
Body Parameters
1[
2 {
3 "id": 0
4 }
5]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
201 |
Created |
Inline |
Example Responses
1[
2 {
3 "createdBy": "string",
4 "lastModifiedBy": "string",
5 "createdDate": "2019-08-24T14:15:22Z",
6 "lastModifiedDate": "2019-08-24T14:15:22Z",
7 "archived": true,
8 "externalId": "string",
9 "id": 0,
10 "priority": 0,
11 "internalId": 0,
12 "pickListCode": "string",
13 "pickListLabel": "string",
14 "label": "string",
15 "cultureId": 0,
16 "labelDtos": [
17 {
18 "createdBy": "string",
19 "lastModifiedBy": "string",
20 "createdDate": "2019-08-24T14:15:22Z",
21 "lastModifiedDate": "2019-08-24T14:15:22Z",
22 "archived": true,
23 "externalId": "string",
24 "id": 0,
25 "cultureId": 0,
26 "value": "string"
27 }
28 ]
29 }
30]
Response Schema
Status Code 201
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing an option within a pick list, utilized for categorizing and managing portfolio assets and analytics in the Nakisa Portfolio Management Suite, particularly in the context of real estate property management.] |
|
» createdBy |
string |
false |
none |
Username of who created this resource |
» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
» createdDate |
string(date-time) |
false |
none |
Date of the created |
» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
» archived |
boolean |
false |
none |
Boolean flag indicating archived status |
» externalId |
string |
false |
none |
Unique identifier for the external |
» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
» priority |
integer(int64) |
false |
none |
Priority of the resource |
» internalId |
integer(int64) |
false |
none |
Unique identifier for the internal |
» pickListCode |
string |
false |
none |
Code for the pick list |
» pickListLabel |
string |
false |
none |
Label for the pick list |
» label |
string |
false |
none |
Label for the resource |
» cultureId |
integer(int64) |
false |
none |
Unique identifier for the culture |
» labelDtos |
false |
none |
List of labelDtos items |
|
»» createdBy |
string |
false |
none |
Username of who created this resource |
»» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
»» createdDate |
string(date-time) |
false |
none |
Date of the created |
»» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
»» archived |
boolean |
false |
none |
Boolean flag indicating archived status |
»» externalId |
string |
false |
none |
Unique identifier for the external |
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» cultureId |
integer(int64) |
false |
none |
Unique identifier for the culture |
»» value |
string |
true |
none |
Text value for value in LabelDto |
Transfer Group Option Locations¶
HTTP Request
POST /api/transfer-location-group-options
📋 Description: Creates a new transfer location group option within the Nakisa Portfolio Management Suite, enabling users to efficiently manage and analyze real estate property allocations across various portfolios.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
from-group-option-id |
query |
integer(int64) |
true |
Unique identifier for the source group option in the asset transfer process within the Nakisa Portfolio Management Suite. |
to-group-option-id |
query |
integer(int64) |
true |
Unique identifier for the target location group option in the Nakisa Portfolio Management Suite, facilitating the transfer of assets within the portfolio analytics framework. |
body |
body |
array[integer] |
true |
Request body containing the transfer location group options data, including portfolio identifiers, asset details, and relevant analytics for real estate property management. |
Body Parameters
1[
2 0
3]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Get Locations¶
HTTP Request
GET /api/locations
📋 Description: Retrieves a list of locations associated with real estate assets within the Nakisa Portfolio Management Suite, enabling users to analyze portfolio distribution and asset management insights.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
Indicates whether the results of the location query should be returned in a paginated format, facilitating efficient data retrieval for portfolio and asset management analytics. |
|
listing |
query |
boolean |
false |
Specifies whether to include detailed listing information for real estate properties in the portfolio analytics response. |
search |
query |
string |
false |
Search term used to filter and retrieve specific locations within the Nakisa Portfolio Management Suite, relevant to portfolio, asset, analytics, and real estate property management. |
address-id |
query |
string |
false |
Unique identifier for the specific address within the Nakisa Portfolio Management Suite, used to retrieve detailed information related to portfolio, asset, and real estate property analytics. |
city-id |
query |
string |
false |
Unique identifier for a city within the Nakisa Portfolio Management Suite, used to retrieve location-specific data related to portfolio, asset, and real estate property analytics. |
province-id |
query |
string |
false |
Unique identifier for the province, used to filter and retrieve location-specific data related to portfolios, assets, and real estate properties within the Nakisa Portfolio Management Suite. |
country-id |
query |
string |
false |
Unique identifier for the country, used to filter and retrieve location-specific data related to portfolio, asset, and real estate property analytics. |
city-id-in |
query |
string |
false |
Unique identifier for the city, used to filter and retrieve specific location data within the Nakisa Portfolio Management Suite for portfolio and asset analytics. |
province-id-in |
query |
string |
false |
Unique identifier for the province, used to filter location data relevant to portfolio management and real estate analytics. |
country-id-in |
query |
string |
false |
Unique identifier for the country, used to filter and retrieve location data relevant to portfolio, asset, and real estate property analytics within the Nakisa Portfolio Management Suite. |
id-in |
query |
string |
false |
Unique identifier for the location within the Nakisa Portfolio Management Suite, facilitating precise retrieval of portfolio, asset, and analytics data related to real estate properties. |
number |
query |
string |
false |
Specifies the unique identifier for a location within the Nakisa Portfolio Management Suite, facilitating precise asset and portfolio analytics in real estate property management. |
number-like |
query |
string |
false |
Represents a numeric value or identifier associated with portfolio assets, facilitating precise location retrieval within the Nakisa Portfolio Management Suite. |
name |
query |
string |
false |
Name of the resource |
archived |
query |
string |
false |
Indicates whether to retrieve archived locations within the portfolio management suite, providing insights into historical asset data and analytics for real estate properties. |
store-number |
query |
string |
false |
Identifies the specific store within the Nakisa Portfolio Management Suite, enabling targeted retrieval of location-related data for portfolio and asset analytics in real estate management. |
default-currency-id |
query |
string |
false |
Identifier for the default currency used in financial transactions within the portfolio management context. |
default-measure-id |
query |
string |
false |
Specifies the unique identifier for the default measurement associated with the portfolio, asset, or real estate property analytics within the Nakisa Portfolio Management Suite. |
type-id |
query |
string |
false |
Unique identifier for the type of location within the Nakisa Portfolio Management Suite, facilitating targeted retrieval of portfolio, asset, and real estate property analytics. |
quality-id |
query |
string |
false |
Unique identifier for the quality assessment associated with a specific real estate property within the Nakisa Portfolio Management Suite. |
property-type-id |
query |
string |
false |
Unique identifier for the type of real estate property, used to filter and retrieve specific portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
category-id |
query |
string |
false |
Unique identifier for the category of locations within the Nakisa Portfolio Management Suite, facilitating targeted retrieval of portfolio, asset, and real estate property analytics. |
legal-entity-id |
query |
string |
false |
Unique identifier for the legal entity associated with a specific location, facilitating accurate portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
business-unit-id-in |
query |
string |
false |
Unique identifier for the business unit, used to filter location data relevant to portfolio, asset, analytics, and real estate property management within the Nakisa Portfolio Management Suite. |
status-id |
query |
string |
false |
Unique identifier for the status of a location within the Nakisa Portfolio Management Suite, facilitating portfolio and asset analytics in real estate property management. |
status-id-in |
query |
string |
false |
Filters the locations returned by the API based on their associated status identifiers, enabling targeted analytics within the Nakisa Portfolio Management Suite for effective portfolio and asset management. |
partner-id-in |
query |
string |
false |
Unique identifier for the partner associated with the portfolio, enabling targeted retrieval of location data within the Nakisa Portfolio Management Suite. |
legal-entity-id-not-in |
query |
string |
false |
Specifies a comma-separated list of legal entity IDs to exclude from the location query results within the Nakisa Portfolio Management Suite, facilitating targeted portfolio and asset analytics in real estate property management. |
legal-entity-id-in |
query |
string |
false |
Unique identifier for the legal entity associated with the portfolio, asset, or real estate property, used to retrieve relevant location data. |
group-id-not-in |
query |
string |
false |
Specifies a comma-separated list of group IDs to exclude from the location query results within the Nakisa Portfolio Management Suite, facilitating targeted portfolio and asset analytics. |
group-id-in |
query |
string |
false |
Unique identifier for the asset group within the Nakisa Portfolio Management Suite, used to filter location data relevant to portfolio and real estate analytics. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "_embedded": {
3 "locations": [
4 {
5 "createdBy": "string",
6 "lastModifiedBy": "string",
7 "createdDate": "2019-08-24T14:15:22Z",
8 "lastModifiedDate": "2019-08-24T14:15:22Z",
9 "archived": true,
10 "externalId": "string",
11 "id": 0,
12 "number": "string",
13 "name": "string",
14 "storeNumber": "string",
15 "defaultCurrencyId": 0,
16 "defaultMeasureId": 0,
17 "typeId": 0,
18 "qualityId": 0,
19 "propertyTypeId": 0,
20 "categoryId": 0,
21 "statusId": 0,
22 "businessUnitId": 0,
23 "groupIds": [
24 0
25 ],
26 "legalEntityIds": [
27 0
28 ],
29 "defaultCurrency": {
30 "id": 0,
31 "status": "CREATED",
32 "displayId": "string",
33 "erpSystemId": 0,
34 "erpSystemDisplayId": "string",
35 "name": "string",
36 "decimalPoints": 0,
37 "depreciationAreaId": 0
38 },
39 "defaultUnitValue": {
40 "createdBy": "string",
41 "lastModifiedBy": "string",
42 "createdDate": "2019-08-24T14:15:22Z",
43 "lastModifiedDate": "2019-08-24T14:15:22Z",
44 "archived": true,
45 "externalId": "string",
46 "id": 0,
47 "unitId": 0,
48 "unitOfMeasureId": 0,
49 "erpSystemId": 0,
50 "unit": {
51 "createdBy": "string",
52 "lastModifiedBy": "string",
53 "createdDate": "2019-08-24T14:15:22Z",
54 "lastModifiedDate": "2019-08-24T14:15:22Z",
55 "archived": true,
56 "externalId": "string",
57 "id": 0,
58 "priority": 0,
59 "internalId": 0,
60 "pickListCode": "string",
61 "pickListLabel": "string",
62 "label": "string",
63 "cultureId": 0,
64 "labelDtos": [
65 {
66 "createdBy": "string",
67 "lastModifiedBy": "string",
68 "createdDate": "2019-08-24T14:15:22Z",
69 "lastModifiedDate": "2019-08-24T14:15:22Z",
70 "archived": true,
71 "externalId": "string",
72 "id": 0,
73 "cultureId": 0,
74 "value": "string"
75 }
76 ]
77 },
78 "unitOfMeasure": {
79 "id": 0,
80 "status": "CREATED",
81 "displayId": "string",
82 "erpSystemId": 0,
83 "erpSystemDisplayId": "string",
84 "name": "string"
85 }
86 },
87 "type": {
88 "createdBy": "string",
89 "lastModifiedBy": "string",
90 "createdDate": "2019-08-24T14:15:22Z",
91 "lastModifiedDate": "2019-08-24T14:15:22Z",
92 "archived": true,
93 "externalId": "string",
94 "id": 0,
95 "priority": 0,
96 "internalId": 0,
97 "pickListCode": "string",
98 "pickListLabel": "string",
99 "label": "string",
100 "cultureId": 0,
101 "labelDtos": [
102 {
103 "createdBy": "string",
104 "lastModifiedBy": "string",
105 "createdDate": "2019-08-24T14:15:22Z",
106 "lastModifiedDate": "2019-08-24T14:15:22Z",
107 "archived": true,
108 "externalId": "string",
109 "id": 0,
110 "cultureId": 0,
111 "value": "string"
112 }
113 ]
114 },
115 "quality": {
116 "createdBy": "string",
117 "lastModifiedBy": "string",
118 "createdDate": "2019-08-24T14:15:22Z",
119 "lastModifiedDate": "2019-08-24T14:15:22Z",
120 "archived": true,
121 "externalId": "string",
122 "id": 0,
123 "priority": 0,
124 "internalId": 0,
125 "pickListCode": "string",
126 "pickListLabel": "string",
127 "label": "string",
128 "cultureId": 0,
129 "labelDtos": [
130 {
131 "createdBy": "string",
132 "lastModifiedBy": "string",
133 "createdDate": "2019-08-24T14:15:22Z",
134 "lastModifiedDate": "2019-08-24T14:15:22Z",
135 "archived": true,
136 "externalId": "string",
137 "id": 0,
138 "cultureId": 0,
139 "value": "string"
140 }
141 ]
142 },
143 "propertyType": {
144 "createdBy": "string",
145 "lastModifiedBy": "string",
146 "createdDate": "2019-08-24T14:15:22Z",
147 "lastModifiedDate": "2019-08-24T14:15:22Z",
148 "archived": true,
149 "externalId": "string",
150 "id": 0,
151 "priority": 0,
152 "internalId": 0,
153 "pickListCode": "string",
154 "pickListLabel": "string",
155 "label": "string",
156 "cultureId": 0,
157 "labelDtos": [
158 {
159 "createdBy": "string",
160 "lastModifiedBy": "string",
161 "createdDate": "2019-08-24T14:15:22Z",
162 "lastModifiedDate": "2019-08-24T14:15:22Z",
163 "archived": true,
164 "externalId": "string",
165 "id": 0,
166 "cultureId": 0,
167 "value": "string"
168 }
169 ]
170 },
171 "category": {
172 "createdBy": "string",
173 "lastModifiedBy": "string",
174 "createdDate": "2019-08-24T14:15:22Z",
175 "lastModifiedDate": "2019-08-24T14:15:22Z",
176 "archived": true,
177 "externalId": "string",
178 "id": 0,
179 "priority": 0,
180 "internalId": 0,
181 "pickListCode": "string",
182 "pickListLabel": "string",
183 "label": "string",
184 "cultureId": 0,
185 "labelDtos": [
186 {
187 "createdBy": "string",
188 "lastModifiedBy": "string",
189 "createdDate": "2019-08-24T14:15:22Z",
190 "lastModifiedDate": "2019-08-24T14:15:22Z",
191 "archived": true,
192 "externalId": "string",
193 "id": 0,
194 "cultureId": 0,
195 "value": "string"
196 }
197 ]
198 },
199 "status": {
200 "createdBy": "string",
201 "lastModifiedBy": "string",
202 "createdDate": "2019-08-24T14:15:22Z",
203 "lastModifiedDate": "2019-08-24T14:15:22Z",
204 "archived": true,
205 "externalId": "string",
206 "id": 0,
207 "priority": 0,
208 "internalId": 0,
209 "pickListCode": "string",
210 "pickListLabel": "string",
211 "label": "string",
212 "cultureId": 0,
213 "labelDtos": [
214 {
215 "createdBy": "string",
216 "lastModifiedBy": "string",
217 "createdDate": "2019-08-24T14:15:22Z",
218 "lastModifiedDate": "2019-08-24T14:15:22Z",
219 "archived": true,
220 "externalId": "string",
221 "id": 0,
222 "cultureId": 0,
223 "value": "string"
224 }
225 ]
226 },
227 "addressDto": {
228 "createdBy": "string",
229 "lastModifiedBy": "string",
230 "createdDate": "2019-08-24T14:15:22Z",
231 "lastModifiedDate": "2019-08-24T14:15:22Z",
232 "archived": true,
233 "externalId": "string",
234 "id": 0,
235 "street": "string",
236 "civicNumber": "string",
237 "suite": "string",
238 "postalCode": "string",
239 "lon": 0.1,
240 "lat": 0.1,
241 "city": {
242 "createdBy": "string",
243 "lastModifiedBy": "string",
244 "createdDate": "2019-08-24T14:15:22Z",
245 "lastModifiedDate": "2019-08-24T14:15:22Z",
246 "archived": true,
247 "externalId": "string",
248 "id": 0,
249 "name": "string",
250 "province": {
251 "createdBy": "string",
252 "lastModifiedBy": "string",
253 "createdDate": "2019-08-24T14:15:22Z",
254 "lastModifiedDate": "2019-08-24T14:15:22Z",
255 "archived": true,
256 "externalId": "string",
257 "id": 0,
258 "name": "string",
259 "code": "string",
260 "country": {
261 "createdBy": "string",
262 "lastModifiedBy": "string",
263 "createdDate": "2019-08-24T14:15:22Z",
264 "lastModifiedDate": "2019-08-24T14:15:22Z",
265 "archived": true,
266 "externalId": "string",
267 "id": 0,
268 "name": "string",
269 "code": "string"
270 }
271 }
272 },
273 "district": {
274 "createdBy": "string",
275 "lastModifiedBy": "string",
276 "createdDate": "2019-08-24T14:15:22Z",
277 "lastModifiedDate": "2019-08-24T14:15:22Z",
278 "archived": true,
279 "externalId": "string",
280 "id": 0,
281 "name": "string",
282 "city": {
283 "createdBy": "string",
284 "lastModifiedBy": "string",
285 "createdDate": "2019-08-24T14:15:22Z",
286 "lastModifiedDate": "2019-08-24T14:15:22Z",
287 "archived": true,
288 "externalId": "string",
289 "id": 0,
290 "name": "string",
291 "province": {
292 "createdBy": "string",
293 "lastModifiedBy": "string",
294 "createdDate": "2019-08-24T14:15:22Z",
295 "lastModifiedDate": "2019-08-24T14:15:22Z",
296 "archived": true,
297 "externalId": "string",
298 "id": 0,
299 "name": "string",
300 "code": "string",
301 "country": {
302 "createdBy": "string",
303 "lastModifiedBy": "string",
304 "createdDate": "2019-08-24T14:15:22Z",
305 "lastModifiedDate": "2019-08-24T14:15:22Z",
306 "archived": true,
307 "externalId": "string",
308 "id": 0,
309 "name": "string",
310 "code": "string"
311 }
312 }
313 }
314 },
315 "cityId": 0,
316 "districtId": 0
317 },
318 "secondAddressDto": {
319 "createdBy": "string",
320 "lastModifiedBy": "string",
321 "createdDate": "2019-08-24T14:15:22Z",
322 "lastModifiedDate": "2019-08-24T14:15:22Z",
323 "archived": true,
324 "externalId": "string",
325 "id": 0,
326 "street": "string",
327 "civicNumber": "string",
328 "suite": "string",
329 "postalCode": "string",
330 "lon": 0.1,
331 "lat": 0.1,
332 "city": {
333 "createdBy": "string",
334 "lastModifiedBy": "string",
335 "createdDate": "2019-08-24T14:15:22Z",
336 "lastModifiedDate": "2019-08-24T14:15:22Z",
337 "archived": true,
338 "externalId": "string",
339 "id": 0,
340 "name": "string",
341 "province": {
342 "createdBy": "string",
343 "lastModifiedBy": "string",
344 "createdDate": "2019-08-24T14:15:22Z",
345 "lastModifiedDate": "2019-08-24T14:15:22Z",
346 "archived": true,
347 "externalId": "string",
348 "id": 0,
349 "name": "string",
350 "code": "string",
351 "country": {
352 "createdBy": "string",
353 "lastModifiedBy": "string",
354 "createdDate": "2019-08-24T14:15:22Z",
355 "lastModifiedDate": "2019-08-24T14:15:22Z",
356 "archived": true,
357 "externalId": "string",
358 "id": 0,
359 "name": "string",
360 "code": "string"
361 }
362 }
363 },
364 "district": {
365 "createdBy": "string",
366 "lastModifiedBy": "string",
367 "createdDate": "2019-08-24T14:15:22Z",
368 "lastModifiedDate": "2019-08-24T14:15:22Z",
369 "archived": true,
370 "externalId": "string",
371 "id": 0,
372 "name": "string",
373 "city": {
374 "createdBy": "string",
375 "lastModifiedBy": "string",
376 "createdDate": "2019-08-24T14:15:22Z",
377 "lastModifiedDate": "2019-08-24T14:15:22Z",
378 "archived": true,
379 "externalId": "string",
380 "id": 0,
381 "name": "string",
382 "province": {
383 "createdBy": "string",
384 "lastModifiedBy": "string",
385 "createdDate": "2019-08-24T14:15:22Z",
386 "lastModifiedDate": "2019-08-24T14:15:22Z",
387 "archived": true,
388 "externalId": "string",
389 "id": 0,
390 "name": "string",
391 "code": "string",
392 "country": {
393 "createdBy": "string",
394 "lastModifiedBy": "string",
395 "createdDate": "2019-08-24T14:15:22Z",
396 "lastModifiedDate": "2019-08-24T14:15:22Z",
397 "archived": true,
398 "externalId": "string",
399 "id": 0,
400 "name": "string",
401 "code": "string"
402 }
403 }
404 }
405 },
406 "cityId": 0,
407 "districtId": 0
408 }
409 }
410 ]
411 },
412 "page": {
413 "size": 0,
414 "totalElements": 0,
415 "totalPages": 0,
416 "number": 0
417 }
418}
Add Locations¶
HTTP Request
POST /api/locations
📋 Description: Creates a new location entry within the Nakisa Portfolio Management Suite, enabling users to manage and analyze real estate properties effectively within their portfolio.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the location details, including portfolio identifiers and asset attributes, essential for real estate property analytics within the Nakisa Portfolio Management Suite. |
Body Parameters
1[
2 {
3 "createdBy": "string",
4 "lastModifiedBy": "string",
5 "createdDate": "2019-08-24T14:15:22Z",
6 "lastModifiedDate": "2019-08-24T14:15:22Z",
7 "archived": true,
8 "externalId": "string",
9 "id": 0,
10 "number": "string",
11 "name": "string",
12 "storeNumber": "string",
13 "defaultCurrencyId": 0,
14 "defaultMeasureId": 0,
15 "typeId": 0,
16 "qualityId": 0,
17 "propertyTypeId": 0,
18 "categoryId": 0,
19 "statusId": 0,
20 "businessUnitId": 0,
21 "groupIds": [
22 0
23 ],
24 "legalEntityIds": [
25 0
26 ],
27 "defaultCurrency": {
28 "id": 0,
29 "status": "CREATED",
30 "displayId": "string",
31 "erpSystemId": 0,
32 "erpSystemDisplayId": "string",
33 "name": "string",
34 "decimalPoints": 0,
35 "depreciationAreaId": 0
36 },
37 "defaultUnitValue": {
38 "createdBy": "string",
39 "lastModifiedBy": "string",
40 "createdDate": "2019-08-24T14:15:22Z",
41 "lastModifiedDate": "2019-08-24T14:15:22Z",
42 "archived": true,
43 "externalId": "string",
44 "id": 0,
45 "unitId": 0,
46 "unitOfMeasureId": 0,
47 "erpSystemId": 0,
48 "unit": {
49 "createdBy": "string",
50 "lastModifiedBy": "string",
51 "createdDate": "2019-08-24T14:15:22Z",
52 "lastModifiedDate": "2019-08-24T14:15:22Z",
53 "archived": true,
54 "externalId": "string",
55 "id": 0,
56 "priority": 0,
57 "internalId": 0,
58 "pickListCode": "string",
59 "pickListLabel": "string",
60 "label": "string",
61 "cultureId": 0,
62 "labelDtos": [
63 {
64 "createdBy": "string",
65 "lastModifiedBy": "string",
66 "createdDate": "2019-08-24T14:15:22Z",
67 "lastModifiedDate": "2019-08-24T14:15:22Z",
68 "archived": true,
69 "externalId": "string",
70 "id": 0,
71 "cultureId": 0,
72 "value": "string"
73 }
74 ]
75 },
76 "unitOfMeasure": {
77 "id": 0,
78 "status": "CREATED",
79 "displayId": "string",
80 "erpSystemId": 0,
81 "erpSystemDisplayId": "string",
82 "name": "string"
83 }
84 },
85 "type": {
86 "createdBy": "string",
87 "lastModifiedBy": "string",
88 "createdDate": "2019-08-24T14:15:22Z",
89 "lastModifiedDate": "2019-08-24T14:15:22Z",
90 "archived": true,
91 "externalId": "string",
92 "id": 0,
93 "priority": 0,
94 "internalId": 0,
95 "pickListCode": "string",
96 "pickListLabel": "string",
97 "label": "string",
98 "cultureId": 0,
99 "labelDtos": [
100 {
101 "createdBy": "string",
102 "lastModifiedBy": "string",
103 "createdDate": "2019-08-24T14:15:22Z",
104 "lastModifiedDate": "2019-08-24T14:15:22Z",
105 "archived": true,
106 "externalId": "string",
107 "id": 0,
108 "cultureId": 0,
109 "value": "string"
110 }
111 ]
112 },
113 "quality": {
114 "createdBy": "string",
115 "lastModifiedBy": "string",
116 "createdDate": "2019-08-24T14:15:22Z",
117 "lastModifiedDate": "2019-08-24T14:15:22Z",
118 "archived": true,
119 "externalId": "string",
120 "id": 0,
121 "priority": 0,
122 "internalId": 0,
123 "pickListCode": "string",
124 "pickListLabel": "string",
125 "label": "string",
126 "cultureId": 0,
127 "labelDtos": [
128 {
129 "createdBy": "string",
130 "lastModifiedBy": "string",
131 "createdDate": "2019-08-24T14:15:22Z",
132 "lastModifiedDate": "2019-08-24T14:15:22Z",
133 "archived": true,
134 "externalId": "string",
135 "id": 0,
136 "cultureId": 0,
137 "value": "string"
138 }
139 ]
140 },
141 "propertyType": {
142 "createdBy": "string",
143 "lastModifiedBy": "string",
144 "createdDate": "2019-08-24T14:15:22Z",
145 "lastModifiedDate": "2019-08-24T14:15:22Z",
146 "archived": true,
147 "externalId": "string",
148 "id": 0,
149 "priority": 0,
150 "internalId": 0,
151 "pickListCode": "string",
152 "pickListLabel": "string",
153 "label": "string",
154 "cultureId": 0,
155 "labelDtos": [
156 {
157 "createdBy": "string",
158 "lastModifiedBy": "string",
159 "createdDate": "2019-08-24T14:15:22Z",
160 "lastModifiedDate": "2019-08-24T14:15:22Z",
161 "archived": true,
162 "externalId": "string",
163 "id": 0,
164 "cultureId": 0,
165 "value": "string"
166 }
167 ]
168 },
169 "category": {
170 "createdBy": "string",
171 "lastModifiedBy": "string",
172 "createdDate": "2019-08-24T14:15:22Z",
173 "lastModifiedDate": "2019-08-24T14:15:22Z",
174 "archived": true,
175 "externalId": "string",
176 "id": 0,
177 "priority": 0,
178 "internalId": 0,
179 "pickListCode": "string",
180 "pickListLabel": "string",
181 "label": "string",
182 "cultureId": 0,
183 "labelDtos": [
184 {
185 "createdBy": "string",
186 "lastModifiedBy": "string",
187 "createdDate": "2019-08-24T14:15:22Z",
188 "lastModifiedDate": "2019-08-24T14:15:22Z",
189 "archived": true,
190 "externalId": "string",
191 "id": 0,
192 "cultureId": 0,
193 "value": "string"
194 }
195 ]
196 },
197 "status": {
198 "createdBy": "string",
199 "lastModifiedBy": "string",
200 "createdDate": "2019-08-24T14:15:22Z",
201 "lastModifiedDate": "2019-08-24T14:15:22Z",
202 "archived": true,
203 "externalId": "string",
204 "id": 0,
205 "priority": 0,
206 "internalId": 0,
207 "pickListCode": "string",
208 "pickListLabel": "string",
209 "label": "string",
210 "cultureId": 0,
211 "labelDtos": [
212 {
213 "createdBy": "string",
214 "lastModifiedBy": "string",
215 "createdDate": "2019-08-24T14:15:22Z",
216 "lastModifiedDate": "2019-08-24T14:15:22Z",
217 "archived": true,
218 "externalId": "string",
219 "id": 0,
220 "cultureId": 0,
221 "value": "string"
222 }
223 ]
224 },
225 "addressDto": {
226 "createdBy": "string",
227 "lastModifiedBy": "string",
228 "createdDate": "2019-08-24T14:15:22Z",
229 "lastModifiedDate": "2019-08-24T14:15:22Z",
230 "archived": true,
231 "externalId": "string",
232 "id": 0,
233 "street": "string",
234 "civicNumber": "string",
235 "suite": "string",
236 "postalCode": "string",
237 "lon": 0.1,
238 "lat": 0.1,
239 "city": {
240 "createdBy": "string",
241 "lastModifiedBy": "string",
242 "createdDate": "2019-08-24T14:15:22Z",
243 "lastModifiedDate": "2019-08-24T14:15:22Z",
244 "archived": true,
245 "externalId": "string",
246 "id": 0,
247 "name": "string",
248 "province": {
249 "createdBy": "string",
250 "lastModifiedBy": "string",
251 "createdDate": "2019-08-24T14:15:22Z",
252 "lastModifiedDate": "2019-08-24T14:15:22Z",
253 "archived": true,
254 "externalId": "string",
255 "id": 0,
256 "name": "string",
257 "code": "string",
258 "country": {
259 "createdBy": "string",
260 "lastModifiedBy": "string",
261 "createdDate": "2019-08-24T14:15:22Z",
262 "lastModifiedDate": "2019-08-24T14:15:22Z",
263 "archived": true,
264 "externalId": "string",
265 "id": 0,
266 "name": "string",
267 "code": "string"
268 }
269 }
270 },
271 "district": {
272 "createdBy": "string",
273 "lastModifiedBy": "string",
274 "createdDate": "2019-08-24T14:15:22Z",
275 "lastModifiedDate": "2019-08-24T14:15:22Z",
276 "archived": true,
277 "externalId": "string",
278 "id": 0,
279 "name": "string",
280 "city": {
281 "createdBy": "string",
282 "lastModifiedBy": "string",
283 "createdDate": "2019-08-24T14:15:22Z",
284 "lastModifiedDate": "2019-08-24T14:15:22Z",
285 "archived": true,
286 "externalId": "string",
287 "id": 0,
288 "name": "string",
289 "province": {
290 "createdBy": "string",
291 "lastModifiedBy": "string",
292 "createdDate": "2019-08-24T14:15:22Z",
293 "lastModifiedDate": "2019-08-24T14:15:22Z",
294 "archived": true,
295 "externalId": "string",
296 "id": 0,
297 "name": "string",
298 "code": "string",
299 "country": {
300 "createdBy": "string",
301 "lastModifiedBy": "string",
302 "createdDate": "2019-08-24T14:15:22Z",
303 "lastModifiedDate": "2019-08-24T14:15:22Z",
304 "archived": true,
305 "externalId": "string",
306 "id": 0,
307 "name": "string",
308 "code": "string"
309 }
310 }
311 }
312 },
313 "cityId": 0,
314 "districtId": 0
315 },
316 "secondAddressDto": {
317 "createdBy": "string",
318 "lastModifiedBy": "string",
319 "createdDate": "2019-08-24T14:15:22Z",
320 "lastModifiedDate": "2019-08-24T14:15:22Z",
321 "archived": true,
322 "externalId": "string",
323 "id": 0,
324 "street": "string",
325 "civicNumber": "string",
326 "suite": "string",
327 "postalCode": "string",
328 "lon": 0.1,
329 "lat": 0.1,
330 "city": {
331 "createdBy": "string",
332 "lastModifiedBy": "string",
333 "createdDate": "2019-08-24T14:15:22Z",
334 "lastModifiedDate": "2019-08-24T14:15:22Z",
335 "archived": true,
336 "externalId": "string",
337 "id": 0,
338 "name": "string",
339 "province": {
340 "createdBy": "string",
341 "lastModifiedBy": "string",
342 "createdDate": "2019-08-24T14:15:22Z",
343 "lastModifiedDate": "2019-08-24T14:15:22Z",
344 "archived": true,
345 "externalId": "string",
346 "id": 0,
347 "name": "string",
348 "code": "string",
349 "country": {
350 "createdBy": "string",
351 "lastModifiedBy": "string",
352 "createdDate": "2019-08-24T14:15:22Z",
353 "lastModifiedDate": "2019-08-24T14:15:22Z",
354 "archived": true,
355 "externalId": "string",
356 "id": 0,
357 "name": "string",
358 "code": "string"
359 }
360 }
361 },
362 "district": {
363 "createdBy": "string",
364 "lastModifiedBy": "string",
365 "createdDate": "2019-08-24T14:15:22Z",
366 "lastModifiedDate": "2019-08-24T14:15:22Z",
367 "archived": true,
368 "externalId": "string",
369 "id": 0,
370 "name": "string",
371 "city": {
372 "createdBy": "string",
373 "lastModifiedBy": "string",
374 "createdDate": "2019-08-24T14:15:22Z",
375 "lastModifiedDate": "2019-08-24T14:15:22Z",
376 "archived": true,
377 "externalId": "string",
378 "id": 0,
379 "name": "string",
380 "province": {
381 "createdBy": "string",
382 "lastModifiedBy": "string",
383 "createdDate": "2019-08-24T14:15:22Z",
384 "lastModifiedDate": "2019-08-24T14:15:22Z",
385 "archived": true,
386 "externalId": "string",
387 "id": 0,
388 "name": "string",
389 "code": "string",
390 "country": {
391 "createdBy": "string",
392 "lastModifiedBy": "string",
393 "createdDate": "2019-08-24T14:15:22Z",
394 "lastModifiedDate": "2019-08-24T14:15:22Z",
395 "archived": true,
396 "externalId": "string",
397 "id": 0,
398 "name": "string",
399 "code": "string"
400 }
401 }
402 }
403 },
404 "cityId": 0,
405 "districtId": 0
406 }
407 }
408]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
201 |
Created |
Inline |
Example Responses
1[
2 {
3 "createdBy": "string",
4 "lastModifiedBy": "string",
5 "createdDate": "2019-08-24T14:15:22Z",
6 "lastModifiedDate": "2019-08-24T14:15:22Z",
7 "archived": true,
8 "externalId": "string",
9 "id": 0,
10 "number": "string",
11 "name": "string",
12 "storeNumber": "string",
13 "defaultCurrencyId": 0,
14 "defaultMeasureId": 0,
15 "typeId": 0,
16 "qualityId": 0,
17 "propertyTypeId": 0,
18 "categoryId": 0,
19 "statusId": 0,
20 "businessUnitId": 0,
21 "groupIds": [
22 0
23 ],
24 "legalEntityIds": [
25 0
26 ],
27 "defaultCurrency": {
28 "id": 0,
29 "status": "CREATED",
30 "displayId": "string",
31 "erpSystemId": 0,
32 "erpSystemDisplayId": "string",
33 "name": "string",
34 "decimalPoints": 0,
35 "depreciationAreaId": 0
36 },
37 "defaultUnitValue": {
38 "createdBy": "string",
39 "lastModifiedBy": "string",
40 "createdDate": "2019-08-24T14:15:22Z",
41 "lastModifiedDate": "2019-08-24T14:15:22Z",
42 "archived": true,
43 "externalId": "string",
44 "id": 0,
45 "unitId": 0,
46 "unitOfMeasureId": 0,
47 "erpSystemId": 0,
48 "unit": {
49 "createdBy": "string",
50 "lastModifiedBy": "string",
51 "createdDate": "2019-08-24T14:15:22Z",
52 "lastModifiedDate": "2019-08-24T14:15:22Z",
53 "archived": true,
54 "externalId": "string",
55 "id": 0,
56 "priority": 0,
57 "internalId": 0,
58 "pickListCode": "string",
59 "pickListLabel": "string",
60 "label": "string",
61 "cultureId": 0,
62 "labelDtos": [
63 {
64 "createdBy": "string",
65 "lastModifiedBy": "string",
66 "createdDate": "2019-08-24T14:15:22Z",
67 "lastModifiedDate": "2019-08-24T14:15:22Z",
68 "archived": true,
69 "externalId": "string",
70 "id": 0,
71 "cultureId": 0,
72 "value": "string"
73 }
74 ]
75 },
76 "unitOfMeasure": {
77 "id": 0,
78 "status": "CREATED",
79 "displayId": "string",
80 "erpSystemId": 0,
81 "erpSystemDisplayId": "string",
82 "name": "string"
83 }
84 },
85 "type": {
86 "createdBy": "string",
87 "lastModifiedBy": "string",
88 "createdDate": "2019-08-24T14:15:22Z",
89 "lastModifiedDate": "2019-08-24T14:15:22Z",
90 "archived": true,
91 "externalId": "string",
92 "id": 0,
93 "priority": 0,
94 "internalId": 0,
95 "pickListCode": "string",
96 "pickListLabel": "string",
97 "label": "string",
98 "cultureId": 0,
99 "labelDtos": [
100 {
101 "createdBy": "string",
102 "lastModifiedBy": "string",
103 "createdDate": "2019-08-24T14:15:22Z",
104 "lastModifiedDate": "2019-08-24T14:15:22Z",
105 "archived": true,
106 "externalId": "string",
107 "id": 0,
108 "cultureId": 0,
109 "value": "string"
110 }
111 ]
112 },
113 "quality": {
114 "createdBy": "string",
115 "lastModifiedBy": "string",
116 "createdDate": "2019-08-24T14:15:22Z",
117 "lastModifiedDate": "2019-08-24T14:15:22Z",
118 "archived": true,
119 "externalId": "string",
120 "id": 0,
121 "priority": 0,
122 "internalId": 0,
123 "pickListCode": "string",
124 "pickListLabel": "string",
125 "label": "string",
126 "cultureId": 0,
127 "labelDtos": [
128 {
129 "createdBy": "string",
130 "lastModifiedBy": "string",
131 "createdDate": "2019-08-24T14:15:22Z",
132 "lastModifiedDate": "2019-08-24T14:15:22Z",
133 "archived": true,
134 "externalId": "string",
135 "id": 0,
136 "cultureId": 0,
137 "value": "string"
138 }
139 ]
140 },
141 "propertyType": {
142 "createdBy": "string",
143 "lastModifiedBy": "string",
144 "createdDate": "2019-08-24T14:15:22Z",
145 "lastModifiedDate": "2019-08-24T14:15:22Z",
146 "archived": true,
147 "externalId": "string",
148 "id": 0,
149 "priority": 0,
150 "internalId": 0,
151 "pickListCode": "string",
152 "pickListLabel": "string",
153 "label": "string",
154 "cultureId": 0,
155 "labelDtos": [
156 {
157 "createdBy": "string",
158 "lastModifiedBy": "string",
159 "createdDate": "2019-08-24T14:15:22Z",
160 "lastModifiedDate": "2019-08-24T14:15:22Z",
161 "archived": true,
162 "externalId": "string",
163 "id": 0,
164 "cultureId": 0,
165 "value": "string"
166 }
167 ]
168 },
169 "category": {
170 "createdBy": "string",
171 "lastModifiedBy": "string",
172 "createdDate": "2019-08-24T14:15:22Z",
173 "lastModifiedDate": "2019-08-24T14:15:22Z",
174 "archived": true,
175 "externalId": "string",
176 "id": 0,
177 "priority": 0,
178 "internalId": 0,
179 "pickListCode": "string",
180 "pickListLabel": "string",
181 "label": "string",
182 "cultureId": 0,
183 "labelDtos": [
184 {
185 "createdBy": "string",
186 "lastModifiedBy": "string",
187 "createdDate": "2019-08-24T14:15:22Z",
188 "lastModifiedDate": "2019-08-24T14:15:22Z",
189 "archived": true,
190 "externalId": "string",
191 "id": 0,
192 "cultureId": 0,
193 "value": "string"
194 }
195 ]
196 },
197 "status": {
198 "createdBy": "string",
199 "lastModifiedBy": "string",
200 "createdDate": "2019-08-24T14:15:22Z",
201 "lastModifiedDate": "2019-08-24T14:15:22Z",
202 "archived": true,
203 "externalId": "string",
204 "id": 0,
205 "priority": 0,
206 "internalId": 0,
207 "pickListCode": "string",
208 "pickListLabel": "string",
209 "label": "string",
210 "cultureId": 0,
211 "labelDtos": [
212 {
213 "createdBy": "string",
214 "lastModifiedBy": "string",
215 "createdDate": "2019-08-24T14:15:22Z",
216 "lastModifiedDate": "2019-08-24T14:15:22Z",
217 "archived": true,
218 "externalId": "string",
219 "id": 0,
220 "cultureId": 0,
221 "value": "string"
222 }
223 ]
224 },
225 "addressDto": {
226 "createdBy": "string",
227 "lastModifiedBy": "string",
228 "createdDate": "2019-08-24T14:15:22Z",
229 "lastModifiedDate": "2019-08-24T14:15:22Z",
230 "archived": true,
231 "externalId": "string",
232 "id": 0,
233 "street": "string",
234 "civicNumber": "string",
235 "suite": "string",
236 "postalCode": "string",
237 "lon": 0.1,
238 "lat": 0.1,
239 "city": {
240 "createdBy": "string",
241 "lastModifiedBy": "string",
242 "createdDate": "2019-08-24T14:15:22Z",
243 "lastModifiedDate": "2019-08-24T14:15:22Z",
244 "archived": true,
245 "externalId": "string",
246 "id": 0,
247 "name": "string",
248 "province": {
249 "createdBy": "string",
250 "lastModifiedBy": "string",
251 "createdDate": "2019-08-24T14:15:22Z",
252 "lastModifiedDate": "2019-08-24T14:15:22Z",
253 "archived": true,
254 "externalId": "string",
255 "id": 0,
256 "name": "string",
257 "code": "string",
258 "country": {
259 "createdBy": "string",
260 "lastModifiedBy": "string",
261 "createdDate": "2019-08-24T14:15:22Z",
262 "lastModifiedDate": "2019-08-24T14:15:22Z",
263 "archived": true,
264 "externalId": "string",
265 "id": 0,
266 "name": "string",
267 "code": "string"
268 }
269 }
270 },
271 "district": {
272 "createdBy": "string",
273 "lastModifiedBy": "string",
274 "createdDate": "2019-08-24T14:15:22Z",
275 "lastModifiedDate": "2019-08-24T14:15:22Z",
276 "archived": true,
277 "externalId": "string",
278 "id": 0,
279 "name": "string",
280 "city": {
281 "createdBy": "string",
282 "lastModifiedBy": "string",
283 "createdDate": "2019-08-24T14:15:22Z",
284 "lastModifiedDate": "2019-08-24T14:15:22Z",
285 "archived": true,
286 "externalId": "string",
287 "id": 0,
288 "name": "string",
289 "province": {
290 "createdBy": "string",
291 "lastModifiedBy": "string",
292 "createdDate": "2019-08-24T14:15:22Z",
293 "lastModifiedDate": "2019-08-24T14:15:22Z",
294 "archived": true,
295 "externalId": "string",
296 "id": 0,
297 "name": "string",
298 "code": "string",
299 "country": {
300 "createdBy": "string",
301 "lastModifiedBy": "string",
302 "createdDate": "2019-08-24T14:15:22Z",
303 "lastModifiedDate": "2019-08-24T14:15:22Z",
304 "archived": true,
305 "externalId": "string",
306 "id": 0,
307 "name": "string",
308 "code": "string"
309 }
310 }
311 }
312 },
313 "cityId": 0,
314 "districtId": 0
315 },
316 "secondAddressDto": {
317 "createdBy": "string",
318 "lastModifiedBy": "string",
319 "createdDate": "2019-08-24T14:15:22Z",
320 "lastModifiedDate": "2019-08-24T14:15:22Z",
321 "archived": true,
322 "externalId": "string",
323 "id": 0,
324 "street": "string",
325 "civicNumber": "string",
326 "suite": "string",
327 "postalCode": "string",
328 "lon": 0.1,
329 "lat": 0.1,
330 "city": {
331 "createdBy": "string",
332 "lastModifiedBy": "string",
333 "createdDate": "2019-08-24T14:15:22Z",
334 "lastModifiedDate": "2019-08-24T14:15:22Z",
335 "archived": true,
336 "externalId": "string",
337 "id": 0,
338 "name": "string",
339 "province": {
340 "createdBy": "string",
341 "lastModifiedBy": "string",
342 "createdDate": "2019-08-24T14:15:22Z",
343 "lastModifiedDate": "2019-08-24T14:15:22Z",
344 "archived": true,
345 "externalId": "string",
346 "id": 0,
347 "name": "string",
348 "code": "string",
349 "country": {
350 "createdBy": "string",
351 "lastModifiedBy": "string",
352 "createdDate": "2019-08-24T14:15:22Z",
353 "lastModifiedDate": "2019-08-24T14:15:22Z",
354 "archived": true,
355 "externalId": "string",
356 "id": 0,
357 "name": "string",
358 "code": "string"
359 }
360 }
361 },
362 "district": {
363 "createdBy": "string",
364 "lastModifiedBy": "string",
365 "createdDate": "2019-08-24T14:15:22Z",
366 "lastModifiedDate": "2019-08-24T14:15:22Z",
367 "archived": true,
368 "externalId": "string",
369 "id": 0,
370 "name": "string",
371 "city": {
372 "createdBy": "string",
373 "lastModifiedBy": "string",
374 "createdDate": "2019-08-24T14:15:22Z",
375 "lastModifiedDate": "2019-08-24T14:15:22Z",
376 "archived": true,
377 "externalId": "string",
378 "id": 0,
379 "name": "string",
380 "province": {
381 "createdBy": "string",
382 "lastModifiedBy": "string",
383 "createdDate": "2019-08-24T14:15:22Z",
384 "lastModifiedDate": "2019-08-24T14:15:22Z",
385 "archived": true,
386 "externalId": "string",
387 "id": 0,
388 "name": "string",
389 "code": "string",
390 "country": {
391 "createdBy": "string",
392 "lastModifiedBy": "string",
393 "createdDate": "2019-08-24T14:15:22Z",
394 "lastModifiedDate": "2019-08-24T14:15:22Z",
395 "archived": true,
396 "externalId": "string",
397 "id": 0,
398 "name": "string",
399 "code": "string"
400 }
401 }
402 }
403 },
404 "cityId": 0,
405 "districtId": 0
406 }
407 }
408]
Response Schema
Status Code 201
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing a location within the Nakisa Portfolio Management Suite, encapsulating essential details related to real estate properties, assets, and portfolio analytics.] |
|
» createdBy |
string |
false |
none |
Username of who created this resource |
» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
» createdDate |
string(date-time) |
false |
none |
Date of the created |
» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
» archived |
boolean |
false |
none |
Boolean flag indicating archived status |
» externalId |
string |
false |
none |
Unique identifier for the external |
» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
» number |
string |
false |
none |
Text value for number in LocationDto |
» name |
string |
true |
none |
Name of the resource |
» storeNumber |
string |
true |
none |
Text value for storeNumber in LocationDto |
» defaultCurrencyId |
integer(int64) |
true |
none |
Unique identifier for the default currency |
» defaultMeasureId |
integer(int64) |
true |
none |
Unique identifier for the default measure |
» typeId |
integer(int64) |
true |
none |
Unique identifier for the type |
» qualityId |
integer(int64) |
false |
none |
Unique identifier for the quality |
» propertyTypeId |
integer(int64) |
false |
none |
Unique identifier for the property type |
» categoryId |
integer(int64) |
false |
none |
Unique identifier for the category |
» statusId |
integer(int64) |
false |
none |
Unique identifier for the status |
» businessUnitId |
integer(int64) |
false |
none |
Unique identifier for the business unit |
» groupIds |
[integer] |
false |
none |
List of groupIds items |
» legalEntityIds |
[integer] |
false |
none |
List of legalEntityIds items |
» defaultCurrency |
false |
none |
Data transfer object representing currency details utilized within the Nakisa Portfolio Management Suite, facilitating accurate financial analysis and reporting for portfolio, asset, and real estate property management. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» status |
string |
false |
none |
Status of the resource |
»» displayId |
string |
true |
none |
Unique identifier for the display |
»» erpSystemId |
integer(int64) |
false |
none |
Unique identifier for the erp system |
»» erpSystemDisplayId |
string |
false |
none |
Unique identifier for the erp system display |
»» name |
string |
false |
none |
Name of the resource |
»» decimalPoints |
integer(int32) |
true |
none |
Numeric value representing decimalPoints |
»» depreciationAreaId |
integer(int64) |
false |
none |
Unique identifier for the depreciation area |
» defaultUnitValue |
false |
none |
Data transfer object representing the default values for units within the Nakisa Portfolio Management Suite, facilitating effective portfolio and asset analytics for real estate properties. |
|
»» createdBy |
string |
false |
none |
Username of who created this resource |
»» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
»» createdDate |
string(date-time) |
false |
none |
Date of the created |
»» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
»» archived |
boolean |
false |
none |
Boolean flag indicating archived status |
»» externalId |
string |
false |
none |
Unique identifier for the external |
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» unitId |
integer(int64) |
false |
none |
Unique identifier for the unit |
»» unitOfMeasureId |
integer(int64) |
false |
none |
Unique identifier for the unit of measure |
»» erpSystemId |
integer(int64) |
false |
none |
Unique identifier for the erp system |
»» unit |
false |
none |
Data transfer object representing an option within a pick list, utilized for categorizing and managing portfolio assets and analytics in the Nakisa Portfolio Management Suite, particularly in the context of real estate property management. |
|
»»» createdBy |
string |
false |
none |
Username of who created this resource |
»»» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
»»» createdDate |
string(date-time) |
false |
none |
Date of the created |
»»» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
»»» archived |
boolean |
false |
none |
Boolean flag indicating archived status |
»»» externalId |
string |
false |
none |
Unique identifier for the external |
»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»» priority |
integer(int64) |
false |
none |
Priority of the resource |
»»» internalId |
integer(int64) |
false |
none |
Unique identifier for the internal |
»»» pickListCode |
string |
false |
none |
Code for the pick list |
»»» pickListLabel |
string |
false |
none |
Label for the pick list |
»»» label |
string |
false |
none |
Label for the resource |
»»» cultureId |
integer(int64) |
false |
none |
Unique identifier for the culture |
»»» labelDtos |
false |
none |
List of labelDtos items |
|
»»»» createdBy |
string |
false |
none |
Username of who created this resource |
»»»» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
»»»» createdDate |
string(date-time) |
false |
none |
Date of the created |
»»»» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
»»»» archived |
boolean |
false |
none |
Boolean flag indicating archived status |
»»»» externalId |
string |
false |
none |
Unique identifier for the external |
»»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»»» cultureId |
integer(int64) |
false |
none |
Unique identifier for the culture |
»»»» value |
string |
true |
none |
Text value for value in LabelDto |
»» unitOfMeasure |
false |
none |
Data transfer object representing the unit of measure utilized within the Nakisa Portfolio Management Suite, essential for accurately quantifying and analyzing assets in the context of portfolio management and real estate property analytics. |
|
»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»» status |
string |
false |
none |
Status of the resource |
»»» displayId |
string |
true |
none |
Unique identifier for the display |
»»» erpSystemId |
integer(int64) |
false |
none |
Unique identifier for the erp system |
»»» erpSystemDisplayId |
string |
false |
none |
Unique identifier for the erp system display |
»»» name |
string |
false |
none |
Name of the resource |
» type |
false |
none |
Data transfer object representing an option within a pick list, utilized for categorizing and managing portfolio assets and analytics in the Nakisa Portfolio Management Suite, particularly in the context of real estate property management. |
|
» quality |
false |
none |
Data transfer object representing an option within a pick list, utilized for categorizing and managing portfolio assets and analytics in the Nakisa Portfolio Management Suite, particularly in the context of real estate property management. |
|
» propertyType |
false |
none |
Data transfer object representing an option within a pick list, utilized for categorizing and managing portfolio assets and analytics in the Nakisa Portfolio Management Suite, particularly in the context of real estate property management. |
|
» category |
false |
none |
Data transfer object representing an option within a pick list, utilized for categorizing and managing portfolio assets and analytics in the Nakisa Portfolio Management Suite, particularly in the context of real estate property management. |
|
» status |
false |
none |
Data transfer object representing an option within a pick list, utilized for categorizing and managing portfolio assets and analytics in the Nakisa Portfolio Management Suite, particularly in the context of real estate property management. |
|
» addressDto |
true |
none |
Data transfer object representing the address details associated with real estate properties within the Nakisa Portfolio Management Suite, facilitating accurate portfolio and asset analytics. |
|
»» createdBy |
string |
false |
none |
Username of who created this resource |
»» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
»» createdDate |
string(date-time) |
false |
none |
Date of the created |
»» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
»» archived |
boolean |
false |
none |
Boolean flag indicating archived status |
»» externalId |
string |
false |
none |
Unique identifier for the external |
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» street |
string |
false |
none |
Text value for street in AddressDto |
»» civicNumber |
string |
false |
none |
Text value for civicNumber in AddressDto |
»» suite |
string |
false |
none |
Text value for suite in AddressDto |
»» postalCode |
string |
false |
none |
Code for the postal |
»» lon |
number(double) |
false |
none |
Value for lon field |
»» lat |
number(double) |
false |
none |
Value for lat field |
»» city |
false |
none |
Data transfer object representing a city within the Nakisa Portfolio Management Suite, encapsulating essential information related to real estate properties, portfolio management, and asset analytics. This object facilitates informed decision-making and strategic planning in urban asset management. |
|
»»» createdBy |
string |
false |
none |
Username of who created this resource |
»»» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
»»» createdDate |
string(date-time) |
false |
none |
Date of the created |
»»» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
»»» archived |
boolean |
false |
none |
Boolean flag indicating archived status |
»»» externalId |
string |
false |
none |
Unique identifier for the external |
»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»» name |
string |
true |
none |
Name of the resource |
»»» province |
false |
none |
Data transfer object representing a province within the Nakisa Portfolio Management Suite, encapsulating essential details for portfolio analysis and asset management in the context of real estate properties. |
|
»»»» createdBy |
string |
false |
none |
Username of who created this resource |
»»»» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
»»»» createdDate |
string(date-time) |
false |
none |
Date of the created |
»»»» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
»»»» archived |
boolean |
false |
none |
Boolean flag indicating archived status |
»»»» externalId |
string |
false |
none |
Unique identifier for the external |
»»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»»» name |
string |
true |
none |
Name of the resource |
»»»» code |
string |
false |
none |
Code identifier for the resource |
»»»» country |
false |
none |
Data transfer object representing a country within the Nakisa Portfolio Management Suite, utilized for portfolio analysis and asset management in the context of real estate properties and analytics. |
|
»»»»» createdBy |
string |
false |
none |
Username of who created this resource |
»»»»» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
»»»»» createdDate |
string(date-time) |
false |
none |
Date of the created |
»»»»» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
»»»»» archived |
boolean |
false |
none |
Boolean flag indicating archived status |
»»»»» externalId |
string |
false |
none |
Unique identifier for the external |
»»»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»»»» name |
string |
true |
none |
Name of the resource |
»»»»» code |
string |
false |
none |
Code identifier for the resource |
»» district |
false |
none |
Data transfer object representing a district within the Nakisa Portfolio Management Suite, encompassing key attributes related to portfolio management, asset allocation, and real estate property analytics. |
|
»»» createdBy |
string |
false |
none |
Username of who created this resource |
»»» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
»»» createdDate |
string(date-time) |
false |
none |
Date of the created |
»»» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
»»» archived |
boolean |
false |
none |
Boolean flag indicating archived status |
»»» externalId |
string |
false |
none |
Unique identifier for the external |
»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»» name |
string |
true |
none |
Name of the resource |
»»» city |
false |
none |
Data transfer object representing a city within the Nakisa Portfolio Management Suite, encapsulating essential information related to real estate properties, portfolio management, and asset analytics. This object facilitates informed decision-making and strategic planning in urban asset management. |
|
»» cityId |
integer(int64) |
false |
none |
Unique identifier for the city |
»» districtId |
integer(int64) |
false |
none |
Unique identifier for the district |
» secondAddressDto |
false |
none |
Data transfer object representing the address details associated with real estate properties within the Nakisa Portfolio Management Suite, facilitating accurate portfolio and asset analytics. |
Enumerated Values
Attribute |
Value |
|---|---|
status |
ACTIVE, CREATED, DECOMMISSIONED, DISABLED |
Get Pictures For Location¶
HTTP Request
GET /api/locations/{locationId}/pictures
📋 Description: Retrieves a list of images associated with a specific location within the Nakisa Portfolio Management Suite, facilitating enhanced asset visualization and analytics for real estate properties.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
Indicates whether the results for pictures associated with a specific location should be returned in a paginated format, facilitating efficient data retrieval within the Nakisa Portfolio Management Suite. |
|
locationId |
path |
string |
true |
Unique identifier for the location |
search |
query |
string |
false |
Search term used to filter and retrieve specific pictures associated with the designated location within the Nakisa Portfolio Management Suite. |
default |
query |
string |
false |
Specifies the default image to be retrieved for the real estate property associated with the given location ID in the Nakisa Portfolio Management Suite. |
name |
query |
string |
false |
Name of the resource |
type |
query |
string |
false |
Type of the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "_embedded": {
3 "pictures": [
4 {
5 "createdBy": "string",
6 "lastModifiedBy": "string",
7 "createdDate": "2019-08-24T14:15:22Z",
8 "lastModifiedDate": "2019-08-24T14:15:22Z",
9 "archived": true,
10 "externalId": "string",
11 "isDefault": true,
12 "documentDto": {
13 "createdBy": "string",
14 "lastModifiedBy": "string",
15 "createdDate": "2019-08-24T14:15:22Z",
16 "lastModifiedDate": "2019-08-24T14:15:22Z",
17 "archived": true,
18 "externalId": "string",
19 "id": 0,
20 "name": "string",
21 "title": "string",
22 "type": "string",
23 "description": "string",
24 "link": "string",
25 "signedDate": "2019-08-24",
26 "documentTypeId": 0,
27 "statusId": 0,
28 "shareable": true,
29 "size": 0,
30 "documentType": {
31 "createdBy": "string",
32 "lastModifiedBy": "string",
33 "createdDate": "2019-08-24T14:15:22Z",
34 "lastModifiedDate": "2019-08-24T14:15:22Z",
35 "archived": true,
36 "externalId": "string",
37 "id": 0,
38 "priority": 0,
39 "internalId": 0,
40 "pickListCode": "string",
41 "pickListLabel": "string",
42 "label": "string",
43 "cultureId": 0,
44 "labelDtos": [
45 {
46 "createdBy": "string",
47 "lastModifiedBy": "string",
48 "createdDate": "2019-08-24T14:15:22Z",
49 "lastModifiedDate": "2019-08-24T14:15:22Z",
50 "archived": true,
51 "externalId": "string",
52 "id": 0,
53 "cultureId": 0,
54 "value": "string"
55 }
56 ]
57 },
58 "status": {
59 "createdBy": "string",
60 "lastModifiedBy": "string",
61 "createdDate": "2019-08-24T14:15:22Z",
62 "lastModifiedDate": "2019-08-24T14:15:22Z",
63 "archived": true,
64 "externalId": "string",
65 "id": 0,
66 "priority": 0,
67 "internalId": 0,
68 "pickListCode": "string",
69 "pickListLabel": "string",
70 "label": "string",
71 "cultureId": 0,
72 "labelDtos": [
73 {
74 "createdBy": "string",
75 "lastModifiedBy": "string",
76 "createdDate": "2019-08-24T14:15:22Z",
77 "lastModifiedDate": "2019-08-24T14:15:22Z",
78 "archived": true,
79 "externalId": "string",
80 "id": 0,
81 "cultureId": 0,
82 "value": "string"
83 }
84 ]
85 }
86 }
87 }
88 ]
89 },
90 "page": {
91 "size": 0,
92 "totalElements": 0,
93 "totalPages": 0,
94 "number": 0
95 }
96}
Upload Location Picture¶
HTTP Request
POST /api/locations/{locationId}/pictures
📋 Description: Uploads images associated with a specific location within the Nakisa Portfolio Management Suite, enhancing the visual representation of real estate assets for portfolio analytics.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
locationId |
path |
integer(int64) |
true |
Unique identifier for the location |
body |
body |
object |
false |
Request body containing the image data and associated metadata for the specified location, facilitating enhanced asset visualization and analytics within the Nakisa Portfolio Management Suite. |
» file |
body |
string(binary) |
true |
none |
» document |
body |
true |
Data transfer object representing a document within the Nakisa Portfolio Management Suite, encapsulating essential information related to portfolio assets, analytics, and real estate properties. |
|
»» createdBy |
body |
string |
false |
Username of who created this resource |
»» lastModifiedBy |
body |
string |
false |
Username of who last modified this resource |
»» createdDate |
body |
string(date-time) |
false |
Date of the created |
»» lastModifiedDate |
body |
string(date-time) |
false |
Date of the last modified |
»» archived |
body |
boolean |
false |
Boolean flag indicating archived status |
»» externalId |
body |
string |
false |
Unique identifier for the external |
»» id |
body |
integer(int64) |
false |
Unique identifier for the resource |
»» name |
body |
string |
false |
Name of the resource |
»» title |
body |
string |
false |
Title of the resource |
»» type |
body |
string |
false |
Type of the resource |
»» description |
body |
string |
false |
Description of the resource |
»» link |
body |
string |
false |
Text value for link in DocumentDto |
»» signedDate |
body |
string(date) |
false |
Date of the signed |
»» documentTypeId |
body |
integer(int64) |
false |
Unique identifier for the document type |
»» statusId |
body |
integer(int64) |
false |
Unique identifier for the status |
»» shareable |
body |
boolean |
false |
Boolean flag indicating shareable status |
»» size |
body |
integer(int64) |
false |
Number of items per page |
»» documentType |
body |
false |
Data transfer object representing an option within a pick list, utilized for categorizing and managing portfolio assets and analytics in the Nakisa Portfolio Management Suite, particularly in the context of real estate property management. |
|
»»» createdBy |
body |
string |
false |
Username of who created this resource |
»»» lastModifiedBy |
body |
string |
false |
Username of who last modified this resource |
»»» createdDate |
body |
string(date-time) |
false |
Date of the created |
»»» lastModifiedDate |
body |
string(date-time) |
false |
Date of the last modified |
»»» archived |
body |
boolean |
false |
Boolean flag indicating archived status |
»»» externalId |
body |
string |
false |
Unique identifier for the external |
»»» id |
body |
integer(int64) |
false |
Unique identifier for the resource |
»»» priority |
body |
integer(int64) |
false |
Priority of the resource |
»»» internalId |
body |
integer(int64) |
false |
Unique identifier for the internal |
»»» pickListCode |
body |
string |
false |
Code for the pick list |
»»» pickListLabel |
body |
string |
false |
Label for the pick list |
»»» label |
body |
string |
false |
Label for the resource |
»»» cultureId |
body |
integer(int64) |
false |
Unique identifier for the culture |
»»» labelDtos |
body |
false |
List of labelDtos items |
|
»»»» createdBy |
body |
string |
false |
Username of who created this resource |
»»»» lastModifiedBy |
body |
string |
false |
Username of who last modified this resource |
»»»» createdDate |
body |
string(date-time) |
false |
Date of the created |
»»»» lastModifiedDate |
body |
string(date-time) |
false |
Date of the last modified |
»»»» archived |
body |
boolean |
false |
Boolean flag indicating archived status |
»»»» externalId |
body |
string |
false |
Unique identifier for the external |
»»»» id |
body |
integer(int64) |
false |
Unique identifier for the resource |
»»»» cultureId |
body |
integer(int64) |
false |
Unique identifier for the culture |
»»»» value |
body |
string |
true |
Text value for value in LabelDto |
»» status |
body |
false |
Data transfer object representing an option within a pick list, utilized for categorizing and managing portfolio assets and analytics in the Nakisa Portfolio Management Suite, particularly in the context of real estate property management. |
Body Parameters
1{
2 "document": {
3 "archived": true,
4 "createdBy": "string",
5 "createdDate": "2019-08-24 14:15:22+00:00",
6 "description": "string",
7 "documentType": {
8 "archived": true,
9 "createdBy": "string",
10 "createdDate": "2019-08-24 14:15:22+00:00",
11 "cultureId": 0,
12 "externalId": "string",
13 "id": 0,
14 "internalId": 0,
15 "label": "string",
16 "labelDtos": [
17 {
18 "archived": true,
19 "createdBy": "string",
20 "createdDate": "2019-08-24 14:15:22+00:00",
21 "cultureId": 0,
22 "externalId": "string",
23 "id": 0,
24 "lastModifiedBy": "string",
25 "lastModifiedDate": "2019-08-24 14:15:22+00:00",
26 "value": "string"
27 }
28 ],
29 "lastModifiedBy": "string",
30 "lastModifiedDate": "2019-08-24 14:15:22+00:00",
31 "pickListCode": "string",
32 "pickListLabel": "string",
33 "priority": 0
34 },
35 "documentTypeId": 0,
36 "externalId": "string",
37 "id": 0,
38 "lastModifiedBy": "string",
39 "lastModifiedDate": "2019-08-24 14:15:22+00:00",
40 "link": "string",
41 "name": "string",
42 "shareable": true,
43 "signedDate": "2019-08-24",
44 "size": 0,
45 "status": {
46 "archived": true,
47 "createdBy": "string",
48 "createdDate": "2019-08-24 14:15:22+00:00",
49 "cultureId": 0,
50 "externalId": "string",
51 "id": 0,
52 "internalId": 0,
53 "label": "string",
54 "labelDtos": [
55 {
56 "archived": true,
57 "createdBy": "string",
58 "createdDate": "2019-08-24 14:15:22+00:00",
59 "cultureId": 0,
60 "externalId": "string",
61 "id": 0,
62 "lastModifiedBy": "string",
63 "lastModifiedDate": "2019-08-24 14:15:22+00:00",
64 "value": "string"
65 }
66 ],
67 "lastModifiedBy": "string",
68 "lastModifiedDate": "2019-08-24 14:15:22+00:00",
69 "pickListCode": "string",
70 "pickListLabel": "string",
71 "priority": 0
72 },
73 "statusId": 0,
74 "title": "string",
75 "type": "string"
76 },
77 "file": "string"
78}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
201 |
Created |
Example Responses
1{
2 "createdBy": "string",
3 "lastModifiedBy": "string",
4 "createdDate": "2019-08-24T14:15:22Z",
5 "lastModifiedDate": "2019-08-24T14:15:22Z",
6 "archived": true,
7 "externalId": "string",
8 "isDefault": true,
9 "documentDto": {
10 "createdBy": "string",
11 "lastModifiedBy": "string",
12 "createdDate": "2019-08-24T14:15:22Z",
13 "lastModifiedDate": "2019-08-24T14:15:22Z",
14 "archived": true,
15 "externalId": "string",
16 "id": 0,
17 "name": "string",
18 "title": "string",
19 "type": "string",
20 "description": "string",
21 "link": "string",
22 "signedDate": "2019-08-24",
23 "documentTypeId": 0,
24 "statusId": 0,
25 "shareable": true,
26 "size": 0,
27 "documentType": {
28 "createdBy": "string",
29 "lastModifiedBy": "string",
30 "createdDate": "2019-08-24T14:15:22Z",
31 "lastModifiedDate": "2019-08-24T14:15:22Z",
32 "archived": true,
33 "externalId": "string",
34 "id": 0,
35 "priority": 0,
36 "internalId": 0,
37 "pickListCode": "string",
38 "pickListLabel": "string",
39 "label": "string",
40 "cultureId": 0,
41 "labelDtos": [
42 {
43 "createdBy": "string",
44 "lastModifiedBy": "string",
45 "createdDate": "2019-08-24T14:15:22Z",
46 "lastModifiedDate": "2019-08-24T14:15:22Z",
47 "archived": true,
48 "externalId": "string",
49 "id": 0,
50 "cultureId": 0,
51 "value": "string"
52 }
53 ]
54 },
55 "status": {
56 "createdBy": "string",
57 "lastModifiedBy": "string",
58 "createdDate": "2019-08-24T14:15:22Z",
59 "lastModifiedDate": "2019-08-24T14:15:22Z",
60 "archived": true,
61 "externalId": "string",
62 "id": 0,
63 "priority": 0,
64 "internalId": 0,
65 "pickListCode": "string",
66 "pickListLabel": "string",
67 "label": "string",
68 "cultureId": 0,
69 "labelDtos": [
70 {
71 "createdBy": "string",
72 "lastModifiedBy": "string",
73 "createdDate": "2019-08-24T14:15:22Z",
74 "lastModifiedDate": "2019-08-24T14:15:22Z",
75 "archived": true,
76 "externalId": "string",
77 "id": 0,
78 "cultureId": 0,
79 "value": "string"
80 }
81 ]
82 }
83 }
84}
Set Default Location Picture¶
HTTP Request
POST /api/locations/{locationId}/pictures/{pictureId}/default
📋 Description: Sets the specified picture as the default image for the designated location within the Nakisa Portfolio Management Suite, enhancing the visual representation of real estate assets in portfolio analytics.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
locationId |
path |
integer(int64) |
true |
Unique identifier for the location |
pictureId |
path |
integer(int64) |
true |
Unique identifier for the picture |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "createdBy": "string",
3 "lastModifiedBy": "string",
4 "createdDate": "2019-08-24T14:15:22Z",
5 "lastModifiedDate": "2019-08-24T14:15:22Z",
6 "archived": true,
7 "externalId": "string",
8 "isDefault": true,
9 "documentDto": {
10 "createdBy": "string",
11 "lastModifiedBy": "string",
12 "createdDate": "2019-08-24T14:15:22Z",
13 "lastModifiedDate": "2019-08-24T14:15:22Z",
14 "archived": true,
15 "externalId": "string",
16 "id": 0,
17 "name": "string",
18 "title": "string",
19 "type": "string",
20 "description": "string",
21 "link": "string",
22 "signedDate": "2019-08-24",
23 "documentTypeId": 0,
24 "statusId": 0,
25 "shareable": true,
26 "size": 0,
27 "documentType": {
28 "createdBy": "string",
29 "lastModifiedBy": "string",
30 "createdDate": "2019-08-24T14:15:22Z",
31 "lastModifiedDate": "2019-08-24T14:15:22Z",
32 "archived": true,
33 "externalId": "string",
34 "id": 0,
35 "priority": 0,
36 "internalId": 0,
37 "pickListCode": "string",
38 "pickListLabel": "string",
39 "label": "string",
40 "cultureId": 0,
41 "labelDtos": [
42 {
43 "createdBy": "string",
44 "lastModifiedBy": "string",
45 "createdDate": "2019-08-24T14:15:22Z",
46 "lastModifiedDate": "2019-08-24T14:15:22Z",
47 "archived": true,
48 "externalId": "string",
49 "id": 0,
50 "cultureId": 0,
51 "value": "string"
52 }
53 ]
54 },
55 "status": {
56 "createdBy": "string",
57 "lastModifiedBy": "string",
58 "createdDate": "2019-08-24T14:15:22Z",
59 "lastModifiedDate": "2019-08-24T14:15:22Z",
60 "archived": true,
61 "externalId": "string",
62 "id": 0,
63 "priority": 0,
64 "internalId": 0,
65 "pickListCode": "string",
66 "pickListLabel": "string",
67 "label": "string",
68 "cultureId": 0,
69 "labelDtos": [
70 {
71 "createdBy": "string",
72 "lastModifiedBy": "string",
73 "createdDate": "2019-08-24T14:15:22Z",
74 "lastModifiedDate": "2019-08-24T14:15:22Z",
75 "archived": true,
76 "externalId": "string",
77 "id": 0,
78 "cultureId": 0,
79 "value": "string"
80 }
81 ]
82 }
83 }
84}
Create Location To Partner¶
HTTP Request
POST /api/locations/{locationId}/partners
📋 Description: Creates a new partner association for a specified location within the Nakisa Portfolio Management Suite, enhancing portfolio analytics and asset management for real estate properties.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
locationId |
path |
integer(int64) |
true |
Unique identifier for the location |
body |
body |
true |
Request body containing partner information, including details such as name, role, and contact data, to associate with a specified location within the Nakisa Portfolio Management Suite. |
Body Parameters
1[
2 {
3 "createdBy": "string",
4 "lastModifiedBy": "string",
5 "createdDate": "2019-08-24T14:15:22Z",
6 "lastModifiedDate": "2019-08-24T14:15:22Z",
7 "archived": true,
8 "externalId": "string",
9 "id": 0,
10 "partnerId": 0,
11 "partnerRoleId": 0,
12 "dateFrom": "2019-08-24",
13 "dateTo": "2019-08-24",
14 "fosContactIds": [
15 0
16 ],
17 "locationId": 0,
18 "partner": {
19 "id": 0,
20 "displayId": "string",
21 "status": "CREATED",
22 "name": "string",
23 "erpSystemDisplayId": "string"
24 },
25 "partnerParent": {
26 "id": 0,
27 "displayId": "string",
28 "status": "CREATED",
29 "name": "string",
30 "erpSystemDisplayId": "string"
31 },
32 "partnerRole": {
33 "id": 0,
34 "displayId": "string",
35 "status": "CREATED",
36 "name": "string"
37 }
38 }
39]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
201 |
Created |
Inline |
Example Responses
1[
2 {
3 "createdBy": "string",
4 "lastModifiedBy": "string",
5 "createdDate": "2019-08-24T14:15:22Z",
6 "lastModifiedDate": "2019-08-24T14:15:22Z",
7 "archived": true,
8 "externalId": "string",
9 "id": 0,
10 "partnerId": 0,
11 "partnerRoleId": 0,
12 "dateFrom": "2019-08-24",
13 "dateTo": "2019-08-24",
14 "fosContactIds": [
15 0
16 ],
17 "locationId": 0,
18 "partner": {
19 "id": 0,
20 "displayId": "string",
21 "status": "CREATED",
22 "name": "string",
23 "erpSystemDisplayId": "string"
24 },
25 "partnerParent": {
26 "id": 0,
27 "displayId": "string",
28 "status": "CREATED",
29 "name": "string",
30 "erpSystemDisplayId": "string"
31 },
32 "partnerRole": {
33 "id": 0,
34 "displayId": "string",
35 "status": "CREATED",
36 "name": "string"
37 }
38 }
39]
Response Schema
Status Code 201
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing the association between a location and its corresponding partner within the Nakisa Portfolio Management Suite, facilitating insights into portfolio, asset management, and real estate property analytics.] |
|
» createdBy |
string |
false |
none |
Username of who created this resource |
» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
» createdDate |
string(date-time) |
false |
none |
Date of the created |
» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
» archived |
boolean |
false |
none |
Boolean flag indicating archived status |
» externalId |
string |
false |
none |
Unique identifier for the external |
» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
» partnerId |
integer(int64) |
false |
none |
Unique identifier for the partner |
» partnerRoleId |
integer(int64) |
false |
none |
Unique identifier for the partner role |
» dateFrom |
string(date) |
false |
none |
Text value for dateFrom in LocationToPartnerDto |
» dateTo |
string(date) |
false |
none |
Text value for dateTo in LocationToPartnerDto |
» fosContactIds |
[integer] |
false |
none |
List of fosContactIds items |
» locationId |
integer(int64) |
false |
none |
Unique identifier for the location |
» partner |
false |
none |
Data transfer object representing a streamlined partner profile within the Nakisa Portfolio Management Suite, encompassing essential details for portfolio, asset, and analytics management in the real estate property sector. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» status |
string |
false |
none |
Status of the resource |
»» name |
string |
false |
none |
Name of the resource |
»» erpSystemDisplayId |
string |
false |
none |
Unique identifier for the erp system display |
» partnerParent |
false |
none |
Data transfer object representing a streamlined partner profile within the Nakisa Portfolio Management Suite, encompassing essential details for portfolio, asset, and analytics management in the real estate property sector. |
|
» partnerRole |
false |
none |
Data transfer object representing a simplified view of a partner’s role within the Nakisa Portfolio Management Suite, facilitating insights into portfolio, asset, and real estate property analytics. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» status |
string |
false |
none |
Status of the resource |
»» name |
string |
false |
none |
Name of the resource |
Enumerated Values
Attribute |
Value |
|---|---|
status |
ACTIVE, CREATED, DECOMMISSIONED, DISABLED |
Get Operating Cost Periods For Location¶
HTTP Request
GET /api/locations/{locationId}/operating-cost-periods
📋 Description: Retrieves the operating cost periods associated with a specified location, providing essential data for portfolio and asset management analytics within the Nakisa Portfolio Management Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
locationId |
path |
integer(int64) |
true |
Unique identifier for the location |
pageable |
query |
true |
Indicates whether the results for operating cost periods associated with a specific location should be returned in a paginated format, facilitating efficient data retrieval for portfolio and asset analysis. |
|
location-id |
query |
string |
false |
Unique identifier for the specific location within the Nakisa Portfolio Management Suite, used to retrieve its associated operating cost periods for portfolio and asset analytics in real estate management. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "_embedded": {
3 "operatingCostPeriods": [
4 {
5 "createdBy": "string",
6 "lastModifiedBy": "string",
7 "createdDate": "2019-08-24T14:15:22Z",
8 "lastModifiedDate": "2019-08-24T14:15:22Z",
9 "archived": true,
10 "externalId": "string",
11 "id": 0,
12 "year": 1950,
13 "statusId": 0,
14 "expenses": [
15 {
16 "createdBy": "string",
17 "lastModifiedBy": "string",
18 "createdDate": "2019-08-24T14:15:22Z",
19 "lastModifiedDate": "2019-08-24T14:15:22Z",
20 "archived": true,
21 "externalId": "string",
22 "id": 0,
23 "operatingCostExpenseTypeId": 0,
24 "amount": 0,
25 "revisedAmount": 0,
26 "considerRevisedAmount": true,
27 "operatingCostExpenseType": {
28 "createdBy": "string",
29 "lastModifiedBy": "string",
30 "createdDate": "2019-08-24T14:15:22Z",
31 "lastModifiedDate": "2019-08-24T14:15:22Z",
32 "archived": true,
33 "externalId": "string",
34 "id": 0,
35 "priority": 0,
36 "internalId": 0,
37 "pickListCode": "string",
38 "pickListLabel": "string",
39 "label": "string",
40 "cultureId": 0,
41 "labelDtos": [
42 {
43 "createdBy": "string",
44 "lastModifiedBy": "string",
45 "createdDate": "2019-08-24T14:15:22Z",
46 "lastModifiedDate": "2019-08-24T14:15:22Z",
47 "archived": true,
48 "externalId": "string",
49 "id": 0,
50 "cultureId": 0,
51 "value": "string"
52 }
53 ]
54 },
55 "expenseGroup": {
56 "createdBy": "string",
57 "lastModifiedBy": "string",
58 "createdDate": "2019-08-24T14:15:22Z",
59 "lastModifiedDate": "2019-08-24T14:15:22Z",
60 "archived": true,
61 "externalId": "string",
62 "id": 0,
63 "priority": 0,
64 "internalId": 0,
65 "pickListCode": "string",
66 "pickListLabel": "string",
67 "label": "string",
68 "cultureId": 0,
69 "labelDtos": [
70 {
71 "createdBy": "string",
72 "lastModifiedBy": "string",
73 "createdDate": "2019-08-24T14:15:22Z",
74 "lastModifiedDate": "2019-08-24T14:15:22Z",
75 "archived": true,
76 "externalId": "string",
77 "id": 0,
78 "cultureId": 0,
79 "value": "string"
80 }
81 ]
82 }
83 }
84 ],
85 "status": {
86 "createdBy": "string",
87 "lastModifiedBy": "string",
88 "createdDate": "2019-08-24T14:15:22Z",
89 "lastModifiedDate": "2019-08-24T14:15:22Z",
90 "archived": true,
91 "externalId": "string",
92 "id": 0,
93 "priority": 0,
94 "internalId": 0,
95 "pickListCode": "string",
96 "pickListLabel": "string",
97 "label": "string",
98 "cultureId": 0,
99 "labelDtos": [
100 {
101 "createdBy": "string",
102 "lastModifiedBy": "string",
103 "createdDate": "2019-08-24T14:15:22Z",
104 "lastModifiedDate": "2019-08-24T14:15:22Z",
105 "archived": true,
106 "externalId": "string",
107 "id": 0,
108 "cultureId": 0,
109 "value": "string"
110 }
111 ]
112 },
113 "leaseReconciliationPeriods": [
114 {
115 "createdBy": "string",
116 "lastModifiedBy": "string",
117 "createdDate": "2019-08-24T14:15:22Z",
118 "lastModifiedDate": "2019-08-24T14:15:22Z",
119 "archived": true,
120 "externalId": "string",
121 "id": 0,
122 "startDate": "2019-08-24",
123 "endDate": "2019-08-24",
124 "statusId": 0,
125 "invoiceAmount": 0,
126 "receivedDate": "2019-08-24",
127 "acceptedAmount": 0,
128 "reviewedBy": "string",
129 "reviewedDate": "2019-08-24",
130 "fullReconciliation": true,
131 "status": {
132 "createdBy": "string",
133 "lastModifiedBy": "string",
134 "createdDate": "2019-08-24T14:15:22Z",
135 "lastModifiedDate": "2019-08-24T14:15:22Z",
136 "archived": true,
137 "externalId": "string",
138 "id": 0,
139 "priority": 0,
140 "internalId": 0,
141 "pickListCode": "string",
142 "pickListLabel": "string",
143 "label": "string",
144 "cultureId": 0,
145 "labelDtos": [
146 {
147 "createdBy": "string",
148 "lastModifiedBy": "string",
149 "createdDate": "2019-08-24T14:15:22Z",
150 "lastModifiedDate": "2019-08-24T14:15:22Z",
151 "archived": true,
152 "externalId": "string",
153 "id": 0,
154 "cultureId": 0,
155 "value": "string"
156 }
157 ]
158 },
159 "operatingCostPeriodId": 0,
160 "reconciledExpenseCategoryDtos": [
161 {
162 "createdBy": "string",
163 "lastModifiedBy": "string",
164 "createdDate": "2019-08-24T14:15:22Z",
165 "lastModifiedDate": "2019-08-24T14:15:22Z",
166 "archived": true,
167 "externalId": "string",
168 "id": 0,
169 "expenseGroupId": 0,
170 "totalCost": 0,
171 "accrualAmount": 0,
172 "balance": 0,
173 "expenseGroup": {
174 "createdBy": "string",
175 "lastModifiedBy": "string",
176 "createdDate": "2019-08-24T14:15:22Z",
177 "lastModifiedDate": "2019-08-24T14:15:22Z",
178 "archived": true,
179 "externalId": "string",
180 "id": 0,
181 "priority": 0,
182 "internalId": 0,
183 "pickListCode": "string",
184 "pickListLabel": "string",
185 "label": "string",
186 "cultureId": 0,
187 "labelDtos": [
188 {}
189 ]
190 },
191 "reconciledExpenseDtos": [
192 {
193 "createdBy": "string",
194 "lastModifiedBy": "string",
195 "createdDate": "2019-08-24T14:15:22Z",
196 "lastModifiedDate": "2019-08-24T14:15:22Z",
197 "archived": true,
198 "externalId": "string",
199 "id": 0,
200 "totalCost": 0,
201 "operatingCostExpenseTypeId": 0,
202 "operatingCostExpenseType": {},
203 "reconciledExpenseSegmentDtos": []
204 }
205 ],
206 "hasWarning": true
207 }
208 ]
209 }
210 ]
211 }
212 ]
213 },
214 "page": {
215 "size": 0,
216 "totalElements": 0,
217 "totalPages": 0,
218 "number": 0
219 }
220}
Add Operating Cost Periods To Location¶
HTTP Request
POST /api/locations/{locationId}/operating-cost-periods
📋 Description: Creates a new operating cost period for a specified location within the Nakisa Portfolio Management Suite, enabling enhanced analytics and management of real estate property expenses.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
locationId |
path |
integer(int64) |
true |
Unique identifier for the location |
body |
body |
true |
Request body containing the operating cost period details, including relevant financial metrics and timeframes, essential for effective portfolio and asset management in real estate analytics. |
Body Parameters
1[
2 {
3 "createdBy": "string",
4 "lastModifiedBy": "string",
5 "createdDate": "2019-08-24T14:15:22Z",
6 "lastModifiedDate": "2019-08-24T14:15:22Z",
7 "archived": true,
8 "externalId": "string",
9 "id": 0,
10 "year": 1950,
11 "statusId": 0,
12 "expenses": [
13 {
14 "createdBy": "string",
15 "lastModifiedBy": "string",
16 "createdDate": "2019-08-24T14:15:22Z",
17 "lastModifiedDate": "2019-08-24T14:15:22Z",
18 "archived": true,
19 "externalId": "string",
20 "id": 0,
21 "operatingCostExpenseTypeId": 0,
22 "amount": 0,
23 "revisedAmount": 0,
24 "considerRevisedAmount": true,
25 "operatingCostExpenseType": {
26 "createdBy": "string",
27 "lastModifiedBy": "string",
28 "createdDate": "2019-08-24T14:15:22Z",
29 "lastModifiedDate": "2019-08-24T14:15:22Z",
30 "archived": true,
31 "externalId": "string",
32 "id": 0,
33 "priority": 0,
34 "internalId": 0,
35 "pickListCode": "string",
36 "pickListLabel": "string",
37 "label": "string",
38 "cultureId": 0,
39 "labelDtos": [
40 {
41 "createdBy": "string",
42 "lastModifiedBy": "string",
43 "createdDate": "2019-08-24T14:15:22Z",
44 "lastModifiedDate": "2019-08-24T14:15:22Z",
45 "archived": true,
46 "externalId": "string",
47 "id": 0,
48 "cultureId": 0,
49 "value": "string"
50 }
51 ]
52 },
53 "expenseGroup": {
54 "createdBy": "string",
55 "lastModifiedBy": "string",
56 "createdDate": "2019-08-24T14:15:22Z",
57 "lastModifiedDate": "2019-08-24T14:15:22Z",
58 "archived": true,
59 "externalId": "string",
60 "id": 0,
61 "priority": 0,
62 "internalId": 0,
63 "pickListCode": "string",
64 "pickListLabel": "string",
65 "label": "string",
66 "cultureId": 0,
67 "labelDtos": [
68 {
69 "createdBy": "string",
70 "lastModifiedBy": "string",
71 "createdDate": "2019-08-24T14:15:22Z",
72 "lastModifiedDate": "2019-08-24T14:15:22Z",
73 "archived": true,
74 "externalId": "string",
75 "id": 0,
76 "cultureId": 0,
77 "value": "string"
78 }
79 ]
80 }
81 }
82 ],
83 "status": {
84 "createdBy": "string",
85 "lastModifiedBy": "string",
86 "createdDate": "2019-08-24T14:15:22Z",
87 "lastModifiedDate": "2019-08-24T14:15:22Z",
88 "archived": true,
89 "externalId": "string",
90 "id": 0,
91 "priority": 0,
92 "internalId": 0,
93 "pickListCode": "string",
94 "pickListLabel": "string",
95 "label": "string",
96 "cultureId": 0,
97 "labelDtos": [
98 {
99 "createdBy": "string",
100 "lastModifiedBy": "string",
101 "createdDate": "2019-08-24T14:15:22Z",
102 "lastModifiedDate": "2019-08-24T14:15:22Z",
103 "archived": true,
104 "externalId": "string",
105 "id": 0,
106 "cultureId": 0,
107 "value": "string"
108 }
109 ]
110 },
111 "leaseReconciliationPeriods": [
112 {
113 "createdBy": "string",
114 "lastModifiedBy": "string",
115 "createdDate": "2019-08-24T14:15:22Z",
116 "lastModifiedDate": "2019-08-24T14:15:22Z",
117 "archived": true,
118 "externalId": "string",
119 "id": 0,
120 "startDate": "2019-08-24",
121 "endDate": "2019-08-24",
122 "statusId": 0,
123 "invoiceAmount": 0,
124 "receivedDate": "2019-08-24",
125 "acceptedAmount": 0,
126 "reviewedBy": "string",
127 "reviewedDate": "2019-08-24",
128 "fullReconciliation": true,
129 "status": {
130 "createdBy": "string",
131 "lastModifiedBy": "string",
132 "createdDate": "2019-08-24T14:15:22Z",
133 "lastModifiedDate": "2019-08-24T14:15:22Z",
134 "archived": true,
135 "externalId": "string",
136 "id": 0,
137 "priority": 0,
138 "internalId": 0,
139 "pickListCode": "string",
140 "pickListLabel": "string",
141 "label": "string",
142 "cultureId": 0,
143 "labelDtos": [
144 {
145 "createdBy": "string",
146 "lastModifiedBy": "string",
147 "createdDate": "2019-08-24T14:15:22Z",
148 "lastModifiedDate": "2019-08-24T14:15:22Z",
149 "archived": true,
150 "externalId": "string",
151 "id": 0,
152 "cultureId": 0,
153 "value": "string"
154 }
155 ]
156 },
157 "operatingCostPeriodId": 0,
158 "reconciledExpenseCategoryDtos": [
159 {
160 "createdBy": "string",
161 "lastModifiedBy": "string",
162 "createdDate": "2019-08-24T14:15:22Z",
163 "lastModifiedDate": "2019-08-24T14:15:22Z",
164 "archived": true,
165 "externalId": "string",
166 "id": 0,
167 "expenseGroupId": 0,
168 "totalCost": 0,
169 "accrualAmount": 0,
170 "balance": 0,
171 "expenseGroup": {
172 "createdBy": "string",
173 "lastModifiedBy": "string",
174 "createdDate": "2019-08-24T14:15:22Z",
175 "lastModifiedDate": "2019-08-24T14:15:22Z",
176 "archived": true,
177 "externalId": "string",
178 "id": 0,
179 "priority": 0,
180 "internalId": 0,
181 "pickListCode": "string",
182 "pickListLabel": "string",
183 "label": "string",
184 "cultureId": 0,
185 "labelDtos": [
186 {
187 "createdBy": "string",
188 "lastModifiedBy": "string",
189 "createdDate": "2019-08-24T14:15:22Z",
190 "lastModifiedDate": "2019-08-24T14:15:22Z",
191 "archived": true,
192 "externalId": "string",
193 "id": 0,
194 "cultureId": 0,
195 "value": "string"
196 }
197 ]
198 },
199 "reconciledExpenseDtos": [
200 {
201 "createdBy": "string",
202 "lastModifiedBy": "string",
203 "createdDate": "2019-08-24T14:15:22Z",
204 "lastModifiedDate": "2019-08-24T14:15:22Z",
205 "archived": true,
206 "externalId": "string",
207 "id": 0,
208 "totalCost": 0,
209 "operatingCostExpenseTypeId": 0,
210 "operatingCostExpenseType": {
211 "createdBy": "string",
212 "lastModifiedBy": "string",
213 "createdDate": "2019-08-24T14:15:22Z",
214 "lastModifiedDate": "2019-08-24T14:15:22Z",
215 "archived": true,
216 "externalId": "string",
217 "id": 0,
218 "priority": 0,
219 "internalId": 0,
220 "pickListCode": "string",
221 "pickListLabel": "string",
222 "label": "string",
223 "cultureId": 0,
224 "labelDtos": [
225 {}
226 ]
227 },
228 "reconciledExpenseSegmentDtos": [
229 {
230 "createdBy": "string",
231 "lastModifiedBy": "string",
232 "createdDate": "2019-08-24T14:15:22Z",
233 "lastModifiedDate": "2019-08-24T14:15:22Z",
234 "archived": true,
235 "externalId": "string",
236 "id": 0,
237 "startDate": "2019-08-24",
238 "endDate": "2019-08-24",
239 "adjustedLocationCost": 0,
240 "proSharePercentage": 0,
241 "proShareCost": 0,
242 "cap": 0,
243 "subtotalCost": 0,
244 "adminFees": 0,
245 "totalCost": 0,
246 "conditionDto": {}
247 }
248 ]
249 }
250 ],
251 "hasWarning": true
252 }
253 ]
254 }
255 ]
256 }
257]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
201 |
Created |
Inline |
Example Responses
1[
2 {
3 "createdBy": "string",
4 "lastModifiedBy": "string",
5 "createdDate": "2019-08-24T14:15:22Z",
6 "lastModifiedDate": "2019-08-24T14:15:22Z",
7 "archived": true,
8 "externalId": "string",
9 "id": 0,
10 "year": 1950,
11 "statusId": 0,
12 "expenses": [
13 {
14 "createdBy": "string",
15 "lastModifiedBy": "string",
16 "createdDate": "2019-08-24T14:15:22Z",
17 "lastModifiedDate": "2019-08-24T14:15:22Z",
18 "archived": true,
19 "externalId": "string",
20 "id": 0,
21 "operatingCostExpenseTypeId": 0,
22 "amount": 0,
23 "revisedAmount": 0,
24 "considerRevisedAmount": true,
25 "operatingCostExpenseType": {
26 "createdBy": "string",
27 "lastModifiedBy": "string",
28 "createdDate": "2019-08-24T14:15:22Z",
29 "lastModifiedDate": "2019-08-24T14:15:22Z",
30 "archived": true,
31 "externalId": "string",
32 "id": 0,
33 "priority": 0,
34 "internalId": 0,
35 "pickListCode": "string",
36 "pickListLabel": "string",
37 "label": "string",
38 "cultureId": 0,
39 "labelDtos": [
40 {
41 "createdBy": "string",
42 "lastModifiedBy": "string",
43 "createdDate": "2019-08-24T14:15:22Z",
44 "lastModifiedDate": "2019-08-24T14:15:22Z",
45 "archived": true,
46 "externalId": "string",
47 "id": 0,
48 "cultureId": 0,
49 "value": "string"
50 }
51 ]
52 },
53 "expenseGroup": {
54 "createdBy": "string",
55 "lastModifiedBy": "string",
56 "createdDate": "2019-08-24T14:15:22Z",
57 "lastModifiedDate": "2019-08-24T14:15:22Z",
58 "archived": true,
59 "externalId": "string",
60 "id": 0,
61 "priority": 0,
62 "internalId": 0,
63 "pickListCode": "string",
64 "pickListLabel": "string",
65 "label": "string",
66 "cultureId": 0,
67 "labelDtos": [
68 {
69 "createdBy": "string",
70 "lastModifiedBy": "string",
71 "createdDate": "2019-08-24T14:15:22Z",
72 "lastModifiedDate": "2019-08-24T14:15:22Z",
73 "archived": true,
74 "externalId": "string",
75 "id": 0,
76 "cultureId": 0,
77 "value": "string"
78 }
79 ]
80 }
81 }
82 ],
83 "status": {
84 "createdBy": "string",
85 "lastModifiedBy": "string",
86 "createdDate": "2019-08-24T14:15:22Z",
87 "lastModifiedDate": "2019-08-24T14:15:22Z",
88 "archived": true,
89 "externalId": "string",
90 "id": 0,
91 "priority": 0,
92 "internalId": 0,
93 "pickListCode": "string",
94 "pickListLabel": "string",
95 "label": "string",
96 "cultureId": 0,
97 "labelDtos": [
98 {
99 "createdBy": "string",
100 "lastModifiedBy": "string",
101 "createdDate": "2019-08-24T14:15:22Z",
102 "lastModifiedDate": "2019-08-24T14:15:22Z",
103 "archived": true,
104 "externalId": "string",
105 "id": 0,
106 "cultureId": 0,
107 "value": "string"
108 }
109 ]
110 },
111 "leaseReconciliationPeriods": [
112 {
113 "createdBy": "string",
114 "lastModifiedBy": "string",
115 "createdDate": "2019-08-24T14:15:22Z",
116 "lastModifiedDate": "2019-08-24T14:15:22Z",
117 "archived": true,
118 "externalId": "string",
119 "id": 0,
120 "startDate": "2019-08-24",
121 "endDate": "2019-08-24",
122 "statusId": 0,
123 "invoiceAmount": 0,
124 "receivedDate": "2019-08-24",
125 "acceptedAmount": 0,
126 "reviewedBy": "string",
127 "reviewedDate": "2019-08-24",
128 "fullReconciliation": true,
129 "status": {
130 "createdBy": "string",
131 "lastModifiedBy": "string",
132 "createdDate": "2019-08-24T14:15:22Z",
133 "lastModifiedDate": "2019-08-24T14:15:22Z",
134 "archived": true,
135 "externalId": "string",
136 "id": 0,
137 "priority": 0,
138 "internalId": 0,
139 "pickListCode": "string",
140 "pickListLabel": "string",
141 "label": "string",
142 "cultureId": 0,
143 "labelDtos": [
144 {
145 "createdBy": "string",
146 "lastModifiedBy": "string",
147 "createdDate": "2019-08-24T14:15:22Z",
148 "lastModifiedDate": "2019-08-24T14:15:22Z",
149 "archived": true,
150 "externalId": "string",
151 "id": 0,
152 "cultureId": 0,
153 "value": "string"
154 }
155 ]
156 },
157 "operatingCostPeriodId": 0,
158 "reconciledExpenseCategoryDtos": [
159 {
160 "createdBy": "string",
161 "lastModifiedBy": "string",
162 "createdDate": "2019-08-24T14:15:22Z",
163 "lastModifiedDate": "2019-08-24T14:15:22Z",
164 "archived": true,
165 "externalId": "string",
166 "id": 0,
167 "expenseGroupId": 0,
168 "totalCost": 0,
169 "accrualAmount": 0,
170 "balance": 0,
171 "expenseGroup": {
172 "createdBy": "string",
173 "lastModifiedBy": "string",
174 "createdDate": "2019-08-24T14:15:22Z",
175 "lastModifiedDate": "2019-08-24T14:15:22Z",
176 "archived": true,
177 "externalId": "string",
178 "id": 0,
179 "priority": 0,
180 "internalId": 0,
181 "pickListCode": "string",
182 "pickListLabel": "string",
183 "label": "string",
184 "cultureId": 0,
185 "labelDtos": [
186 {
187 "createdBy": "string",
188 "lastModifiedBy": "string",
189 "createdDate": "2019-08-24T14:15:22Z",
190 "lastModifiedDate": "2019-08-24T14:15:22Z",
191 "archived": true,
192 "externalId": "string",
193 "id": 0,
194 "cultureId": 0,
195 "value": "string"
196 }
197 ]
198 },
199 "reconciledExpenseDtos": [
200 {
201 "createdBy": "string",
202 "lastModifiedBy": "string",
203 "createdDate": "2019-08-24T14:15:22Z",
204 "lastModifiedDate": "2019-08-24T14:15:22Z",
205 "archived": true,
206 "externalId": "string",
207 "id": 0,
208 "totalCost": 0,
209 "operatingCostExpenseTypeId": 0,
210 "operatingCostExpenseType": {
211 "createdBy": "string",
212 "lastModifiedBy": "string",
213 "createdDate": "2019-08-24T14:15:22Z",
214 "lastModifiedDate": "2019-08-24T14:15:22Z",
215 "archived": true,
216 "externalId": "string",
217 "id": 0,
218 "priority": 0,
219 "internalId": 0,
220 "pickListCode": "string",
221 "pickListLabel": "string",
222 "label": "string",
223 "cultureId": 0,
224 "labelDtos": [
225 {}
226 ]
227 },
228 "reconciledExpenseSegmentDtos": [
229 {
230 "createdBy": "string",
231 "lastModifiedBy": "string",
232 "createdDate": "2019-08-24T14:15:22Z",
233 "lastModifiedDate": "2019-08-24T14:15:22Z",
234 "archived": true,
235 "externalId": "string",
236 "id": 0,
237 "startDate": "2019-08-24",
238 "endDate": "2019-08-24",
239 "adjustedLocationCost": 0,
240 "proSharePercentage": 0,
241 "proShareCost": 0,
242 "cap": 0,
243 "subtotalCost": 0,
244 "adminFees": 0,
245 "totalCost": 0,
246 "conditionDto": {}
247 }
248 ]
249 }
250 ],
251 "hasWarning": true
252 }
253 ]
254 }
255 ]
256 }
257]
Response Schema
Status Code 201
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing the operating cost period for assets within the Nakisa Portfolio Management Suite, facilitating analytics and insights related to portfolio and real estate property management.] |
|
» createdBy |
string |
false |
none |
Username of who created this resource |
» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
» createdDate |
string(date-time) |
false |
none |
Date of the created |
» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
» archived |
boolean |
false |
none |
Boolean flag indicating archived status |
» externalId |
string |
false |
none |
Unique identifier for the external |
» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
» year |
integer(int32) |
false |
none |
Numeric value representing year |
» statusId |
integer(int64) |
false |
none |
Unique identifier for the status |
» expenses |
false |
none |
List of expenses items |
|
»» createdBy |
string |
false |
none |
Username of who created this resource |
»» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
»» createdDate |
string(date-time) |
false |
none |
Date of the created |
»» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
»» archived |
boolean |
false |
none |
Boolean flag indicating archived status |
»» externalId |
string |
false |
none |
Unique identifier for the external |
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» operatingCostExpenseTypeId |
integer(int64) |
false |
none |
Unique identifier for the operating cost expense type |
»» amount |
number |
true |
none |
Amount value |
»» revisedAmount |
number |
false |
none |
Amount of revised |
»» considerRevisedAmount |
boolean |
false |
none |
Amount of consider revised |
»» operatingCostExpenseType |
false |
none |
Data transfer object representing an option within a pick list, utilized for categorizing and managing portfolio assets and analytics in the Nakisa Portfolio Management Suite, particularly in the context of real estate property management. |
|
»»» createdBy |
string |
false |
none |
Username of who created this resource |
»»» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
»»» createdDate |
string(date-time) |
false |
none |
Date of the created |
»»» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
»»» archived |
boolean |
false |
none |
Boolean flag indicating archived status |
»»» externalId |
string |
false |
none |
Unique identifier for the external |
»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»» priority |
integer(int64) |
false |
none |
Priority of the resource |
»»» internalId |
integer(int64) |
false |
none |
Unique identifier for the internal |
»»» pickListCode |
string |
false |
none |
Code for the pick list |
»»» pickListLabel |
string |
false |
none |
Label for the pick list |
»»» label |
string |
false |
none |
Label for the resource |
»»» cultureId |
integer(int64) |
false |
none |
Unique identifier for the culture |
»»» labelDtos |
false |
none |
List of labelDtos items |
|
»»»» createdBy |
string |
false |
none |
Username of who created this resource |
»»»» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
»»»» createdDate |
string(date-time) |
false |
none |
Date of the created |
»»»» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
»»»» archived |
boolean |
false |
none |
Boolean flag indicating archived status |
»»»» externalId |
string |
false |
none |
Unique identifier for the external |
»»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»»» cultureId |
integer(int64) |
false |
none |
Unique identifier for the culture |
»»»» value |
string |
true |
none |
Text value for value in LabelDto |
»» expenseGroup |
false |
none |
Data transfer object representing an option within a pick list, utilized for categorizing and managing portfolio assets and analytics in the Nakisa Portfolio Management Suite, particularly in the context of real estate property management. |
|
» status |
false |
none |
Data transfer object representing an option within a pick list, utilized for categorizing and managing portfolio assets and analytics in the Nakisa Portfolio Management Suite, particularly in the context of real estate property management. |
|
» leaseReconciliationPeriods |
false |
none |
List of leaseReconciliationPeriods items |
|
»» createdBy |
string |
false |
none |
Username of who created this resource |
»» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
»» createdDate |
string(date-time) |
false |
none |
Date of the created |
»» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
»» archived |
boolean |
false |
none |
Boolean flag indicating archived status |
»» externalId |
string |
false |
none |
Unique identifier for the external |
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» startDate |
string(date) |
false |
none |
Start date of the resource |
»» endDate |
string(date) |
false |
none |
End date of the resource |
»» statusId |
integer(int64) |
false |
none |
Unique identifier for the status |
»» invoiceAmount |
number |
false |
none |
Amount of invoice |
»» receivedDate |
string(date) |
false |
none |
Date of the received |
»» acceptedAmount |
number |
false |
none |
Amount of accepted |
»» reviewedBy |
string |
false |
none |
Text value for reviewedBy in LeaseReconciliationPeriodDto |
»» reviewedDate |
string(date) |
false |
none |
Date of the reviewed |
»» fullReconciliation |
boolean |
false |
none |
Boolean flag indicating fullReconciliation status |
»» status |
false |
none |
Data transfer object representing an option within a pick list, utilized for categorizing and managing portfolio assets and analytics in the Nakisa Portfolio Management Suite, particularly in the context of real estate property management. |
|
»» operatingCostPeriodId |
integer(int64) |
false |
none |
Unique identifier for the operating cost period |
»» reconciledExpenseCategoryDtos |
false |
none |
List of reconciledExpenseCategoryDtos items |
|
»»» createdBy |
string |
false |
none |
Username of who created this resource |
»»» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
»»» createdDate |
string(date-time) |
false |
none |
Date of the created |
»»» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
»»» archived |
boolean |
false |
none |
Boolean flag indicating archived status |
»»» externalId |
string |
false |
none |
Unique identifier for the external |
»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»» expenseGroupId |
integer(int64) |
false |
none |
Unique identifier for the expense group |
»»» totalCost |
number |
false |
none |
Value for totalCost field |
»»» accrualAmount |
number |
false |
none |
Amount of accrual |
»»» balance |
number |
false |
none |
Value for balance field |
»»» expenseGroup |
false |
none |
Data transfer object representing an option within a pick list, utilized for categorizing and managing portfolio assets and analytics in the Nakisa Portfolio Management Suite, particularly in the context of real estate property management. |
|
»»» reconciledExpenseDtos |
false |
none |
List of reconciledExpenseDtos items |
|
»»»» createdBy |
string |
false |
none |
Username of who created this resource |
»»»» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
»»»» createdDate |
string(date-time) |
false |
none |
Date of the created |
»»»» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
»»»» archived |
boolean |
false |
none |
Boolean flag indicating archived status |
»»»» externalId |
string |
false |
none |
Unique identifier for the external |
»»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»»» totalCost |
number |
false |
none |
Value for totalCost field |
»»»» operatingCostExpenseTypeId |
integer(int64) |
false |
none |
Unique identifier for the operating cost expense type |
»»»» operatingCostExpenseType |
false |
none |
Data transfer object representing an option within a pick list, utilized for categorizing and managing portfolio assets and analytics in the Nakisa Portfolio Management Suite, particularly in the context of real estate property management. |
|
»»»» reconciledExpenseSegmentDtos |
false |
none |
List of reconciledExpenseSegmentDtos items |
|
»»»»» createdBy |
string |
false |
none |
Username of who created this resource |
»»»»» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
»»»»» createdDate |
string(date-time) |
false |
none |
Date of the created |
»»»»» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
»»»»» archived |
boolean |
false |
none |
Boolean flag indicating archived status |
»»»»» externalId |
string |
false |
none |
Unique identifier for the external |
»»»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»»»» startDate |
string(date) |
false |
none |
Start date of the resource |
»»»»» endDate |
string(date) |
false |
none |
End date of the resource |
»»»»» adjustedLocationCost |
number |
false |
none |
Value for adjustedLocationCost field |
»»»»» proSharePercentage |
number |
false |
none |
Percentage of pro share |
»»»»» proShareCost |
number |
false |
none |
Value for proShareCost field |
»»»»» cap |
number |
false |
none |
Value for cap field |
»»»»» subtotalCost |
number |
false |
none |
Value for subtotalCost field |
»»»»» adminFees |
number |
false |
none |
Value for adminFees field |
»»»»» totalCost |
number |
false |
none |
Value for totalCost field |
»»»»» conditionDto |
false |
none |
Data transfer object representing the conditions associated with a lease within the Nakisa Portfolio Management Suite, facilitating insights and analytics for real estate property management and portfolio optimization. |
|
»»»»»» createdBy |
string |
false |
none |
Username of who created this resource |
»»»»»» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
»»»»»» createdDate |
string(date-time) |
false |
none |
Date of the created |
»»»»»» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
»»»»»» archived |
boolean |
false |
none |
Boolean flag indicating archived status |
»»»»»» externalId |
string |
false |
none |
Unique identifier for the external |
»»»»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»»»»» typeId |
integer(int64) |
false |
none |
Unique identifier for the type |
»»»»»» startDate |
string(date) |
false |
none |
Start date of the resource |
»»»»»» endDate |
string(date) |
false |
none |
End date of the resource |
»»»»»» replaceById |
integer(int64) |
false |
none |
Unique identifier for the replace by |
»»»»»» managedById |
integer(int64) |
false |
none |
Unique identifier for the managed by |
»»»»»» payById |
integer(int64) |
false |
none |
Unique identifier for the pay by |
»»»»»» adminFee |
number |
false |
none |
Value for adminFee field |
»»»»»» fixedIncreasePercentage |
number |
false |
none |
Percentage of fixed increase |
»»»»»» note |
string |
false |
none |
Text value for note in LeaseConditionDto |
»»»»»» pageNumber |
string |
false |
none |
Page number for pagination |
»»»»»» section |
string |
false |
none |
Text value for section in LeaseConditionDto |
»»»»»» type |
false |
none |
Data transfer object representing an option within a pick list, utilized for categorizing and managing portfolio assets and analytics in the Nakisa Portfolio Management Suite, particularly in the context of real estate property management. |
|
»»»»»» replaceBy |
false |
none |
Data transfer object representing an option within a pick list, utilized for categorizing and managing portfolio assets and analytics in the Nakisa Portfolio Management Suite, particularly in the context of real estate property management. |
|
»»»»»» managedBy |
false |
none |
Data transfer object representing an option within a pick list, utilized for categorizing and managing portfolio assets and analytics in the Nakisa Portfolio Management Suite, particularly in the context of real estate property management. |
|
»»»»»» payBy |
false |
none |
Data transfer object representing an option within a pick list, utilized for categorizing and managing portfolio assets and analytics in the Nakisa Portfolio Management Suite, particularly in the context of real estate property management. |
|
»»»»»» proShareDto |
any |
false |
none |
Value for proShareDto field |
oneOf - discriminator: type
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»»»»» anonymous |
false |
none |
Data transfer object representing a comprehensive overview of a real estate property within the Nakisa Portfolio Management Suite, encompassing key portfolio and asset analytics for informed decision-making. |
|
»»»»»»»» createdBy |
string |
false |
none |
Username of who created this resource |
»»»»»»»» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
»»»»»»»» createdDate |
string(date-time) |
false |
none |
Date of the created |
»»»»»»»» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
»»»»»»»» archived |
boolean |
false |
none |
Boolean flag indicating archived status |
»»»»»»»» externalId |
string |
false |
none |
Unique identifier for the external |
»»»»»»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»»»»»»» type |
string |
true |
none |
Type of the resource |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»»»»» anonymous |
false |
none |
Data transfer object representing area-based professional sharing insights within the Nakisa Portfolio Management Suite, facilitating analytics and decision-making related to portfolio and asset management in real estate properties. |
allOf - discriminator: type
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»»»»»» anonymous |
false |
none |
Data transfer object representing a comprehensive overview of a real estate property within the Nakisa Portfolio Management Suite, encompassing key portfolio and asset analytics for informed decision-making. |
and
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»»»»»» anonymous |
object |
false |
none |
none |
»»»»»»»»» dividendAreaTypeId |
integer(int64) |
false |
none |
none |
»»»»»»»»» divisorAreaTypeId |
integer(int64) |
false |
none |
none |
»»»»»»»»» dividendAreaId |
integer(int64) |
false |
none |
none |
»»»»»»»»» divisorAreaId |
integer(int64) |
false |
none |
none |
»»»»»»»»» dividendAreaType |
false |
none |
Data transfer object representing an option within a pick list, utilized for categorizing and managing portfolio assets and analytics in the Nakisa Portfolio Management Suite, particularly in the context of real estate property management. |
|
»»»»»»»»» divisorAreaType |
false |
none |
Data transfer object representing an option within a pick list, utilized for categorizing and managing portfolio assets and analytics in the Nakisa Portfolio Management Suite, particularly in the context of real estate property management. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»»»»» anonymous |
false |
none |
Data transfer object representing a fixed percentage profit-sharing arrangement within the Nakisa Portfolio Management Suite, facilitating analytics and decision-making for real estate property assets in portfolio management. |
allOf - discriminator: type
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»»»»»» anonymous |
false |
none |
Data transfer object representing a comprehensive overview of a real estate property within the Nakisa Portfolio Management Suite, encompassing key portfolio and asset analytics for informed decision-making. |
and
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»»»»»» anonymous |
object |
false |
none |
none |
»»»»»»»»» fixedPercentage |
number |
false |
none |
none |
continued
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»»»» capDto |
any |
false |
none |
Value for capDto field |
oneOf - discriminator: type
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»»»»» anonymous |
false |
none |
Data transfer object representing a comprehensive view of portfolio assets within the Nakisa Portfolio Management Suite, facilitating analytics and insights for real estate property management. |
|
»»»»»»»» createdBy |
string |
false |
none |
Username of who created this resource |
»»»»»»»» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
»»»»»»»» createdDate |
string(date-time) |
false |
none |
Date of the created |
»»»»»»»» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
»»»»»»»» archived |
boolean |
false |
none |
Boolean flag indicating archived status |
»»»»»»»» externalId |
string |
false |
none |
Unique identifier for the external |
»»»»»»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»»»»»»» type |
string |
true |
none |
Type of the resource |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»»»»» anonymous |
false |
none |
Data transfer object representing fixed capital assets within the Nakisa Portfolio Management Suite, encompassing key attributes for portfolio analysis, asset management, and real estate property evaluation. |
allOf - discriminator: type
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»»»»»» anonymous |
false |
none |
Data transfer object representing a comprehensive view of portfolio assets within the Nakisa Portfolio Management Suite, facilitating analytics and insights for real estate property management. |
and
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»»»»»» anonymous |
object |
false |
none |
none |
»»»»»»»»» amount |
number |
false |
none |
none |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»»»»» anonymous |
false |
none |
Data transfer object representing a comprehensive overview of portfolio assets within the Nakisa Portfolio Management Suite, facilitating analytics and insights for real estate property management. |
allOf - discriminator: type
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»»»»»» anonymous |
false |
none |
Data transfer object representing a comprehensive view of portfolio assets within the Nakisa Portfolio Management Suite, facilitating analytics and insights for real estate property management. |
and
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»»»»»» anonymous |
object |
false |
none |
none |
»»»»»»»»» baseYear |
integer(int32) |
false |
none |
none |
»»»»»»»»» baseAmount |
number |
false |
none |
none |
»»»»»»»»» maxIncreasePercentage |
number |
false |
none |
none |
»»»»»»»»» cumulative |
boolean |
false |
none |
none |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»»»»» anonymous |
false |
none |
Data transfer object representing the annual capital allocation projections for real estate properties within the Nakisa Portfolio Management Suite, facilitating portfolio analytics and asset management. |
allOf - discriminator: type
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»»»»»» anonymous |
false |
none |
Data transfer object representing a comprehensive view of portfolio assets within the Nakisa Portfolio Management Suite, facilitating analytics and insights for real estate property management. |
and
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»»»»»» anonymous |
object |
false |
none |
none |
»»»»»»»»» baseYear |
integer(int32) |
false |
none |
none |
»»»»»»»»» baseAmount |
number |
false |
none |
none |
»»»»»»»»» maxIncreasePercentage |
number |
false |
none |
none |
»»»»»»»»» cumulative |
boolean |
false |
none |
none |
continued
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» hasWarning |
boolean |
false |
none |
Whether the resource has has warning |
Add Notes To Location¶
HTTP Request
POST /api/locations/{locationId}/notes
📋 Description: Creates a new note associated with a specified location within the Nakisa Portfolio Management Suite, enhancing portfolio and asset management by allowing users to document insights or observations related to real estate properties.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
locationId |
path |
integer(int64) |
true |
Unique identifier for the location |
body |
body |
true |
Request body containing the note details, including text and associated metadata, for the specified location within the Nakisa Portfolio Management Suite. |
Body Parameters
1[
2 {
3 "createdBy": "string",
4 "lastModifiedBy": "string",
5 "createdDate": "2019-08-24T14:15:22Z",
6 "lastModifiedDate": "2019-08-24T14:15:22Z",
7 "archived": true,
8 "externalId": "string",
9 "id": 0,
10 "message": "string",
11 "userIds": [
12 0
13 ],
14 "redirectUrl": "string"
15 }
16]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
201 |
Created |
Inline |
Example Responses
1[
2 {
3 "createdBy": "string",
4 "lastModifiedBy": "string",
5 "createdDate": "2019-08-24T14:15:22Z",
6 "lastModifiedDate": "2019-08-24T14:15:22Z",
7 "archived": true,
8 "externalId": "string",
9 "id": 0,
10 "message": "string",
11 "userIds": [
12 0
13 ],
14 "redirectUrl": "string"
15 }
16]
Response Schema
Status Code 201
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing a note associated with portfolio management, asset analytics, and real estate properties, facilitating effective communication and documentation within the Nakisa Portfolio Management Suite.] |
|
» createdBy |
string |
false |
none |
Username of who created this resource |
» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
» createdDate |
string(date-time) |
false |
none |
Date of the created |
» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
» archived |
boolean |
false |
none |
Boolean flag indicating archived status |
» externalId |
string |
false |
none |
Unique identifier for the external |
» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
» message |
string |
true |
none |
Text value for message in NoteDto |
» userIds |
[integer] |
false |
none |
User information related to portfolio management |
» redirectUrl |
string |
false |
none |
Text value for redirectUrl in NoteDto |
Get Legal Entities For Location¶
HTTP Request
GET /api/locations/{locationId}/legal-entities
📋 Description: Retrieves legal entities associated with a specific location, enabling users to analyze portfolio and asset relationships within the Nakisa Portfolio Management Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
locationId |
path |
integer(int64) |
true |
Unique identifier for the location |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "_embedded": {
3 "companyDtoList": [
4 {
5 "id": 0,
6 "status": "CREATED",
7 "displayId": "string",
8 "erpSystemId": 0,
9 "erpSystemDisplayId": "string",
10 "countryId": 0,
11 "countryDisplayId": "string",
12 "postingPeriodVariantId": 0,
13 "postingPeriodVariantDisplayId": "string",
14 "controllingAreaId": 0,
15 "controllingAreaDisplayId": "string",
16 "chartOfAccountId": 0,
17 "chartOfAccountDisplayId": "string",
18 "fiscalVariantId": 0,
19 "fiscalVariantDisplayId": "string",
20 "chartOfDepreciationId": 0,
21 "chartOfDepreciationDisplayId": "string",
22 "purchasingOrganizationId": 0,
23 "assetId": 0,
24 "exchangeRateTypeId": 0,
25 "plantId": 0,
26 "incrementalBorrowingRateId": 0,
27 "businessUnitId": 0,
28 "projectId": 0,
29 "transferVariantId": 0,
30 "partnerId": 0,
31 "departmentId": 0,
32 "accountingStandardId": 0,
33 "generalLedgerAccountId": 0,
34 "consumerPriceIndexCategoryId": 0,
35 "costCenterId": 0,
36 "costCenterRelationValidFrom": "2019-08-24",
37 "costCenterRelationValidTo": "2019-08-24"
38 }
39 ]
40 },
41 "page": {
42 "size": 0,
43 "totalElements": 0,
44 "totalPages": 0,
45 "number": 0
46 }
47}
Add Legal Entities To Location¶
HTTP Request
POST /api/locations/{locationId}/legal-entities
📋 Description: Creates a new legal entity associated with a specified location within the Nakisa Portfolio Management Suite, enabling enhanced management and analytics of real estate assets.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
locationId |
path |
integer(int64) |
true |
Unique identifier for the location |
body |
body |
true |
Request body containing the legal entity details, including name, type, and associated metadata, for integration into the portfolio management framework within the Nakisa Portfolio Management Suite. |
Body Parameters
1[
2 {
3 "id": 0,
4 "status": "CREATED",
5 "displayId": "string",
6 "erpSystemId": 0,
7 "erpSystemDisplayId": "string",
8 "countryId": 0,
9 "countryDisplayId": "string",
10 "postingPeriodVariantId": 0,
11 "postingPeriodVariantDisplayId": "string",
12 "controllingAreaId": 0,
13 "controllingAreaDisplayId": "string",
14 "chartOfAccountId": 0,
15 "chartOfAccountDisplayId": "string",
16 "fiscalVariantId": 0,
17 "fiscalVariantDisplayId": "string",
18 "chartOfDepreciationId": 0,
19 "chartOfDepreciationDisplayId": "string",
20 "purchasingOrganizationId": 0,
21 "assetId": 0,
22 "exchangeRateTypeId": 0,
23 "plantId": 0,
24 "incrementalBorrowingRateId": 0,
25 "businessUnitId": 0,
26 "projectId": 0,
27 "transferVariantId": 0,
28 "partnerId": 0,
29 "departmentId": 0,
30 "accountingStandardId": 0,
31 "generalLedgerAccountId": 0,
32 "consumerPriceIndexCategoryId": 0,
33 "costCenterId": 0,
34 "costCenterRelationValidFrom": "2019-08-24",
35 "costCenterRelationValidTo": "2019-08-24"
36 }
37]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
201 |
Created |
Inline |
Example Responses
1[
2 {
3 "id": 0,
4 "status": "CREATED",
5 "displayId": "string",
6 "erpSystemId": 0,
7 "erpSystemDisplayId": "string",
8 "countryId": 0,
9 "countryDisplayId": "string",
10 "postingPeriodVariantId": 0,
11 "postingPeriodVariantDisplayId": "string",
12 "controllingAreaId": 0,
13 "controllingAreaDisplayId": "string",
14 "chartOfAccountId": 0,
15 "chartOfAccountDisplayId": "string",
16 "fiscalVariantId": 0,
17 "fiscalVariantDisplayId": "string",
18 "chartOfDepreciationId": 0,
19 "chartOfDepreciationDisplayId": "string",
20 "purchasingOrganizationId": 0,
21 "assetId": 0,
22 "exchangeRateTypeId": 0,
23 "plantId": 0,
24 "incrementalBorrowingRateId": 0,
25 "businessUnitId": 0,
26 "projectId": 0,
27 "transferVariantId": 0,
28 "partnerId": 0,
29 "departmentId": 0,
30 "accountingStandardId": 0,
31 "generalLedgerAccountId": 0,
32 "consumerPriceIndexCategoryId": 0,
33 "costCenterId": 0,
34 "costCenterRelationValidFrom": "2019-08-24",
35 "costCenterRelationValidTo": "2019-08-24"
36 }
37]
Response Schema
Status Code 201
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing a company within the Nakisa Portfolio Management Suite, encapsulating essential information related to portfolio assets, analytics, and real estate properties.] |
|
» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
» status |
string |
false |
none |
Status of the resource |
» displayId |
string |
true |
none |
Unique identifier for the display |
» erpSystemId |
integer(int64) |
false |
none |
Unique identifier for the erp system |
» erpSystemDisplayId |
string |
false |
none |
Unique identifier for the erp system display |
» countryId |
integer(int64) |
false |
none |
Unique identifier for the country |
» countryDisplayId |
string |
false |
none |
Unique identifier for the country display |
» postingPeriodVariantId |
integer(int64) |
false |
none |
Unique identifier for the posting period variant |
» postingPeriodVariantDisplayId |
string |
false |
none |
Unique identifier for the posting period variant display |
» controllingAreaId |
integer(int64) |
false |
none |
Unique identifier for the controlling area |
» controllingAreaDisplayId |
string |
false |
none |
Unique identifier for the controlling area display |
» chartOfAccountId |
integer(int64) |
false |
none |
Unique identifier for the chart of account |
» chartOfAccountDisplayId |
string |
false |
none |
Unique identifier for the chart of account display |
» fiscalVariantId |
integer(int64) |
false |
none |
Unique identifier for the fiscal variant |
» fiscalVariantDisplayId |
string |
false |
none |
Unique identifier for the fiscal variant display |
» chartOfDepreciationId |
integer(int64) |
false |
none |
Unique identifier for the chart of depreciation |
» chartOfDepreciationDisplayId |
string |
false |
none |
Unique identifier for the chart of depreciation display |
» purchasingOrganizationId |
integer(int64) |
false |
none |
Unique identifier for the purchasing organization |
» assetId |
integer(int64) |
false |
none |
Unique identifier for the asset |
» exchangeRateTypeId |
integer(int64) |
false |
none |
Unique identifier for the exchange rate type |
» plantId |
integer(int64) |
false |
none |
Unique identifier for the plant |
» incrementalBorrowingRateId |
integer(int64) |
false |
none |
Unique identifier for the incremental borrowing rate |
» businessUnitId |
integer(int64) |
false |
none |
Unique identifier for the business unit |
» projectId |
integer(int64) |
false |
none |
Unique identifier for the project |
» transferVariantId |
integer(int64) |
false |
none |
Unique identifier for the transfer variant |
» partnerId |
integer(int64) |
false |
none |
Unique identifier for the partner |
» departmentId |
integer(int64) |
false |
none |
Unique identifier for the department |
» accountingStandardId |
integer(int64) |
false |
none |
Unique identifier for the accounting standard |
» generalLedgerAccountId |
integer(int64) |
false |
none |
Unique identifier for the general ledger account |
» consumerPriceIndexCategoryId |
integer(int64) |
false |
none |
Unique identifier for the consumer price index category |
» costCenterId |
integer(int64) |
false |
none |
Unique identifier for the cost center |
» costCenterRelationValidFrom |
string(date) |
false |
none |
Text value for costCenterRelationValidFrom in CompanyDto |
» costCenterRelationValidTo |
string(date) |
false |
none |
Text value for costCenterRelationValidTo in CompanyDto |
Enumerated Values
Attribute |
Value |
|---|---|
status |
ACTIVE, CREATED, DECOMMISSIONED, DISABLED |
Add Legal Entities To Location By Legal Entity Id¶
HTTP Request
POST /api/locations/{locationId}/legal-entities/{legalEntityId}
📋 Description: Creates a new legal entity associated with a specified location within the Nakisa Portfolio Management Suite, enabling enhanced management of portfolio assets and analytics for real estate properties.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
locationId |
path |
integer(int64) |
true |
Unique identifier for the location |
legalEntityId |
path |
integer(int64) |
true |
Unique identifier for the legal entity |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
201 |
Created |
Example Responses
1{
2 "id": 0,
3 "status": "CREATED",
4 "displayId": "string",
5 "erpSystemId": 0,
6 "erpSystemDisplayId": "string",
7 "countryId": 0,
8 "countryDisplayId": "string",
9 "postingPeriodVariantId": 0,
10 "postingPeriodVariantDisplayId": "string",
11 "controllingAreaId": 0,
12 "controllingAreaDisplayId": "string",
13 "chartOfAccountId": 0,
14 "chartOfAccountDisplayId": "string",
15 "fiscalVariantId": 0,
16 "fiscalVariantDisplayId": "string",
17 "chartOfDepreciationId": 0,
18 "chartOfDepreciationDisplayId": "string",
19 "purchasingOrganizationId": 0,
20 "assetId": 0,
21 "exchangeRateTypeId": 0,
22 "plantId": 0,
23 "incrementalBorrowingRateId": 0,
24 "businessUnitId": 0,
25 "projectId": 0,
26 "transferVariantId": 0,
27 "partnerId": 0,
28 "departmentId": 0,
29 "accountingStandardId": 0,
30 "generalLedgerAccountId": 0,
31 "consumerPriceIndexCategoryId": 0,
32 "costCenterId": 0,
33 "costCenterRelationValidFrom": "2019-08-24",
34 "costCenterRelationValidTo": "2019-08-24"
35}
Delete Legal Entity To Location By Legal Entity Id¶
HTTP Request
DELETE /api/locations/{locationId}/legal-entities/{legalEntityId}
📋 Description: Deletes the specified legal entity associated with a location in the Nakisa Portfolio Management Suite, facilitating the management of real estate assets and ensuring accurate portfolio analytics.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
locationId |
path |
integer(int64) |
true |
Unique identifier for the location |
legalEntityId |
path |
integer(int64) |
true |
Unique identifier for the legal entity |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
204 |
No Content |
None |
Get Location Documents¶
HTTP Request
GET /api/locations/{locationId}/documents
📋 Description: Retrieves documents associated with a specific location within the Nakisa Portfolio Management Suite, enabling users to access critical information related to portfolio, asset, and real estate property analytics.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
locationId |
path |
integer(int64) |
true |
Unique identifier for the location |
pageable |
query |
true |
Indicates whether the response should be paginated, facilitating efficient retrieval of document data associated with a specific location within the Nakisa Portfolio Management Suite. |
|
search |
query |
string |
false |
Search term used to filter documents related to a specific location within the Nakisa Portfolio Management Suite, enhancing portfolio and asset analytics for real estate properties. |
id |
query |
string |
false |
Unique identifier for the resource |
status-id |
query |
string |
false |
Unique identifier for the status of documents associated with a specific location within the Nakisa Portfolio Management Suite, facilitating effective portfolio and asset management. |
signed-date |
query |
string |
false |
Specifies the date on which the document was signed, providing essential context for portfolio and asset management within the Nakisa Portfolio Management Suite. |
name |
query |
string |
false |
Name of the resource |
title |
query |
string |
false |
Title of the resource |
type |
query |
string |
false |
Type of the resource |
shareable |
query |
string |
false |
Indicates whether the documents associated with the specified location can be shared, facilitating collaboration and transparency in portfolio and asset management within the Nakisa Portfolio Management Suite. |
document-type-id |
query |
string |
false |
Unique identifier for the type of document associated with a specific location within the Nakisa Portfolio Management Suite, facilitating effective portfolio and asset management. |
document-type-id-in |
query |
string |
false |
Unique identifier for the type of document associated with a specific location, facilitating targeted retrieval of portfolio, asset, and real estate property analytics. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "_embedded": {
3 "documents": [
4 {
5 "createdBy": "string",
6 "lastModifiedBy": "string",
7 "createdDate": "2019-08-24T14:15:22Z",
8 "lastModifiedDate": "2019-08-24T14:15:22Z",
9 "archived": true,
10 "externalId": "string",
11 "id": 0,
12 "name": "string",
13 "title": "string",
14 "type": "string",
15 "description": "string",
16 "link": "string",
17 "signedDate": "2019-08-24",
18 "documentTypeId": 0,
19 "statusId": 0,
20 "shareable": true,
21 "size": 0,
22 "documentType": {
23 "createdBy": "string",
24 "lastModifiedBy": "string",
25 "createdDate": "2019-08-24T14:15:22Z",
26 "lastModifiedDate": "2019-08-24T14:15:22Z",
27 "archived": true,
28 "externalId": "string",
29 "id": 0,
30 "priority": 0,
31 "internalId": 0,
32 "pickListCode": "string",
33 "pickListLabel": "string",
34 "label": "string",
35 "cultureId": 0,
36 "labelDtos": [
37 {
38 "createdBy": "string",
39 "lastModifiedBy": "string",
40 "createdDate": "2019-08-24T14:15:22Z",
41 "lastModifiedDate": "2019-08-24T14:15:22Z",
42 "archived": true,
43 "externalId": "string",
44 "id": 0,
45 "cultureId": 0,
46 "value": "string"
47 }
48 ]
49 },
50 "status": {
51 "createdBy": "string",
52 "lastModifiedBy": "string",
53 "createdDate": "2019-08-24T14:15:22Z",
54 "lastModifiedDate": "2019-08-24T14:15:22Z",
55 "archived": true,
56 "externalId": "string",
57 "id": 0,
58 "priority": 0,
59 "internalId": 0,
60 "pickListCode": "string",
61 "pickListLabel": "string",
62 "label": "string",
63 "cultureId": 0,
64 "labelDtos": [
65 {
66 "createdBy": "string",
67 "lastModifiedBy": "string",
68 "createdDate": "2019-08-24T14:15:22Z",
69 "lastModifiedDate": "2019-08-24T14:15:22Z",
70 "archived": true,
71 "externalId": "string",
72 "id": 0,
73 "cultureId": 0,
74 "value": "string"
75 }
76 ]
77 }
78 }
79 ]
80 },
81 "page": {
82 "size": 0,
83 "totalElements": 0,
84 "totalPages": 0,
85 "number": 0
86 }
87}
Upload Location Document¶
HTTP Request
POST /api/locations/{locationId}/documents
📋 Description: Uploads documents associated with a specific location in the Nakisa Portfolio Management Suite, enhancing asset management and analytics for real estate properties.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
locationId |
path |
integer(int64) |
true |
Unique identifier for the location |
body |
body |
object |
false |
Request body containing the document details, including metadata and associated asset information, for the specified real estate property within the Nakisa Portfolio Management Suite. |
» file |
body |
string(binary) |
false |
none |
» document |
body |
true |
Data transfer object representing a document within the Nakisa Portfolio Management Suite, encapsulating essential information related to portfolio assets, analytics, and real estate properties. |
|
»» createdBy |
body |
string |
false |
Username of who created this resource |
»» lastModifiedBy |
body |
string |
false |
Username of who last modified this resource |
»» createdDate |
body |
string(date-time) |
false |
Date of the created |
»» lastModifiedDate |
body |
string(date-time) |
false |
Date of the last modified |
»» archived |
body |
boolean |
false |
Boolean flag indicating archived status |
»» externalId |
body |
string |
false |
Unique identifier for the external |
»» id |
body |
integer(int64) |
false |
Unique identifier for the resource |
»» name |
body |
string |
false |
Name of the resource |
»» title |
body |
string |
false |
Title of the resource |
»» type |
body |
string |
false |
Type of the resource |
»» description |
body |
string |
false |
Description of the resource |
»» link |
body |
string |
false |
Text value for link in DocumentDto |
»» signedDate |
body |
string(date) |
false |
Date of the signed |
»» documentTypeId |
body |
integer(int64) |
false |
Unique identifier for the document type |
»» statusId |
body |
integer(int64) |
false |
Unique identifier for the status |
»» shareable |
body |
boolean |
false |
Boolean flag indicating shareable status |
»» size |
body |
integer(int64) |
false |
Number of items per page |
»» documentType |
body |
false |
Data transfer object representing an option within a pick list, utilized for categorizing and managing portfolio assets and analytics in the Nakisa Portfolio Management Suite, particularly in the context of real estate property management. |
|
»»» createdBy |
body |
string |
false |
Username of who created this resource |
»»» lastModifiedBy |
body |
string |
false |
Username of who last modified this resource |
»»» createdDate |
body |
string(date-time) |
false |
Date of the created |
»»» lastModifiedDate |
body |
string(date-time) |
false |
Date of the last modified |
»»» archived |
body |
boolean |
false |
Boolean flag indicating archived status |
»»» externalId |
body |
string |
false |
Unique identifier for the external |
»»» id |
body |
integer(int64) |
false |
Unique identifier for the resource |
»»» priority |
body |
integer(int64) |
false |
Priority of the resource |
»»» internalId |
body |
integer(int64) |
false |
Unique identifier for the internal |
»»» pickListCode |
body |
string |
false |
Code for the pick list |
»»» pickListLabel |
body |
string |
false |
Label for the pick list |
»»» label |
body |
string |
false |
Label for the resource |
»»» cultureId |
body |
integer(int64) |
false |
Unique identifier for the culture |
»»» labelDtos |
body |
false |
List of labelDtos items |
|
»»»» createdBy |
body |
string |
false |
Username of who created this resource |
»»»» lastModifiedBy |
body |
string |
false |
Username of who last modified this resource |
»»»» createdDate |
body |
string(date-time) |
false |
Date of the created |
»»»» lastModifiedDate |
body |
string(date-time) |
false |
Date of the last modified |
»»»» archived |
body |
boolean |
false |
Boolean flag indicating archived status |
»»»» externalId |
body |
string |
false |
Unique identifier for the external |
»»»» id |
body |
integer(int64) |
false |
Unique identifier for the resource |
»»»» cultureId |
body |
integer(int64) |
false |
Unique identifier for the culture |
»»»» value |
body |
string |
true |
Text value for value in LabelDto |
»» status |
body |
false |
Data transfer object representing an option within a pick list, utilized for categorizing and managing portfolio assets and analytics in the Nakisa Portfolio Management Suite, particularly in the context of real estate property management. |
Body Parameters
1{
2 "document": {
3 "archived": true,
4 "createdBy": "string",
5 "createdDate": "2019-08-24 14:15:22+00:00",
6 "description": "string",
7 "documentType": {
8 "archived": true,
9 "createdBy": "string",
10 "createdDate": "2019-08-24 14:15:22+00:00",
11 "cultureId": 0,
12 "externalId": "string",
13 "id": 0,
14 "internalId": 0,
15 "label": "string",
16 "labelDtos": [
17 {
18 "archived": true,
19 "createdBy": "string",
20 "createdDate": "2019-08-24 14:15:22+00:00",
21 "cultureId": 0,
22 "externalId": "string",
23 "id": 0,
24 "lastModifiedBy": "string",
25 "lastModifiedDate": "2019-08-24 14:15:22+00:00",
26 "value": "string"
27 }
28 ],
29 "lastModifiedBy": "string",
30 "lastModifiedDate": "2019-08-24 14:15:22+00:00",
31 "pickListCode": "string",
32 "pickListLabel": "string",
33 "priority": 0
34 },
35 "documentTypeId": 0,
36 "externalId": "string",
37 "id": 0,
38 "lastModifiedBy": "string",
39 "lastModifiedDate": "2019-08-24 14:15:22+00:00",
40 "link": "string",
41 "name": "string",
42 "shareable": true,
43 "signedDate": "2019-08-24",
44 "size": 0,
45 "status": {
46 "archived": true,
47 "createdBy": "string",
48 "createdDate": "2019-08-24 14:15:22+00:00",
49 "cultureId": 0,
50 "externalId": "string",
51 "id": 0,
52 "internalId": 0,
53 "label": "string",
54 "labelDtos": [
55 {
56 "archived": true,
57 "createdBy": "string",
58 "createdDate": "2019-08-24 14:15:22+00:00",
59 "cultureId": 0,
60 "externalId": "string",
61 "id": 0,
62 "lastModifiedBy": "string",
63 "lastModifiedDate": "2019-08-24 14:15:22+00:00",
64 "value": "string"
65 }
66 ],
67 "lastModifiedBy": "string",
68 "lastModifiedDate": "2019-08-24 14:15:22+00:00",
69 "pickListCode": "string",
70 "pickListLabel": "string",
71 "priority": 0
72 },
73 "statusId": 0,
74 "title": "string",
75 "type": "string"
76 },
77 "file": "string"
78}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
201 |
Created |
Example Responses
1{
2 "createdBy": "string",
3 "lastModifiedBy": "string",
4 "createdDate": "2019-08-24T14:15:22Z",
5 "lastModifiedDate": "2019-08-24T14:15:22Z",
6 "archived": true,
7 "externalId": "string",
8 "id": 0,
9 "name": "string",
10 "title": "string",
11 "type": "string",
12 "description": "string",
13 "link": "string",
14 "signedDate": "2019-08-24",
15 "documentTypeId": 0,
16 "statusId": 0,
17 "shareable": true,
18 "size": 0,
19 "documentType": {
20 "createdBy": "string",
21 "lastModifiedBy": "string",
22 "createdDate": "2019-08-24T14:15:22Z",
23 "lastModifiedDate": "2019-08-24T14:15:22Z",
24 "archived": true,
25 "externalId": "string",
26 "id": 0,
27 "priority": 0,
28 "internalId": 0,
29 "pickListCode": "string",
30 "pickListLabel": "string",
31 "label": "string",
32 "cultureId": 0,
33 "labelDtos": [
34 {
35 "createdBy": "string",
36 "lastModifiedBy": "string",
37 "createdDate": "2019-08-24T14:15:22Z",
38 "lastModifiedDate": "2019-08-24T14:15:22Z",
39 "archived": true,
40 "externalId": "string",
41 "id": 0,
42 "cultureId": 0,
43 "value": "string"
44 }
45 ]
46 },
47 "status": {
48 "createdBy": "string",
49 "lastModifiedBy": "string",
50 "createdDate": "2019-08-24T14:15:22Z",
51 "lastModifiedDate": "2019-08-24T14:15:22Z",
52 "archived": true,
53 "externalId": "string",
54 "id": 0,
55 "priority": 0,
56 "internalId": 0,
57 "pickListCode": "string",
58 "pickListLabel": "string",
59 "label": "string",
60 "cultureId": 0,
61 "labelDtos": [
62 {
63 "createdBy": "string",
64 "lastModifiedBy": "string",
65 "createdDate": "2019-08-24T14:15:22Z",
66 "lastModifiedDate": "2019-08-24T14:15:22Z",
67 "archived": true,
68 "externalId": "string",
69 "id": 0,
70 "cultureId": 0,
71 "value": "string"
72 }
73 ]
74 }
75}
Add Areas To Location¶
HTTP Request
POST /api/locations/{locationId}/areas
📋 Description: Creates a new area within a specified location in the Nakisa Portfolio Management Suite, enabling enhanced organization and analytics of real estate properties within the portfolio.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
locationId |
path |
integer(int64) |
true |
Unique identifier for the location |
body |
body |
true |
Request body containing the area details, including attributes and metrics relevant to the specified location within the Nakisa Portfolio Management Suite. |
Body Parameters
1[
2 {
3 "createdBy": "string",
4 "lastModifiedBy": "string",
5 "createdDate": "2019-08-24T14:15:22Z",
6 "lastModifiedDate": "2019-08-24T14:15:22Z",
7 "archived": true,
8 "externalId": "string",
9 "id": 0,
10 "typeId": 0,
11 "unitId": 0,
12 "sourceId": 0,
13 "proShareTypeId": 0,
14 "documentId": 0,
15 "grossUp": 0,
16 "lot": "string",
17 "cadaster": "string",
18 "name": "string",
19 "verified": true,
20 "toBeMeasured": true,
21 "gla": true,
22 "type": {
23 "createdBy": "string",
24 "lastModifiedBy": "string",
25 "createdDate": "2019-08-24T14:15:22Z",
26 "lastModifiedDate": "2019-08-24T14:15:22Z",
27 "archived": true,
28 "externalId": "string",
29 "id": 0,
30 "priority": 0,
31 "internalId": 0,
32 "pickListCode": "string",
33 "pickListLabel": "string",
34 "label": "string",
35 "cultureId": 0,
36 "labelDtos": [
37 {
38 "createdBy": "string",
39 "lastModifiedBy": "string",
40 "createdDate": "2019-08-24T14:15:22Z",
41 "lastModifiedDate": "2019-08-24T14:15:22Z",
42 "archived": true,
43 "externalId": "string",
44 "id": 0,
45 "cultureId": 0,
46 "value": "string"
47 }
48 ]
49 },
50 "source": {
51 "createdBy": "string",
52 "lastModifiedBy": "string",
53 "createdDate": "2019-08-24T14:15:22Z",
54 "lastModifiedDate": "2019-08-24T14:15:22Z",
55 "archived": true,
56 "externalId": "string",
57 "id": 0,
58 "priority": 0,
59 "internalId": 0,
60 "pickListCode": "string",
61 "pickListLabel": "string",
62 "label": "string",
63 "cultureId": 0,
64 "labelDtos": [
65 {
66 "createdBy": "string",
67 "lastModifiedBy": "string",
68 "createdDate": "2019-08-24T14:15:22Z",
69 "lastModifiedDate": "2019-08-24T14:15:22Z",
70 "archived": true,
71 "externalId": "string",
72 "id": 0,
73 "cultureId": 0,
74 "value": "string"
75 }
76 ]
77 },
78 "proShareType": {
79 "createdBy": "string",
80 "lastModifiedBy": "string",
81 "createdDate": "2019-08-24T14:15:22Z",
82 "lastModifiedDate": "2019-08-24T14:15:22Z",
83 "archived": true,
84 "externalId": "string",
85 "id": 0,
86 "priority": 0,
87 "internalId": 0,
88 "pickListCode": "string",
89 "pickListLabel": "string",
90 "label": "string",
91 "cultureId": 0,
92 "labelDtos": [
93 {
94 "createdBy": "string",
95 "lastModifiedBy": "string",
96 "createdDate": "2019-08-24T14:15:22Z",
97 "lastModifiedDate": "2019-08-24T14:15:22Z",
98 "archived": true,
99 "externalId": "string",
100 "id": 0,
101 "cultureId": 0,
102 "value": "string"
103 }
104 ]
105 },
106 "unitType": {
107 "createdBy": "string",
108 "lastModifiedBy": "string",
109 "createdDate": "2019-08-24T14:15:22Z",
110 "lastModifiedDate": "2019-08-24T14:15:22Z",
111 "archived": true,
112 "externalId": "string",
113 "id": 0,
114 "priority": 0,
115 "internalId": 0,
116 "pickListCode": "string",
117 "pickListLabel": "string",
118 "label": "string",
119 "cultureId": 0,
120 "labelDtos": [
121 {
122 "createdBy": "string",
123 "lastModifiedBy": "string",
124 "createdDate": "2019-08-24T14:15:22Z",
125 "lastModifiedDate": "2019-08-24T14:15:22Z",
126 "archived": true,
127 "externalId": "string",
128 "id": 0,
129 "cultureId": 0,
130 "value": "string"
131 }
132 ]
133 },
134 "historiesDto": [
135 {
136 "createdBy": "string",
137 "lastModifiedBy": "string",
138 "createdDate": "2019-08-24T14:15:22Z",
139 "lastModifiedDate": "2019-08-24T14:15:22Z",
140 "archived": true,
141 "externalId": "string",
142 "id": 0,
143 "startDate": "2019-08-24",
144 "endDate": "2019-08-24",
145 "measure": 0,
146 "details": "string",
147 "floor": "string",
148 "suite": "string",
149 "areaId": 0
150 }
151 ],
152 "archivedAssociation": true
153 }
154]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
201 |
Created |
Inline |
Example Responses
1[
2 {
3 "createdBy": "string",
4 "lastModifiedBy": "string",
5 "createdDate": "2019-08-24T14:15:22Z",
6 "lastModifiedDate": "2019-08-24T14:15:22Z",
7 "archived": true,
8 "externalId": "string",
9 "id": 0,
10 "typeId": 0,
11 "unitId": 0,
12 "sourceId": 0,
13 "proShareTypeId": 0,
14 "documentId": 0,
15 "grossUp": 0,
16 "lot": "string",
17 "cadaster": "string",
18 "name": "string",
19 "verified": true,
20 "toBeMeasured": true,
21 "gla": true,
22 "type": {
23 "createdBy": "string",
24 "lastModifiedBy": "string",
25 "createdDate": "2019-08-24T14:15:22Z",
26 "lastModifiedDate": "2019-08-24T14:15:22Z",
27 "archived": true,
28 "externalId": "string",
29 "id": 0,
30 "priority": 0,
31 "internalId": 0,
32 "pickListCode": "string",
33 "pickListLabel": "string",
34 "label": "string",
35 "cultureId": 0,
36 "labelDtos": [
37 {
38 "createdBy": "string",
39 "lastModifiedBy": "string",
40 "createdDate": "2019-08-24T14:15:22Z",
41 "lastModifiedDate": "2019-08-24T14:15:22Z",
42 "archived": true,
43 "externalId": "string",
44 "id": 0,
45 "cultureId": 0,
46 "value": "string"
47 }
48 ]
49 },
50 "source": {
51 "createdBy": "string",
52 "lastModifiedBy": "string",
53 "createdDate": "2019-08-24T14:15:22Z",
54 "lastModifiedDate": "2019-08-24T14:15:22Z",
55 "archived": true,
56 "externalId": "string",
57 "id": 0,
58 "priority": 0,
59 "internalId": 0,
60 "pickListCode": "string",
61 "pickListLabel": "string",
62 "label": "string",
63 "cultureId": 0,
64 "labelDtos": [
65 {
66 "createdBy": "string",
67 "lastModifiedBy": "string",
68 "createdDate": "2019-08-24T14:15:22Z",
69 "lastModifiedDate": "2019-08-24T14:15:22Z",
70 "archived": true,
71 "externalId": "string",
72 "id": 0,
73 "cultureId": 0,
74 "value": "string"
75 }
76 ]
77 },
78 "proShareType": {
79 "createdBy": "string",
80 "lastModifiedBy": "string",
81 "createdDate": "2019-08-24T14:15:22Z",
82 "lastModifiedDate": "2019-08-24T14:15:22Z",
83 "archived": true,
84 "externalId": "string",
85 "id": 0,
86 "priority": 0,
87 "internalId": 0,
88 "pickListCode": "string",
89 "pickListLabel": "string",
90 "label": "string",
91 "cultureId": 0,
92 "labelDtos": [
93 {
94 "createdBy": "string",
95 "lastModifiedBy": "string",
96 "createdDate": "2019-08-24T14:15:22Z",
97 "lastModifiedDate": "2019-08-24T14:15:22Z",
98 "archived": true,
99 "externalId": "string",
100 "id": 0,
101 "cultureId": 0,
102 "value": "string"
103 }
104 ]
105 },
106 "unitType": {
107 "createdBy": "string",
108 "lastModifiedBy": "string",
109 "createdDate": "2019-08-24T14:15:22Z",
110 "lastModifiedDate": "2019-08-24T14:15:22Z",
111 "archived": true,
112 "externalId": "string",
113 "id": 0,
114 "priority": 0,
115 "internalId": 0,
116 "pickListCode": "string",
117 "pickListLabel": "string",
118 "label": "string",
119 "cultureId": 0,
120 "labelDtos": [
121 {
122 "createdBy": "string",
123 "lastModifiedBy": "string",
124 "createdDate": "2019-08-24T14:15:22Z",
125 "lastModifiedDate": "2019-08-24T14:15:22Z",
126 "archived": true,
127 "externalId": "string",
128 "id": 0,
129 "cultureId": 0,
130 "value": "string"
131 }
132 ]
133 },
134 "historiesDto": [
135 {
136 "createdBy": "string",
137 "lastModifiedBy": "string",
138 "createdDate": "2019-08-24T14:15:22Z",
139 "lastModifiedDate": "2019-08-24T14:15:22Z",
140 "archived": true,
141 "externalId": "string",
142 "id": 0,
143 "startDate": "2019-08-24",
144 "endDate": "2019-08-24",
145 "measure": 0,
146 "details": "string",
147 "floor": "string",
148 "suite": "string",
149 "areaId": 0
150 }
151 ],
152 "archivedAssociation": true
153 }
154]
Response Schema
Status Code 201
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing a geographical area within the Nakisa Portfolio Management Suite, encompassing relevant attributes for portfolio analysis, asset management, and real estate property analytics.] |
|
» createdBy |
string |
false |
none |
Username of who created this resource |
» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
» createdDate |
string(date-time) |
false |
none |
Date of the created |
» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
» archived |
boolean |
false |
none |
Boolean flag indicating archived status |
» externalId |
string |
false |
none |
Unique identifier for the external |
» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
» typeId |
integer(int64) |
true |
none |
Unique identifier for the type |
» unitId |
integer(int64) |
false |
none |
Unique identifier for the unit |
» sourceId |
integer(int64) |
false |
none |
Unique identifier for the source |
» proShareTypeId |
integer(int64) |
false |
none |
Unique identifier for the pro share type |
» documentId |
integer(int64) |
false |
none |
Unique identifier for the document |
» grossUp |
integer(int64) |
false |
none |
Numeric value representing grossUp |
» lot |
string |
false |
none |
Text value for lot in AreaDto |
» cadaster |
string |
false |
none |
Text value for cadaster in AreaDto |
» name |
string |
false |
none |
Name of the resource |
» verified |
boolean |
false |
none |
Boolean flag indicating verified status |
» toBeMeasured |
boolean |
false |
none |
Boolean flag indicating toBeMeasured status |
» gla |
boolean |
false |
none |
Boolean flag indicating gla status |
» type |
false |
none |
Data transfer object representing an option within a pick list, utilized for categorizing and managing portfolio assets and analytics in the Nakisa Portfolio Management Suite, particularly in the context of real estate property management. |
|
»» createdBy |
string |
false |
none |
Username of who created this resource |
»» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
»» createdDate |
string(date-time) |
false |
none |
Date of the created |
»» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
»» archived |
boolean |
false |
none |
Boolean flag indicating archived status |
»» externalId |
string |
false |
none |
Unique identifier for the external |
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» priority |
integer(int64) |
false |
none |
Priority of the resource |
»» internalId |
integer(int64) |
false |
none |
Unique identifier for the internal |
»» pickListCode |
string |
false |
none |
Code for the pick list |
»» pickListLabel |
string |
false |
none |
Label for the pick list |
»» label |
string |
false |
none |
Label for the resource |
»» cultureId |
integer(int64) |
false |
none |
Unique identifier for the culture |
»» labelDtos |
false |
none |
List of labelDtos items |
|
»»» createdBy |
string |
false |
none |
Username of who created this resource |
»»» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
»»» createdDate |
string(date-time) |
false |
none |
Date of the created |
»»» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
»»» archived |
boolean |
false |
none |
Boolean flag indicating archived status |
»»» externalId |
string |
false |
none |
Unique identifier for the external |
»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»» cultureId |
integer(int64) |
false |
none |
Unique identifier for the culture |
»»» value |
string |
true |
none |
Text value for value in LabelDto |
» source |
false |
none |
Data transfer object representing an option within a pick list, utilized for categorizing and managing portfolio assets and analytics in the Nakisa Portfolio Management Suite, particularly in the context of real estate property management. |
|
» proShareType |
false |
none |
Data transfer object representing an option within a pick list, utilized for categorizing and managing portfolio assets and analytics in the Nakisa Portfolio Management Suite, particularly in the context of real estate property management. |
|
» unitType |
false |
none |
Data transfer object representing an option within a pick list, utilized for categorizing and managing portfolio assets and analytics in the Nakisa Portfolio Management Suite, particularly in the context of real estate property management. |
|
» historiesDto |
false |
none |
List of historiesDto items |
|
»» createdBy |
string |
false |
none |
Username of who created this resource |
»» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
»» createdDate |
string(date-time) |
false |
none |
Date of the created |
»» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
»» archived |
boolean |
false |
none |
Boolean flag indicating archived status |
»» externalId |
string |
false |
none |
Unique identifier for the external |
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» startDate |
string(date) |
false |
none |
Start date of the resource |
»» endDate |
string(date) |
false |
none |
End date of the resource |
»» measure |
number |
false |
none |
Value for measure field |
»» details |
string |
false |
none |
Text value for details in AreaHistoryDto |
»» floor |
string |
false |
none |
Text value for floor in AreaHistoryDto |
»» suite |
string |
false |
none |
Text value for suite in AreaHistoryDto |
»» areaId |
integer(int64) |
false |
none |
Unique identifier for the area |
» archivedAssociation |
boolean |
false |
none |
none |
Get Location References¶
HTTP Request
GET /api/locations/{id}/references
📋 Description: Retrieves references associated with a specific location within the Nakisa Portfolio Management Suite, providing insights for portfolio and asset analytics in the context of real estate properties.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
pageable |
query |
true |
Indicates whether the results should be returned in a paginated format, facilitating efficient retrieval of references associated with a specific location within the Nakisa Portfolio Management Suite. |
|
search |
query |
string |
false |
Search term used to filter and retrieve specific references related to the asset within the Nakisa Portfolio Management Suite. |
number |
query |
string |
false |
String representation of the reference number associated with the specified location, used for retrieving analytics and portfolio-related data within the Nakisa Portfolio Management Suite. |
department-id |
query |
string |
false |
Unique identifier for the department associated with the specified location, used to retrieve relevant portfolio, asset, and analytics data within the Nakisa Portfolio Management Suite. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "_embedded": {
3 "references": [
4 {
5 "createdBy": "string",
6 "lastModifiedBy": "string",
7 "createdDate": "2019-08-24T14:15:22Z",
8 "lastModifiedDate": "2019-08-24T14:15:22Z",
9 "archived": true,
10 "externalId": "string",
11 "id": 0,
12 "number": "string",
13 "departmentId": 0,
14 "department": {
15 "createdBy": "string",
16 "lastModifiedBy": "string",
17 "createdDate": "2019-08-24T14:15:22Z",
18 "lastModifiedDate": "2019-08-24T14:15:22Z",
19 "archived": true,
20 "externalId": "string",
21 "id": 0,
22 "priority": 0,
23 "internalId": 0,
24 "pickListCode": "string",
25 "pickListLabel": "string",
26 "label": "string",
27 "cultureId": 0,
28 "labelDtos": [
29 {
30 "createdBy": "string",
31 "lastModifiedBy": "string",
32 "createdDate": "2019-08-24T14:15:22Z",
33 "lastModifiedDate": "2019-08-24T14:15:22Z",
34 "archived": true,
35 "externalId": "string",
36 "id": 0,
37 "cultureId": 0,
38 "value": "string"
39 }
40 ]
41 }
42 }
43 ]
44 },
45 "page": {
46 "size": 0,
47 "totalElements": 0,
48 "totalPages": 0,
49 "number": 0
50 }
51}
Add Location References¶
HTTP Request
POST /api/locations/{id}/references
📋 Description: Creates a new reference entry associated with a specified location within the Nakisa Portfolio Management Suite, enhancing portfolio and asset analytics for real estate properties.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing the reference data associated with a specific location, including details relevant to portfolio management and asset analytics. |
Body Parameters
1[
2 {
3 "createdBy": "string",
4 "lastModifiedBy": "string",
5 "createdDate": "2019-08-24T14:15:22Z",
6 "lastModifiedDate": "2019-08-24T14:15:22Z",
7 "archived": true,
8 "externalId": "string",
9 "id": 0,
10 "number": "string",
11 "departmentId": 0,
12 "department": {
13 "createdBy": "string",
14 "lastModifiedBy": "string",
15 "createdDate": "2019-08-24T14:15:22Z",
16 "lastModifiedDate": "2019-08-24T14:15:22Z",
17 "archived": true,
18 "externalId": "string",
19 "id": 0,
20 "priority": 0,
21 "internalId": 0,
22 "pickListCode": "string",
23 "pickListLabel": "string",
24 "label": "string",
25 "cultureId": 0,
26 "labelDtos": [
27 {
28 "createdBy": "string",
29 "lastModifiedBy": "string",
30 "createdDate": "2019-08-24T14:15:22Z",
31 "lastModifiedDate": "2019-08-24T14:15:22Z",
32 "archived": true,
33 "externalId": "string",
34 "id": 0,
35 "cultureId": 0,
36 "value": "string"
37 }
38 ]
39 }
40 }
41]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
201 |
Created |
Inline |
Example Responses
1[
2 {
3 "createdBy": "string",
4 "lastModifiedBy": "string",
5 "createdDate": "2019-08-24T14:15:22Z",
6 "lastModifiedDate": "2019-08-24T14:15:22Z",
7 "archived": true,
8 "externalId": "string",
9 "id": 0,
10 "number": "string",
11 "departmentId": 0,
12 "department": {
13 "createdBy": "string",
14 "lastModifiedBy": "string",
15 "createdDate": "2019-08-24T14:15:22Z",
16 "lastModifiedDate": "2019-08-24T14:15:22Z",
17 "archived": true,
18 "externalId": "string",
19 "id": 0,
20 "priority": 0,
21 "internalId": 0,
22 "pickListCode": "string",
23 "pickListLabel": "string",
24 "label": "string",
25 "cultureId": 0,
26 "labelDtos": [
27 {
28 "createdBy": "string",
29 "lastModifiedBy": "string",
30 "createdDate": "2019-08-24T14:15:22Z",
31 "lastModifiedDate": "2019-08-24T14:15:22Z",
32 "archived": true,
33 "externalId": "string",
34 "id": 0,
35 "cultureId": 0,
36 "value": "string"
37 }
38 ]
39 }
40 }
41]
Response Schema
Status Code 201
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing a reference entity within the Nakisa Portfolio Management Suite, encompassing key attributes related to portfolio, asset, analytics, and real estate property management.] |
|
» createdBy |
string |
false |
none |
Username of who created this resource |
» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
» createdDate |
string(date-time) |
false |
none |
Date of the created |
» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
» archived |
boolean |
false |
none |
Boolean flag indicating archived status |
» externalId |
string |
false |
none |
Unique identifier for the external |
» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
» number |
string |
true |
none |
Text value for number in ReferenceDto |
» departmentId |
integer(int64) |
false |
none |
Unique identifier for the department |
» department |
false |
none |
Data transfer object representing an option within a pick list, utilized for categorizing and managing portfolio assets and analytics in the Nakisa Portfolio Management Suite, particularly in the context of real estate property management. |
|
»» createdBy |
string |
false |
none |
Username of who created this resource |
»» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
»» createdDate |
string(date-time) |
false |
none |
Date of the created |
»» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
»» archived |
boolean |
false |
none |
Boolean flag indicating archived status |
»» externalId |
string |
false |
none |
Unique identifier for the external |
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» priority |
integer(int64) |
false |
none |
Priority of the resource |
»» internalId |
integer(int64) |
false |
none |
Unique identifier for the internal |
»» pickListCode |
string |
false |
none |
Code for the pick list |
»» pickListLabel |
string |
false |
none |
Label for the pick list |
»» label |
string |
false |
none |
Label for the resource |
»» cultureId |
integer(int64) |
false |
none |
Unique identifier for the culture |
»» labelDtos |
false |
none |
List of labelDtos items |
|
»»» createdBy |
string |
false |
none |
Username of who created this resource |
»»» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
»»» createdDate |
string(date-time) |
false |
none |
Date of the created |
»»» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
»»» archived |
boolean |
false |
none |
Boolean flag indicating archived status |
»»» externalId |
string |
false |
none |
Unique identifier for the external |
»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»» cultureId |
integer(int64) |
false |
none |
Unique identifier for the culture |
»»» value |
string |
true |
none |
Text value for value in LabelDto |
Perform Transition¶
HTTP Request
POST /api/locations/{id}/perform-transition
📋 Description: Initiates a transition for the specified location within the Nakisa Portfolio Management Suite, enabling updates to asset management and analytics related to real estate properties.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing the transition details for a specified location, including asset status updates and relevant analytics for effective portfolio management. |
Body Parameters
1{
2 "name": "SEND_FOR_APPROVAL",
3 "from": {
4 "name": "DRAFT",
5 "end": true,
6 "readOnly": true
7 },
8 "to": {
9 "name": "DRAFT",
10 "end": true,
11 "readOnly": true
12 },
13 "permission": "string"
14}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 {
3 "name": "SEND_FOR_APPROVAL",
4 "from": {
5 "name": "DRAFT",
6 "end": true,
7 "readOnly": true
8 },
9 "to": {
10 "name": "DRAFT",
11 "end": true,
12 "readOnly": true
13 },
14 "permission": "string"
15 }
16]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing a transition within the Nakisa Portfolio Management Suite, capturing the movement of assets across portfolios to enhance analytics and optimize real estate property management.] |
|
» name |
string |
false |
none |
Name of the resource |
» from |
false |
none |
Data transfer object representing the state of assets within the Nakisa Portfolio Management Suite, providing insights into portfolio performance, asset analytics, and real estate property management. This schema facilitates informed decision-making by capturing the current status and metrics of portfolio components. |
|
»» name |
string |
false |
none |
Name of the resource |
»» end |
boolean |
false |
none |
Boolean flag indicating end status |
»» readOnly |
boolean |
false |
none |
Boolean flag indicating readOnly status |
» to |
false |
none |
Data transfer object representing the state of assets within the Nakisa Portfolio Management Suite, providing insights into portfolio performance, asset analytics, and real estate property management. This schema facilitates informed decision-making by capturing the current status and metrics of portfolio components. |
|
» permission |
string |
false |
none |
Text value for permission in Transition |
Enumerated Values
Attribute |
Value |
|---|---|
name |
ACTIVATE, ACTIVE, APPROVE, APPROVED, AWAITING_ACTIVATION, DEACTIVATE, DRAFT, INACTIVE, OPEN_FOR_MODIFICATIONS, PENDING_APPROVAL, PENDING_TERMINATE, PENDING_TERMINATION, REJECT, SEND_FOR_APPROVAL, TERMINATE, TERMINATED |
Archive Location¶
HTTP Request
POST /api/locations/{id}/archive
📋 Description: Archives a specified location within the Nakisa Portfolio Management Suite, enabling effective management of real estate assets and enhancing portfolio analytics.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "createdBy": "string",
3 "lastModifiedBy": "string",
4 "createdDate": "2019-08-24T14:15:22Z",
5 "lastModifiedDate": "2019-08-24T14:15:22Z",
6 "archived": true,
7 "externalId": "string",
8 "id": 0,
9 "number": "string",
10 "name": "string",
11 "storeNumber": "string",
12 "defaultCurrencyId": 0,
13 "defaultMeasureId": 0,
14 "typeId": 0,
15 "qualityId": 0,
16 "propertyTypeId": 0,
17 "categoryId": 0,
18 "statusId": 0,
19 "businessUnitId": 0,
20 "groupIds": [
21 0
22 ],
23 "legalEntityIds": [
24 0
25 ],
26 "defaultCurrency": {
27 "id": 0,
28 "status": "CREATED",
29 "displayId": "string",
30 "erpSystemId": 0,
31 "erpSystemDisplayId": "string",
32 "name": "string",
33 "decimalPoints": 0,
34 "depreciationAreaId": 0
35 },
36 "defaultUnitValue": {
37 "createdBy": "string",
38 "lastModifiedBy": "string",
39 "createdDate": "2019-08-24T14:15:22Z",
40 "lastModifiedDate": "2019-08-24T14:15:22Z",
41 "archived": true,
42 "externalId": "string",
43 "id": 0,
44 "unitId": 0,
45 "unitOfMeasureId": 0,
46 "erpSystemId": 0,
47 "unit": {
48 "createdBy": "string",
49 "lastModifiedBy": "string",
50 "createdDate": "2019-08-24T14:15:22Z",
51 "lastModifiedDate": "2019-08-24T14:15:22Z",
52 "archived": true,
53 "externalId": "string",
54 "id": 0,
55 "priority": 0,
56 "internalId": 0,
57 "pickListCode": "string",
58 "pickListLabel": "string",
59 "label": "string",
60 "cultureId": 0,
61 "labelDtos": [
62 {
63 "createdBy": "string",
64 "lastModifiedBy": "string",
65 "createdDate": "2019-08-24T14:15:22Z",
66 "lastModifiedDate": "2019-08-24T14:15:22Z",
67 "archived": true,
68 "externalId": "string",
69 "id": 0,
70 "cultureId": 0,
71 "value": "string"
72 }
73 ]
74 },
75 "unitOfMeasure": {
76 "id": 0,
77 "status": "CREATED",
78 "displayId": "string",
79 "erpSystemId": 0,
80 "erpSystemDisplayId": "string",
81 "name": "string"
82 }
83 },
84 "type": {
85 "createdBy": "string",
86 "lastModifiedBy": "string",
87 "createdDate": "2019-08-24T14:15:22Z",
88 "lastModifiedDate": "2019-08-24T14:15:22Z",
89 "archived": true,
90 "externalId": "string",
91 "id": 0,
92 "priority": 0,
93 "internalId": 0,
94 "pickListCode": "string",
95 "pickListLabel": "string",
96 "label": "string",
97 "cultureId": 0,
98 "labelDtos": [
99 {
100 "createdBy": "string",
101 "lastModifiedBy": "string",
102 "createdDate": "2019-08-24T14:15:22Z",
103 "lastModifiedDate": "2019-08-24T14:15:22Z",
104 "archived": true,
105 "externalId": "string",
106 "id": 0,
107 "cultureId": 0,
108 "value": "string"
109 }
110 ]
111 },
112 "quality": {
113 "createdBy": "string",
114 "lastModifiedBy": "string",
115 "createdDate": "2019-08-24T14:15:22Z",
116 "lastModifiedDate": "2019-08-24T14:15:22Z",
117 "archived": true,
118 "externalId": "string",
119 "id": 0,
120 "priority": 0,
121 "internalId": 0,
122 "pickListCode": "string",
123 "pickListLabel": "string",
124 "label": "string",
125 "cultureId": 0,
126 "labelDtos": [
127 {
128 "createdBy": "string",
129 "lastModifiedBy": "string",
130 "createdDate": "2019-08-24T14:15:22Z",
131 "lastModifiedDate": "2019-08-24T14:15:22Z",
132 "archived": true,
133 "externalId": "string",
134 "id": 0,
135 "cultureId": 0,
136 "value": "string"
137 }
138 ]
139 },
140 "propertyType": {
141 "createdBy": "string",
142 "lastModifiedBy": "string",
143 "createdDate": "2019-08-24T14:15:22Z",
144 "lastModifiedDate": "2019-08-24T14:15:22Z",
145 "archived": true,
146 "externalId": "string",
147 "id": 0,
148 "priority": 0,
149 "internalId": 0,
150 "pickListCode": "string",
151 "pickListLabel": "string",
152 "label": "string",
153 "cultureId": 0,
154 "labelDtos": [
155 {
156 "createdBy": "string",
157 "lastModifiedBy": "string",
158 "createdDate": "2019-08-24T14:15:22Z",
159 "lastModifiedDate": "2019-08-24T14:15:22Z",
160 "archived": true,
161 "externalId": "string",
162 "id": 0,
163 "cultureId": 0,
164 "value": "string"
165 }
166 ]
167 },
168 "category": {
169 "createdBy": "string",
170 "lastModifiedBy": "string",
171 "createdDate": "2019-08-24T14:15:22Z",
172 "lastModifiedDate": "2019-08-24T14:15:22Z",
173 "archived": true,
174 "externalId": "string",
175 "id": 0,
176 "priority": 0,
177 "internalId": 0,
178 "pickListCode": "string",
179 "pickListLabel": "string",
180 "label": "string",
181 "cultureId": 0,
182 "labelDtos": [
183 {
184 "createdBy": "string",
185 "lastModifiedBy": "string",
186 "createdDate": "2019-08-24T14:15:22Z",
187 "lastModifiedDate": "2019-08-24T14:15:22Z",
188 "archived": true,
189 "externalId": "string",
190 "id": 0,
191 "cultureId": 0,
192 "value": "string"
193 }
194 ]
195 },
196 "status": {
197 "createdBy": "string",
198 "lastModifiedBy": "string",
199 "createdDate": "2019-08-24T14:15:22Z",
200 "lastModifiedDate": "2019-08-24T14:15:22Z",
201 "archived": true,
202 "externalId": "string",
203 "id": 0,
204 "priority": 0,
205 "internalId": 0,
206 "pickListCode": "string",
207 "pickListLabel": "string",
208 "label": "string",
209 "cultureId": 0,
210 "labelDtos": [
211 {
212 "createdBy": "string",
213 "lastModifiedBy": "string",
214 "createdDate": "2019-08-24T14:15:22Z",
215 "lastModifiedDate": "2019-08-24T14:15:22Z",
216 "archived": true,
217 "externalId": "string",
218 "id": 0,
219 "cultureId": 0,
220 "value": "string"
221 }
222 ]
223 },
224 "addressDto": {
225 "createdBy": "string",
226 "lastModifiedBy": "string",
227 "createdDate": "2019-08-24T14:15:22Z",
228 "lastModifiedDate": "2019-08-24T14:15:22Z",
229 "archived": true,
230 "externalId": "string",
231 "id": 0,
232 "street": "string",
233 "civicNumber": "string",
234 "suite": "string",
235 "postalCode": "string",
236 "lon": 0.1,
237 "lat": 0.1,
238 "city": {
239 "createdBy": "string",
240 "lastModifiedBy": "string",
241 "createdDate": "2019-08-24T14:15:22Z",
242 "lastModifiedDate": "2019-08-24T14:15:22Z",
243 "archived": true,
244 "externalId": "string",
245 "id": 0,
246 "name": "string",
247 "province": {
248 "createdBy": "string",
249 "lastModifiedBy": "string",
250 "createdDate": "2019-08-24T14:15:22Z",
251 "lastModifiedDate": "2019-08-24T14:15:22Z",
252 "archived": true,
253 "externalId": "string",
254 "id": 0,
255 "name": "string",
256 "code": "string",
257 "country": {
258 "createdBy": "string",
259 "lastModifiedBy": "string",
260 "createdDate": "2019-08-24T14:15:22Z",
261 "lastModifiedDate": "2019-08-24T14:15:22Z",
262 "archived": true,
263 "externalId": "string",
264 "id": 0,
265 "name": "string",
266 "code": "string"
267 }
268 }
269 },
270 "district": {
271 "createdBy": "string",
272 "lastModifiedBy": "string",
273 "createdDate": "2019-08-24T14:15:22Z",
274 "lastModifiedDate": "2019-08-24T14:15:22Z",
275 "archived": true,
276 "externalId": "string",
277 "id": 0,
278 "name": "string",
279 "city": {
280 "createdBy": "string",
281 "lastModifiedBy": "string",
282 "createdDate": "2019-08-24T14:15:22Z",
283 "lastModifiedDate": "2019-08-24T14:15:22Z",
284 "archived": true,
285 "externalId": "string",
286 "id": 0,
287 "name": "string",
288 "province": {
289 "createdBy": "string",
290 "lastModifiedBy": "string",
291 "createdDate": "2019-08-24T14:15:22Z",
292 "lastModifiedDate": "2019-08-24T14:15:22Z",
293 "archived": true,
294 "externalId": "string",
295 "id": 0,
296 "name": "string",
297 "code": "string",
298 "country": {
299 "createdBy": "string",
300 "lastModifiedBy": "string",
301 "createdDate": "2019-08-24T14:15:22Z",
302 "lastModifiedDate": "2019-08-24T14:15:22Z",
303 "archived": true,
304 "externalId": "string",
305 "id": 0,
306 "name": "string",
307 "code": "string"
308 }
309 }
310 }
311 },
312 "cityId": 0,
313 "districtId": 0
314 },
315 "secondAddressDto": {
316 "createdBy": "string",
317 "lastModifiedBy": "string",
318 "createdDate": "2019-08-24T14:15:22Z",
319 "lastModifiedDate": "2019-08-24T14:15:22Z",
320 "archived": true,
321 "externalId": "string",
322 "id": 0,
323 "street": "string",
324 "civicNumber": "string",
325 "suite": "string",
326 "postalCode": "string",
327 "lon": 0.1,
328 "lat": 0.1,
329 "city": {
330 "createdBy": "string",
331 "lastModifiedBy": "string",
332 "createdDate": "2019-08-24T14:15:22Z",
333 "lastModifiedDate": "2019-08-24T14:15:22Z",
334 "archived": true,
335 "externalId": "string",
336 "id": 0,
337 "name": "string",
338 "province": {
339 "createdBy": "string",
340 "lastModifiedBy": "string",
341 "createdDate": "2019-08-24T14:15:22Z",
342 "lastModifiedDate": "2019-08-24T14:15:22Z",
343 "archived": true,
344 "externalId": "string",
345 "id": 0,
346 "name": "string",
347 "code": "string",
348 "country": {
349 "createdBy": "string",
350 "lastModifiedBy": "string",
351 "createdDate": "2019-08-24T14:15:22Z",
352 "lastModifiedDate": "2019-08-24T14:15:22Z",
353 "archived": true,
354 "externalId": "string",
355 "id": 0,
356 "name": "string",
357 "code": "string"
358 }
359 }
360 },
361 "district": {
362 "createdBy": "string",
363 "lastModifiedBy": "string",
364 "createdDate": "2019-08-24T14:15:22Z",
365 "lastModifiedDate": "2019-08-24T14:15:22Z",
366 "archived": true,
367 "externalId": "string",
368 "id": 0,
369 "name": "string",
370 "city": {
371 "createdBy": "string",
372 "lastModifiedBy": "string",
373 "createdDate": "2019-08-24T14:15:22Z",
374 "lastModifiedDate": "2019-08-24T14:15:22Z",
375 "archived": true,
376 "externalId": "string",
377 "id": 0,
378 "name": "string",
379 "province": {
380 "createdBy": "string",
381 "lastModifiedBy": "string",
382 "createdDate": "2019-08-24T14:15:22Z",
383 "lastModifiedDate": "2019-08-24T14:15:22Z",
384 "archived": true,
385 "externalId": "string",
386 "id": 0,
387 "name": "string",
388 "code": "string",
389 "country": {
390 "createdBy": "string",
391 "lastModifiedBy": "string",
392 "createdDate": "2019-08-24T14:15:22Z",
393 "lastModifiedDate": "2019-08-24T14:15:22Z",
394 "archived": true,
395 "externalId": "string",
396 "id": 0,
397 "name": "string",
398 "code": "string"
399 }
400 }
401 }
402 },
403 "cityId": 0,
404 "districtId": 0
405 }
406}
Get Image¶
HTTP Request
GET /api/locations/{locationId}/pictures/{pictureId}/download
📋 Description: Downloads the specified picture associated with a location within the Nakisa Portfolio Management Suite, facilitating access to visual assets for portfolio and asset analysis in real estate management.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
locationId |
path |
integer(int64) |
true |
Unique identifier for the location |
pictureId |
path |
integer(int64) |
true |
Unique identifier for the picture |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
string |
Get Operating Cost Expense Types For Location¶
HTTP Request
GET /api/locations/{locationId}/operating-cost-expense-types
📋 Description: Retrieves the operating cost expense types associated with a specific location, enabling users to analyze and manage financial aspects of real estate properties within the Nakisa Portfolio Management Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
locationId |
path |
integer(int64) |
true |
Unique identifier for the location |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 {
3 "createdBy": "string",
4 "lastModifiedBy": "string",
5 "createdDate": "2019-08-24T14:15:22Z",
6 "lastModifiedDate": "2019-08-24T14:15:22Z",
7 "archived": true,
8 "externalId": "string",
9 "id": 0,
10 "operatingCostExpenseTypeId": 0,
11 "expenseGroupId": 0,
12 "operatingCostExpenseTypeOption": {
13 "createdBy": "string",
14 "lastModifiedBy": "string",
15 "createdDate": "2019-08-24T14:15:22Z",
16 "lastModifiedDate": "2019-08-24T14:15:22Z",
17 "archived": true,
18 "externalId": "string",
19 "id": 0,
20 "priority": 0,
21 "internalId": 0,
22 "pickListCode": "string",
23 "pickListLabel": "string",
24 "label": "string",
25 "cultureId": 0,
26 "labelDtos": [
27 {
28 "createdBy": "string",
29 "lastModifiedBy": "string",
30 "createdDate": "2019-08-24T14:15:22Z",
31 "lastModifiedDate": "2019-08-24T14:15:22Z",
32 "archived": true,
33 "externalId": "string",
34 "id": 0,
35 "cultureId": 0,
36 "value": "string"
37 }
38 ]
39 }
40 }
41]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing the classification of operating cost expenses associated with real estate properties within the Nakisa Portfolio Management Suite, facilitating effective portfolio and asset analytics.] |
|
» createdBy |
string |
false |
none |
Username of who created this resource |
» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
» createdDate |
string(date-time) |
false |
none |
Date of the created |
» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
» archived |
boolean |
false |
none |
Boolean flag indicating archived status |
» externalId |
string |
false |
none |
Unique identifier for the external |
» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
» operatingCostExpenseTypeId |
integer(int64) |
false |
none |
Unique identifier for the operating cost expense type |
» expenseGroupId |
integer(int64) |
false |
none |
Unique identifier for the expense group |
» operatingCostExpenseTypeOption |
false |
none |
Data transfer object representing an option within a pick list, utilized for categorizing and managing portfolio assets and analytics in the Nakisa Portfolio Management Suite, particularly in the context of real estate property management. |
|
»» createdBy |
string |
false |
none |
Username of who created this resource |
»» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
»» createdDate |
string(date-time) |
false |
none |
Date of the created |
»» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
»» archived |
boolean |
false |
none |
Boolean flag indicating archived status |
»» externalId |
string |
false |
none |
Unique identifier for the external |
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» priority |
integer(int64) |
false |
none |
Priority of the resource |
»» internalId |
integer(int64) |
false |
none |
Unique identifier for the internal |
»» pickListCode |
string |
false |
none |
Code for the pick list |
»» pickListLabel |
string |
false |
none |
Label for the pick list |
»» label |
string |
false |
none |
Label for the resource |
»» cultureId |
integer(int64) |
false |
none |
Unique identifier for the culture |
»» labelDtos |
false |
none |
List of labelDtos items |
|
»»» createdBy |
string |
false |
none |
Username of who created this resource |
»»» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
»»» createdDate |
string(date-time) |
false |
none |
Date of the created |
»»» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
»»» archived |
boolean |
false |
none |
Boolean flag indicating archived status |
»»» externalId |
string |
false |
none |
Unique identifier for the external |
»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»» cultureId |
integer(int64) |
false |
none |
Unique identifier for the culture |
»»» value |
string |
true |
none |
Text value for value in LabelDto |
Location Has Active Child¶
HTTP Request
GET /api/locations/{locationId}/has-active-child
📋 Description: Retrieves a boolean value indicating whether the specified location has any active child assets within the Nakisa Portfolio Management Suite, facilitating effective portfolio and asset management in real estate analytics.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
locationId |
path |
integer(int64) |
true |
Unique identifier for the location |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
boolean |
Example Responses
1true
Download Location Document¶
HTTP Request
GET /api/locations/{locationId}/documents/{documentId}/download
📋 Description: Downloads the specified document associated with a particular location within the Nakisa Portfolio Management Suite, facilitating access to critical asset and portfolio information for real estate analytics.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
locationId |
path |
integer(int64) |
true |
Unique identifier for the location |
documentId |
path |
integer(int64) |
true |
Unique identifier for the document |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{}
Get Location Access Level¶
HTTP Request
GET /api/locations/{locationId}/authorization
📋 Description: Retrieves authorization details for a specified location within the Nakisa Portfolio Management Suite, enabling users to manage portfolio and asset access for real estate properties effectively.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
locationId |
path |
integer(int64) |
true |
Unique identifier for the location |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "createdBy": "string",
3 "lastModifiedBy": "string",
4 "createdDate": "2019-08-24T14:15:22Z",
5 "lastModifiedDate": "2019-08-24T14:15:22Z",
6 "archived": true,
7 "externalId": "string",
8 "id": 0,
9 "priority": 0,
10 "internalId": 0,
11 "pickListCode": "string",
12 "pickListLabel": "string",
13 "label": "string",
14 "cultureId": 0,
15 "labelDtos": [
16 {
17 "createdBy": "string",
18 "lastModifiedBy": "string",
19 "createdDate": "2019-08-24T14:15:22Z",
20 "lastModifiedDate": "2019-08-24T14:15:22Z",
21 "archived": true,
22 "externalId": "string",
23 "id": 0,
24 "cultureId": 0,
25 "value": "string"
26 }
27 ]
28}
Get Transitions¶
HTTP Request
GET /api/locations/{id}/transitions
📋 Description: Retrieves the transition history for a specified location within the Nakisa Portfolio Management Suite, providing insights into asset movements and changes relevant to portfolio and real estate analytics.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 {
3 "name": "SEND_FOR_APPROVAL",
4 "from": {
5 "name": "DRAFT",
6 "end": true,
7 "readOnly": true
8 },
9 "to": {
10 "name": "DRAFT",
11 "end": true,
12 "readOnly": true
13 },
14 "permission": "string"
15 }
16]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing a transition within the Nakisa Portfolio Management Suite, capturing the movement of assets across portfolios to enhance analytics and optimize real estate property management.] |
|
» name |
string |
false |
none |
Name of the resource |
» from |
false |
none |
Data transfer object representing the state of assets within the Nakisa Portfolio Management Suite, providing insights into portfolio performance, asset analytics, and real estate property management. This schema facilitates informed decision-making by capturing the current status and metrics of portfolio components. |
|
»» name |
string |
false |
none |
Name of the resource |
»» end |
boolean |
false |
none |
Boolean flag indicating end status |
»» readOnly |
boolean |
false |
none |
Boolean flag indicating readOnly status |
» to |
false |
none |
Data transfer object representing the state of assets within the Nakisa Portfolio Management Suite, providing insights into portfolio performance, asset analytics, and real estate property management. This schema facilitates informed decision-making by capturing the current status and metrics of portfolio components. |
|
» permission |
string |
false |
none |
Text value for permission in Transition |
Enumerated Values
Attribute |
Value |
|---|---|
name |
ACTIVATE, ACTIVE, APPROVE, APPROVED, AWAITING_ACTIVATION, DEACTIVATE, DRAFT, INACTIVE, OPEN_FOR_MODIFICATIONS, PENDING_APPROVAL, PENDING_TERMINATE, PENDING_TERMINATION, REJECT, SEND_FOR_APPROVAL, TERMINATE, TERMINATED |
Get Location Reminders¶
HTTP Request
GET /api/locations/{id}/reminders
📋 Description: Fetches reminders associated with a specific location within the Nakisa Portfolio Management Suite, enabling users to manage portfolio and asset-related notifications effectively.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
pageable |
query |
true |
Indicates whether the results of the reminders associated with a specific location should be returned in a paginated format, facilitating efficient data retrieval for portfolio and asset management analytics. |
|
subject-id |
query |
string |
false |
Unique identifier for the subject associated with reminders in the context of portfolio management and asset analytics. |
category-id |
query |
string |
false |
Unique identifier for the category of reminders associated with a specific location within the Nakisa Portfolio Management Suite, facilitating effective portfolio and asset management. |
lease-id |
query |
string |
false |
Unique identifier for the lease associated with the specified location, enabling retrieval of relevant reminders within the Nakisa Portfolio Management Suite. |
lease-id-in |
query |
string |
false |
Unique identifier for the lease associated with the specified location, used to retrieve relevant reminders within the Nakisa Portfolio Management Suite. |
status-id |
query |
string |
false |
Unique identifier for the status of reminders associated with a specific location within the Nakisa Portfolio Management Suite, facilitating effective portfolio and asset management. |
status-id-in |
query |
string |
false |
Specifies the unique status identifier for reminders associated with a particular location within the Nakisa Portfolio Management Suite, facilitating effective portfolio and asset management. |
reminder-type-id |
query |
string |
false |
Unique identifier for the type of reminder associated with a specific location within the Nakisa Portfolio Management Suite, facilitating effective portfolio and asset management. |
reminder-type-id-in |
query |
string |
false |
Unique identifier for the type of reminder associated with a specific location within the Nakisa Portfolio Management Suite, facilitating effective portfolio and asset management. |
date |
query |
string |
false |
Date of the resource |
follow-up-date |
query |
string |
false |
Specifies the date for follow-up reminders related to the selected location’s portfolio assets within the Nakisa Portfolio Management Suite. |
follow-up-date-before |
query |
string |
false |
Specifies the cutoff date for retrieving reminders related to a particular location, enabling users to focus on upcoming follow-up actions within the Nakisa Portfolio Management Suite. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "_embedded": {
3 "reminders": [
4 {
5 "createdBy": "string",
6 "lastModifiedBy": "string",
7 "createdDate": "2019-08-24T14:15:22Z",
8 "lastModifiedDate": "2019-08-24T14:15:22Z",
9 "archived": true,
10 "externalId": "string",
11 "id": 0,
12 "subjectId": 0,
13 "categoryId": 0,
14 "statusId": 0,
15 "reminderTypeId": 0,
16 "date": "2019-08-24",
17 "followUpDate": "2019-08-24",
18 "comments": "string",
19 "primaryUserId": 0,
20 "subject": {
21 "createdBy": "string",
22 "lastModifiedBy": "string",
23 "createdDate": "2019-08-24T14:15:22Z",
24 "lastModifiedDate": "2019-08-24T14:15:22Z",
25 "archived": true,
26 "externalId": "string",
27 "id": 0,
28 "priority": 0,
29 "internalId": 0,
30 "pickListCode": "string",
31 "pickListLabel": "string",
32 "label": "string",
33 "cultureId": 0,
34 "labelDtos": [
35 {
36 "createdBy": "string",
37 "lastModifiedBy": "string",
38 "createdDate": "2019-08-24T14:15:22Z",
39 "lastModifiedDate": "2019-08-24T14:15:22Z",
40 "archived": true,
41 "externalId": "string",
42 "id": 0,
43 "cultureId": 0,
44 "value": "string"
45 }
46 ]
47 },
48 "category": {
49 "createdBy": "string",
50 "lastModifiedBy": "string",
51 "createdDate": "2019-08-24T14:15:22Z",
52 "lastModifiedDate": "2019-08-24T14:15:22Z",
53 "archived": true,
54 "externalId": "string",
55 "id": 0,
56 "priority": 0,
57 "internalId": 0,
58 "pickListCode": "string",
59 "pickListLabel": "string",
60 "label": "string",
61 "cultureId": 0,
62 "labelDtos": [
63 {
64 "createdBy": "string",
65 "lastModifiedBy": "string",
66 "createdDate": "2019-08-24T14:15:22Z",
67 "lastModifiedDate": "2019-08-24T14:15:22Z",
68 "archived": true,
69 "externalId": "string",
70 "id": 0,
71 "cultureId": 0,
72 "value": "string"
73 }
74 ]
75 },
76 "status": {
77 "createdBy": "string",
78 "lastModifiedBy": "string",
79 "createdDate": "2019-08-24T14:15:22Z",
80 "lastModifiedDate": "2019-08-24T14:15:22Z",
81 "archived": true,
82 "externalId": "string",
83 "id": 0,
84 "priority": 0,
85 "internalId": 0,
86 "pickListCode": "string",
87 "pickListLabel": "string",
88 "label": "string",
89 "cultureId": 0,
90 "labelDtos": [
91 {
92 "createdBy": "string",
93 "lastModifiedBy": "string",
94 "createdDate": "2019-08-24T14:15:22Z",
95 "lastModifiedDate": "2019-08-24T14:15:22Z",
96 "archived": true,
97 "externalId": "string",
98 "id": 0,
99 "cultureId": 0,
100 "value": "string"
101 }
102 ]
103 },
104 "reminderType": {
105 "createdBy": "string",
106 "lastModifiedBy": "string",
107 "createdDate": "2019-08-24T14:15:22Z",
108 "lastModifiedDate": "2019-08-24T14:15:22Z",
109 "archived": true,
110 "externalId": "string",
111 "id": 0,
112 "priority": 0,
113 "internalId": 0,
114 "pickListCode": "string",
115 "pickListLabel": "string",
116 "label": "string",
117 "cultureId": 0,
118 "labelDtos": [
119 {
120 "createdBy": "string",
121 "lastModifiedBy": "string",
122 "createdDate": "2019-08-24T14:15:22Z",
123 "lastModifiedDate": "2019-08-24T14:15:22Z",
124 "archived": true,
125 "externalId": "string",
126 "id": 0,
127 "cultureId": 0,
128 "value": "string"
129 }
130 ]
131 },
132 "primaryUser": {
133 "createdBy": "string",
134 "lastModifiedBy": "string",
135 "createdDate": "2019-08-24T14:15:22Z",
136 "lastModifiedDate": "2019-08-24T14:15:22Z",
137 "archived": true,
138 "externalId": "string",
139 "id": 0,
140 "email": "string",
141 "userName": "string",
142 "firstName": "string",
143 "lastName": "string",
144 "displayName": "string",
145 "permissions": "string",
146 "internalId": "string",
147 "preferredCulture": {
148 "createdBy": "string",
149 "lastModifiedBy": "string",
150 "createdDate": "2019-08-24T14:15:22Z",
151 "lastModifiedDate": "2019-08-24T14:15:22Z",
152 "archived": true,
153 "externalId": "string",
154 "id": 0,
155 "name": "string",
156 "code": "string",
157 "defaultCulture": true,
158 "enable": true
159 },
160 "userGroups": [
161 {
162 "createdBy": "string",
163 "lastModifiedBy": "string",
164 "createdDate": "2019-08-24T14:15:22Z",
165 "lastModifiedDate": "2019-08-24T14:15:22Z",
166 "archived": true,
167 "externalId": "string",
168 "id": 0,
169 "name": "string",
170 "description": "string",
171 "internalId": "string"
172 }
173 ],
174 "partnerIds": [
175 0
176 ],
177 "partners": [
178 {
179 "id": 0,
180 "status": "CREATED",
181 "displayId": "string",
182 "erpSystemId": 0,
183 "erpSystemDisplayId": "string",
184 "name": "string",
185 "fax": "string",
186 "phone": "string",
187 "parentId": 0,
188 "parentName": "string",
189 "parentDisplayId": "string",
190 "companyId": 0,
191 "partnerRoleId": 0,
192 "partnerContactId": 0
193 }
194 ]
195 },
196 "leaseExternalId": "string",
197 "premiseName": "string",
198 "reminderUserDtos": [
199 {
200 "createdBy": "string",
201 "lastModifiedBy": "string",
202 "createdDate": "2019-08-24T14:15:22Z",
203 "lastModifiedDate": "2019-08-24T14:15:22Z",
204 "archived": true,
205 "externalId": "string",
206 "acknowledge": true,
207 "userDto": {
208 "createdBy": "string",
209 "lastModifiedBy": "string",
210 "createdDate": "2019-08-24T14:15:22Z",
211 "lastModifiedDate": "2019-08-24T14:15:22Z",
212 "archived": true,
213 "externalId": "string",
214 "id": 0,
215 "email": "string",
216 "userName": "string",
217 "firstName": "string",
218 "lastName": "string",
219 "displayName": "string",
220 "permissions": "string",
221 "internalId": "string",
222 "preferredCulture": {
223 "createdBy": "string",
224 "lastModifiedBy": "string",
225 "createdDate": "2019-08-24T14:15:22Z",
226 "lastModifiedDate": "2019-08-24T14:15:22Z",
227 "archived": true,
228 "externalId": "string",
229 "id": 0,
230 "name": "string",
231 "code": "string",
232 "defaultCulture": true,
233 "enable": true
234 },
235 "userGroups": [
236 {
237 "createdBy": "string",
238 "lastModifiedBy": "string",
239 "createdDate": "2019-08-24T14:15:22Z",
240 "lastModifiedDate": "2019-08-24T14:15:22Z",
241 "archived": true,
242 "externalId": "string",
243 "id": 0,
244 "name": "string",
245 "description": "string",
246 "internalId": "string"
247 }
248 ],
249 "partnerIds": [
250 0
251 ],
252 "partners": [
253 {
254 "id": 0,
255 "status": "CREATED",
256 "displayId": "string",
257 "erpSystemId": 0,
258 "erpSystemDisplayId": "string",
259 "name": "string",
260 "fax": "string",
261 "phone": "string",
262 "parentId": 0,
263 "parentName": "string",
264 "parentDisplayId": "string",
265 "companyId": 0,
266 "partnerRoleId": 0,
267 "partnerContactId": 0
268 }
269 ]
270 }
271 }
272 ]
273 }
274 ]
275 },
276 "page": {
277 "size": 0,
278 "totalElements": 0,
279 "totalPages": 0,
280 "number": 0
281 }
282}
Get Location Premises¶
HTTP Request
GET /api/locations/{id}/premises
📋 Description: Retrieves a list of premises associated with a specific location, providing valuable insights for portfolio and asset management within the Nakisa Portfolio Management Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
pageable |
query |
true |
Indicates whether the results of the premises associated with a specific location should be returned in a paginated format, facilitating efficient data retrieval for portfolio and asset management analytics. |
|
search |
query |
string |
false |
Search term used to filter and retrieve specific premises associated with a given location within the Nakisa Portfolio Management Suite. |
city-id |
query |
string |
false |
Unique identifier for the city associated with the premises, used to retrieve relevant asset and portfolio analytics within the Nakisa Portfolio Management Suite. |
province-id |
query |
string |
false |
Unique identifier for the province associated with the specified premises, facilitating precise asset and portfolio analytics within the Nakisa Portfolio Management Suite. |
country-id |
query |
string |
false |
Unique identifier for the country associated with the specified premises, facilitating accurate portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
city-id-in |
query |
string |
false |
Unique identifier for the city associated with the specified premises, facilitating targeted analytics and insights within the Nakisa Portfolio Management Suite. |
province-id-in |
query |
string |
false |
Unique identifier for the province associated with the specified location, used to filter premises data within the Nakisa Portfolio Management Suite. |
country-id-in |
query |
string |
false |
Specifies the unique identifier for the country associated with the premises being queried in the Nakisa Portfolio Management Suite, facilitating accurate portfolio and asset analytics within real estate property management. |
id-in |
query |
string |
false |
Unique identifier for the specific location within the Nakisa Portfolio Management Suite, used to retrieve associated premises data for portfolio and asset analytics. |
legal-entity-id-in |
query |
string |
false |
Unique identifier for the legal entity associated with the specified premises, facilitating accurate portfolio and asset management within the Nakisa Portfolio Management Suite. |
location-id |
query |
string |
false |
Unique identifier for the specific location within the Nakisa Portfolio Management Suite, used to retrieve associated premises data for portfolio and asset analysis in real estate management. |
location-type-id |
query |
string |
false |
Identifier for the type of location associated with the specified premises, facilitating portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
location-id-in |
query |
string |
false |
Unique identifier for the specific location within the Nakisa Portfolio Management Suite, used to retrieve associated premises data for portfolio and asset analytics. |
location-number-like |
query |
string |
false |
Specifies a string pattern to filter premises associated with a location in the Nakisa Portfolio Management Suite, enhancing analytics and asset management within real estate portfolios. |
location-external-id |
query |
string |
false |
Unique identifier for the external location associated with the premises, facilitating accurate asset and portfolio analytics within the Nakisa Portfolio Management Suite. |
external-id-like |
query |
string |
false |
Specifies a string pattern to filter premises by their external identifiers, facilitating targeted asset management and analytics within the Nakisa Portfolio Management Suite. |
number |
query |
string |
false |
Specifies the unique identifier for the location’s premises within the Nakisa Portfolio Management Suite, facilitating asset and portfolio analytics in real estate property management. |
number-like |
query |
string |
false |
Represents a numeric value or identifier related to the premises within a specified location in the Nakisa Portfolio Management Suite, facilitating asset and portfolio analytics. |
name |
query |
string |
false |
Name of the resource |
name-like |
query |
string |
false |
Filters the list of premises associated with the specified location by matching names that are similar to the provided string, enhancing asset management and analytics within the real estate portfolio. |
head-premise |
query |
string |
false |
Specifies the head premise associated with a particular location, enabling effective portfolio and asset management within the Nakisa Portfolio Management Suite. |
possession-date |
query |
string |
false |
Specifies the date of possession for the premises, enabling accurate tracking and analysis of real estate property assets within the portfolio. |
opening-date |
query |
string |
false |
Specifies the opening date of the premises associated with the given location, facilitating portfolio and asset analysis within the Nakisa Portfolio Management Suite. |
closing-date |
query |
string |
false |
Specifies the closing date for the premises associated with the given location, facilitating accurate portfolio and asset analysis within the Nakisa Portfolio Management Suite. |
relocation-date |
query |
string |
false |
Specifies the date of relocation for the premises, enabling accurate portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
vacating-date |
query |
string |
false |
Specifies the date on which the premises will be vacated, facilitating accurate portfolio and asset management within the Nakisa Portfolio Management Suite. |
expansion-date |
query |
string |
false |
Specifies the date for which the premises data is being requested, enabling users to analyze portfolio and asset performance within the Nakisa Portfolio Management Suite. |
status-id |
query |
string |
false |
Unique identifier for the status of premises associated with a specific location, facilitating effective portfolio and asset management within the Nakisa Portfolio Management Suite. |
status-id-in |
query |
string |
false |
Specifies the status ID to filter premises associated with a given location, enabling targeted analytics within the Nakisa Portfolio Management Suite. |
usage-id |
query |
string |
false |
Unique identifier for the specific usage instance within the portfolio, enabling retrieval of premises data associated with a real estate property. |
parent-premise-id |
query |
string |
false |
Unique identifier for the parent premise within the Nakisa Portfolio Management Suite, used to retrieve associated premises for effective portfolio and asset analysis in real estate management. |
contract-id-not-null |
query |
string |
false |
Identifier for the contract associated with the specified location, ensuring that only premises linked to valid contracts are retrieved for portfolio and asset analysis. |
master-agreement-id-in |
query |
string |
false |
Unique identifier for the master agreement associated with the specified location, facilitating effective portfolio and asset management within the Nakisa Portfolio Management Suite. |
business-unit-id-in |
query |
string |
false |
Unique identifier for the business unit associated with the specified location, used to filter premises data within the Nakisa Portfolio Management Suite. |
group-id-in |
query |
string |
false |
Unique identifier for the group associated with the specified location, used to filter premises data within the Nakisa Portfolio Management Suite. |
contract-id-in |
query |
string |
false |
Unique identifier for the specific contract associated with the premises, facilitating precise portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
head-premise-opt |
query |
string |
false |
Specifies the head premise option for retrieving detailed information about a specific location’s premises within the Nakisa Portfolio Management Suite, facilitating enhanced portfolio and asset analytics in real estate property management. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "_embedded": {
3 "premises": [
4 {
5 "createdBy": "string",
6 "lastModifiedBy": "string",
7 "createdDate": "2019-08-24T14:15:22Z",
8 "lastModifiedDate": "2019-08-24T14:15:22Z",
9 "archived": true,
10 "externalId": "string",
11 "id": 0,
12 "number": "string",
13 "name": "string",
14 "headPremise": true,
15 "possessionDate": "2019-08-24",
16 "openingDate": "2019-08-24",
17 "closingDate": "2019-08-24",
18 "relocationDate": "2019-08-24",
19 "vacatingDate": "2019-08-24",
20 "expansionDate": "2019-08-24",
21 "statusId": 0,
22 "usageId": 0,
23 "parentPremiseId": 0,
24 "costCenterId": 0,
25 "profitCenterId": 0,
26 "legalEntityId": 0,
27 "occupancyIds": [
28 0
29 ],
30 "locationId": 0,
31 "locationDto": {
32 "createdBy": "string",
33 "lastModifiedBy": "string",
34 "createdDate": "2019-08-24T14:15:22Z",
35 "lastModifiedDate": "2019-08-24T14:15:22Z",
36 "archived": true,
37 "externalId": "string",
38 "id": 0,
39 "number": "string",
40 "name": "string",
41 "storeNumber": "string",
42 "defaultCurrencyId": 0,
43 "defaultMeasureId": 0,
44 "typeId": 0,
45 "qualityId": 0,
46 "propertyTypeId": 0,
47 "categoryId": 0,
48 "statusId": 0,
49 "businessUnitId": 0,
50 "groupIds": [
51 0
52 ],
53 "legalEntityIds": [
54 0
55 ],
56 "defaultCurrency": {
57 "id": 0,
58 "status": "CREATED",
59 "displayId": "string",
60 "erpSystemId": 0,
61 "erpSystemDisplayId": "string",
62 "name": "string",
63 "decimalPoints": 0,
64 "depreciationAreaId": 0
65 },
66 "defaultUnitValue": {
67 "createdBy": "string",
68 "lastModifiedBy": "string",
69 "createdDate": "2019-08-24T14:15:22Z",
70 "lastModifiedDate": "2019-08-24T14:15:22Z",
71 "archived": true,
72 "externalId": "string",
73 "id": 0,
74 "unitId": 0,
75 "unitOfMeasureId": 0,
76 "erpSystemId": 0,
77 "unit": {
78 "createdBy": "string",
79 "lastModifiedBy": "string",
80 "createdDate": "2019-08-24T14:15:22Z",
81 "lastModifiedDate": "2019-08-24T14:15:22Z",
82 "archived": true,
83 "externalId": "string",
84 "id": 0,
85 "priority": 0,
86 "internalId": 0,
87 "pickListCode": "string",
88 "pickListLabel": "string",
89 "label": "string",
90 "cultureId": 0,
91 "labelDtos": [
92 {
93 "createdBy": "string",
94 "lastModifiedBy": "string",
95 "createdDate": "2019-08-24T14:15:22Z",
96 "lastModifiedDate": "2019-08-24T14:15:22Z",
97 "archived": true,
98 "externalId": "string",
99 "id": 0,
100 "cultureId": 0,
101 "value": "string"
102 }
103 ]
104 },
105 "unitOfMeasure": {
106 "id": 0,
107 "status": "CREATED",
108 "displayId": "string",
109 "erpSystemId": 0,
110 "erpSystemDisplayId": "string",
111 "name": "string"
112 }
113 },
114 "type": {
115 "createdBy": "string",
116 "lastModifiedBy": "string",
117 "createdDate": "2019-08-24T14:15:22Z",
118 "lastModifiedDate": "2019-08-24T14:15:22Z",
119 "archived": true,
120 "externalId": "string",
121 "id": 0,
122 "priority": 0,
123 "internalId": 0,
124 "pickListCode": "string",
125 "pickListLabel": "string",
126 "label": "string",
127 "cultureId": 0,
128 "labelDtos": [
129 {
130 "createdBy": "string",
131 "lastModifiedBy": "string",
132 "createdDate": "2019-08-24T14:15:22Z",
133 "lastModifiedDate": "2019-08-24T14:15:22Z",
134 "archived": true,
135 "externalId": "string",
136 "id": 0,
137 "cultureId": 0,
138 "value": "string"
139 }
140 ]
141 },
142 "quality": {
143 "createdBy": "string",
144 "lastModifiedBy": "string",
145 "createdDate": "2019-08-24T14:15:22Z",
146 "lastModifiedDate": "2019-08-24T14:15:22Z",
147 "archived": true,
148 "externalId": "string",
149 "id": 0,
150 "priority": 0,
151 "internalId": 0,
152 "pickListCode": "string",
153 "pickListLabel": "string",
154 "label": "string",
155 "cultureId": 0,
156 "labelDtos": [
157 {
158 "createdBy": "string",
159 "lastModifiedBy": "string",
160 "createdDate": "2019-08-24T14:15:22Z",
161 "lastModifiedDate": "2019-08-24T14:15:22Z",
162 "archived": true,
163 "externalId": "string",
164 "id": 0,
165 "cultureId": 0,
166 "value": "string"
167 }
168 ]
169 },
170 "propertyType": {
171 "createdBy": "string",
172 "lastModifiedBy": "string",
173 "createdDate": "2019-08-24T14:15:22Z",
174 "lastModifiedDate": "2019-08-24T14:15:22Z",
175 "archived": true,
176 "externalId": "string",
177 "id": 0,
178 "priority": 0,
179 "internalId": 0,
180 "pickListCode": "string",
181 "pickListLabel": "string",
182 "label": "string",
183 "cultureId": 0,
184 "labelDtos": [
185 {
186 "createdBy": "string",
187 "lastModifiedBy": "string",
188 "createdDate": "2019-08-24T14:15:22Z",
189 "lastModifiedDate": "2019-08-24T14:15:22Z",
190 "archived": true,
191 "externalId": "string",
192 "id": 0,
193 "cultureId": 0,
194 "value": "string"
195 }
196 ]
197 },
198 "category": {
199 "createdBy": "string",
200 "lastModifiedBy": "string",
201 "createdDate": "2019-08-24T14:15:22Z",
202 "lastModifiedDate": "2019-08-24T14:15:22Z",
203 "archived": true,
204 "externalId": "string",
205 "id": 0,
206 "priority": 0,
207 "internalId": 0,
208 "pickListCode": "string",
209 "pickListLabel": "string",
210 "label": "string",
211 "cultureId": 0,
212 "labelDtos": [
213 {
214 "createdBy": "string",
215 "lastModifiedBy": "string",
216 "createdDate": "2019-08-24T14:15:22Z",
217 "lastModifiedDate": "2019-08-24T14:15:22Z",
218 "archived": true,
219 "externalId": "string",
220 "id": 0,
221 "cultureId": 0,
222 "value": "string"
223 }
224 ]
225 },
226 "status": {
227 "createdBy": "string",
228 "lastModifiedBy": "string",
229 "createdDate": "2019-08-24T14:15:22Z",
230 "lastModifiedDate": "2019-08-24T14:15:22Z",
231 "archived": true,
232 "externalId": "string",
233 "id": 0,
234 "priority": 0,
235 "internalId": 0,
236 "pickListCode": "string",
237 "pickListLabel": "string",
238 "label": "string",
239 "cultureId": 0,
240 "labelDtos": [
241 {
242 "createdBy": "string",
243 "lastModifiedBy": "string",
244 "createdDate": "2019-08-24T14:15:22Z",
245 "lastModifiedDate": "2019-08-24T14:15:22Z",
246 "archived": true,
247 "externalId": "string",
248 "id": 0,
249 "cultureId": 0,
250 "value": "string"
251 }
252 ]
253 },
254 "addressDto": {
255 "createdBy": "string",
256 "lastModifiedBy": "string",
257 "createdDate": "2019-08-24T14:15:22Z",
258 "lastModifiedDate": "2019-08-24T14:15:22Z",
259 "archived": true,
260 "externalId": "string",
261 "id": 0,
262 "street": "string",
263 "civicNumber": "string",
264 "suite": "string",
265 "postalCode": "string",
266 "lon": 0.1,
267 "lat": 0.1,
268 "city": {
269 "createdBy": "string",
270 "lastModifiedBy": "string",
271 "createdDate": "2019-08-24T14:15:22Z",
272 "lastModifiedDate": "2019-08-24T14:15:22Z",
273 "archived": true,
274 "externalId": "string",
275 "id": 0,
276 "name": "string",
277 "province": {
278 "createdBy": "string",
279 "lastModifiedBy": "string",
280 "createdDate": "2019-08-24T14:15:22Z",
281 "lastModifiedDate": "2019-08-24T14:15:22Z",
282 "archived": true,
283 "externalId": "string",
284 "id": 0,
285 "name": "string",
286 "code": "string",
287 "country": {
288 "createdBy": "string",
289 "lastModifiedBy": "string",
290 "createdDate": "2019-08-24T14:15:22Z",
291 "lastModifiedDate": "2019-08-24T14:15:22Z",
292 "archived": true,
293 "externalId": "string",
294 "id": 0,
295 "name": "string",
296 "code": "string"
297 }
298 }
299 },
300 "district": {
301 "createdBy": "string",
302 "lastModifiedBy": "string",
303 "createdDate": "2019-08-24T14:15:22Z",
304 "lastModifiedDate": "2019-08-24T14:15:22Z",
305 "archived": true,
306 "externalId": "string",
307 "id": 0,
308 "name": "string",
309 "city": {
310 "createdBy": "string",
311 "lastModifiedBy": "string",
312 "createdDate": "2019-08-24T14:15:22Z",
313 "lastModifiedDate": "2019-08-24T14:15:22Z",
314 "archived": true,
315 "externalId": "string",
316 "id": 0,
317 "name": "string",
318 "province": {
319 "createdBy": "string",
320 "lastModifiedBy": "string",
321 "createdDate": "2019-08-24T14:15:22Z",
322 "lastModifiedDate": "2019-08-24T14:15:22Z",
323 "archived": true,
324 "externalId": "string",
325 "id": 0,
326 "name": "string",
327 "code": "string",
328 "country": {
329 "createdBy": "string",
330 "lastModifiedBy": "string",
331 "createdDate": "2019-08-24T14:15:22Z",
332 "lastModifiedDate": "2019-08-24T14:15:22Z",
333 "archived": true,
334 "externalId": "string",
335 "id": 0,
336 "name": "string",
337 "code": "string"
338 }
339 }
340 }
341 },
342 "cityId": 0,
343 "districtId": 0
344 },
345 "secondAddressDto": {
346 "createdBy": "string",
347 "lastModifiedBy": "string",
348 "createdDate": "2019-08-24T14:15:22Z",
349 "lastModifiedDate": "2019-08-24T14:15:22Z",
350 "archived": true,
351 "externalId": "string",
352 "id": 0,
353 "street": "string",
354 "civicNumber": "string",
355 "suite": "string",
356 "postalCode": "string",
357 "lon": 0.1,
358 "lat": 0.1,
359 "city": {
360 "createdBy": "string",
361 "lastModifiedBy": "string",
362 "createdDate": "2019-08-24T14:15:22Z",
363 "lastModifiedDate": "2019-08-24T14:15:22Z",
364 "archived": true,
365 "externalId": "string",
366 "id": 0,
367 "name": "string",
368 "province": {
369 "createdBy": "string",
370 "lastModifiedBy": "string",
371 "createdDate": "2019-08-24T14:15:22Z",
372 "lastModifiedDate": "2019-08-24T14:15:22Z",
373 "archived": true,
374 "externalId": "string",
375 "id": 0,
376 "name": "string",
377 "code": "string",
378 "country": {
379 "createdBy": "string",
380 "lastModifiedBy": "string",
381 "createdDate": "2019-08-24T14:15:22Z",
382 "lastModifiedDate": "2019-08-24T14:15:22Z",
383 "archived": true,
384 "externalId": "string",
385 "id": 0,
386 "name": "string",
387 "code": "string"
388 }
389 }
390 },
391 "district": {
392 "createdBy": "string",
393 "lastModifiedBy": "string",
394 "createdDate": "2019-08-24T14:15:22Z",
395 "lastModifiedDate": "2019-08-24T14:15:22Z",
396 "archived": true,
397 "externalId": "string",
398 "id": 0,
399 "name": "string",
400 "city": {
401 "createdBy": "string",
402 "lastModifiedBy": "string",
403 "createdDate": "2019-08-24T14:15:22Z",
404 "lastModifiedDate": "2019-08-24T14:15:22Z",
405 "archived": true,
406 "externalId": "string",
407 "id": 0,
408 "name": "string",
409 "province": {
410 "createdBy": "string",
411 "lastModifiedBy": "string",
412 "createdDate": "2019-08-24T14:15:22Z",
413 "lastModifiedDate": "2019-08-24T14:15:22Z",
414 "archived": true,
415 "externalId": "string",
416 "id": 0,
417 "name": "string",
418 "code": "string",
419 "country": {
420 "createdBy": "string",
421 "lastModifiedBy": "string",
422 "createdDate": "2019-08-24T14:15:22Z",
423 "lastModifiedDate": "2019-08-24T14:15:22Z",
424 "archived": true,
425 "externalId": "string",
426 "id": 0,
427 "name": "string",
428 "code": "string"
429 }
430 }
431 }
432 },
433 "cityId": 0,
434 "districtId": 0
435 }
436 },
437 "status": {
438 "createdBy": "string",
439 "lastModifiedBy": "string",
440 "createdDate": "2019-08-24T14:15:22Z",
441 "lastModifiedDate": "2019-08-24T14:15:22Z",
442 "archived": true,
443 "externalId": "string",
444 "id": 0,
445 "priority": 0,
446 "internalId": 0,
447 "pickListCode": "string",
448 "pickListLabel": "string",
449 "label": "string",
450 "cultureId": 0,
451 "labelDtos": [
452 {
453 "createdBy": "string",
454 "lastModifiedBy": "string",
455 "createdDate": "2019-08-24T14:15:22Z",
456 "lastModifiedDate": "2019-08-24T14:15:22Z",
457 "archived": true,
458 "externalId": "string",
459 "id": 0,
460 "cultureId": 0,
461 "value": "string"
462 }
463 ]
464 },
465 "usage": {
466 "createdBy": "string",
467 "lastModifiedBy": "string",
468 "createdDate": "2019-08-24T14:15:22Z",
469 "lastModifiedDate": "2019-08-24T14:15:22Z",
470 "archived": true,
471 "externalId": "string",
472 "id": 0,
473 "priority": 0,
474 "internalId": 0,
475 "pickListCode": "string",
476 "pickListLabel": "string",
477 "label": "string",
478 "cultureId": 0,
479 "labelDtos": [
480 {
481 "createdBy": "string",
482 "lastModifiedBy": "string",
483 "createdDate": "2019-08-24T14:15:22Z",
484 "lastModifiedDate": "2019-08-24T14:15:22Z",
485 "archived": true,
486 "externalId": "string",
487 "id": 0,
488 "cultureId": 0,
489 "value": "string"
490 }
491 ]
492 },
493 "occupanciesDto": [
494 {
495 "createdBy": "string",
496 "lastModifiedBy": "string",
497 "createdDate": "2019-08-24T14:15:22Z",
498 "lastModifiedDate": "2019-08-24T14:15:22Z",
499 "archived": true,
500 "externalId": "string",
501 "id": 0,
502 "priority": 0,
503 "internalId": 0,
504 "pickListCode": "string",
505 "pickListLabel": "string",
506 "label": "string",
507 "cultureId": 0,
508 "labelDtos": [
509 {
510 "createdBy": "string",
511 "lastModifiedBy": "string",
512 "createdDate": "2019-08-24T14:15:22Z",
513 "lastModifiedDate": "2019-08-24T14:15:22Z",
514 "archived": true,
515 "externalId": "string",
516 "id": 0,
517 "cultureId": 0,
518 "value": "string"
519 }
520 ]
521 }
522 ]
523 }
524 ]
525 },
526 "page": {
527 "size": 0,
528 "totalElements": 0,
529 "totalPages": 0,
530 "number": 0
531 }
532}
Get Partners For Location¶
HTTP Request
GET /api/locations/{id}/partners
📋 Description: Retrieves a list of partners associated with a specific location within the Nakisa Portfolio Management Suite, enabling users to analyze collaborative relationships in the context of portfolio and asset management.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
pageable |
query |
true |
Indicates whether the response should be paginated, allowing users to efficiently retrieve partner information related to a specific location within the Nakisa Portfolio Management Suite. |
|
partner-id |
query |
string |
false |
Unique identifier for the partner associated with a specific location, facilitating portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
partner-role-id |
query |
string |
false |
Unique identifier for the partner role associated with a specific location, facilitating effective portfolio and asset management within the Nakisa Portfolio Management Suite. |
partner-role-id-in |
query |
string |
false |
Unique identifier for the partner role associated with a specific location, facilitating targeted analytics and management within the Nakisa Portfolio Management Suite. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "_embedded": {
3 "locationToPartners": [
4 {
5 "createdBy": "string",
6 "lastModifiedBy": "string",
7 "createdDate": "2019-08-24T14:15:22Z",
8 "lastModifiedDate": "2019-08-24T14:15:22Z",
9 "archived": true,
10 "externalId": "string",
11 "id": 0,
12 "partnerId": 0,
13 "partnerRoleId": 0,
14 "dateFrom": "2019-08-24",
15 "dateTo": "2019-08-24",
16 "fosContactIds": [
17 0
18 ],
19 "locationId": 0,
20 "partner": {
21 "id": 0,
22 "displayId": "string",
23 "status": "CREATED",
24 "name": "string",
25 "erpSystemDisplayId": "string"
26 },
27 "partnerParent": {
28 "id": 0,
29 "displayId": "string",
30 "status": "CREATED",
31 "name": "string",
32 "erpSystemDisplayId": "string"
33 },
34 "partnerRole": {
35 "id": 0,
36 "displayId": "string",
37 "status": "CREATED",
38 "name": "string"
39 }
40 }
41 ]
42 },
43 "page": {
44 "size": 0,
45 "totalElements": 0,
46 "totalPages": 0,
47 "number": 0
48 }
49}
Get Notes For Location¶
HTTP Request
GET /api/locations/{id}/notes
📋 Description: Retrieves notes associated with a specific location within the Nakisa Portfolio Management Suite, enabling users to access critical insights related to portfolio and asset management for real estate properties.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
pageable |
query |
true |
Indicates whether the results of the notes associated with a specific location should be returned in a paginated format, facilitating efficient data retrieval for portfolio and asset management within the Nakisa Portfolio Management Suite. |
|
search |
query |
string |
false |
Search term used to filter notes associated with a specific location within the Nakisa Portfolio Management Suite, enhancing asset and portfolio analytics. |
message |
query |
string |
false |
Textual content of the note associated with the specified location, providing insights relevant to portfolio and asset management within the Nakisa Portfolio Management Suite. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "_embedded": {
3 "notes": [
4 {
5 "createdBy": "string",
6 "lastModifiedBy": "string",
7 "createdDate": "2019-08-24T14:15:22Z",
8 "lastModifiedDate": "2019-08-24T14:15:22Z",
9 "archived": true,
10 "externalId": "string",
11 "id": 0,
12 "message": "string",
13 "userIds": [
14 0
15 ],
16 "redirectUrl": "string"
17 }
18 ]
19 },
20 "page": {
21 "size": 0,
22 "totalElements": 0,
23 "totalPages": 0,
24 "number": 0
25 }
26}
Get Areas For Location¶
HTTP Request
GET /api/locations/{id}/areas
📋 Description: Retrieves a list of areas associated with a specific location within the Nakisa Portfolio Management Suite, enabling users to analyze and manage real estate properties effectively.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
pageable |
query |
true |
Indicates whether the results of the area retrieval for a specific location should be paginated, facilitating efficient data management within the Nakisa Portfolio Management Suite. |
|
search |
query |
string |
false |
Search term used to filter and retrieve specific areas within a location in the Nakisa Portfolio Management Suite, enhancing portfolio and asset analytics for real estate properties. |
type-id |
query |
string |
false |
Unique identifier for the type of area associated with a specific location, facilitating targeted analytics within the Nakisa Portfolio Management Suite. |
unit-id |
query |
string |
false |
Unique identifier for the specific unit within the Nakisa Portfolio Management Suite, used to retrieve associated areas relevant to portfolio and asset analytics in real estate property management. |
source-id |
query |
string |
false |
Unique identifier for the source of the location data, facilitating precise retrieval of area information within the Nakisa Portfolio Management Suite. |
pro-share-type-id |
query |
string |
false |
Unique identifier for the type of profit-sharing arrangement associated with the specified location’s areas within the Nakisa Portfolio Management Suite. |
document-id |
query |
string |
false |
Unique identifier for the specific document associated with the real estate property within the Nakisa Portfolio Management Suite, facilitating targeted retrieval of area data. |
gross-up |
query |
string |
false |
Specifies the gross-up value for calculating adjusted financial metrics related to real estate properties within the portfolio. |
lot |
query |
string |
false |
Specifies the lot associated with the real estate property to retrieve area details within the Nakisa Portfolio Management Suite. |
cadaster |
query |
string |
false |
Identifier for the cadaster associated with the specified location, used to retrieve detailed area information within the Nakisa Portfolio Management Suite for effective asset and portfolio analytics. |
verified |
query |
string |
false |
Indicates whether the areas associated with the specified location have been verified, providing essential insights for portfolio and asset management within the Nakisa Portfolio Management Suite. |
to-be-measured |
query |
string |
false |
Specifies the area to be measured within the real estate property portfolio, enabling targeted analytics and asset management. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "_embedded": {
3 "areas": [
4 {
5 "createdBy": "string",
6 "lastModifiedBy": "string",
7 "createdDate": "2019-08-24T14:15:22Z",
8 "lastModifiedDate": "2019-08-24T14:15:22Z",
9 "archived": true,
10 "externalId": "string",
11 "id": 0,
12 "typeId": 0,
13 "unitId": 0,
14 "sourceId": 0,
15 "proShareTypeId": 0,
16 "documentId": 0,
17 "grossUp": 0,
18 "lot": "string",
19 "cadaster": "string",
20 "name": "string",
21 "verified": true,
22 "toBeMeasured": true,
23 "gla": true,
24 "type": {
25 "createdBy": "string",
26 "lastModifiedBy": "string",
27 "createdDate": "2019-08-24T14:15:22Z",
28 "lastModifiedDate": "2019-08-24T14:15:22Z",
29 "archived": true,
30 "externalId": "string",
31 "id": 0,
32 "priority": 0,
33 "internalId": 0,
34 "pickListCode": "string",
35 "pickListLabel": "string",
36 "label": "string",
37 "cultureId": 0,
38 "labelDtos": [
39 {
40 "createdBy": "string",
41 "lastModifiedBy": "string",
42 "createdDate": "2019-08-24T14:15:22Z",
43 "lastModifiedDate": "2019-08-24T14:15:22Z",
44 "archived": true,
45 "externalId": "string",
46 "id": 0,
47 "cultureId": 0,
48 "value": "string"
49 }
50 ]
51 },
52 "source": {
53 "createdBy": "string",
54 "lastModifiedBy": "string",
55 "createdDate": "2019-08-24T14:15:22Z",
56 "lastModifiedDate": "2019-08-24T14:15:22Z",
57 "archived": true,
58 "externalId": "string",
59 "id": 0,
60 "priority": 0,
61 "internalId": 0,
62 "pickListCode": "string",
63 "pickListLabel": "string",
64 "label": "string",
65 "cultureId": 0,
66 "labelDtos": [
67 {
68 "createdBy": "string",
69 "lastModifiedBy": "string",
70 "createdDate": "2019-08-24T14:15:22Z",
71 "lastModifiedDate": "2019-08-24T14:15:22Z",
72 "archived": true,
73 "externalId": "string",
74 "id": 0,
75 "cultureId": 0,
76 "value": "string"
77 }
78 ]
79 },
80 "proShareType": {
81 "createdBy": "string",
82 "lastModifiedBy": "string",
83 "createdDate": "2019-08-24T14:15:22Z",
84 "lastModifiedDate": "2019-08-24T14:15:22Z",
85 "archived": true,
86 "externalId": "string",
87 "id": 0,
88 "priority": 0,
89 "internalId": 0,
90 "pickListCode": "string",
91 "pickListLabel": "string",
92 "label": "string",
93 "cultureId": 0,
94 "labelDtos": [
95 {
96 "createdBy": "string",
97 "lastModifiedBy": "string",
98 "createdDate": "2019-08-24T14:15:22Z",
99 "lastModifiedDate": "2019-08-24T14:15:22Z",
100 "archived": true,
101 "externalId": "string",
102 "id": 0,
103 "cultureId": 0,
104 "value": "string"
105 }
106 ]
107 },
108 "unitType": {
109 "createdBy": "string",
110 "lastModifiedBy": "string",
111 "createdDate": "2019-08-24T14:15:22Z",
112 "lastModifiedDate": "2019-08-24T14:15:22Z",
113 "archived": true,
114 "externalId": "string",
115 "id": 0,
116 "priority": 0,
117 "internalId": 0,
118 "pickListCode": "string",
119 "pickListLabel": "string",
120 "label": "string",
121 "cultureId": 0,
122 "labelDtos": [
123 {
124 "createdBy": "string",
125 "lastModifiedBy": "string",
126 "createdDate": "2019-08-24T14:15:22Z",
127 "lastModifiedDate": "2019-08-24T14:15:22Z",
128 "archived": true,
129 "externalId": "string",
130 "id": 0,
131 "cultureId": 0,
132 "value": "string"
133 }
134 ]
135 },
136 "historiesDto": [
137 {
138 "createdBy": "string",
139 "lastModifiedBy": "string",
140 "createdDate": "2019-08-24T14:15:22Z",
141 "lastModifiedDate": "2019-08-24T14:15:22Z",
142 "archived": true,
143 "externalId": "string",
144 "id": 0,
145 "startDate": "2019-08-24",
146 "endDate": "2019-08-24",
147 "measure": 0,
148 "details": "string",
149 "floor": "string",
150 "suite": "string",
151 "areaId": 0
152 }
153 ],
154 "archivedAssociation": true
155 }
156 ]
157 },
158 "page": {
159 "size": 0,
160 "totalElements": 0,
161 "totalPages": 0,
162 "number": 0
163 }
164}
Get Default Location¶
HTTP Request
GET /api/locations/default/{userId}
📋 Description: Retrieves the default location settings for a specified user within the Nakisa Portfolio Management Suite, facilitating enhanced portfolio and asset management for real estate properties.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
userId |
path |
integer(int64) |
true |
Unique identifier for the user |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "createdBy": "string",
3 "lastModifiedBy": "string",
4 "createdDate": "2019-08-24T14:15:22Z",
5 "lastModifiedDate": "2019-08-24T14:15:22Z",
6 "archived": true,
7 "externalId": "string",
8 "id": 0,
9 "number": "string",
10 "name": "string",
11 "storeNumber": "string",
12 "defaultCurrencyId": 0,
13 "defaultMeasureId": 0,
14 "typeId": 0,
15 "qualityId": 0,
16 "propertyTypeId": 0,
17 "categoryId": 0,
18 "statusId": 0,
19 "businessUnitId": 0,
20 "groupIds": [
21 0
22 ],
23 "legalEntityIds": [
24 0
25 ],
26 "defaultCurrency": {
27 "id": 0,
28 "status": "CREATED",
29 "displayId": "string",
30 "erpSystemId": 0,
31 "erpSystemDisplayId": "string",
32 "name": "string",
33 "decimalPoints": 0,
34 "depreciationAreaId": 0
35 },
36 "defaultUnitValue": {
37 "createdBy": "string",
38 "lastModifiedBy": "string",
39 "createdDate": "2019-08-24T14:15:22Z",
40 "lastModifiedDate": "2019-08-24T14:15:22Z",
41 "archived": true,
42 "externalId": "string",
43 "id": 0,
44 "unitId": 0,
45 "unitOfMeasureId": 0,
46 "erpSystemId": 0,
47 "unit": {
48 "createdBy": "string",
49 "lastModifiedBy": "string",
50 "createdDate": "2019-08-24T14:15:22Z",
51 "lastModifiedDate": "2019-08-24T14:15:22Z",
52 "archived": true,
53 "externalId": "string",
54 "id": 0,
55 "priority": 0,
56 "internalId": 0,
57 "pickListCode": "string",
58 "pickListLabel": "string",
59 "label": "string",
60 "cultureId": 0,
61 "labelDtos": [
62 {
63 "createdBy": "string",
64 "lastModifiedBy": "string",
65 "createdDate": "2019-08-24T14:15:22Z",
66 "lastModifiedDate": "2019-08-24T14:15:22Z",
67 "archived": true,
68 "externalId": "string",
69 "id": 0,
70 "cultureId": 0,
71 "value": "string"
72 }
73 ]
74 },
75 "unitOfMeasure": {
76 "id": 0,
77 "status": "CREATED",
78 "displayId": "string",
79 "erpSystemId": 0,
80 "erpSystemDisplayId": "string",
81 "name": "string"
82 }
83 },
84 "type": {
85 "createdBy": "string",
86 "lastModifiedBy": "string",
87 "createdDate": "2019-08-24T14:15:22Z",
88 "lastModifiedDate": "2019-08-24T14:15:22Z",
89 "archived": true,
90 "externalId": "string",
91 "id": 0,
92 "priority": 0,
93 "internalId": 0,
94 "pickListCode": "string",
95 "pickListLabel": "string",
96 "label": "string",
97 "cultureId": 0,
98 "labelDtos": [
99 {
100 "createdBy": "string",
101 "lastModifiedBy": "string",
102 "createdDate": "2019-08-24T14:15:22Z",
103 "lastModifiedDate": "2019-08-24T14:15:22Z",
104 "archived": true,
105 "externalId": "string",
106 "id": 0,
107 "cultureId": 0,
108 "value": "string"
109 }
110 ]
111 },
112 "quality": {
113 "createdBy": "string",
114 "lastModifiedBy": "string",
115 "createdDate": "2019-08-24T14:15:22Z",
116 "lastModifiedDate": "2019-08-24T14:15:22Z",
117 "archived": true,
118 "externalId": "string",
119 "id": 0,
120 "priority": 0,
121 "internalId": 0,
122 "pickListCode": "string",
123 "pickListLabel": "string",
124 "label": "string",
125 "cultureId": 0,
126 "labelDtos": [
127 {
128 "createdBy": "string",
129 "lastModifiedBy": "string",
130 "createdDate": "2019-08-24T14:15:22Z",
131 "lastModifiedDate": "2019-08-24T14:15:22Z",
132 "archived": true,
133 "externalId": "string",
134 "id": 0,
135 "cultureId": 0,
136 "value": "string"
137 }
138 ]
139 },
140 "propertyType": {
141 "createdBy": "string",
142 "lastModifiedBy": "string",
143 "createdDate": "2019-08-24T14:15:22Z",
144 "lastModifiedDate": "2019-08-24T14:15:22Z",
145 "archived": true,
146 "externalId": "string",
147 "id": 0,
148 "priority": 0,
149 "internalId": 0,
150 "pickListCode": "string",
151 "pickListLabel": "string",
152 "label": "string",
153 "cultureId": 0,
154 "labelDtos": [
155 {
156 "createdBy": "string",
157 "lastModifiedBy": "string",
158 "createdDate": "2019-08-24T14:15:22Z",
159 "lastModifiedDate": "2019-08-24T14:15:22Z",
160 "archived": true,
161 "externalId": "string",
162 "id": 0,
163 "cultureId": 0,
164 "value": "string"
165 }
166 ]
167 },
168 "category": {
169 "createdBy": "string",
170 "lastModifiedBy": "string",
171 "createdDate": "2019-08-24T14:15:22Z",
172 "lastModifiedDate": "2019-08-24T14:15:22Z",
173 "archived": true,
174 "externalId": "string",
175 "id": 0,
176 "priority": 0,
177 "internalId": 0,
178 "pickListCode": "string",
179 "pickListLabel": "string",
180 "label": "string",
181 "cultureId": 0,
182 "labelDtos": [
183 {
184 "createdBy": "string",
185 "lastModifiedBy": "string",
186 "createdDate": "2019-08-24T14:15:22Z",
187 "lastModifiedDate": "2019-08-24T14:15:22Z",
188 "archived": true,
189 "externalId": "string",
190 "id": 0,
191 "cultureId": 0,
192 "value": "string"
193 }
194 ]
195 },
196 "status": {
197 "createdBy": "string",
198 "lastModifiedBy": "string",
199 "createdDate": "2019-08-24T14:15:22Z",
200 "lastModifiedDate": "2019-08-24T14:15:22Z",
201 "archived": true,
202 "externalId": "string",
203 "id": 0,
204 "priority": 0,
205 "internalId": 0,
206 "pickListCode": "string",
207 "pickListLabel": "string",
208 "label": "string",
209 "cultureId": 0,
210 "labelDtos": [
211 {
212 "createdBy": "string",
213 "lastModifiedBy": "string",
214 "createdDate": "2019-08-24T14:15:22Z",
215 "lastModifiedDate": "2019-08-24T14:15:22Z",
216 "archived": true,
217 "externalId": "string",
218 "id": 0,
219 "cultureId": 0,
220 "value": "string"
221 }
222 ]
223 },
224 "addressDto": {
225 "createdBy": "string",
226 "lastModifiedBy": "string",
227 "createdDate": "2019-08-24T14:15:22Z",
228 "lastModifiedDate": "2019-08-24T14:15:22Z",
229 "archived": true,
230 "externalId": "string",
231 "id": 0,
232 "street": "string",
233 "civicNumber": "string",
234 "suite": "string",
235 "postalCode": "string",
236 "lon": 0.1,
237 "lat": 0.1,
238 "city": {
239 "createdBy": "string",
240 "lastModifiedBy": "string",
241 "createdDate": "2019-08-24T14:15:22Z",
242 "lastModifiedDate": "2019-08-24T14:15:22Z",
243 "archived": true,
244 "externalId": "string",
245 "id": 0,
246 "name": "string",
247 "province": {
248 "createdBy": "string",
249 "lastModifiedBy": "string",
250 "createdDate": "2019-08-24T14:15:22Z",
251 "lastModifiedDate": "2019-08-24T14:15:22Z",
252 "archived": true,
253 "externalId": "string",
254 "id": 0,
255 "name": "string",
256 "code": "string",
257 "country": {
258 "createdBy": "string",
259 "lastModifiedBy": "string",
260 "createdDate": "2019-08-24T14:15:22Z",
261 "lastModifiedDate": "2019-08-24T14:15:22Z",
262 "archived": true,
263 "externalId": "string",
264 "id": 0,
265 "name": "string",
266 "code": "string"
267 }
268 }
269 },
270 "district": {
271 "createdBy": "string",
272 "lastModifiedBy": "string",
273 "createdDate": "2019-08-24T14:15:22Z",
274 "lastModifiedDate": "2019-08-24T14:15:22Z",
275 "archived": true,
276 "externalId": "string",
277 "id": 0,
278 "name": "string",
279 "city": {
280 "createdBy": "string",
281 "lastModifiedBy": "string",
282 "createdDate": "2019-08-24T14:15:22Z",
283 "lastModifiedDate": "2019-08-24T14:15:22Z",
284 "archived": true,
285 "externalId": "string",
286 "id": 0,
287 "name": "string",
288 "province": {
289 "createdBy": "string",
290 "lastModifiedBy": "string",
291 "createdDate": "2019-08-24T14:15:22Z",
292 "lastModifiedDate": "2019-08-24T14:15:22Z",
293 "archived": true,
294 "externalId": "string",
295 "id": 0,
296 "name": "string",
297 "code": "string",
298 "country": {
299 "createdBy": "string",
300 "lastModifiedBy": "string",
301 "createdDate": "2019-08-24T14:15:22Z",
302 "lastModifiedDate": "2019-08-24T14:15:22Z",
303 "archived": true,
304 "externalId": "string",
305 "id": 0,
306 "name": "string",
307 "code": "string"
308 }
309 }
310 }
311 },
312 "cityId": 0,
313 "districtId": 0
314 },
315 "secondAddressDto": {
316 "createdBy": "string",
317 "lastModifiedBy": "string",
318 "createdDate": "2019-08-24T14:15:22Z",
319 "lastModifiedDate": "2019-08-24T14:15:22Z",
320 "archived": true,
321 "externalId": "string",
322 "id": 0,
323 "street": "string",
324 "civicNumber": "string",
325 "suite": "string",
326 "postalCode": "string",
327 "lon": 0.1,
328 "lat": 0.1,
329 "city": {
330 "createdBy": "string",
331 "lastModifiedBy": "string",
332 "createdDate": "2019-08-24T14:15:22Z",
333 "lastModifiedDate": "2019-08-24T14:15:22Z",
334 "archived": true,
335 "externalId": "string",
336 "id": 0,
337 "name": "string",
338 "province": {
339 "createdBy": "string",
340 "lastModifiedBy": "string",
341 "createdDate": "2019-08-24T14:15:22Z",
342 "lastModifiedDate": "2019-08-24T14:15:22Z",
343 "archived": true,
344 "externalId": "string",
345 "id": 0,
346 "name": "string",
347 "code": "string",
348 "country": {
349 "createdBy": "string",
350 "lastModifiedBy": "string",
351 "createdDate": "2019-08-24T14:15:22Z",
352 "lastModifiedDate": "2019-08-24T14:15:22Z",
353 "archived": true,
354 "externalId": "string",
355 "id": 0,
356 "name": "string",
357 "code": "string"
358 }
359 }
360 },
361 "district": {
362 "createdBy": "string",
363 "lastModifiedBy": "string",
364 "createdDate": "2019-08-24T14:15:22Z",
365 "lastModifiedDate": "2019-08-24T14:15:22Z",
366 "archived": true,
367 "externalId": "string",
368 "id": 0,
369 "name": "string",
370 "city": {
371 "createdBy": "string",
372 "lastModifiedBy": "string",
373 "createdDate": "2019-08-24T14:15:22Z",
374 "lastModifiedDate": "2019-08-24T14:15:22Z",
375 "archived": true,
376 "externalId": "string",
377 "id": 0,
378 "name": "string",
379 "province": {
380 "createdBy": "string",
381 "lastModifiedBy": "string",
382 "createdDate": "2019-08-24T14:15:22Z",
383 "lastModifiedDate": "2019-08-24T14:15:22Z",
384 "archived": true,
385 "externalId": "string",
386 "id": 0,
387 "name": "string",
388 "code": "string",
389 "country": {
390 "createdBy": "string",
391 "lastModifiedBy": "string",
392 "createdDate": "2019-08-24T14:15:22Z",
393 "lastModifiedDate": "2019-08-24T14:15:22Z",
394 "archived": true,
395 "externalId": "string",
396 "id": 0,
397 "name": "string",
398 "code": "string"
399 }
400 }
401 }
402 },
403 "cityId": 0,
404 "districtId": 0
405 }
406}
Delete Location Picture¶
HTTP Request
DELETE /api/locations/{locationId}/pictures/{pictureId}
📋 Description: Deletes a specified picture associated with a location within the Nakisa Portfolio Management Suite, facilitating the management of visual assets related to real estate properties.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
locationId |
path |
integer(int64) |
true |
Unique identifier for the location |
pictureId |
path |
integer(int64) |
true |
Unique identifier for the picture |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
204 |
No Content |
None |
Delete Location Document¶
HTTP Request
DELETE /api/locations/{locationId}/documents/{documentId}
📋 Description: Deletes a specified document associated with a particular location within the Nakisa Portfolio Management Suite, facilitating the management of portfolio-related assets and enhancing data accuracy in real estate property analytics.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
locationId |
path |
integer(int64) |
true |
Unique identifier for the location |
documentId |
path |
integer(int64) |
true |
Unique identifier for the document |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Delete Location Second Address¶
HTTP Request
DELETE /api/locations/{id}/second-address
📋 Description: Deletes the secondary address associated with a specified location in the Nakisa Portfolio Management Suite, streamlining asset management and enhancing data accuracy within real estate property portfolios.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
204 |
No Content |
None |
Delete Location Group¶
HTTP Request
DELETE /api/locations/{id}/groups/{groupId}
📋 Description: Deletes a specified group from a location within the Nakisa Portfolio Management Suite, facilitating effective portfolio and asset management by allowing users to maintain accurate and organized real estate property data.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
groupId |
path |
integer(int64) |
true |
Unique identifier for the group |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
204 |
No Content |
Example Responses
1{
2 "createdBy": "string",
3 "lastModifiedBy": "string",
4 "createdDate": "2019-08-24T14:15:22Z",
5 "lastModifiedDate": "2019-08-24T14:15:22Z",
6 "archived": true,
7 "externalId": "string",
8 "id": 0,
9 "number": "string",
10 "name": "string",
11 "storeNumber": "string",
12 "defaultCurrencyId": 0,
13 "defaultMeasureId": 0,
14 "typeId": 0,
15 "qualityId": 0,
16 "propertyTypeId": 0,
17 "categoryId": 0,
18 "statusId": 0,
19 "businessUnitId": 0,
20 "groupIds": [
21 0
22 ],
23 "legalEntityIds": [
24 0
25 ],
26 "defaultCurrency": {
27 "id": 0,
28 "status": "CREATED",
29 "displayId": "string",
30 "erpSystemId": 0,
31 "erpSystemDisplayId": "string",
32 "name": "string",
33 "decimalPoints": 0,
34 "depreciationAreaId": 0
35 },
36 "defaultUnitValue": {
37 "createdBy": "string",
38 "lastModifiedBy": "string",
39 "createdDate": "2019-08-24T14:15:22Z",
40 "lastModifiedDate": "2019-08-24T14:15:22Z",
41 "archived": true,
42 "externalId": "string",
43 "id": 0,
44 "unitId": 0,
45 "unitOfMeasureId": 0,
46 "erpSystemId": 0,
47 "unit": {
48 "createdBy": "string",
49 "lastModifiedBy": "string",
50 "createdDate": "2019-08-24T14:15:22Z",
51 "lastModifiedDate": "2019-08-24T14:15:22Z",
52 "archived": true,
53 "externalId": "string",
54 "id": 0,
55 "priority": 0,
56 "internalId": 0,
57 "pickListCode": "string",
58 "pickListLabel": "string",
59 "label": "string",
60 "cultureId": 0,
61 "labelDtos": [
62 {
63 "createdBy": "string",
64 "lastModifiedBy": "string",
65 "createdDate": "2019-08-24T14:15:22Z",
66 "lastModifiedDate": "2019-08-24T14:15:22Z",
67 "archived": true,
68 "externalId": "string",
69 "id": 0,
70 "cultureId": 0,
71 "value": "string"
72 }
73 ]
74 },
75 "unitOfMeasure": {
76 "id": 0,
77 "status": "CREATED",
78 "displayId": "string",
79 "erpSystemId": 0,
80 "erpSystemDisplayId": "string",
81 "name": "string"
82 }
83 },
84 "type": {
85 "createdBy": "string",
86 "lastModifiedBy": "string",
87 "createdDate": "2019-08-24T14:15:22Z",
88 "lastModifiedDate": "2019-08-24T14:15:22Z",
89 "archived": true,
90 "externalId": "string",
91 "id": 0,
92 "priority": 0,
93 "internalId": 0,
94 "pickListCode": "string",
95 "pickListLabel": "string",
96 "label": "string",
97 "cultureId": 0,
98 "labelDtos": [
99 {
100 "createdBy": "string",
101 "lastModifiedBy": "string",
102 "createdDate": "2019-08-24T14:15:22Z",
103 "lastModifiedDate": "2019-08-24T14:15:22Z",
104 "archived": true,
105 "externalId": "string",
106 "id": 0,
107 "cultureId": 0,
108 "value": "string"
109 }
110 ]
111 },
112 "quality": {
113 "createdBy": "string",
114 "lastModifiedBy": "string",
115 "createdDate": "2019-08-24T14:15:22Z",
116 "lastModifiedDate": "2019-08-24T14:15:22Z",
117 "archived": true,
118 "externalId": "string",
119 "id": 0,
120 "priority": 0,
121 "internalId": 0,
122 "pickListCode": "string",
123 "pickListLabel": "string",
124 "label": "string",
125 "cultureId": 0,
126 "labelDtos": [
127 {
128 "createdBy": "string",
129 "lastModifiedBy": "string",
130 "createdDate": "2019-08-24T14:15:22Z",
131 "lastModifiedDate": "2019-08-24T14:15:22Z",
132 "archived": true,
133 "externalId": "string",
134 "id": 0,
135 "cultureId": 0,
136 "value": "string"
137 }
138 ]
139 },
140 "propertyType": {
141 "createdBy": "string",
142 "lastModifiedBy": "string",
143 "createdDate": "2019-08-24T14:15:22Z",
144 "lastModifiedDate": "2019-08-24T14:15:22Z",
145 "archived": true,
146 "externalId": "string",
147 "id": 0,
148 "priority": 0,
149 "internalId": 0,
150 "pickListCode": "string",
151 "pickListLabel": "string",
152 "label": "string",
153 "cultureId": 0,
154 "labelDtos": [
155 {
156 "createdBy": "string",
157 "lastModifiedBy": "string",
158 "createdDate": "2019-08-24T14:15:22Z",
159 "lastModifiedDate": "2019-08-24T14:15:22Z",
160 "archived": true,
161 "externalId": "string",
162 "id": 0,
163 "cultureId": 0,
164 "value": "string"
165 }
166 ]
167 },
168 "category": {
169 "createdBy": "string",
170 "lastModifiedBy": "string",
171 "createdDate": "2019-08-24T14:15:22Z",
172 "lastModifiedDate": "2019-08-24T14:15:22Z",
173 "archived": true,
174 "externalId": "string",
175 "id": 0,
176 "priority": 0,
177 "internalId": 0,
178 "pickListCode": "string",
179 "pickListLabel": "string",
180 "label": "string",
181 "cultureId": 0,
182 "labelDtos": [
183 {
184 "createdBy": "string",
185 "lastModifiedBy": "string",
186 "createdDate": "2019-08-24T14:15:22Z",
187 "lastModifiedDate": "2019-08-24T14:15:22Z",
188 "archived": true,
189 "externalId": "string",
190 "id": 0,
191 "cultureId": 0,
192 "value": "string"
193 }
194 ]
195 },
196 "status": {
197 "createdBy": "string",
198 "lastModifiedBy": "string",
199 "createdDate": "2019-08-24T14:15:22Z",
200 "lastModifiedDate": "2019-08-24T14:15:22Z",
201 "archived": true,
202 "externalId": "string",
203 "id": 0,
204 "priority": 0,
205 "internalId": 0,
206 "pickListCode": "string",
207 "pickListLabel": "string",
208 "label": "string",
209 "cultureId": 0,
210 "labelDtos": [
211 {
212 "createdBy": "string",
213 "lastModifiedBy": "string",
214 "createdDate": "2019-08-24T14:15:22Z",
215 "lastModifiedDate": "2019-08-24T14:15:22Z",
216 "archived": true,
217 "externalId": "string",
218 "id": 0,
219 "cultureId": 0,
220 "value": "string"
221 }
222 ]
223 },
224 "addressDto": {
225 "createdBy": "string",
226 "lastModifiedBy": "string",
227 "createdDate": "2019-08-24T14:15:22Z",
228 "lastModifiedDate": "2019-08-24T14:15:22Z",
229 "archived": true,
230 "externalId": "string",
231 "id": 0,
232 "street": "string",
233 "civicNumber": "string",
234 "suite": "string",
235 "postalCode": "string",
236 "lon": 0.1,
237 "lat": 0.1,
238 "city": {
239 "createdBy": "string",
240 "lastModifiedBy": "string",
241 "createdDate": "2019-08-24T14:15:22Z",
242 "lastModifiedDate": "2019-08-24T14:15:22Z",
243 "archived": true,
244 "externalId": "string",
245 "id": 0,
246 "name": "string",
247 "province": {
248 "createdBy": "string",
249 "lastModifiedBy": "string",
250 "createdDate": "2019-08-24T14:15:22Z",
251 "lastModifiedDate": "2019-08-24T14:15:22Z",
252 "archived": true,
253 "externalId": "string",
254 "id": 0,
255 "name": "string",
256 "code": "string",
257 "country": {
258 "createdBy": "string",
259 "lastModifiedBy": "string",
260 "createdDate": "2019-08-24T14:15:22Z",
261 "lastModifiedDate": "2019-08-24T14:15:22Z",
262 "archived": true,
263 "externalId": "string",
264 "id": 0,
265 "name": "string",
266 "code": "string"
267 }
268 }
269 },
270 "district": {
271 "createdBy": "string",
272 "lastModifiedBy": "string",
273 "createdDate": "2019-08-24T14:15:22Z",
274 "lastModifiedDate": "2019-08-24T14:15:22Z",
275 "archived": true,
276 "externalId": "string",
277 "id": 0,
278 "name": "string",
279 "city": {
280 "createdBy": "string",
281 "lastModifiedBy": "string",
282 "createdDate": "2019-08-24T14:15:22Z",
283 "lastModifiedDate": "2019-08-24T14:15:22Z",
284 "archived": true,
285 "externalId": "string",
286 "id": 0,
287 "name": "string",
288 "province": {
289 "createdBy": "string",
290 "lastModifiedBy": "string",
291 "createdDate": "2019-08-24T14:15:22Z",
292 "lastModifiedDate": "2019-08-24T14:15:22Z",
293 "archived": true,
294 "externalId": "string",
295 "id": 0,
296 "name": "string",
297 "code": "string",
298 "country": {
299 "createdBy": "string",
300 "lastModifiedBy": "string",
301 "createdDate": "2019-08-24T14:15:22Z",
302 "lastModifiedDate": "2019-08-24T14:15:22Z",
303 "archived": true,
304 "externalId": "string",
305 "id": 0,
306 "name": "string",
307 "code": "string"
308 }
309 }
310 }
311 },
312 "cityId": 0,
313 "districtId": 0
314 },
315 "secondAddressDto": {
316 "createdBy": "string",
317 "lastModifiedBy": "string",
318 "createdDate": "2019-08-24T14:15:22Z",
319 "lastModifiedDate": "2019-08-24T14:15:22Z",
320 "archived": true,
321 "externalId": "string",
322 "id": 0,
323 "street": "string",
324 "civicNumber": "string",
325 "suite": "string",
326 "postalCode": "string",
327 "lon": 0.1,
328 "lat": 0.1,
329 "city": {
330 "createdBy": "string",
331 "lastModifiedBy": "string",
332 "createdDate": "2019-08-24T14:15:22Z",
333 "lastModifiedDate": "2019-08-24T14:15:22Z",
334 "archived": true,
335 "externalId": "string",
336 "id": 0,
337 "name": "string",
338 "province": {
339 "createdBy": "string",
340 "lastModifiedBy": "string",
341 "createdDate": "2019-08-24T14:15:22Z",
342 "lastModifiedDate": "2019-08-24T14:15:22Z",
343 "archived": true,
344 "externalId": "string",
345 "id": 0,
346 "name": "string",
347 "code": "string",
348 "country": {
349 "createdBy": "string",
350 "lastModifiedBy": "string",
351 "createdDate": "2019-08-24T14:15:22Z",
352 "lastModifiedDate": "2019-08-24T14:15:22Z",
353 "archived": true,
354 "externalId": "string",
355 "id": 0,
356 "name": "string",
357 "code": "string"
358 }
359 }
360 },
361 "district": {
362 "createdBy": "string",
363 "lastModifiedBy": "string",
364 "createdDate": "2019-08-24T14:15:22Z",
365 "lastModifiedDate": "2019-08-24T14:15:22Z",
366 "archived": true,
367 "externalId": "string",
368 "id": 0,
369 "name": "string",
370 "city": {
371 "createdBy": "string",
372 "lastModifiedBy": "string",
373 "createdDate": "2019-08-24T14:15:22Z",
374 "lastModifiedDate": "2019-08-24T14:15:22Z",
375 "archived": true,
376 "externalId": "string",
377 "id": 0,
378 "name": "string",
379 "province": {
380 "createdBy": "string",
381 "lastModifiedBy": "string",
382 "createdDate": "2019-08-24T14:15:22Z",
383 "lastModifiedDate": "2019-08-24T14:15:22Z",
384 "archived": true,
385 "externalId": "string",
386 "id": 0,
387 "name": "string",
388 "code": "string",
389 "country": {
390 "createdBy": "string",
391 "lastModifiedBy": "string",
392 "createdDate": "2019-08-24T14:15:22Z",
393 "lastModifiedDate": "2019-08-24T14:15:22Z",
394 "archived": true,
395 "externalId": "string",
396 "id": 0,
397 "name": "string",
398 "code": "string"
399 }
400 }
401 }
402 },
403 "cityId": 0,
404 "districtId": 0
405 }
406}