Unit¶
Unit - Ship Unit¶
HTTP Request
POST /api/units/ship
📋 Description: Submits a shipping request for units within the Nakisa Portfolio Management Suite, facilitating the management of real estate assets and enhancing portfolio analytics.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the shipping details for real estate assets, including portfolio identifiers and analytical metrics essential for effective asset management. |
Body Parameters
1{
2 "objectType": "string",
3 "comment": "string",
4 "shippingDate": "2019-08-24",
5 "deliveryDate": "2019-08-24",
6 "receptionDate": "2019-08-24",
7 "processingTaskId": 0,
8 "processingJobType": "string",
9 "objectId": 0
10}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "id": 0,
3 "success": true,
4 "cancelled": true,
5 "failureMessage": "string",
6 "warningMessage": "string"
7}
Unit - Initialize Unit¶
HTTP Request
POST /api/units/send-to-initial
📋 Description: Sends specified units to the initial processing stage within the Nakisa Portfolio Management Suite, facilitating streamlined management and analytics of real estate properties and assets in the portfolio.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the initial data for portfolio units, including asset details and analytics parameters relevant to real estate property management. |
Body Parameters
1{
2 "objectType": "string",
3 "comment": "string",
4 "shippingDate": "2019-08-24",
5 "deliveryDate": "2019-08-24",
6 "receptionDate": "2019-08-24",
7 "processingTaskId": 0,
8 "processingJobType": "string",
9 "objectId": 0
10}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "id": 0,
3 "success": true,
4 "cancelled": true,
5 "failureMessage": "string",
6 "warningMessage": "string"
7}
Unit - Search Unit¶
HTTP Request
POST /api/units/search
📋 Description: Submits a search request to retrieve units within the Nakisa Portfolio Management Suite, enabling users to efficiently analyze and manage real estate assets and portfolios.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing search criteria and filters for portfolio, asset, and real estate property analytics within the Nakisa Portfolio Management Suite. |
Body Parameters
1{
2 "idIn": [
3 0
4 ],
5 "idEqual": 0,
6 "idLike": "string",
7 "createdAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
8 "createdAtLessThanOrEqual": "2019-08-24T14:15:22Z",
9 "createdByLike": "string",
10 "createdByEqual": "string",
11 "modifiedAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
12 "modifiedAtLessThanOrEqual": "2019-08-24T14:15:22Z",
13 "modifiedByLike": "string",
14 "modifiedByEqual": "string",
15 "displayIdIn": [
16 "string"
17 ],
18 "displayIdLike": "string",
19 "nameOrDisplayIdLike": "string",
20 "nameLike": "string",
21 "assetNumberLike": "string",
22 "referenceIdLike": "string",
23 "serialNumberLike": "string",
24 "licenseNumberLike": "string",
25 "inventoryNumberLike": "string",
26 "shippingDateGreaterThanOrEqual": "2019-08-24",
27 "shippingDateLessThanOrEqual": "2019-08-24",
28 "shippingDateEqual": "2019-08-24",
29 "deliveryDateGreaterThanOrEqual": "2019-08-24",
30 "deliveryDateLessThanOrEqual": "2019-08-24",
31 "deliveryDateEqual": "2019-08-24",
32 "receptionDateGreaterThanOrEqual": "2019-08-24",
33 "receptionDateLessThanOrEqual": "2019-08-24",
34 "receptionDateEqual": "2019-08-24",
35 "activationDateGreaterThanOrEqual": "2019-08-24",
36 "activationDateLessThanOrEqual": "2019-08-24",
37 "activationDateEqual": "2019-08-24",
38 "rouEndDateGreaterThanOrEqual": "2019-08-24",
39 "rouEndDateLessThanOrEqual": "2019-08-24",
40 "rouEndDateEqual": "2019-08-24",
41 "stateIn": [
42 "MLA_DEFINE"
43 ],
44 "taxCalculationTypeIn": [
45 "NET"
46 ],
47 "internalAssetClassIdEqual": 0,
48 "internalAssetClassDisplayIdEqual": "string",
49 "profitCenterIdEqual": 0,
50 "profitCenterDisplayIdEqual": "string",
51 "workBreakdownStructureIdEqual": 0,
52 "workBreakdownStructureDisplayIdEqual": "string",
53 "functionalAreaIdEqual": 0,
54 "functionalAreaDisplayIdEqual": "string",
55 "businessAreaIdEqual": 0,
56 "businessAreaDisplayIdEqual": "string",
57 "networkIdEqual": 0,
58 "networkDisplayIdEqual": "string",
59 "segmentIdEqual": 0,
60 "segmentDisplayIdEqual": "string",
61 "internalOrderIdEqual": 0,
62 "internalOrderDisplayIdEqual": "string",
63 "internalOrderTypeIdEqual": 0,
64 "internalOrderTypeDisplayIdEqual": "string",
65 "currencyCodeEqual": 0,
66 "currencyCodeDisplayIdEqual": "string",
67 "taxCodeForPrincipalPaymentIdEqual": 0,
68 "taxCodeForPrincipalPaymentDisplayIdEqual": "string",
69 "taxJurisdictionForPrincipalPaymentIdEqual": 0,
70 "taxJurisdictionForPrincipalPaymentDisplayIdEqual": "string",
71 "taxCodeForInterestPaymentIdEqual": 0,
72 "taxCodeForInterestPaymentDisplayIdEqual": "string",
73 "taxJurisdictionForInterestPaymentIdEqual": 0,
74 "taxJurisdictionForInterestPaymentDisplayIdEqual": "string",
75 "taxCodeForNonLeasePaymentIdEqual": 0,
76 "taxCodeForNonLeasePaymentDisplayIdEqual": "string",
77 "taxJurisdictionForNonLeasePaymentIdEqual": 0,
78 "taxJurisdictionForNonLeasePaymentDisplayIdEqual": "string",
79 "costCenterIdIn": [
80 0
81 ],
82 "costCenterDisplayIdIn": [
83 "string"
84 ],
85 "taxJurisdictionIdEqual": 0,
86 "taxJurisdictionDisplayIdEqual": "string",
87 "taxCodeIdEqual": 0,
88 "taxCodeDisplayIdEqual": "string",
89 "responsibleCostCenterIdEqual": 0,
90 "responsibleCostCenterDisplayIdEqual": "string",
91 "plantIdEqual": 0,
92 "plantDisplayDisplayIdEqual": "string",
93 "assetCostCenterIdEqual": 0,
94 "assetCostCenterDisplayIdEqual": "string",
95 "assetProfitCenterIdEqual": 0,
96 "assetProfitCenterDisplayIdEqual": "string",
97 "assetWorkBreakdownStructureIdEqual": 0,
98 "assetWorkBreakdownStructureDisplayIdEqual": "string",
99 "assetTaxJurisdictionIdEqual": 0,
100 "assetTaxJurisdictionDisplayIdEqual": "string",
101 "assetBusinessUnitIdEqual": 0,
102 "assetBusinessUnitDisplayIdEqual": "string",
103 "assetSegmentIdEqual": 0,
104 "assetSegmentDisplayIdEqual": "string",
105 "activationGroupIdIn": [
106 0
107 ],
108 "activationGroupDisplayIdIn": [
109 "string"
110 ],
111 "activationGroupDisplayIdLike": "string"
112}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "totalElements": 0,
3 "totalPages": 0,
4 "pageable": {
5 "pageNumber": 0,
6 "pageSize": 0,
7 "unpaged": true,
8 "paged": true,
9 "offset": 0,
10 "sort": {
11 "sorted": true,
12 "unsorted": true,
13 "empty": true
14 }
15 },
16 "numberOfElements": 0,
17 "size": 0,
18 "content": [
19 {
20 "id": 0,
21 "displayId": "string",
22 "name": "string",
23 "description": "string",
24 "assetNumber": "string",
25 "referenceId": "string",
26 "serialNumber": "string",
27 "licenseNumber": "string",
28 "inventoryNumber": "string",
29 "room": "string",
30 "location": "string",
31 "evaluationGroup1": "string",
32 "evaluationGroup2": "string",
33 "evaluationGroup3": "string",
34 "investmentReason": "string",
35 "typeName": "string",
36 "calculateGrossTax": true,
37 "bulkAsset": true,
38 "bulkAssetQuantity": 0,
39 "shippingDate": "2019-08-24",
40 "deliveryDate": "2019-08-24",
41 "receptionDate": "2019-08-24",
42 "activationDate": "2019-08-24",
43 "rouEndDate": "2019-08-24",
44 "erpAssetRetirementDate": "2019-08-24",
45 "state": "MLA_DEFINE",
46 "taxCalculationType": "NET",
47 "internalAssetClass": {
48 "id": 0,
49 "displayId": "string",
50 "status": "CREATED",
51 "name": "string",
52 "assetClassType": "PROPERTY",
53 "infiniteUsefulLife": true
54 },
55 "profitCenter": {
56 "id": 0,
57 "displayId": "string",
58 "status": "CREATED",
59 "name": "string",
60 "validTo": "2019-08-24",
61 "erpSystemId": 0,
62 "erpSystemDisplayId": "string"
63 },
64 "workBreakdownStructure": {
65 "id": 0,
66 "displayId": "string",
67 "status": "CREATED",
68 "name": "string",
69 "erpSystemId": 0
70 },
71 "functionalArea": {
72 "id": 0,
73 "displayId": "string",
74 "status": "CREATED",
75 "name": "string",
76 "erpSystemId": 0
77 },
78 "businessArea": {
79 "id": 0,
80 "displayId": "string",
81 "status": "CREATED",
82 "name": "string",
83 "erpSystemId": 0
84 },
85 "network": {
86 "id": 0,
87 "displayId": "string",
88 "status": "CREATED",
89 "name": "string",
90 "erpSystemId": 0
91 },
92 "segment": {
93 "id": 0,
94 "displayId": "string",
95 "status": "CREATED",
96 "name": "string",
97 "erpSystemId": 0
98 },
99 "internalOrder": {
100 "id": 0,
101 "status": "CREATED",
102 "displayId": "string",
103 "erpSystemId": 0,
104 "erpSystemDisplayId": "string",
105 "name": "string",
106 "internalOrderTypeId": 0,
107 "internalOrderTypeDisplayId": "string",
108 "controllingAreaId": 0,
109 "controllingAreaDisplayId": "string"
110 },
111 "internalOrderType": {
112 "id": 0,
113 "status": "CREATED",
114 "displayId": "string",
115 "erpSystemId": 0,
116 "erpSystemDisplayId": "string",
117 "name": "string",
118 "internalOrderId": 0
119 },
120 "currency": {
121 "id": 0,
122 "displayId": "string",
123 "status": "CREATED",
124 "name": "string",
125 "decimalPoints": 0
126 },
127 "taxCodeForPrincipalPayment": {
128 "id": 0,
129 "displayId": "string",
130 "status": "CREATED",
131 "name": "string",
132 "erpSystemId": 0
133 },
134 "taxJurisdictionForPrincipalPayment": {
135 "id": 0,
136 "displayId": "string",
137 "status": "CREATED",
138 "name": "string",
139 "erpSystemId": 0,
140 "schema": "string",
141 "countryDisplayId": "string"
142 },
143 "taxCodeForInterestPayment": {
144 "id": 0,
145 "displayId": "string",
146 "status": "CREATED",
147 "name": "string",
148 "erpSystemId": 0
149 },
150 "taxJurisdictionForInterestPayment": {
151 "id": 0,
152 "displayId": "string",
153 "status": "CREATED",
154 "name": "string",
155 "erpSystemId": 0,
156 "schema": "string",
157 "countryDisplayId": "string"
158 },
159 "taxCodeForNonLeasePayment": {
160 "id": 0,
161 "displayId": "string",
162 "status": "CREATED",
163 "name": "string",
164 "erpSystemId": 0
165 },
166 "taxJurisdictionForNonLeasePayment": {
167 "id": 0,
168 "displayId": "string",
169 "status": "CREATED",
170 "name": "string",
171 "erpSystemId": 0,
172 "schema": "string",
173 "countryDisplayId": "string"
174 },
175 "costCenter": {
176 "id": 0,
177 "displayId": "string",
178 "status": "CREATED",
179 "name": "string",
180 "erpSystemId": 0
181 },
182 "company": {
183 "id": 0,
184 "displayId": "string",
185 "status": "CREATED",
186 "erpSystemId": 0,
187 "erpSystemDisplayId": "string",
188 "countryId": 0,
189 "countryDisplayId": "string",
190 "name": "string",
191 "postingPeriodVariantId": 0,
192 "fiscalVariantId": 0
193 },
194 "taxJurisdiction": {
195 "id": 0,
196 "displayId": "string",
197 "status": "CREATED",
198 "name": "string",
199 "erpSystemId": 0,
200 "schema": "string",
201 "countryDisplayId": "string"
202 },
203 "taxCode": {
204 "id": 0,
205 "displayId": "string",
206 "status": "CREATED",
207 "name": "string",
208 "erpSystemId": 0
209 },
210 "responsibleCostCenter": {
211 "id": 0,
212 "displayId": "string",
213 "status": "CREATED",
214 "name": "string",
215 "erpSystemId": 0
216 },
217 "plant": {
218 "id": 0,
219 "displayId": "string",
220 "status": "CREATED",
221 "name": "string",
222 "companyId": 0
223 },
224 "assetCostCenter": {
225 "id": 0,
226 "displayId": "string",
227 "status": "CREATED",
228 "name": "string",
229 "erpSystemId": 0
230 },
231 "assetProfitCenter": {
232 "id": 0,
233 "displayId": "string",
234 "status": "CREATED",
235 "name": "string",
236 "validTo": "2019-08-24",
237 "erpSystemId": 0,
238 "erpSystemDisplayId": "string"
239 },
240 "assetWorkBreakdownStructure": {
241 "id": 0,
242 "displayId": "string",
243 "status": "CREATED",
244 "name": "string",
245 "erpSystemId": 0
246 },
247 "assetTaxJurisdiction": {
248 "id": 0,
249 "displayId": "string",
250 "status": "CREATED",
251 "name": "string",
252 "erpSystemId": 0,
253 "schema": "string",
254 "countryDisplayId": "string"
255 },
256 "assetBusinessArea": {
257 "id": 0,
258 "displayId": "string",
259 "status": "CREATED",
260 "name": "string",
261 "erpSystemId": 0
262 },
263 "assetSegment": {
264 "id": 0,
265 "displayId": "string",
266 "status": "CREATED",
267 "name": "string",
268 "erpSystemId": 0
269 },
270 "activationGroupId": 0,
271 "activationGroupDisplayId": "string",
272 "principalPositionType": "LESSEE",
273 "effectiveDate": "2019-08-24",
274 "costCenterAllocations": [
275 {
276 "id": 0,
277 "mainCostCenter": true,
278 "allocationPercentage": 0.1,
279 "costCenter": {
280 "id": 0,
281 "displayId": "string",
282 "status": "CREATED",
283 "name": "string",
284 "erpSystemId": 0
285 },
286 "profitCenter": {
287 "id": 0,
288 "displayId": "string",
289 "status": "CREATED",
290 "name": "string",
291 "validTo": "2019-08-24",
292 "erpSystemId": 0,
293 "erpSystemDisplayId": "string"
294 }
295 }
296 ],
297 "numberRangeIdentifierType": {
298 "name": "string"
299 },
300 "numberRangeIdentifierValue": "string",
301 "numberRangeType": {
302 "name": "string"
303 },
304 "allowsSystemGenerateNewId": true
305 }
306 ],
307 "number": 0,
308 "sort": {
309 "sorted": true,
310 "unsorted": true,
311 "empty": true
312 },
313 "first": true,
314 "last": true,
315 "empty": true
316}
Unit - Return Unit¶
HTTP Request
POST /api/units/return
📋 Description: Submits a request to return a specified unit within the Nakisa Portfolio Management Suite, facilitating the management of assets and enhancing portfolio analytics for real estate properties.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the return details for real estate property assets, including portfolio identifiers and analytics metrics. |
Body Parameters
1{
2 "objectType": "string",
3 "comment": "string",
4 "shippingDate": "2019-08-24",
5 "deliveryDate": "2019-08-24",
6 "receptionDate": "2019-08-24",
7 "processingTaskId": 0,
8 "processingJobType": "string",
9 "objectId": 0
10}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "id": 0,
3 "success": true,
4 "cancelled": true,
5 "failureMessage": "string",
6 "warningMessage": "string"
7}
Unit - Received Unit¶
HTTP Request
POST /api/units/received
📋 Description: Submits received unit data to the Nakisa Portfolio Management Suite, enabling accurate tracking and analytics of real estate assets within the portfolio.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the details of received units, including asset identifiers, portfolio associations, and relevant analytics for real estate property management. |
Body Parameters
1{
2 "objectType": "string",
3 "comment": "string",
4 "shippingDate": "2019-08-24",
5 "deliveryDate": "2019-08-24",
6 "receptionDate": "2019-08-24",
7 "processingTaskId": 0,
8 "processingJobType": "string",
9 "objectId": 0
10}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "id": 0,
3 "success": true,
4 "cancelled": true,
5 "failureMessage": "string",
6 "warningMessage": "string"
7}
Unit - Deliver Unit¶
HTTP Request
POST /api/units/deliver
📋 Description: Submits delivery requests for units within the Nakisa Portfolio Management Suite, facilitating the allocation of assets in the context of portfolio management and real estate analytics.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the delivery details for real estate assets, including portfolio identifiers, asset specifications, and analytical metrics. |
Body Parameters
1{
2 "objectType": "string",
3 "comment": "string",
4 "shippingDate": "2019-08-24",
5 "deliveryDate": "2019-08-24",
6 "receptionDate": "2019-08-24",
7 "processingTaskId": 0,
8 "processingJobType": "string",
9 "objectId": 0
10}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "id": 0,
3 "success": true,
4 "cancelled": true,
5 "failureMessage": "string",
6 "warningMessage": "string"
7}
Unit - Activate Unit¶
HTTP Request
POST /api/units/activate
📋 Description: Activates specified units within the Nakisa Portfolio Management Suite, enabling enhanced analytics and management of real estate assets within the portfolio. This operation supports streamlined asset performance tracking and portfolio optimization.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the activation details for real estate property units, including portfolio identifiers and asset analytics parameters. |
Body Parameters
1{
2 "objectType": "string",
3 "comment": "string",
4 "shippingDate": "2019-08-24",
5 "deliveryDate": "2019-08-24",
6 "receptionDate": "2019-08-24",
7 "processingTaskId": 0,
8 "processingJobType": "string",
9 "objectId": 0
10}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "id": 0,
3 "success": true,
4 "cancelled": true,
5 "failureMessage": "string",
6 "warningMessage": "string"
7}