Unit¶
Retrieve A Specific Unit¶
HTTP Request
GET /api/v1/units/{id}
📋 Description: Fetches detailed information about a specific unit identified by its unique ID, facilitating the management of leases, contracts, and associated financial obligations within the Nakisa Lease Accounting Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer |
true |
Unique identifier for the resource |
Example Values¶
Parameter |
Example |
Type |
|---|---|---|
id |
|
path |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
Successfully retrieved unit. |
Example Responses
1{
2 "code": "OK",
3 "errors": {
4 "all": []
5 },
6 "object": {
7 "id": 10000001,
8 "displayId": "UNIT-000123",
9 "name": "Office Printer",
10 "description": "High-speed color printer for main office.",
11 "assetNumber": "A-1001",
12 "referenceId": "REF-2024-001",
13 "serialNumber": "SN12345678",
14 "licenseNumber": "LIC-98765",
15 "inventoryNumber": "INV-55555",
16 "room": "Room 101",
17 "location": "Head Office",
18 "evaluationGroup1": "Group A",
19 "evaluationGroup2": "Group B",
20 "evaluationGroup3": "Group C",
21 "investmentReason": "Replacement of outdated equipment",
22 "typeName": "Printer",
23 "calculateGrossTax": true,
24 "bulkAsset": true,
25 "bulkAssetQuantity": 0,
26 "shippingDate": "2024-01-15",
27 "deliveryDate": "2024-01-20",
28 "receptionDate": "2024-01-21",
29 "activationDate": "2024-01-22",
30 "rouEndDate": "2026-01-22",
31 "erpAssetRetirementDate": "2028-01-01",
32 "state": "UNIT_ACTIVE",
33 "taxCalculationType": "NET",
34 "internalAssetClass": {
35 "id": 10000001,
36 "displayId": "IAC-001",
37 "status": {
38 "name": "ACTIVE",
39 "captionKey": "enum.objectStatus.active",
40 "active": true,
41 "caption": "Active"
42 },
43 "name": "Machinery and Equipment",
44 "assetClassType": "PROPERTY",
45 "infiniteUsefulLife": false
46 },
47 "profitCenter": {
48 "id": 9001,
49 "displayId": "PC-001",
50 "status": {
51 "name": "ACTIVE",
52 "captionKey": "enum.objectStatus.active",
53 "active": true,
54 "caption": "Active"
55 },
56 "name": "North Region Profit Center",
57 "validTo": "2025-12-31",
58 "erpSystemId": 101,
59 "erpSystemDisplayId": "SAP-01"
60 },
61 "workBreakdownStructure": {
62 "id": 1001,
63 "displayId": "WBS-2025-001",
64 "status": {
65 "name": "ACTIVE",
66 "captionKey": "enum.objectStatus.active",
67 "active": true,
68 "caption": "Active"
69 },
70 "name": "Main Project WBS",
71 "erpSystemId": 0
72 },
73 "functionalArea": {
74 "id": 2001,
75 "displayId": "FA-2025-001",
76 "status": {
77 "name": "ACTIVE",
78 "captionKey": "enum.objectStatus.active",
79 "active": true,
80 "caption": "Active"
81 },
82 "name": "Accounting Department",
83 "erpSystemId": 0
84 },
85 "businessArea": {
86 "id": 3001,
87 "displayId": "BA-2025-001",
88 "status": {
89 "name": "ACTIVE",
90 "captionKey": "enum.objectStatus.active",
91 "active": true,
92 "caption": "Active"
93 },
94 "name": "North America Operations",
95 "erpSystemId": 0
96 },
97 "network": {
98 "id": 10001,
99 "displayId": "NET-001",
100 "status": {
101 "name": "ACTIVE",
102 "captionKey": "enum.objectStatus.active",
103 "active": true,
104 "caption": "Active"
105 },
106 "name": "Global Network",
107 "erpSystemId": 0
108 },
109 "segment": {
110 "id": 11001,
111 "displayId": "SEG-001",
112 "status": {
113 "name": "ACTIVE",
114 "captionKey": "enum.objectStatus.active",
115 "active": true,
116 "caption": "Active"
117 },
118 "name": "Segment Alpha",
119 "erpSystemId": 0
120 },
121 "internalOrder": {
122 "id": 10000001,
123 "status": {
124 "name": "ACTIVE",
125 "captionKey": "enum.objectStatus.active",
126 "active": true,
127 "caption": "Active"
128 },
129 "displayId": "IO-2024-001",
130 "erpSystemId": 1001,
131 "erpSystemDisplayId": "SAP-001",
132 "name": "Office Renovation Order",
133 "internalOrderTypeId": 3001,
134 "internalOrderTypeDisplayId": "CAPEX",
135 "controllingAreaId": 4001,
136 "controllingAreaDisplayId": "CA-1001"
137 },
138 "internalOrderType": {
139 "id": 10000001,
140 "status": {
141 "name": "ACTIVE",
142 "captionKey": "enum.objectStatus.active",
143 "active": true,
144 "caption": "Active"
145 },
146 "displayId": "CAPEX",
147 "erpSystemId": 1001,
148 "erpSystemDisplayId": "SAP-001",
149 "name": "Capital Expenditure Orders",
150 "internalOrderId": 20004567
151 },
152 "currency": {
153 "id": 840,
154 "displayId": "USD",
155 "status": {
156 "name": "ACTIVE",
157 "captionKey": "enum.objectStatus.active",
158 "active": true,
159 "caption": "Active"
160 },
161 "name": "United States Dollar",
162 "decimalPoints": 2
163 },
164 "taxCodeForPrincipalPayment": {
165 "id": 5001,
166 "displayId": "TC-001",
167 "status": {
168 "name": "ACTIVE",
169 "captionKey": "enum.objectStatus.active",
170 "active": true,
171 "caption": "Active"
172 },
173 "name": "VAT Standard Rate",
174 "erpSystemId": 0
175 },
176 "taxJurisdictionForPrincipalPayment": {
177 "id": 4001,
178 "displayId": "TJ-2025-001",
179 "status": {
180 "name": "ACTIVE",
181 "captionKey": "enum.objectStatus.active",
182 "active": true,
183 "caption": "Active"
184 },
185 "name": "California Tax Authority",
186 "erpSystemId": 0,
187 "schema": "string",
188 "countryDisplayId": "string"
189 },
190 "taxCodeForInterestPayment": {
191 "id": 5001,
192 "displayId": "TC-001",
193 "status": {
194 "name": "ACTIVE",
195 "captionKey": "enum.objectStatus.active",
196 "active": true,
197 "caption": "Active"
198 },
199 "name": "VAT Standard Rate",
200 "erpSystemId": 0
201 },
202 "taxJurisdictionForInterestPayment": {
203 "id": 4001,
204 "displayId": "TJ-2025-001",
205 "status": {
206 "name": "ACTIVE",
207 "captionKey": "enum.objectStatus.active",
208 "active": true,
209 "caption": "Active"
210 },
211 "name": "California Tax Authority",
212 "erpSystemId": 0,
213 "schema": "string",
214 "countryDisplayId": "string"
215 },
216 "taxCodeForNonLeasePayment": {
217 "id": 5001,
218 "displayId": "TC-001",
219 "status": {
220 "name": "ACTIVE",
221 "captionKey": "enum.objectStatus.active",
222 "active": true,
223 "caption": "Active"
224 },
225 "name": "VAT Standard Rate",
226 "erpSystemId": 0
227 },
228 "taxJurisdictionForNonLeasePayment": {
229 "id": 4001,
230 "displayId": "TJ-2025-001",
231 "status": {
232 "name": "ACTIVE",
233 "captionKey": "enum.objectStatus.active",
234 "active": true,
235 "caption": "Active"
236 },
237 "name": "California Tax Authority",
238 "erpSystemId": 0,
239 "schema": "string",
240 "countryDisplayId": "string"
241 },
242 "costCenter": {
243 "id": 14001,
244 "displayId": "CC-001",
245 "status": {
246 "name": "ACTIVE",
247 "captionKey": "enum.objectStatus.active",
248 "active": true,
249 "caption": "Active"
250 },
251 "name": "Cost Center A",
252 "erpSystemId": 0
253 },
254 "company": {
255 "id": 10000006,
256 "displayId": "1005",
257 "status": {
258 "name": "ACTIVE",
259 "captionKey": "enum.objectStatus.active",
260 "active": true,
261 "caption": "Active"
262 },
263 "erpSystemId": 10000001,
264 "erpSystemDisplayId": "FINQ8S-300",
265 "countryId": 10000095,
266 "countryDisplayId": "CA",
267 "name": "string",
268 "postingPeriodVariantId": 0,
269 "fiscalVariantId": 0
270 },
271 "taxJurisdiction": {
272 "id": 4001,
273 "displayId": "TJ-2025-001",
274 "status": {
275 "name": "ACTIVE",
276 "captionKey": "enum.objectStatus.active",
277 "active": true,
278 "caption": "Active"
279 },
280 "name": "California Tax Authority",
281 "erpSystemId": 0,
282 "schema": "string",
283 "countryDisplayId": "string"
284 },
285 "taxCode": {
286 "id": 5001,
287 "displayId": "TC-001",
288 "status": {
289 "name": "ACTIVE",
290 "captionKey": "enum.objectStatus.active",
291 "active": true,
292 "caption": "Active"
293 },
294 "name": "VAT Standard Rate",
295 "erpSystemId": 0
296 },
297 "responsibleCostCenter": {
298 "id": 14001,
299 "displayId": "CC-001",
300 "status": {
301 "name": "ACTIVE",
302 "captionKey": "enum.objectStatus.active",
303 "active": true,
304 "caption": "Active"
305 },
306 "name": "Cost Center A",
307 "erpSystemId": 0
308 },
309 "plant": {
310 "id": 10000001,
311 "displayId": "PLANT-001",
312 "status": {
313 "name": "ACTIVE",
314 "captionKey": "enum.objectStatus.active",
315 "active": true,
316 "caption": "Active"
317 },
318 "name": "Berlin Manufacturing Plant",
319 "companyId": 7001
320 },
321 "assetCostCenter": {
322 "id": 14001,
323 "displayId": "CC-001",
324 "status": {
325 "name": "ACTIVE",
326 "captionKey": "enum.objectStatus.active",
327 "active": true,
328 "caption": "Active"
329 },
330 "name": "Cost Center A",
331 "erpSystemId": 0
332 },
333 "assetProfitCenter": {
334 "id": 9001,
335 "displayId": "PC-001",
336 "status": {
337 "name": "ACTIVE",
338 "captionKey": "enum.objectStatus.active",
339 "active": true,
340 "caption": "Active"
341 },
342 "name": "North Region Profit Center",
343 "validTo": "2025-12-31",
344 "erpSystemId": 101,
345 "erpSystemDisplayId": "SAP-01"
346 },
347 "assetWorkBreakdownStructure": {
348 "id": 1001,
349 "displayId": "WBS-2025-001",
350 "status": {
351 "name": "ACTIVE",
352 "captionKey": "enum.objectStatus.active",
353 "active": true,
354 "caption": "Active"
355 },
356 "name": "Main Project WBS",
357 "erpSystemId": 0
358 },
359 "assetTaxJurisdiction": {
360 "id": 4001,
361 "displayId": "TJ-2025-001",
362 "status": {
363 "name": "ACTIVE",
364 "captionKey": "enum.objectStatus.active",
365 "active": true,
366 "caption": "Active"
367 },
368 "name": "California Tax Authority",
369 "erpSystemId": 0,
370 "schema": "string",
371 "countryDisplayId": "string"
372 },
373 "assetBusinessArea": {
374 "id": 3001,
375 "displayId": "BA-2025-001",
376 "status": {
377 "name": "ACTIVE",
378 "captionKey": "enum.objectStatus.active",
379 "active": true,
380 "caption": "Active"
381 },
382 "name": "North America Operations",
383 "erpSystemId": 0
384 },
385 "assetSegment": {
386 "id": 11001,
387 "displayId": "SEG-001",
388 "status": {
389 "name": "ACTIVE",
390 "captionKey": "enum.objectStatus.active",
391 "active": true,
392 "caption": "Active"
393 },
394 "name": "Segment Alpha",
395 "erpSystemId": 0
396 },
397 "activationGroupId": 101,
398 "activationGroupDisplayId": "AG-001",
399 "principalPositionType": {
400 "name": "LESSEE",
401 "captionKey": "enum.principalpositiontype.lessee",
402 "caption": "Lessee"
403 },
404 "effectiveDate": "2024-01-01",
405 "costCenterAllocations": [
406 {
407 "id": 10001,
408 "mainCostCenter": true,
409 "allocationPercentage": 75,
410 "costCenter": {
411 "id": 14001,
412 "displayId": "CC-001",
413 "status": {
414 "name": "ACTIVE",
415 "captionKey": "enum.objectStatus.active",
416 "active": true,
417 "caption": "Active"
418 },
419 "name": "Cost Center A",
420 "erpSystemId": 0
421 },
422 "profitCenter": {
423 "id": 9001,
424 "displayId": "PC-001",
425 "status": {
426 "name": "ACTIVE",
427 "captionKey": "enum.objectStatus.active",
428 "active": true,
429 "caption": "Active"
430 },
431 "name": "North Region Profit Center",
432 "validTo": "2025-12-31",
433 "erpSystemId": 101,
434 "erpSystemDisplayId": "SAP-01"
435 }
436 }
437 ],
438 "numberRangeIdentifierValue": "NR-0001",
439 "numberRangeIdentifierType": {
440 "name": "COMPANY_CODE"
441 },
442 "numberRangeType": {
443 "name": "CONTRACT"
444 },
445 "allowsSystemGenerateNewId": true
446 }
447}
Update A Specific Unit¶
HTTP Request
PUT /api/v1/units/{id}
📋 Description: Updates the details of a specified unit within the Nakisa Lease Accounting Suite, allowing users to modify lease, contract, or financial obligation information associated with that unit to ensure accurate accounting entries.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer |
true |
Unique identifier for the resource |
body |
body |
false |
Request body containing updated unit information, including lease details, contract terms, and financial obligations relevant to accounting entries. |
Example Values¶
Parameter |
Example |
Type |
|---|---|---|
id |
|
path |
Body Parameters
1{
2 "id": 10000001,
3 "displayId": "UNIT-000123",
4 "name": "Office Printer",
5 "description": "High-speed color printer for main office.",
6 "assetNumber": "A-1001",
7 "referenceId": "REF-2024-001",
8 "serialNumber": "SN12345678",
9 "licenseNumber": "LIC-98765",
10 "inventoryNumber": "INV-55555",
11 "room": "Room 101",
12 "location": "Head Office",
13 "evaluationGroup1": "Group A",
14 "evaluationGroup2": "Group B",
15 "evaluationGroup3": "Group C",
16 "investmentReason": "Replacement of outdated equipment",
17 "typeName": "Printer",
18 "calculateGrossTax": true,
19 "bulkAsset": true,
20 "bulkAssetQuantity": 0,
21 "shippingDate": "2024-01-15",
22 "deliveryDate": "2024-01-20",
23 "receptionDate": "2024-01-21",
24 "activationDate": "2024-01-22",
25 "rouEndDate": "2026-01-22",
26 "erpAssetRetirementDate": "2028-01-01",
27 "state": "UNIT_ACTIVE",
28 "taxCalculationType": "NET",
29 "internalAssetClass": {
30 "id": 10000001,
31 "displayId": "IAC-001",
32 "status": {
33 "name": "ACTIVE",
34 "captionKey": "enum.objectStatus.active",
35 "active": true,
36 "caption": "Active"
37 },
38 "name": "Machinery and Equipment",
39 "assetClassType": "PROPERTY",
40 "infiniteUsefulLife": false
41 },
42 "profitCenter": {
43 "id": 9001,
44 "displayId": "PC-001",
45 "status": {
46 "name": "ACTIVE",
47 "captionKey": "enum.objectStatus.active",
48 "active": true,
49 "caption": "Active"
50 },
51 "name": "North Region Profit Center",
52 "validTo": "2025-12-31",
53 "erpSystemId": 101,
54 "erpSystemDisplayId": "SAP-01"
55 },
56 "workBreakdownStructure": {
57 "id": 1001,
58 "displayId": "WBS-2025-001",
59 "status": {
60 "name": "ACTIVE",
61 "captionKey": "enum.objectStatus.active",
62 "active": true,
63 "caption": "Active"
64 },
65 "name": "Main Project WBS",
66 "erpSystemId": 0
67 },
68 "functionalArea": {
69 "id": 2001,
70 "displayId": "FA-2025-001",
71 "status": {
72 "name": "ACTIVE",
73 "captionKey": "enum.objectStatus.active",
74 "active": true,
75 "caption": "Active"
76 },
77 "name": "Accounting Department",
78 "erpSystemId": 0
79 },
80 "businessArea": {
81 "id": 3001,
82 "displayId": "BA-2025-001",
83 "status": {
84 "name": "ACTIVE",
85 "captionKey": "enum.objectStatus.active",
86 "active": true,
87 "caption": "Active"
88 },
89 "name": "North America Operations",
90 "erpSystemId": 0
91 },
92 "network": {
93 "id": 10001,
94 "displayId": "NET-001",
95 "status": {
96 "name": "ACTIVE",
97 "captionKey": "enum.objectStatus.active",
98 "active": true,
99 "caption": "Active"
100 },
101 "name": "Global Network",
102 "erpSystemId": 0
103 },
104 "segment": {
105 "id": 11001,
106 "displayId": "SEG-001",
107 "status": {
108 "name": "ACTIVE",
109 "captionKey": "enum.objectStatus.active",
110 "active": true,
111 "caption": "Active"
112 },
113 "name": "Segment Alpha",
114 "erpSystemId": 0
115 },
116 "internalOrder": {
117 "id": 10000001,
118 "status": {
119 "name": "ACTIVE",
120 "captionKey": "enum.objectStatus.active",
121 "active": true,
122 "caption": "Active"
123 },
124 "displayId": "IO-2024-001",
125 "erpSystemId": 1001,
126 "erpSystemDisplayId": "SAP-001",
127 "name": "Office Renovation Order",
128 "internalOrderTypeId": 3001,
129 "internalOrderTypeDisplayId": "CAPEX",
130 "controllingAreaId": 4001,
131 "controllingAreaDisplayId": "CA-1001"
132 },
133 "internalOrderType": {
134 "id": 10000001,
135 "status": {
136 "name": "ACTIVE",
137 "captionKey": "enum.objectStatus.active",
138 "active": true,
139 "caption": "Active"
140 },
141 "displayId": "CAPEX",
142 "erpSystemId": 1001,
143 "erpSystemDisplayId": "SAP-001",
144 "name": "Capital Expenditure Orders",
145 "internalOrderId": 20004567
146 },
147 "currency": {
148 "id": 840,
149 "displayId": "USD",
150 "status": {
151 "name": "ACTIVE",
152 "captionKey": "enum.objectStatus.active",
153 "active": true,
154 "caption": "Active"
155 },
156 "name": "United States Dollar",
157 "decimalPoints": 2
158 },
159 "taxCodeForPrincipalPayment": {
160 "id": 5001,
161 "displayId": "TC-001",
162 "status": {
163 "name": "ACTIVE",
164 "captionKey": "enum.objectStatus.active",
165 "active": true,
166 "caption": "Active"
167 },
168 "name": "VAT Standard Rate",
169 "erpSystemId": 0
170 },
171 "taxJurisdictionForPrincipalPayment": {
172 "id": 4001,
173 "displayId": "TJ-2025-001",
174 "status": {
175 "name": "ACTIVE",
176 "captionKey": "enum.objectStatus.active",
177 "active": true,
178 "caption": "Active"
179 },
180 "name": "California Tax Authority",
181 "erpSystemId": 0,
182 "schema": "string",
183 "countryDisplayId": "string"
184 },
185 "taxCodeForInterestPayment": {
186 "id": 5001,
187 "displayId": "TC-001",
188 "status": {
189 "name": "ACTIVE",
190 "captionKey": "enum.objectStatus.active",
191 "active": true,
192 "caption": "Active"
193 },
194 "name": "VAT Standard Rate",
195 "erpSystemId": 0
196 },
197 "taxJurisdictionForInterestPayment": {
198 "id": 4001,
199 "displayId": "TJ-2025-001",
200 "status": {
201 "name": "ACTIVE",
202 "captionKey": "enum.objectStatus.active",
203 "active": true,
204 "caption": "Active"
205 },
206 "name": "California Tax Authority",
207 "erpSystemId": 0,
208 "schema": "string",
209 "countryDisplayId": "string"
210 },
211 "taxCodeForNonLeasePayment": {
212 "id": 5001,
213 "displayId": "TC-001",
214 "status": {
215 "name": "ACTIVE",
216 "captionKey": "enum.objectStatus.active",
217 "active": true,
218 "caption": "Active"
219 },
220 "name": "VAT Standard Rate",
221 "erpSystemId": 0
222 },
223 "taxJurisdictionForNonLeasePayment": {
224 "id": 4001,
225 "displayId": "TJ-2025-001",
226 "status": {
227 "name": "ACTIVE",
228 "captionKey": "enum.objectStatus.active",
229 "active": true,
230 "caption": "Active"
231 },
232 "name": "California Tax Authority",
233 "erpSystemId": 0,
234 "schema": "string",
235 "countryDisplayId": "string"
236 },
237 "costCenter": {
238 "id": 14001,
239 "displayId": "CC-001",
240 "status": {
241 "name": "ACTIVE",
242 "captionKey": "enum.objectStatus.active",
243 "active": true,
244 "caption": "Active"
245 },
246 "name": "Cost Center A",
247 "erpSystemId": 0
248 },
249 "company": {
250 "id": 10000006,
251 "displayId": "1005",
252 "status": {
253 "name": "ACTIVE",
254 "captionKey": "enum.objectStatus.active",
255 "active": true,
256 "caption": "Active"
257 },
258 "erpSystemId": 10000001,
259 "erpSystemDisplayId": "FINQ8S-300",
260 "countryId": 10000095,
261 "countryDisplayId": "CA",
262 "name": "string",
263 "postingPeriodVariantId": 0,
264 "fiscalVariantId": 0
265 },
266 "taxJurisdiction": {
267 "id": 4001,
268 "displayId": "TJ-2025-001",
269 "status": {
270 "name": "ACTIVE",
271 "captionKey": "enum.objectStatus.active",
272 "active": true,
273 "caption": "Active"
274 },
275 "name": "California Tax Authority",
276 "erpSystemId": 0,
277 "schema": "string",
278 "countryDisplayId": "string"
279 },
280 "taxCode": {
281 "id": 5001,
282 "displayId": "TC-001",
283 "status": {
284 "name": "ACTIVE",
285 "captionKey": "enum.objectStatus.active",
286 "active": true,
287 "caption": "Active"
288 },
289 "name": "VAT Standard Rate",
290 "erpSystemId": 0
291 },
292 "responsibleCostCenter": {
293 "id": 14001,
294 "displayId": "CC-001",
295 "status": {
296 "name": "ACTIVE",
297 "captionKey": "enum.objectStatus.active",
298 "active": true,
299 "caption": "Active"
300 },
301 "name": "Cost Center A",
302 "erpSystemId": 0
303 },
304 "plant": {
305 "id": 10000001,
306 "displayId": "PLANT-001",
307 "status": {
308 "name": "ACTIVE",
309 "captionKey": "enum.objectStatus.active",
310 "active": true,
311 "caption": "Active"
312 },
313 "name": "Berlin Manufacturing Plant",
314 "companyId": 7001
315 },
316 "assetCostCenter": {
317 "id": 14001,
318 "displayId": "CC-001",
319 "status": {
320 "name": "ACTIVE",
321 "captionKey": "enum.objectStatus.active",
322 "active": true,
323 "caption": "Active"
324 },
325 "name": "Cost Center A",
326 "erpSystemId": 0
327 },
328 "assetProfitCenter": {
329 "id": 9001,
330 "displayId": "PC-001",
331 "status": {
332 "name": "ACTIVE",
333 "captionKey": "enum.objectStatus.active",
334 "active": true,
335 "caption": "Active"
336 },
337 "name": "North Region Profit Center",
338 "validTo": "2025-12-31",
339 "erpSystemId": 101,
340 "erpSystemDisplayId": "SAP-01"
341 },
342 "assetWorkBreakdownStructure": {
343 "id": 1001,
344 "displayId": "WBS-2025-001",
345 "status": {
346 "name": "ACTIVE",
347 "captionKey": "enum.objectStatus.active",
348 "active": true,
349 "caption": "Active"
350 },
351 "name": "Main Project WBS",
352 "erpSystemId": 0
353 },
354 "assetTaxJurisdiction": {
355 "id": 4001,
356 "displayId": "TJ-2025-001",
357 "status": {
358 "name": "ACTIVE",
359 "captionKey": "enum.objectStatus.active",
360 "active": true,
361 "caption": "Active"
362 },
363 "name": "California Tax Authority",
364 "erpSystemId": 0,
365 "schema": "string",
366 "countryDisplayId": "string"
367 },
368 "assetBusinessArea": {
369 "id": 3001,
370 "displayId": "BA-2025-001",
371 "status": {
372 "name": "ACTIVE",
373 "captionKey": "enum.objectStatus.active",
374 "active": true,
375 "caption": "Active"
376 },
377 "name": "North America Operations",
378 "erpSystemId": 0
379 },
380 "assetSegment": {
381 "id": 11001,
382 "displayId": "SEG-001",
383 "status": {
384 "name": "ACTIVE",
385 "captionKey": "enum.objectStatus.active",
386 "active": true,
387 "caption": "Active"
388 },
389 "name": "Segment Alpha",
390 "erpSystemId": 0
391 },
392 "activationGroupId": 101,
393 "activationGroupDisplayId": "AG-001",
394 "principalPositionType": {
395 "name": "LESSEE",
396 "captionKey": "enum.principalpositiontype.lessee",
397 "caption": "Lessee"
398 },
399 "effectiveDate": "2024-01-01",
400 "costCenterAllocations": [
401 {
402 "id": 10001,
403 "mainCostCenter": true,
404 "allocationPercentage": 75,
405 "costCenter": {
406 "id": 14001,
407 "displayId": "CC-001",
408 "status": {
409 "name": "ACTIVE",
410 "captionKey": "enum.objectStatus.active",
411 "active": true,
412 "caption": "Active"
413 },
414 "name": "Cost Center A",
415 "erpSystemId": 0
416 },
417 "profitCenter": {
418 "id": 9001,
419 "displayId": "PC-001",
420 "status": {
421 "name": "ACTIVE",
422 "captionKey": "enum.objectStatus.active",
423 "active": true,
424 "caption": "Active"
425 },
426 "name": "North Region Profit Center",
427 "validTo": "2025-12-31",
428 "erpSystemId": 101,
429 "erpSystemDisplayId": "SAP-01"
430 }
431 }
432 ],
433 "numberRangeIdentifierValue": "NR-0001",
434 "numberRangeIdentifierType": {
435 "name": "COMPANY_CODE"
436 },
437 "numberRangeType": {
438 "name": "CONTRACT"
439 },
440 "allowsSystemGenerateNewId": true
441}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
Unit successfully updated. |
Example Responses
1{
2 "id": 10000001,
3 "displayId": "UNIT-000123",
4 "name": "Office Printer",
5 "description": "High-speed color printer for main office.",
6 "assetNumber": "A-1001",
7 "referenceId": "REF-2024-001",
8 "serialNumber": "SN12345678",
9 "licenseNumber": "LIC-98765",
10 "inventoryNumber": "INV-55555",
11 "room": "Room 101",
12 "location": "Head Office",
13 "evaluationGroup1": "Group A",
14 "evaluationGroup2": "Group B",
15 "evaluationGroup3": "Group C",
16 "investmentReason": "Replacement of outdated equipment",
17 "typeName": "Printer",
18 "calculateGrossTax": true,
19 "bulkAsset": true,
20 "bulkAssetQuantity": 0,
21 "shippingDate": "2024-01-15",
22 "deliveryDate": "2024-01-20",
23 "receptionDate": "2024-01-21",
24 "activationDate": "2024-01-22",
25 "rouEndDate": "2026-01-22",
26 "erpAssetRetirementDate": "2028-01-01",
27 "state": "UNIT_ACTIVE",
28 "taxCalculationType": "NET",
29 "internalAssetClass": {
30 "id": 10000001,
31 "displayId": "IAC-001",
32 "status": {
33 "name": "ACTIVE",
34 "captionKey": "enum.objectStatus.active",
35 "active": true,
36 "caption": "Active"
37 },
38 "name": "Machinery and Equipment",
39 "assetClassType": "PROPERTY",
40 "infiniteUsefulLife": false
41 },
42 "profitCenter": {
43 "id": 9001,
44 "displayId": "PC-001",
45 "status": {
46 "name": "ACTIVE",
47 "captionKey": "enum.objectStatus.active",
48 "active": true,
49 "caption": "Active"
50 },
51 "name": "North Region Profit Center",
52 "validTo": "2025-12-31",
53 "erpSystemId": 101,
54 "erpSystemDisplayId": "SAP-01"
55 },
56 "workBreakdownStructure": {
57 "id": 1001,
58 "displayId": "WBS-2025-001",
59 "status": {
60 "name": "ACTIVE",
61 "captionKey": "enum.objectStatus.active",
62 "active": true,
63 "caption": "Active"
64 },
65 "name": "Main Project WBS",
66 "erpSystemId": 0
67 },
68 "functionalArea": {
69 "id": 2001,
70 "displayId": "FA-2025-001",
71 "status": {
72 "name": "ACTIVE",
73 "captionKey": "enum.objectStatus.active",
74 "active": true,
75 "caption": "Active"
76 },
77 "name": "Accounting Department",
78 "erpSystemId": 0
79 },
80 "businessArea": {
81 "id": 3001,
82 "displayId": "BA-2025-001",
83 "status": {
84 "name": "ACTIVE",
85 "captionKey": "enum.objectStatus.active",
86 "active": true,
87 "caption": "Active"
88 },
89 "name": "North America Operations",
90 "erpSystemId": 0
91 },
92 "network": {
93 "id": 10001,
94 "displayId": "NET-001",
95 "status": {
96 "name": "ACTIVE",
97 "captionKey": "enum.objectStatus.active",
98 "active": true,
99 "caption": "Active"
100 },
101 "name": "Global Network",
102 "erpSystemId": 0
103 },
104 "segment": {
105 "id": 11001,
106 "displayId": "SEG-001",
107 "status": {
108 "name": "ACTIVE",
109 "captionKey": "enum.objectStatus.active",
110 "active": true,
111 "caption": "Active"
112 },
113 "name": "Segment Alpha",
114 "erpSystemId": 0
115 },
116 "internalOrder": {
117 "id": 10000001,
118 "status": {
119 "name": "ACTIVE",
120 "captionKey": "enum.objectStatus.active",
121 "active": true,
122 "caption": "Active"
123 },
124 "displayId": "IO-2024-001",
125 "erpSystemId": 1001,
126 "erpSystemDisplayId": "SAP-001",
127 "name": "Office Renovation Order",
128 "internalOrderTypeId": 3001,
129 "internalOrderTypeDisplayId": "CAPEX",
130 "controllingAreaId": 4001,
131 "controllingAreaDisplayId": "CA-1001"
132 },
133 "internalOrderType": {
134 "id": 10000001,
135 "status": {
136 "name": "ACTIVE",
137 "captionKey": "enum.objectStatus.active",
138 "active": true,
139 "caption": "Active"
140 },
141 "displayId": "CAPEX",
142 "erpSystemId": 1001,
143 "erpSystemDisplayId": "SAP-001",
144 "name": "Capital Expenditure Orders",
145 "internalOrderId": 20004567
146 },
147 "currency": {
148 "id": 840,
149 "displayId": "USD",
150 "status": {
151 "name": "ACTIVE",
152 "captionKey": "enum.objectStatus.active",
153 "active": true,
154 "caption": "Active"
155 },
156 "name": "United States Dollar",
157 "decimalPoints": 2
158 },
159 "taxCodeForPrincipalPayment": {
160 "id": 5001,
161 "displayId": "TC-001",
162 "status": {
163 "name": "ACTIVE",
164 "captionKey": "enum.objectStatus.active",
165 "active": true,
166 "caption": "Active"
167 },
168 "name": "VAT Standard Rate",
169 "erpSystemId": 0
170 },
171 "taxJurisdictionForPrincipalPayment": {
172 "id": 4001,
173 "displayId": "TJ-2025-001",
174 "status": {
175 "name": "ACTIVE",
176 "captionKey": "enum.objectStatus.active",
177 "active": true,
178 "caption": "Active"
179 },
180 "name": "California Tax Authority",
181 "erpSystemId": 0,
182 "schema": "string",
183 "countryDisplayId": "string"
184 },
185 "taxCodeForInterestPayment": {
186 "id": 5001,
187 "displayId": "TC-001",
188 "status": {
189 "name": "ACTIVE",
190 "captionKey": "enum.objectStatus.active",
191 "active": true,
192 "caption": "Active"
193 },
194 "name": "VAT Standard Rate",
195 "erpSystemId": 0
196 },
197 "taxJurisdictionForInterestPayment": {
198 "id": 4001,
199 "displayId": "TJ-2025-001",
200 "status": {
201 "name": "ACTIVE",
202 "captionKey": "enum.objectStatus.active",
203 "active": true,
204 "caption": "Active"
205 },
206 "name": "California Tax Authority",
207 "erpSystemId": 0,
208 "schema": "string",
209 "countryDisplayId": "string"
210 },
211 "taxCodeForNonLeasePayment": {
212 "id": 5001,
213 "displayId": "TC-001",
214 "status": {
215 "name": "ACTIVE",
216 "captionKey": "enum.objectStatus.active",
217 "active": true,
218 "caption": "Active"
219 },
220 "name": "VAT Standard Rate",
221 "erpSystemId": 0
222 },
223 "taxJurisdictionForNonLeasePayment": {
224 "id": 4001,
225 "displayId": "TJ-2025-001",
226 "status": {
227 "name": "ACTIVE",
228 "captionKey": "enum.objectStatus.active",
229 "active": true,
230 "caption": "Active"
231 },
232 "name": "California Tax Authority",
233 "erpSystemId": 0,
234 "schema": "string",
235 "countryDisplayId": "string"
236 },
237 "costCenter": {
238 "id": 14001,
239 "displayId": "CC-001",
240 "status": {
241 "name": "ACTIVE",
242 "captionKey": "enum.objectStatus.active",
243 "active": true,
244 "caption": "Active"
245 },
246 "name": "Cost Center A",
247 "erpSystemId": 0
248 },
249 "company": {
250 "id": 10000006,
251 "displayId": "1005",
252 "status": {
253 "name": "ACTIVE",
254 "captionKey": "enum.objectStatus.active",
255 "active": true,
256 "caption": "Active"
257 },
258 "erpSystemId": 10000001,
259 "erpSystemDisplayId": "FINQ8S-300",
260 "countryId": 10000095,
261 "countryDisplayId": "CA",
262 "name": "string",
263 "postingPeriodVariantId": 0,
264 "fiscalVariantId": 0
265 },
266 "taxJurisdiction": {
267 "id": 4001,
268 "displayId": "TJ-2025-001",
269 "status": {
270 "name": "ACTIVE",
271 "captionKey": "enum.objectStatus.active",
272 "active": true,
273 "caption": "Active"
274 },
275 "name": "California Tax Authority",
276 "erpSystemId": 0,
277 "schema": "string",
278 "countryDisplayId": "string"
279 },
280 "taxCode": {
281 "id": 5001,
282 "displayId": "TC-001",
283 "status": {
284 "name": "ACTIVE",
285 "captionKey": "enum.objectStatus.active",
286 "active": true,
287 "caption": "Active"
288 },
289 "name": "VAT Standard Rate",
290 "erpSystemId": 0
291 },
292 "responsibleCostCenter": {
293 "id": 14001,
294 "displayId": "CC-001",
295 "status": {
296 "name": "ACTIVE",
297 "captionKey": "enum.objectStatus.active",
298 "active": true,
299 "caption": "Active"
300 },
301 "name": "Cost Center A",
302 "erpSystemId": 0
303 },
304 "plant": {
305 "id": 10000001,
306 "displayId": "PLANT-001",
307 "status": {
308 "name": "ACTIVE",
309 "captionKey": "enum.objectStatus.active",
310 "active": true,
311 "caption": "Active"
312 },
313 "name": "Berlin Manufacturing Plant",
314 "companyId": 7001
315 },
316 "assetCostCenter": {
317 "id": 14001,
318 "displayId": "CC-001",
319 "status": {
320 "name": "ACTIVE",
321 "captionKey": "enum.objectStatus.active",
322 "active": true,
323 "caption": "Active"
324 },
325 "name": "Cost Center A",
326 "erpSystemId": 0
327 },
328 "assetProfitCenter": {
329 "id": 9001,
330 "displayId": "PC-001",
331 "status": {
332 "name": "ACTIVE",
333 "captionKey": "enum.objectStatus.active",
334 "active": true,
335 "caption": "Active"
336 },
337 "name": "North Region Profit Center",
338 "validTo": "2025-12-31",
339 "erpSystemId": 101,
340 "erpSystemDisplayId": "SAP-01"
341 },
342 "assetWorkBreakdownStructure": {
343 "id": 1001,
344 "displayId": "WBS-2025-001",
345 "status": {
346 "name": "ACTIVE",
347 "captionKey": "enum.objectStatus.active",
348 "active": true,
349 "caption": "Active"
350 },
351 "name": "Main Project WBS",
352 "erpSystemId": 0
353 },
354 "assetTaxJurisdiction": {
355 "id": 4001,
356 "displayId": "TJ-2025-001",
357 "status": {
358 "name": "ACTIVE",
359 "captionKey": "enum.objectStatus.active",
360 "active": true,
361 "caption": "Active"
362 },
363 "name": "California Tax Authority",
364 "erpSystemId": 0,
365 "schema": "string",
366 "countryDisplayId": "string"
367 },
368 "assetBusinessArea": {
369 "id": 3001,
370 "displayId": "BA-2025-001",
371 "status": {
372 "name": "ACTIVE",
373 "captionKey": "enum.objectStatus.active",
374 "active": true,
375 "caption": "Active"
376 },
377 "name": "North America Operations",
378 "erpSystemId": 0
379 },
380 "assetSegment": {
381 "id": 11001,
382 "displayId": "SEG-001",
383 "status": {
384 "name": "ACTIVE",
385 "captionKey": "enum.objectStatus.active",
386 "active": true,
387 "caption": "Active"
388 },
389 "name": "Segment Alpha",
390 "erpSystemId": 0
391 },
392 "activationGroupId": 101,
393 "activationGroupDisplayId": "AG-001",
394 "principalPositionType": {
395 "name": "LESSEE",
396 "captionKey": "enum.principalpositiontype.lessee",
397 "caption": "Lessee"
398 },
399 "effectiveDate": "2024-01-01",
400 "costCenterAllocations": [
401 {
402 "id": 10001,
403 "mainCostCenter": true,
404 "allocationPercentage": 75,
405 "costCenter": {
406 "id": 14001,
407 "displayId": "CC-001",
408 "status": {
409 "name": "ACTIVE",
410 "captionKey": "enum.objectStatus.active",
411 "active": true,
412 "caption": "Active"
413 },
414 "name": "Cost Center A",
415 "erpSystemId": 0
416 },
417 "profitCenter": {
418 "id": 9001,
419 "displayId": "PC-001",
420 "status": {
421 "name": "ACTIVE",
422 "captionKey": "enum.objectStatus.active",
423 "active": true,
424 "caption": "Active"
425 },
426 "name": "North Region Profit Center",
427 "validTo": "2025-12-31",
428 "erpSystemId": 101,
429 "erpSystemDisplayId": "SAP-01"
430 }
431 }
432 ],
433 "numberRangeIdentifierValue": "NR-0001",
434 "numberRangeIdentifierType": {
435 "name": "COMPANY_CODE"
436 },
437 "numberRangeType": {
438 "name": "CONTRACT"
439 },
440 "allowsSystemGenerateNewId": true
441}
Partially Update A Unit¶
HTTP Request
PATCH /api/v1/units/{id}
📋 Description: Updates the specified unit within the Nakisa Lease Accounting Suite, allowing for modifications to lease, contract, or financial obligation details associated with accounting entries. This operation ensures that all relevant information remains current and accurate for effective financial management.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer |
true |
Unique identifier for the resource |
body |
body |
false |
Request body containing updated lease unit information, including financial obligations and accounting entries, for the specified unit identified by its unique ID. |
Example Values¶
Parameter |
Example |
Type |
|---|---|---|
id |
|
path |
body |
|
body |
Body Parameters
1{
2 "op": "replace",
3 "path": "/name",
4 "value": "patched contract"
5}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
Successfully patched unit. |
Example Responses
1{
2 "code": "OK",
3 "errors": {
4 "all": []
5 },
6 "object": {
7 "id": 10000001,
8 "displayId": "UNIT-000123",
9 "name": "Office Printer",
10 "description": "High-speed color printer for main office.",
11 "assetNumber": "A-1001",
12 "referenceId": "REF-2024-001",
13 "serialNumber": "SN12345678",
14 "licenseNumber": "LIC-98765",
15 "inventoryNumber": "INV-55555",
16 "room": "Room 101",
17 "location": "Head Office",
18 "evaluationGroup1": "Group A",
19 "evaluationGroup2": "Group B",
20 "evaluationGroup3": "Group C",
21 "investmentReason": "Replacement of outdated equipment",
22 "typeName": "Printer",
23 "calculateGrossTax": true,
24 "bulkAsset": true,
25 "bulkAssetQuantity": 0,
26 "shippingDate": "2024-01-15",
27 "deliveryDate": "2024-01-20",
28 "receptionDate": "2024-01-21",
29 "activationDate": "2024-01-22",
30 "rouEndDate": "2026-01-22",
31 "erpAssetRetirementDate": "2028-01-01",
32 "state": "UNIT_ACTIVE",
33 "taxCalculationType": "NET",
34 "internalAssetClass": {
35 "id": 10000001,
36 "displayId": "IAC-001",
37 "status": {
38 "name": "ACTIVE",
39 "captionKey": "enum.objectStatus.active",
40 "active": true,
41 "caption": "Active"
42 },
43 "name": "Machinery and Equipment",
44 "assetClassType": "PROPERTY",
45 "infiniteUsefulLife": false
46 },
47 "profitCenter": {
48 "id": 9001,
49 "displayId": "PC-001",
50 "status": {
51 "name": "ACTIVE",
52 "captionKey": "enum.objectStatus.active",
53 "active": true,
54 "caption": "Active"
55 },
56 "name": "North Region Profit Center",
57 "validTo": "2025-12-31",
58 "erpSystemId": 101,
59 "erpSystemDisplayId": "SAP-01"
60 },
61 "workBreakdownStructure": {
62 "id": 1001,
63 "displayId": "WBS-2025-001",
64 "status": {
65 "name": "ACTIVE",
66 "captionKey": "enum.objectStatus.active",
67 "active": true,
68 "caption": "Active"
69 },
70 "name": "Main Project WBS",
71 "erpSystemId": 0
72 },
73 "functionalArea": {
74 "id": 2001,
75 "displayId": "FA-2025-001",
76 "status": {
77 "name": "ACTIVE",
78 "captionKey": "enum.objectStatus.active",
79 "active": true,
80 "caption": "Active"
81 },
82 "name": "Accounting Department",
83 "erpSystemId": 0
84 },
85 "businessArea": {
86 "id": 3001,
87 "displayId": "BA-2025-001",
88 "status": {
89 "name": "ACTIVE",
90 "captionKey": "enum.objectStatus.active",
91 "active": true,
92 "caption": "Active"
93 },
94 "name": "North America Operations",
95 "erpSystemId": 0
96 },
97 "network": {
98 "id": 10001,
99 "displayId": "NET-001",
100 "status": {
101 "name": "ACTIVE",
102 "captionKey": "enum.objectStatus.active",
103 "active": true,
104 "caption": "Active"
105 },
106 "name": "Global Network",
107 "erpSystemId": 0
108 },
109 "segment": {
110 "id": 11001,
111 "displayId": "SEG-001",
112 "status": {
113 "name": "ACTIVE",
114 "captionKey": "enum.objectStatus.active",
115 "active": true,
116 "caption": "Active"
117 },
118 "name": "Segment Alpha",
119 "erpSystemId": 0
120 },
121 "internalOrder": {
122 "id": 10000001,
123 "status": {
124 "name": "ACTIVE",
125 "captionKey": "enum.objectStatus.active",
126 "active": true,
127 "caption": "Active"
128 },
129 "displayId": "IO-2024-001",
130 "erpSystemId": 1001,
131 "erpSystemDisplayId": "SAP-001",
132 "name": "Office Renovation Order",
133 "internalOrderTypeId": 3001,
134 "internalOrderTypeDisplayId": "CAPEX",
135 "controllingAreaId": 4001,
136 "controllingAreaDisplayId": "CA-1001"
137 },
138 "internalOrderType": {
139 "id": 10000001,
140 "status": {
141 "name": "ACTIVE",
142 "captionKey": "enum.objectStatus.active",
143 "active": true,
144 "caption": "Active"
145 },
146 "displayId": "CAPEX",
147 "erpSystemId": 1001,
148 "erpSystemDisplayId": "SAP-001",
149 "name": "Capital Expenditure Orders",
150 "internalOrderId": 20004567
151 },
152 "currency": {
153 "id": 840,
154 "displayId": "USD",
155 "status": {
156 "name": "ACTIVE",
157 "captionKey": "enum.objectStatus.active",
158 "active": true,
159 "caption": "Active"
160 },
161 "name": "United States Dollar",
162 "decimalPoints": 2
163 },
164 "taxCodeForPrincipalPayment": {
165 "id": 5001,
166 "displayId": "TC-001",
167 "status": {
168 "name": "ACTIVE",
169 "captionKey": "enum.objectStatus.active",
170 "active": true,
171 "caption": "Active"
172 },
173 "name": "VAT Standard Rate",
174 "erpSystemId": 0
175 },
176 "taxJurisdictionForPrincipalPayment": {
177 "id": 4001,
178 "displayId": "TJ-2025-001",
179 "status": {
180 "name": "ACTIVE",
181 "captionKey": "enum.objectStatus.active",
182 "active": true,
183 "caption": "Active"
184 },
185 "name": "California Tax Authority",
186 "erpSystemId": 0,
187 "schema": "string",
188 "countryDisplayId": "string"
189 },
190 "taxCodeForInterestPayment": {
191 "id": 5001,
192 "displayId": "TC-001",
193 "status": {
194 "name": "ACTIVE",
195 "captionKey": "enum.objectStatus.active",
196 "active": true,
197 "caption": "Active"
198 },
199 "name": "VAT Standard Rate",
200 "erpSystemId": 0
201 },
202 "taxJurisdictionForInterestPayment": {
203 "id": 4001,
204 "displayId": "TJ-2025-001",
205 "status": {
206 "name": "ACTIVE",
207 "captionKey": "enum.objectStatus.active",
208 "active": true,
209 "caption": "Active"
210 },
211 "name": "California Tax Authority",
212 "erpSystemId": 0,
213 "schema": "string",
214 "countryDisplayId": "string"
215 },
216 "taxCodeForNonLeasePayment": {
217 "id": 5001,
218 "displayId": "TC-001",
219 "status": {
220 "name": "ACTIVE",
221 "captionKey": "enum.objectStatus.active",
222 "active": true,
223 "caption": "Active"
224 },
225 "name": "VAT Standard Rate",
226 "erpSystemId": 0
227 },
228 "taxJurisdictionForNonLeasePayment": {
229 "id": 4001,
230 "displayId": "TJ-2025-001",
231 "status": {
232 "name": "ACTIVE",
233 "captionKey": "enum.objectStatus.active",
234 "active": true,
235 "caption": "Active"
236 },
237 "name": "California Tax Authority",
238 "erpSystemId": 0,
239 "schema": "string",
240 "countryDisplayId": "string"
241 },
242 "costCenter": {
243 "id": 14001,
244 "displayId": "CC-001",
245 "status": {
246 "name": "ACTIVE",
247 "captionKey": "enum.objectStatus.active",
248 "active": true,
249 "caption": "Active"
250 },
251 "name": "Cost Center A",
252 "erpSystemId": 0
253 },
254 "company": {
255 "id": 10000006,
256 "displayId": "1005",
257 "status": {
258 "name": "ACTIVE",
259 "captionKey": "enum.objectStatus.active",
260 "active": true,
261 "caption": "Active"
262 },
263 "erpSystemId": 10000001,
264 "erpSystemDisplayId": "FINQ8S-300",
265 "countryId": 10000095,
266 "countryDisplayId": "CA",
267 "name": "string",
268 "postingPeriodVariantId": 0,
269 "fiscalVariantId": 0
270 },
271 "taxJurisdiction": {
272 "id": 4001,
273 "displayId": "TJ-2025-001",
274 "status": {
275 "name": "ACTIVE",
276 "captionKey": "enum.objectStatus.active",
277 "active": true,
278 "caption": "Active"
279 },
280 "name": "California Tax Authority",
281 "erpSystemId": 0,
282 "schema": "string",
283 "countryDisplayId": "string"
284 },
285 "taxCode": {
286 "id": 5001,
287 "displayId": "TC-001",
288 "status": {
289 "name": "ACTIVE",
290 "captionKey": "enum.objectStatus.active",
291 "active": true,
292 "caption": "Active"
293 },
294 "name": "VAT Standard Rate",
295 "erpSystemId": 0
296 },
297 "responsibleCostCenter": {
298 "id": 14001,
299 "displayId": "CC-001",
300 "status": {
301 "name": "ACTIVE",
302 "captionKey": "enum.objectStatus.active",
303 "active": true,
304 "caption": "Active"
305 },
306 "name": "Cost Center A",
307 "erpSystemId": 0
308 },
309 "plant": {
310 "id": 10000001,
311 "displayId": "PLANT-001",
312 "status": {
313 "name": "ACTIVE",
314 "captionKey": "enum.objectStatus.active",
315 "active": true,
316 "caption": "Active"
317 },
318 "name": "Berlin Manufacturing Plant",
319 "companyId": 7001
320 },
321 "assetCostCenter": {
322 "id": 14001,
323 "displayId": "CC-001",
324 "status": {
325 "name": "ACTIVE",
326 "captionKey": "enum.objectStatus.active",
327 "active": true,
328 "caption": "Active"
329 },
330 "name": "Cost Center A",
331 "erpSystemId": 0
332 },
333 "assetProfitCenter": {
334 "id": 9001,
335 "displayId": "PC-001",
336 "status": {
337 "name": "ACTIVE",
338 "captionKey": "enum.objectStatus.active",
339 "active": true,
340 "caption": "Active"
341 },
342 "name": "North Region Profit Center",
343 "validTo": "2025-12-31",
344 "erpSystemId": 101,
345 "erpSystemDisplayId": "SAP-01"
346 },
347 "assetWorkBreakdownStructure": {
348 "id": 1001,
349 "displayId": "WBS-2025-001",
350 "status": {
351 "name": "ACTIVE",
352 "captionKey": "enum.objectStatus.active",
353 "active": true,
354 "caption": "Active"
355 },
356 "name": "Main Project WBS",
357 "erpSystemId": 0
358 },
359 "assetTaxJurisdiction": {
360 "id": 4001,
361 "displayId": "TJ-2025-001",
362 "status": {
363 "name": "ACTIVE",
364 "captionKey": "enum.objectStatus.active",
365 "active": true,
366 "caption": "Active"
367 },
368 "name": "California Tax Authority",
369 "erpSystemId": 0,
370 "schema": "string",
371 "countryDisplayId": "string"
372 },
373 "assetBusinessArea": {
374 "id": 3001,
375 "displayId": "BA-2025-001",
376 "status": {
377 "name": "ACTIVE",
378 "captionKey": "enum.objectStatus.active",
379 "active": true,
380 "caption": "Active"
381 },
382 "name": "North America Operations",
383 "erpSystemId": 0
384 },
385 "assetSegment": {
386 "id": 11001,
387 "displayId": "SEG-001",
388 "status": {
389 "name": "ACTIVE",
390 "captionKey": "enum.objectStatus.active",
391 "active": true,
392 "caption": "Active"
393 },
394 "name": "Segment Alpha",
395 "erpSystemId": 0
396 },
397 "activationGroupId": 101,
398 "activationGroupDisplayId": "AG-001",
399 "principalPositionType": {
400 "name": "LESSEE",
401 "captionKey": "enum.principalpositiontype.lessee",
402 "caption": "Lessee"
403 },
404 "effectiveDate": "2024-01-01",
405 "costCenterAllocations": [
406 {
407 "id": 10001,
408 "mainCostCenter": true,
409 "allocationPercentage": 75,
410 "costCenter": {
411 "id": 14001,
412 "displayId": "CC-001",
413 "status": {
414 "name": "ACTIVE",
415 "captionKey": "enum.objectStatus.active",
416 "active": true,
417 "caption": "Active"
418 },
419 "name": "Cost Center A",
420 "erpSystemId": 0
421 },
422 "profitCenter": {
423 "id": 9001,
424 "displayId": "PC-001",
425 "status": {
426 "name": "ACTIVE",
427 "captionKey": "enum.objectStatus.active",
428 "active": true,
429 "caption": "Active"
430 },
431 "name": "North Region Profit Center",
432 "validTo": "2025-12-31",
433 "erpSystemId": 101,
434 "erpSystemDisplayId": "SAP-01"
435 }
436 }
437 ],
438 "numberRangeIdentifierValue": "NR-0001",
439 "numberRangeIdentifierType": {
440 "name": "COMPANY_CODE"
441 },
442 "numberRangeType": {
443 "name": "CONTRACT"
444 },
445 "allowsSystemGenerateNewId": true
446 }
447}
Update Units In Bulk¶
HTTP Request
PUT /api/v1/units/bulk
📋 Description: Updates multiple units in bulk within the Nakisa Lease Accounting Suite, enabling efficient management of lease contracts and associated financial obligations in a streamlined manner.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
false |
Request body containing a bulk array of unit data, including lease details, contract specifications, and associated financial obligations for accounting entries. |
Body Parameters
1[
2 {
3 "id": 10000001,
4 "displayId": "UNIT-000123",
5 "name": "Office Printer",
6 "description": "High-speed color printer for main office.",
7 "assetNumber": "A-1001",
8 "referenceId": "REF-2024-001",
9 "serialNumber": "SN12345678",
10 "licenseNumber": "LIC-98765",
11 "inventoryNumber": "INV-55555",
12 "room": "Room 101",
13 "location": "Head Office",
14 "evaluationGroup1": "Group A",
15 "evaluationGroup2": "Group B",
16 "evaluationGroup3": "Group C",
17 "investmentReason": "Replacement of outdated equipment",
18 "typeName": "Printer",
19 "calculateGrossTax": true,
20 "bulkAsset": true,
21 "bulkAssetQuantity": 0,
22 "shippingDate": "2024-01-15",
23 "deliveryDate": "2024-01-20",
24 "receptionDate": "2024-01-21",
25 "activationDate": "2024-01-22",
26 "rouEndDate": "2026-01-22",
27 "erpAssetRetirementDate": "2028-01-01",
28 "state": "UNIT_ACTIVE",
29 "taxCalculationType": "NET",
30 "internalAssetClass": {
31 "id": 10000001,
32 "displayId": "IAC-001",
33 "status": {
34 "name": "ACTIVE",
35 "captionKey": "enum.objectStatus.active",
36 "active": true,
37 "caption": "Active"
38 },
39 "name": "Machinery and Equipment",
40 "assetClassType": "PROPERTY",
41 "infiniteUsefulLife": false
42 },
43 "profitCenter": {
44 "id": 9001,
45 "displayId": "PC-001",
46 "status": {
47 "name": "ACTIVE",
48 "captionKey": "enum.objectStatus.active",
49 "active": true,
50 "caption": "Active"
51 },
52 "name": "North Region Profit Center",
53 "validTo": "2025-12-31",
54 "erpSystemId": 101,
55 "erpSystemDisplayId": "SAP-01"
56 },
57 "workBreakdownStructure": {
58 "id": 1001,
59 "displayId": "WBS-2025-001",
60 "status": {
61 "name": "ACTIVE",
62 "captionKey": "enum.objectStatus.active",
63 "active": true,
64 "caption": "Active"
65 },
66 "name": "Main Project WBS",
67 "erpSystemId": 0
68 },
69 "functionalArea": {
70 "id": 2001,
71 "displayId": "FA-2025-001",
72 "status": {
73 "name": "ACTIVE",
74 "captionKey": "enum.objectStatus.active",
75 "active": true,
76 "caption": "Active"
77 },
78 "name": "Accounting Department",
79 "erpSystemId": 0
80 },
81 "businessArea": {
82 "id": 3001,
83 "displayId": "BA-2025-001",
84 "status": {
85 "name": "ACTIVE",
86 "captionKey": "enum.objectStatus.active",
87 "active": true,
88 "caption": "Active"
89 },
90 "name": "North America Operations",
91 "erpSystemId": 0
92 },
93 "network": {
94 "id": 10001,
95 "displayId": "NET-001",
96 "status": {
97 "name": "ACTIVE",
98 "captionKey": "enum.objectStatus.active",
99 "active": true,
100 "caption": "Active"
101 },
102 "name": "Global Network",
103 "erpSystemId": 0
104 },
105 "segment": {
106 "id": 11001,
107 "displayId": "SEG-001",
108 "status": {
109 "name": "ACTIVE",
110 "captionKey": "enum.objectStatus.active",
111 "active": true,
112 "caption": "Active"
113 },
114 "name": "Segment Alpha",
115 "erpSystemId": 0
116 },
117 "internalOrder": {
118 "id": 10000001,
119 "status": {
120 "name": "ACTIVE",
121 "captionKey": "enum.objectStatus.active",
122 "active": true,
123 "caption": "Active"
124 },
125 "displayId": "IO-2024-001",
126 "erpSystemId": 1001,
127 "erpSystemDisplayId": "SAP-001",
128 "name": "Office Renovation Order",
129 "internalOrderTypeId": 3001,
130 "internalOrderTypeDisplayId": "CAPEX",
131 "controllingAreaId": 4001,
132 "controllingAreaDisplayId": "CA-1001"
133 },
134 "internalOrderType": {
135 "id": 10000001,
136 "status": {
137 "name": "ACTIVE",
138 "captionKey": "enum.objectStatus.active",
139 "active": true,
140 "caption": "Active"
141 },
142 "displayId": "CAPEX",
143 "erpSystemId": 1001,
144 "erpSystemDisplayId": "SAP-001",
145 "name": "Capital Expenditure Orders",
146 "internalOrderId": 20004567
147 },
148 "currency": {
149 "id": 840,
150 "displayId": "USD",
151 "status": {
152 "name": "ACTIVE",
153 "captionKey": "enum.objectStatus.active",
154 "active": true,
155 "caption": "Active"
156 },
157 "name": "United States Dollar",
158 "decimalPoints": 2
159 },
160 "taxCodeForPrincipalPayment": {
161 "id": 5001,
162 "displayId": "TC-001",
163 "status": {
164 "name": "ACTIVE",
165 "captionKey": "enum.objectStatus.active",
166 "active": true,
167 "caption": "Active"
168 },
169 "name": "VAT Standard Rate",
170 "erpSystemId": 0
171 },
172 "taxJurisdictionForPrincipalPayment": {
173 "id": 4001,
174 "displayId": "TJ-2025-001",
175 "status": {
176 "name": "ACTIVE",
177 "captionKey": "enum.objectStatus.active",
178 "active": true,
179 "caption": "Active"
180 },
181 "name": "California Tax Authority",
182 "erpSystemId": 0,
183 "schema": "string",
184 "countryDisplayId": "string"
185 },
186 "taxCodeForInterestPayment": {
187 "id": 5001,
188 "displayId": "TC-001",
189 "status": {
190 "name": "ACTIVE",
191 "captionKey": "enum.objectStatus.active",
192 "active": true,
193 "caption": "Active"
194 },
195 "name": "VAT Standard Rate",
196 "erpSystemId": 0
197 },
198 "taxJurisdictionForInterestPayment": {
199 "id": 4001,
200 "displayId": "TJ-2025-001",
201 "status": {
202 "name": "ACTIVE",
203 "captionKey": "enum.objectStatus.active",
204 "active": true,
205 "caption": "Active"
206 },
207 "name": "California Tax Authority",
208 "erpSystemId": 0,
209 "schema": "string",
210 "countryDisplayId": "string"
211 },
212 "taxCodeForNonLeasePayment": {
213 "id": 5001,
214 "displayId": "TC-001",
215 "status": {
216 "name": "ACTIVE",
217 "captionKey": "enum.objectStatus.active",
218 "active": true,
219 "caption": "Active"
220 },
221 "name": "VAT Standard Rate",
222 "erpSystemId": 0
223 },
224 "taxJurisdictionForNonLeasePayment": {
225 "id": 4001,
226 "displayId": "TJ-2025-001",
227 "status": {
228 "name": "ACTIVE",
229 "captionKey": "enum.objectStatus.active",
230 "active": true,
231 "caption": "Active"
232 },
233 "name": "California Tax Authority",
234 "erpSystemId": 0,
235 "schema": "string",
236 "countryDisplayId": "string"
237 },
238 "costCenter": {
239 "id": 14001,
240 "displayId": "CC-001",
241 "status": {
242 "name": "ACTIVE",
243 "captionKey": "enum.objectStatus.active",
244 "active": true,
245 "caption": "Active"
246 },
247 "name": "Cost Center A",
248 "erpSystemId": 0
249 },
250 "company": {
251 "id": 10000006,
252 "displayId": "1005",
253 "status": {
254 "name": "ACTIVE",
255 "captionKey": "enum.objectStatus.active",
256 "active": true,
257 "caption": "Active"
258 },
259 "erpSystemId": 10000001,
260 "erpSystemDisplayId": "FINQ8S-300",
261 "countryId": 10000095,
262 "countryDisplayId": "CA",
263 "name": "string",
264 "postingPeriodVariantId": 0,
265 "fiscalVariantId": 0
266 },
267 "taxJurisdiction": {
268 "id": 4001,
269 "displayId": "TJ-2025-001",
270 "status": {
271 "name": "ACTIVE",
272 "captionKey": "enum.objectStatus.active",
273 "active": true,
274 "caption": "Active"
275 },
276 "name": "California Tax Authority",
277 "erpSystemId": 0,
278 "schema": "string",
279 "countryDisplayId": "string"
280 },
281 "taxCode": {
282 "id": 5001,
283 "displayId": "TC-001",
284 "status": {
285 "name": "ACTIVE",
286 "captionKey": "enum.objectStatus.active",
287 "active": true,
288 "caption": "Active"
289 },
290 "name": "VAT Standard Rate",
291 "erpSystemId": 0
292 },
293 "responsibleCostCenter": {
294 "id": 14001,
295 "displayId": "CC-001",
296 "status": {
297 "name": "ACTIVE",
298 "captionKey": "enum.objectStatus.active",
299 "active": true,
300 "caption": "Active"
301 },
302 "name": "Cost Center A",
303 "erpSystemId": 0
304 },
305 "plant": {
306 "id": 10000001,
307 "displayId": "PLANT-001",
308 "status": {
309 "name": "ACTIVE",
310 "captionKey": "enum.objectStatus.active",
311 "active": true,
312 "caption": "Active"
313 },
314 "name": "Berlin Manufacturing Plant",
315 "companyId": 7001
316 },
317 "assetCostCenter": {
318 "id": 14001,
319 "displayId": "CC-001",
320 "status": {
321 "name": "ACTIVE",
322 "captionKey": "enum.objectStatus.active",
323 "active": true,
324 "caption": "Active"
325 },
326 "name": "Cost Center A",
327 "erpSystemId": 0
328 },
329 "assetProfitCenter": {
330 "id": 9001,
331 "displayId": "PC-001",
332 "status": {
333 "name": "ACTIVE",
334 "captionKey": "enum.objectStatus.active",
335 "active": true,
336 "caption": "Active"
337 },
338 "name": "North Region Profit Center",
339 "validTo": "2025-12-31",
340 "erpSystemId": 101,
341 "erpSystemDisplayId": "SAP-01"
342 },
343 "assetWorkBreakdownStructure": {
344 "id": 1001,
345 "displayId": "WBS-2025-001",
346 "status": {
347 "name": "ACTIVE",
348 "captionKey": "enum.objectStatus.active",
349 "active": true,
350 "caption": "Active"
351 },
352 "name": "Main Project WBS",
353 "erpSystemId": 0
354 },
355 "assetTaxJurisdiction": {
356 "id": 4001,
357 "displayId": "TJ-2025-001",
358 "status": {
359 "name": "ACTIVE",
360 "captionKey": "enum.objectStatus.active",
361 "active": true,
362 "caption": "Active"
363 },
364 "name": "California Tax Authority",
365 "erpSystemId": 0,
366 "schema": "string",
367 "countryDisplayId": "string"
368 },
369 "assetBusinessArea": {
370 "id": 3001,
371 "displayId": "BA-2025-001",
372 "status": {
373 "name": "ACTIVE",
374 "captionKey": "enum.objectStatus.active",
375 "active": true,
376 "caption": "Active"
377 },
378 "name": "North America Operations",
379 "erpSystemId": 0
380 },
381 "assetSegment": {
382 "id": 11001,
383 "displayId": "SEG-001",
384 "status": {
385 "name": "ACTIVE",
386 "captionKey": "enum.objectStatus.active",
387 "active": true,
388 "caption": "Active"
389 },
390 "name": "Segment Alpha",
391 "erpSystemId": 0
392 },
393 "activationGroupId": 101,
394 "activationGroupDisplayId": "AG-001",
395 "principalPositionType": {
396 "name": "LESSEE",
397 "captionKey": "enum.principalpositiontype.lessee",
398 "caption": "Lessee"
399 },
400 "effectiveDate": "2024-01-01",
401 "costCenterAllocations": [
402 {
403 "id": 10001,
404 "mainCostCenter": true,
405 "allocationPercentage": 75,
406 "costCenter": {
407 "id": 14001,
408 "displayId": "CC-001",
409 "status": {
410 "name": "ACTIVE",
411 "captionKey": "enum.objectStatus.active",
412 "active": true,
413 "caption": "Active"
414 },
415 "name": "Cost Center A",
416 "erpSystemId": 0
417 },
418 "profitCenter": {
419 "id": 9001,
420 "displayId": "PC-001",
421 "status": {
422 "name": "ACTIVE",
423 "captionKey": "enum.objectStatus.active",
424 "active": true,
425 "caption": "Active"
426 },
427 "name": "North Region Profit Center",
428 "validTo": "2025-12-31",
429 "erpSystemId": 101,
430 "erpSystemDisplayId": "SAP-01"
431 }
432 }
433 ],
434 "numberRangeIdentifierValue": "NR-0001",
435 "numberRangeIdentifierType": {
436 "name": "COMPANY_CODE"
437 },
438 "numberRangeType": {
439 "name": "CONTRACT"
440 },
441 "allowsSystemGenerateNewId": true
442 }
443]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
Units successfully updated in bulk. |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": []
5 },
6 "object": [
7 {
8 "id": 10000001,
9 "displayId": "UNIT-000123",
10 "name": "Office Printer",
11 "description": "High-speed color printer for main office.",
12 "assetNumber": "A-1001",
13 "referenceId": "REF-2024-001",
14 "serialNumber": "SN12345678",
15 "licenseNumber": "LIC-98765",
16 "inventoryNumber": "INV-55555",
17 "room": "Room 101",
18 "location": "Head Office",
19 "evaluationGroup1": "Group A",
20 "evaluationGroup2": "Group B",
21 "evaluationGroup3": "Group C",
22 "investmentReason": "Replacement of outdated equipment",
23 "typeName": "Printer",
24 "calculateGrossTax": true,
25 "bulkAsset": true,
26 "bulkAssetQuantity": 0,
27 "shippingDate": "2024-01-15",
28 "deliveryDate": "2024-01-20",
29 "receptionDate": "2024-01-21",
30 "activationDate": "2024-01-22",
31 "rouEndDate": "2026-01-22",
32 "erpAssetRetirementDate": "2028-01-01",
33 "state": "UNIT_ACTIVE",
34 "taxCalculationType": "NET",
35 "internalAssetClass": {
36 "id": 10000001,
37 "displayId": "IAC-001",
38 "status": {
39 "name": "ACTIVE",
40 "captionKey": "enum.objectStatus.active",
41 "active": true,
42 "caption": "Active"
43 },
44 "name": "Machinery and Equipment",
45 "assetClassType": "PROPERTY",
46 "infiniteUsefulLife": false
47 },
48 "profitCenter": {
49 "id": 9001,
50 "displayId": "PC-001",
51 "status": {
52 "name": "ACTIVE",
53 "captionKey": "enum.objectStatus.active",
54 "active": true,
55 "caption": "Active"
56 },
57 "name": "North Region Profit Center",
58 "validTo": "2025-12-31",
59 "erpSystemId": 101,
60 "erpSystemDisplayId": "SAP-01"
61 },
62 "workBreakdownStructure": {
63 "id": 1001,
64 "displayId": "WBS-2025-001",
65 "status": {
66 "name": "ACTIVE",
67 "captionKey": "enum.objectStatus.active",
68 "active": true,
69 "caption": "Active"
70 },
71 "name": "Main Project WBS",
72 "erpSystemId": 0
73 },
74 "functionalArea": {
75 "id": 2001,
76 "displayId": "FA-2025-001",
77 "status": {
78 "name": "ACTIVE",
79 "captionKey": "enum.objectStatus.active",
80 "active": true,
81 "caption": "Active"
82 },
83 "name": "Accounting Department",
84 "erpSystemId": 0
85 },
86 "businessArea": {
87 "id": 3001,
88 "displayId": "BA-2025-001",
89 "status": {
90 "name": "ACTIVE",
91 "captionKey": "enum.objectStatus.active",
92 "active": true,
93 "caption": "Active"
94 },
95 "name": "North America Operations",
96 "erpSystemId": 0
97 },
98 "network": {
99 "id": 10001,
100 "displayId": "NET-001",
101 "status": {
102 "name": "ACTIVE",
103 "captionKey": "enum.objectStatus.active",
104 "active": true,
105 "caption": "Active"
106 },
107 "name": "Global Network",
108 "erpSystemId": 0
109 },
110 "segment": {
111 "id": 11001,
112 "displayId": "SEG-001",
113 "status": {
114 "name": "ACTIVE",
115 "captionKey": "enum.objectStatus.active",
116 "active": true,
117 "caption": "Active"
118 },
119 "name": "Segment Alpha",
120 "erpSystemId": 0
121 },
122 "internalOrder": {
123 "id": 10000001,
124 "status": {
125 "name": "ACTIVE",
126 "captionKey": "enum.objectStatus.active",
127 "active": true,
128 "caption": "Active"
129 },
130 "displayId": "IO-2024-001",
131 "erpSystemId": 1001,
132 "erpSystemDisplayId": "SAP-001",
133 "name": "Office Renovation Order",
134 "internalOrderTypeId": 3001,
135 "internalOrderTypeDisplayId": "CAPEX",
136 "controllingAreaId": 4001,
137 "controllingAreaDisplayId": "CA-1001"
138 },
139 "internalOrderType": {
140 "id": 10000001,
141 "status": {
142 "name": "ACTIVE",
143 "captionKey": "enum.objectStatus.active",
144 "active": true,
145 "caption": "Active"
146 },
147 "displayId": "CAPEX",
148 "erpSystemId": 1001,
149 "erpSystemDisplayId": "SAP-001",
150 "name": "Capital Expenditure Orders",
151 "internalOrderId": 20004567
152 },
153 "currency": {
154 "id": 840,
155 "displayId": "USD",
156 "status": {
157 "name": "ACTIVE",
158 "captionKey": "enum.objectStatus.active",
159 "active": true,
160 "caption": "Active"
161 },
162 "name": "United States Dollar",
163 "decimalPoints": 2
164 },
165 "taxCodeForPrincipalPayment": {
166 "id": 5001,
167 "displayId": "TC-001",
168 "status": {
169 "name": "ACTIVE",
170 "captionKey": "enum.objectStatus.active",
171 "active": true,
172 "caption": "Active"
173 },
174 "name": "VAT Standard Rate",
175 "erpSystemId": 0
176 },
177 "taxJurisdictionForPrincipalPayment": {
178 "id": 4001,
179 "displayId": "TJ-2025-001",
180 "status": {
181 "name": "ACTIVE",
182 "captionKey": "enum.objectStatus.active",
183 "active": true,
184 "caption": "Active"
185 },
186 "name": "California Tax Authority",
187 "erpSystemId": 0,
188 "schema": "string",
189 "countryDisplayId": "string"
190 },
191 "taxCodeForInterestPayment": {
192 "id": 5001,
193 "displayId": "TC-001",
194 "status": {
195 "name": "ACTIVE",
196 "captionKey": "enum.objectStatus.active",
197 "active": true,
198 "caption": "Active"
199 },
200 "name": "VAT Standard Rate",
201 "erpSystemId": 0
202 },
203 "taxJurisdictionForInterestPayment": {
204 "id": 4001,
205 "displayId": "TJ-2025-001",
206 "status": {
207 "name": "ACTIVE",
208 "captionKey": "enum.objectStatus.active",
209 "active": true,
210 "caption": "Active"
211 },
212 "name": "California Tax Authority",
213 "erpSystemId": 0,
214 "schema": "string",
215 "countryDisplayId": "string"
216 },
217 "taxCodeForNonLeasePayment": {
218 "id": 5001,
219 "displayId": "TC-001",
220 "status": {
221 "name": "ACTIVE",
222 "captionKey": "enum.objectStatus.active",
223 "active": true,
224 "caption": "Active"
225 },
226 "name": "VAT Standard Rate",
227 "erpSystemId": 0
228 },
229 "taxJurisdictionForNonLeasePayment": {
230 "id": 4001,
231 "displayId": "TJ-2025-001",
232 "status": {
233 "name": "ACTIVE",
234 "captionKey": "enum.objectStatus.active",
235 "active": true,
236 "caption": "Active"
237 },
238 "name": "California Tax Authority",
239 "erpSystemId": 0,
240 "schema": "string",
241 "countryDisplayId": "string"
242 },
243 "costCenter": {
244 "id": 14001,
245 "displayId": "CC-001",
246 "status": {
247 "name": "ACTIVE",
248 "captionKey": "enum.objectStatus.active",
249 "active": true,
250 "caption": "Active"
251 },
252 "name": "Cost Center A",
253 "erpSystemId": 0
254 },
255 "company": {
256 "id": 10000006,
257 "displayId": "1005",
258 "status": {
259 "name": "ACTIVE",
260 "captionKey": "enum.objectStatus.active",
261 "active": true,
262 "caption": "Active"
263 },
264 "erpSystemId": 10000001,
265 "erpSystemDisplayId": "FINQ8S-300",
266 "countryId": 10000095,
267 "countryDisplayId": "CA",
268 "name": "string",
269 "postingPeriodVariantId": 0,
270 "fiscalVariantId": 0
271 },
272 "taxJurisdiction": {
273 "id": 4001,
274 "displayId": "TJ-2025-001",
275 "status": {
276 "name": "ACTIVE",
277 "captionKey": "enum.objectStatus.active",
278 "active": true,
279 "caption": "Active"
280 },
281 "name": "California Tax Authority",
282 "erpSystemId": 0,
283 "schema": "string",
284 "countryDisplayId": "string"
285 },
286 "taxCode": {
287 "id": 5001,
288 "displayId": "TC-001",
289 "status": {
290 "name": "ACTIVE",
291 "captionKey": "enum.objectStatus.active",
292 "active": true,
293 "caption": "Active"
294 },
295 "name": "VAT Standard Rate",
296 "erpSystemId": 0
297 },
298 "responsibleCostCenter": {
299 "id": 14001,
300 "displayId": "CC-001",
301 "status": {
302 "name": "ACTIVE",
303 "captionKey": "enum.objectStatus.active",
304 "active": true,
305 "caption": "Active"
306 },
307 "name": "Cost Center A",
308 "erpSystemId": 0
309 },
310 "plant": {
311 "id": 10000001,
312 "displayId": "PLANT-001",
313 "status": {
314 "name": "ACTIVE",
315 "captionKey": "enum.objectStatus.active",
316 "active": true,
317 "caption": "Active"
318 },
319 "name": "Berlin Manufacturing Plant",
320 "companyId": 7001
321 },
322 "assetCostCenter": {
323 "id": 14001,
324 "displayId": "CC-001",
325 "status": {
326 "name": "ACTIVE",
327 "captionKey": "enum.objectStatus.active",
328 "active": true,
329 "caption": "Active"
330 },
331 "name": "Cost Center A",
332 "erpSystemId": 0
333 },
334 "assetProfitCenter": {
335 "id": 9001,
336 "displayId": "PC-001",
337 "status": {
338 "name": "ACTIVE",
339 "captionKey": "enum.objectStatus.active",
340 "active": true,
341 "caption": "Active"
342 },
343 "name": "North Region Profit Center",
344 "validTo": "2025-12-31",
345 "erpSystemId": 101,
346 "erpSystemDisplayId": "SAP-01"
347 },
348 "assetWorkBreakdownStructure": {
349 "id": 1001,
350 "displayId": "WBS-2025-001",
351 "status": {
352 "name": "ACTIVE",
353 "captionKey": "enum.objectStatus.active",
354 "active": true,
355 "caption": "Active"
356 },
357 "name": "Main Project WBS",
358 "erpSystemId": 0
359 },
360 "assetTaxJurisdiction": {
361 "id": 4001,
362 "displayId": "TJ-2025-001",
363 "status": {
364 "name": "ACTIVE",
365 "captionKey": "enum.objectStatus.active",
366 "active": true,
367 "caption": "Active"
368 },
369 "name": "California Tax Authority",
370 "erpSystemId": 0,
371 "schema": "string",
372 "countryDisplayId": "string"
373 },
374 "assetBusinessArea": {
375 "id": 3001,
376 "displayId": "BA-2025-001",
377 "status": {
378 "name": "ACTIVE",
379 "captionKey": "enum.objectStatus.active",
380 "active": true,
381 "caption": "Active"
382 },
383 "name": "North America Operations",
384 "erpSystemId": 0
385 },
386 "assetSegment": {
387 "id": 11001,
388 "displayId": "SEG-001",
389 "status": {
390 "name": "ACTIVE",
391 "captionKey": "enum.objectStatus.active",
392 "active": true,
393 "caption": "Active"
394 },
395 "name": "Segment Alpha",
396 "erpSystemId": 0
397 },
398 "activationGroupId": 101,
399 "activationGroupDisplayId": "AG-001",
400 "principalPositionType": {
401 "name": "LESSEE",
402 "captionKey": "enum.principalpositiontype.lessee",
403 "caption": "Lessee"
404 },
405 "effectiveDate": "2024-01-01",
406 "costCenterAllocations": [
407 {
408 "id": 10001,
409 "mainCostCenter": true,
410 "allocationPercentage": 75,
411 "costCenter": {
412 "id": 14001,
413 "displayId": "CC-001",
414 "status": {
415 "name": "ACTIVE",
416 "captionKey": "enum.objectStatus.active",
417 "active": true,
418 "caption": "Active"
419 },
420 "name": "Cost Center A",
421 "erpSystemId": 0
422 },
423 "profitCenter": {
424 "id": 9001,
425 "displayId": "PC-001",
426 "status": {
427 "name": "ACTIVE",
428 "captionKey": "enum.objectStatus.active",
429 "active": true,
430 "caption": "Active"
431 },
432 "name": "North Region Profit Center",
433 "validTo": "2025-12-31",
434 "erpSystemId": 101,
435 "erpSystemDisplayId": "SAP-01"
436 }
437 }
438 ],
439 "numberRangeIdentifierValue": "NR-0001",
440 "numberRangeIdentifierType": {
441 "name": "COMPANY_CODE"
442 },
443 "numberRangeType": {
444 "name": "CONTRACT"
445 },
446 "allowsSystemGenerateNewId": true
447 }
448 ]
449}
Search Units¶
HTTP Request
POST /api/v1/units/search
📋 Description: Submits a search request for lease units within the Nakisa Lease Accounting Suite, allowing users to filter results based on specific lease, contract, financial obligation, or accounting entry criteria.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
page |
query |
integer |
false |
Zero-based page index (0..N) |
size |
query |
integer |
false |
The size of the page to be returned |
sort |
query |
array[string] |
false |
Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. |
body |
body |
false |
Request body containing search criteria for lease units, including relevant contract details and financial obligations to facilitate accurate accounting entry retrieval. |
Default Values¶
Parameter |
Default |
Type |
|---|---|---|
page |
|
query |
size |
|
query |
sort |
|
query |
Parameter Constraints¶
Parameter |
Constraints |
|---|---|
page |
Min: 0 |
size |
Min: 1 |
Body Parameters
1{
2 "idIn": [
3 101,
4 102,
5 103
6 ],
7 "idEqual": 101,
8 "idLike": "10*",
9 "createdAtGreaterThanOrEqual": "2024-01-01T00:00:00Z",
10 "createdAtLessThanOrEqual": "2024-12-31T23:59:59Z",
11 "createdByLike": "john*",
12 "createdByEqual": "john.doe",
13 "modifiedAtGreaterThanOrEqual": "2024-02-01T00:00:00Z",
14 "modifiedAtLessThanOrEqual": "2024-06-30T23:59:59Z",
15 "modifiedByLike": "admin*",
16 "modifiedByEqual": "admin.user",
17 "displayIdIn": [
18 "UNIT-001",
19 "UNIT-002"
20 ],
21 "displayIdLike": "UNIT-*",
22 "nameOrDisplayIdLike": "Printer*",
23 "nameLike": "Office*",
24 "assetNumberLike": "A-*",
25 "referenceIdLike": "REF-*",
26 "serialNumberLike": "SN*",
27 "licenseNumberLike": "LIC*",
28 "inventoryNumberLike": "INV*",
29 "shippingDateGreaterThanOrEqual": "2024-01-01",
30 "shippingDateLessThanOrEqual": "2024-12-31",
31 "shippingDateEqual": "2024-06-15",
32 "deliveryDateGreaterThanOrEqual": "2024-01-10",
33 "deliveryDateLessThanOrEqual": "2024-12-10",
34 "deliveryDateEqual": "2024-05-01",
35 "receptionDateGreaterThanOrEqual": "2024-01-15",
36 "receptionDateLessThanOrEqual": "2024-12-15",
37 "receptionDateEqual": "2024-06-20",
38 "activationDateGreaterThanOrEqual": "2024-02-01",
39 "activationDateLessThanOrEqual": "2024-11-01",
40 "activationDateEqual": "2024-04-15",
41 "rouEndDateGreaterThanOrEqual": "2025-01-01",
42 "rouEndDateLessThanOrEqual": "2026-12-31",
43 "rouEndDateEqual": "2026-06-30",
44 "stateIn": {
45 "name": "AG_ACTIVE",
46 "captionKey": "enum.entityStatus.agActive",
47 "caption": "Active"
48 },
49 "taxCalculationTypeIn": [
50 "NET"
51 ],
52 "internalAssetClassIdEqual": 501,
53 "internalAssetClassDisplayIdEqual": "IAC-01",
54 "profitCenterIdEqual": 601,
55 "profitCenterDisplayIdEqual": "PC-01",
56 "workBreakdownStructureIdEqual": 701,
57 "workBreakdownStructureDisplayIdEqual": "WBS-01",
58 "functionalAreaIdEqual": 801,
59 "functionalAreaDisplayIdEqual": "FA-01",
60 "businessAreaIdEqual": 901,
61 "businessAreaDisplayIdEqual": "BA-01",
62 "networkIdEqual": 1001,
63 "networkDisplayIdEqual": "NET-01",
64 "segmentIdEqual": 1101,
65 "segmentDisplayIdEqual": "SEG-01",
66 "internalOrderIdEqual": 1201,
67 "internalOrderDisplayIdEqual": "IO-01",
68 "internalOrderTypeIdEqual": 1301,
69 "internalOrderTypeDisplayIdEqual": "IOT-01",
70 "currencyCodeEqual": 1401,
71 "currencyCodeDisplayIdEqual": "USD",
72 "taxCodeForPrincipalPaymentIdEqual": 1501,
73 "taxCodeForPrincipalPaymentDisplayIdEqual": "TAXP-01",
74 "taxJurisdictionForPrincipalPaymentIdEqual": 1601,
75 "taxJurisdictionForPrincipalPaymentDisplayIdEqual": "TXJ-01",
76 "taxCodeForInterestPaymentIdEqual": 1701,
77 "taxCodeForInterestPaymentDisplayIdEqual": "TAXI-01",
78 "taxJurisdictionForInterestPaymentIdEqual": 1801,
79 "taxJurisdictionForInterestPaymentDisplayIdEqual": "TXI-01",
80 "taxCodeForNonLeasePaymentIdEqual": 1901,
81 "taxCodeForNonLeasePaymentDisplayIdEqual": "TAXN-01",
82 "taxJurisdictionForNonLeasePaymentIdEqual": 2001,
83 "taxJurisdictionForNonLeasePaymentDisplayIdEqual": "TXN-01",
84 "costCenterIdIn": [
85 2101,
86 2102
87 ],
88 "costCenterDisplayIdIn": [
89 "CC-01",
90 "CC-02"
91 ],
92 "taxJurisdictionIdEqual": 2201,
93 "taxJurisdictionDisplayIdEqual": "TXJ-02",
94 "taxCodeIdEqual": 2301,
95 "taxCodeDisplayIdEqual": "TAX-02",
96 "responsibleCostCenterIdEqual": 2401,
97 "responsibleCostCenterDisplayIdEqual": "RCC-01",
98 "plantIdEqual": 2501,
99 "plantDisplayDisplayIdEqual": "PLANT-01",
100 "assetCostCenterIdEqual": 2601,
101 "assetCostCenterDisplayIdEqual": "ACC-01",
102 "assetProfitCenterIdEqual": 2701,
103 "assetProfitCenterDisplayIdEqual": "APC-01",
104 "assetWorkBreakdownStructureIdEqual": 2801,
105 "assetWorkBreakdownStructureDisplayIdEqual": "AWBS-01",
106 "assetTaxJurisdictionIdEqual": 2901,
107 "assetTaxJurisdictionDisplayIdEqual": "ATX-01",
108 "assetBusinessUnitIdEqual": 3001,
109 "assetBusinessUnitDisplayIdEqual": "ABU-01",
110 "assetSegmentIdEqual": 3101,
111 "assetSegmentDisplayIdEqual": "ASEG-01",
112 "activationGroupIdIn": [
113 3201,
114 3202
115 ],
116 "activationGroupDisplayIdIn": [
117 "AG-01",
118 "AG-02"
119 ],
120 "activationGroupDisplayIdLike": "AG-*"
121}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
Search results for units successfully returned. |
Example Responses
1{
2 "totalElements": 10000001,
3 "totalPages": 15,
4 "pageable": {
5 "pageNumber": 0,
6 "unpaged": false,
7 "paged": true,
8 "pageSize": 100,
9 "offset": 0,
10 "sort": {
11 "unsorted": false,
12 "sorted": true,
13 "empty": false
14 }
15 },
16 "numberOfElements": 10,
17 "size": 10,
18 "content": [
19 {
20 "id": 10000001,
21 "displayId": "UNIT-000123",
22 "name": "Office Printer",
23 "description": "High-speed color printer for main office.",
24 "assetNumber": "A-1001",
25 "referenceId": "REF-2024-001",
26 "serialNumber": "SN12345678",
27 "licenseNumber": "LIC-98765",
28 "inventoryNumber": "INV-55555",
29 "room": "Room 101",
30 "location": "Head Office",
31 "evaluationGroup1": "Group A",
32 "evaluationGroup2": "Group B",
33 "evaluationGroup3": "Group C",
34 "investmentReason": "Replacement of outdated equipment",
35 "typeName": "Printer",
36 "calculateGrossTax": true,
37 "bulkAsset": true,
38 "bulkAssetQuantity": 0,
39 "shippingDate": "2024-01-15",
40 "deliveryDate": "2024-01-20",
41 "receptionDate": "2024-01-21",
42 "activationDate": "2024-01-22",
43 "rouEndDate": "2026-01-22",
44 "erpAssetRetirementDate": "2028-01-01",
45 "state": "UNIT_ACTIVE",
46 "taxCalculationType": "NET",
47 "internalAssetClass": {
48 "id": 10000001,
49 "displayId": "IAC-001",
50 "status": {
51 "name": "ACTIVE",
52 "captionKey": "enum.objectStatus.active",
53 "active": true,
54 "caption": "Active"
55 },
56 "name": "Machinery and Equipment",
57 "assetClassType": "PROPERTY",
58 "infiniteUsefulLife": false
59 },
60 "profitCenter": {
61 "id": 9001,
62 "displayId": "PC-001",
63 "status": {
64 "name": "ACTIVE",
65 "captionKey": "enum.objectStatus.active",
66 "active": true,
67 "caption": "Active"
68 },
69 "name": "North Region Profit Center",
70 "validTo": "2025-12-31",
71 "erpSystemId": 101,
72 "erpSystemDisplayId": "SAP-01"
73 },
74 "workBreakdownStructure": {
75 "id": 1001,
76 "displayId": "WBS-2025-001",
77 "status": {
78 "name": "ACTIVE",
79 "captionKey": "enum.objectStatus.active",
80 "active": true,
81 "caption": "Active"
82 },
83 "name": "Main Project WBS",
84 "erpSystemId": 0
85 },
86 "functionalArea": {
87 "id": 2001,
88 "displayId": "FA-2025-001",
89 "status": {
90 "name": "ACTIVE",
91 "captionKey": "enum.objectStatus.active",
92 "active": true,
93 "caption": "Active"
94 },
95 "name": "Accounting Department",
96 "erpSystemId": 0
97 },
98 "businessArea": {
99 "id": 3001,
100 "displayId": "BA-2025-001",
101 "status": {
102 "name": "ACTIVE",
103 "captionKey": "enum.objectStatus.active",
104 "active": true,
105 "caption": "Active"
106 },
107 "name": "North America Operations",
108 "erpSystemId": 0
109 },
110 "network": {
111 "id": 10001,
112 "displayId": "NET-001",
113 "status": {
114 "name": "ACTIVE",
115 "captionKey": "enum.objectStatus.active",
116 "active": true,
117 "caption": "Active"
118 },
119 "name": "Global Network",
120 "erpSystemId": 0
121 },
122 "segment": {
123 "id": 11001,
124 "displayId": "SEG-001",
125 "status": {
126 "name": "ACTIVE",
127 "captionKey": "enum.objectStatus.active",
128 "active": true,
129 "caption": "Active"
130 },
131 "name": "Segment Alpha",
132 "erpSystemId": 0
133 },
134 "internalOrder": {
135 "id": 10000001,
136 "status": {
137 "name": "ACTIVE",
138 "captionKey": "enum.objectStatus.active",
139 "active": true,
140 "caption": "Active"
141 },
142 "displayId": "IO-2024-001",
143 "erpSystemId": 1001,
144 "erpSystemDisplayId": "SAP-001",
145 "name": "Office Renovation Order",
146 "internalOrderTypeId": 3001,
147 "internalOrderTypeDisplayId": "CAPEX",
148 "controllingAreaId": 4001,
149 "controllingAreaDisplayId": "CA-1001"
150 },
151 "internalOrderType": {
152 "id": 10000001,
153 "status": {
154 "name": "ACTIVE",
155 "captionKey": "enum.objectStatus.active",
156 "active": true,
157 "caption": "Active"
158 },
159 "displayId": "CAPEX",
160 "erpSystemId": 1001,
161 "erpSystemDisplayId": "SAP-001",
162 "name": "Capital Expenditure Orders",
163 "internalOrderId": 20004567
164 },
165 "currency": {
166 "id": 840,
167 "displayId": "USD",
168 "status": {
169 "name": "ACTIVE",
170 "captionKey": "enum.objectStatus.active",
171 "active": true,
172 "caption": "Active"
173 },
174 "name": "United States Dollar",
175 "decimalPoints": 2
176 },
177 "taxCodeForPrincipalPayment": {
178 "id": 5001,
179 "displayId": "TC-001",
180 "status": {
181 "name": "ACTIVE",
182 "captionKey": "enum.objectStatus.active",
183 "active": true,
184 "caption": "Active"
185 },
186 "name": "VAT Standard Rate",
187 "erpSystemId": 0
188 },
189 "taxJurisdictionForPrincipalPayment": {
190 "id": 4001,
191 "displayId": "TJ-2025-001",
192 "status": {
193 "name": "ACTIVE",
194 "captionKey": "enum.objectStatus.active",
195 "active": true,
196 "caption": "Active"
197 },
198 "name": "California Tax Authority",
199 "erpSystemId": 0,
200 "schema": "string",
201 "countryDisplayId": "string"
202 },
203 "taxCodeForInterestPayment": {
204 "id": 5001,
205 "displayId": "TC-001",
206 "status": {
207 "name": "ACTIVE",
208 "captionKey": "enum.objectStatus.active",
209 "active": true,
210 "caption": "Active"
211 },
212 "name": "VAT Standard Rate",
213 "erpSystemId": 0
214 },
215 "taxJurisdictionForInterestPayment": {
216 "id": 4001,
217 "displayId": "TJ-2025-001",
218 "status": {
219 "name": "ACTIVE",
220 "captionKey": "enum.objectStatus.active",
221 "active": true,
222 "caption": "Active"
223 },
224 "name": "California Tax Authority",
225 "erpSystemId": 0,
226 "schema": "string",
227 "countryDisplayId": "string"
228 },
229 "taxCodeForNonLeasePayment": {
230 "id": 5001,
231 "displayId": "TC-001",
232 "status": {
233 "name": "ACTIVE",
234 "captionKey": "enum.objectStatus.active",
235 "active": true,
236 "caption": "Active"
237 },
238 "name": "VAT Standard Rate",
239 "erpSystemId": 0
240 },
241 "taxJurisdictionForNonLeasePayment": {
242 "id": 4001,
243 "displayId": "TJ-2025-001",
244 "status": {
245 "name": "ACTIVE",
246 "captionKey": "enum.objectStatus.active",
247 "active": true,
248 "caption": "Active"
249 },
250 "name": "California Tax Authority",
251 "erpSystemId": 0,
252 "schema": "string",
253 "countryDisplayId": "string"
254 },
255 "costCenter": {
256 "id": 14001,
257 "displayId": "CC-001",
258 "status": {
259 "name": "ACTIVE",
260 "captionKey": "enum.objectStatus.active",
261 "active": true,
262 "caption": "Active"
263 },
264 "name": "Cost Center A",
265 "erpSystemId": 0
266 },
267 "company": {
268 "id": 10000006,
269 "displayId": "1005",
270 "status": {
271 "name": "ACTIVE",
272 "captionKey": "enum.objectStatus.active",
273 "active": true,
274 "caption": "Active"
275 },
276 "erpSystemId": 10000001,
277 "erpSystemDisplayId": "FINQ8S-300",
278 "countryId": 10000095,
279 "countryDisplayId": "CA",
280 "name": "string",
281 "postingPeriodVariantId": 0,
282 "fiscalVariantId": 0
283 },
284 "taxJurisdiction": {
285 "id": 4001,
286 "displayId": "TJ-2025-001",
287 "status": {
288 "name": "ACTIVE",
289 "captionKey": "enum.objectStatus.active",
290 "active": true,
291 "caption": "Active"
292 },
293 "name": "California Tax Authority",
294 "erpSystemId": 0,
295 "schema": "string",
296 "countryDisplayId": "string"
297 },
298 "taxCode": {
299 "id": 5001,
300 "displayId": "TC-001",
301 "status": {
302 "name": "ACTIVE",
303 "captionKey": "enum.objectStatus.active",
304 "active": true,
305 "caption": "Active"
306 },
307 "name": "VAT Standard Rate",
308 "erpSystemId": 0
309 },
310 "responsibleCostCenter": {
311 "id": 14001,
312 "displayId": "CC-001",
313 "status": {
314 "name": "ACTIVE",
315 "captionKey": "enum.objectStatus.active",
316 "active": true,
317 "caption": "Active"
318 },
319 "name": "Cost Center A",
320 "erpSystemId": 0
321 },
322 "plant": {
323 "id": 10000001,
324 "displayId": "PLANT-001",
325 "status": {
326 "name": "ACTIVE",
327 "captionKey": "enum.objectStatus.active",
328 "active": true,
329 "caption": "Active"
330 },
331 "name": "Berlin Manufacturing Plant",
332 "companyId": 7001
333 },
334 "assetCostCenter": {
335 "id": 14001,
336 "displayId": "CC-001",
337 "status": {
338 "name": "ACTIVE",
339 "captionKey": "enum.objectStatus.active",
340 "active": true,
341 "caption": "Active"
342 },
343 "name": "Cost Center A",
344 "erpSystemId": 0
345 },
346 "assetProfitCenter": {
347 "id": 9001,
348 "displayId": "PC-001",
349 "status": {
350 "name": "ACTIVE",
351 "captionKey": "enum.objectStatus.active",
352 "active": true,
353 "caption": "Active"
354 },
355 "name": "North Region Profit Center",
356 "validTo": "2025-12-31",
357 "erpSystemId": 101,
358 "erpSystemDisplayId": "SAP-01"
359 },
360 "assetWorkBreakdownStructure": {
361 "id": 1001,
362 "displayId": "WBS-2025-001",
363 "status": {
364 "name": "ACTIVE",
365 "captionKey": "enum.objectStatus.active",
366 "active": true,
367 "caption": "Active"
368 },
369 "name": "Main Project WBS",
370 "erpSystemId": 0
371 },
372 "assetTaxJurisdiction": {
373 "id": 4001,
374 "displayId": "TJ-2025-001",
375 "status": {
376 "name": "ACTIVE",
377 "captionKey": "enum.objectStatus.active",
378 "active": true,
379 "caption": "Active"
380 },
381 "name": "California Tax Authority",
382 "erpSystemId": 0,
383 "schema": "string",
384 "countryDisplayId": "string"
385 },
386 "assetBusinessArea": {
387 "id": 3001,
388 "displayId": "BA-2025-001",
389 "status": {
390 "name": "ACTIVE",
391 "captionKey": "enum.objectStatus.active",
392 "active": true,
393 "caption": "Active"
394 },
395 "name": "North America Operations",
396 "erpSystemId": 0
397 },
398 "assetSegment": {
399 "id": 11001,
400 "displayId": "SEG-001",
401 "status": {
402 "name": "ACTIVE",
403 "captionKey": "enum.objectStatus.active",
404 "active": true,
405 "caption": "Active"
406 },
407 "name": "Segment Alpha",
408 "erpSystemId": 0
409 },
410 "activationGroupId": 101,
411 "activationGroupDisplayId": "AG-001",
412 "principalPositionType": {
413 "name": "LESSEE",
414 "captionKey": "enum.principalpositiontype.lessee",
415 "caption": "Lessee"
416 },
417 "effectiveDate": "2024-01-01",
418 "costCenterAllocations": [
419 {
420 "id": 10001,
421 "mainCostCenter": true,
422 "allocationPercentage": 75,
423 "costCenter": {
424 "id": 14001,
425 "displayId": "CC-001",
426 "status": {
427 "name": "ACTIVE",
428 "captionKey": "enum.objectStatus.active",
429 "active": true,
430 "caption": "Active"
431 },
432 "name": "Cost Center A",
433 "erpSystemId": 0
434 },
435 "profitCenter": {
436 "id": 9001,
437 "displayId": "PC-001",
438 "status": {
439 "name": "ACTIVE",
440 "captionKey": "enum.objectStatus.active",
441 "active": true,
442 "caption": "Active"
443 },
444 "name": "North Region Profit Center",
445 "validTo": "2025-12-31",
446 "erpSystemId": 101,
447 "erpSystemDisplayId": "SAP-01"
448 }
449 }
450 ],
451 "numberRangeIdentifierValue": "NR-0001",
452 "numberRangeIdentifierType": {
453 "name": "COMPANY_CODE"
454 },
455 "numberRangeType": {
456 "name": "CONTRACT"
457 },
458 "allowsSystemGenerateNewId": true
459 }
460 ],
461 "number": 0,
462 "sort": {
463 "unsorted": false,
464 "sorted": true,
465 "empty": false
466 },
467 "first": true,
468 "last": false,
469 "empty": false
470}
Create Or Update Unit Cost Objects¶
HTTP Request
POST /api/v1/units/cost-objects/createOrUpdate
📋 Description: Creates or updates cost objects associated with leases and contracts within the Nakisa Lease Accounting Suite, ensuring accurate financial obligations and accounting entries are maintained.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
false |
Request body containing the lease and contract details, including financial obligations and accounting entries, for creating or updating cost objects within the Nakisa Lease Accounting Suite. |
Body Parameters
1{
2 "unitId": 10000001,
3 "effectiveDate": "2024-02-01",
4 "allocations": [
5 {
6 "id": 10001,
7 "mainCostCenter": true,
8 "allocationPercentage": 75,
9 "costCenter": {
10 "id": 14001,
11 "displayId": "CC-001",
12 "status": {
13 "name": "ACTIVE",
14 "captionKey": "enum.objectStatus.active",
15 "active": true,
16 "caption": "Active"
17 },
18 "name": "Cost Center A",
19 "erpSystemId": 0
20 },
21 "profitCenter": {
22 "id": 9001,
23 "displayId": "PC-001",
24 "status": {
25 "name": "ACTIVE",
26 "captionKey": "enum.objectStatus.active",
27 "active": true,
28 "caption": "Active"
29 },
30 "name": "North Region Profit Center",
31 "validTo": "2025-12-31",
32 "erpSystemId": 101,
33 "erpSystemDisplayId": "SAP-01"
34 }
35 }
36 ],
37 "workBreakdownStructure": {
38 "id": 1001,
39 "displayId": "WBS-2025-001",
40 "status": {
41 "name": "ACTIVE",
42 "captionKey": "enum.objectStatus.active",
43 "active": true,
44 "caption": "Active"
45 },
46 "name": "Main Project WBS",
47 "erpSystemId": 0
48 },
49 "profitCenter": {
50 "id": 9001,
51 "displayId": "PC-001",
52 "status": {
53 "name": "ACTIVE",
54 "captionKey": "enum.objectStatus.active",
55 "active": true,
56 "caption": "Active"
57 },
58 "name": "North Region Profit Center",
59 "validTo": "2025-12-31",
60 "erpSystemId": 101,
61 "erpSystemDisplayId": "SAP-01"
62 },
63 "costCenter": {
64 "id": 14001,
65 "displayId": "CC-001",
66 "status": {
67 "name": "ACTIVE",
68 "captionKey": "enum.objectStatus.active",
69 "active": true,
70 "caption": "Active"
71 },
72 "name": "Cost Center A",
73 "erpSystemId": 0
74 },
75 "responsibleCostCenter": {
76 "id": 14001,
77 "displayId": "CC-001",
78 "status": {
79 "name": "ACTIVE",
80 "captionKey": "enum.objectStatus.active",
81 "active": true,
82 "caption": "Active"
83 },
84 "name": "Cost Center A",
85 "erpSystemId": 0
86 }
87}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
Successfully created or updated unit cost objects. |
Example Responses
1{
2 "code": "OK",
3 "errors": {
4 "all": []
5 },
6 "object": {}
7}
List All Units¶
HTTP Request
GET /api/v1/units
📋 Description: Retrieves a list of units associated with leases and contracts within the Nakisa Lease Accounting Suite, providing essential data for managing financial obligations and accounting entries.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
false |
Indicates whether the results of the lease units query should be returned in a paginated format, facilitating efficient data retrieval and management of financial obligations within the Nakisa Lease Accounting Suite. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
Successfully retrieved list of units. |
Example Responses
1{
2 "totalElements": 10000001,
3 "totalPages": 15,
4 "pageable": {
5 "pageNumber": 0,
6 "unpaged": false,
7 "paged": true,
8 "pageSize": 100,
9 "offset": 0,
10 "sort": {
11 "unsorted": false,
12 "sorted": true,
13 "empty": false
14 }
15 },
16 "numberOfElements": 10,
17 "size": 10,
18 "content": [
19 {
20 "id": 10000001,
21 "displayId": "UNIT-000123",
22 "name": "Office Printer",
23 "description": "High-speed color printer for main office.",
24 "assetNumber": "A-1001",
25 "referenceId": "REF-2024-001",
26 "serialNumber": "SN12345678",
27 "licenseNumber": "LIC-98765",
28 "inventoryNumber": "INV-55555",
29 "room": "Room 101",
30 "location": "Head Office",
31 "evaluationGroup1": "Group A",
32 "evaluationGroup2": "Group B",
33 "evaluationGroup3": "Group C",
34 "investmentReason": "Replacement of outdated equipment",
35 "typeName": "Printer",
36 "calculateGrossTax": true,
37 "bulkAsset": true,
38 "bulkAssetQuantity": 0,
39 "shippingDate": "2024-01-15",
40 "deliveryDate": "2024-01-20",
41 "receptionDate": "2024-01-21",
42 "activationDate": "2024-01-22",
43 "rouEndDate": "2026-01-22",
44 "erpAssetRetirementDate": "2028-01-01",
45 "state": "UNIT_ACTIVE",
46 "taxCalculationType": "NET",
47 "internalAssetClass": {
48 "id": 10000001,
49 "displayId": "IAC-001",
50 "status": {
51 "name": "ACTIVE",
52 "captionKey": "enum.objectStatus.active",
53 "active": true,
54 "caption": "Active"
55 },
56 "name": "Machinery and Equipment",
57 "assetClassType": "PROPERTY",
58 "infiniteUsefulLife": false
59 },
60 "profitCenter": {
61 "id": 9001,
62 "displayId": "PC-001",
63 "status": {
64 "name": "ACTIVE",
65 "captionKey": "enum.objectStatus.active",
66 "active": true,
67 "caption": "Active"
68 },
69 "name": "North Region Profit Center",
70 "validTo": "2025-12-31",
71 "erpSystemId": 101,
72 "erpSystemDisplayId": "SAP-01"
73 },
74 "workBreakdownStructure": {
75 "id": 1001,
76 "displayId": "WBS-2025-001",
77 "status": {
78 "name": "ACTIVE",
79 "captionKey": "enum.objectStatus.active",
80 "active": true,
81 "caption": "Active"
82 },
83 "name": "Main Project WBS",
84 "erpSystemId": 0
85 },
86 "functionalArea": {
87 "id": 2001,
88 "displayId": "FA-2025-001",
89 "status": {
90 "name": "ACTIVE",
91 "captionKey": "enum.objectStatus.active",
92 "active": true,
93 "caption": "Active"
94 },
95 "name": "Accounting Department",
96 "erpSystemId": 0
97 },
98 "businessArea": {
99 "id": 3001,
100 "displayId": "BA-2025-001",
101 "status": {
102 "name": "ACTIVE",
103 "captionKey": "enum.objectStatus.active",
104 "active": true,
105 "caption": "Active"
106 },
107 "name": "North America Operations",
108 "erpSystemId": 0
109 },
110 "network": {
111 "id": 10001,
112 "displayId": "NET-001",
113 "status": {
114 "name": "ACTIVE",
115 "captionKey": "enum.objectStatus.active",
116 "active": true,
117 "caption": "Active"
118 },
119 "name": "Global Network",
120 "erpSystemId": 0
121 },
122 "segment": {
123 "id": 11001,
124 "displayId": "SEG-001",
125 "status": {
126 "name": "ACTIVE",
127 "captionKey": "enum.objectStatus.active",
128 "active": true,
129 "caption": "Active"
130 },
131 "name": "Segment Alpha",
132 "erpSystemId": 0
133 },
134 "internalOrder": {
135 "id": 10000001,
136 "status": {
137 "name": "ACTIVE",
138 "captionKey": "enum.objectStatus.active",
139 "active": true,
140 "caption": "Active"
141 },
142 "displayId": "IO-2024-001",
143 "erpSystemId": 1001,
144 "erpSystemDisplayId": "SAP-001",
145 "name": "Office Renovation Order",
146 "internalOrderTypeId": 3001,
147 "internalOrderTypeDisplayId": "CAPEX",
148 "controllingAreaId": 4001,
149 "controllingAreaDisplayId": "CA-1001"
150 },
151 "internalOrderType": {
152 "id": 10000001,
153 "status": {
154 "name": "ACTIVE",
155 "captionKey": "enum.objectStatus.active",
156 "active": true,
157 "caption": "Active"
158 },
159 "displayId": "CAPEX",
160 "erpSystemId": 1001,
161 "erpSystemDisplayId": "SAP-001",
162 "name": "Capital Expenditure Orders",
163 "internalOrderId": 20004567
164 },
165 "currency": {
166 "id": 840,
167 "displayId": "USD",
168 "status": {
169 "name": "ACTIVE",
170 "captionKey": "enum.objectStatus.active",
171 "active": true,
172 "caption": "Active"
173 },
174 "name": "United States Dollar",
175 "decimalPoints": 2
176 },
177 "taxCodeForPrincipalPayment": {
178 "id": 5001,
179 "displayId": "TC-001",
180 "status": {
181 "name": "ACTIVE",
182 "captionKey": "enum.objectStatus.active",
183 "active": true,
184 "caption": "Active"
185 },
186 "name": "VAT Standard Rate",
187 "erpSystemId": 0
188 },
189 "taxJurisdictionForPrincipalPayment": {
190 "id": 4001,
191 "displayId": "TJ-2025-001",
192 "status": {
193 "name": "ACTIVE",
194 "captionKey": "enum.objectStatus.active",
195 "active": true,
196 "caption": "Active"
197 },
198 "name": "California Tax Authority",
199 "erpSystemId": 0,
200 "schema": "string",
201 "countryDisplayId": "string"
202 },
203 "taxCodeForInterestPayment": {
204 "id": 5001,
205 "displayId": "TC-001",
206 "status": {
207 "name": "ACTIVE",
208 "captionKey": "enum.objectStatus.active",
209 "active": true,
210 "caption": "Active"
211 },
212 "name": "VAT Standard Rate",
213 "erpSystemId": 0
214 },
215 "taxJurisdictionForInterestPayment": {
216 "id": 4001,
217 "displayId": "TJ-2025-001",
218 "status": {
219 "name": "ACTIVE",
220 "captionKey": "enum.objectStatus.active",
221 "active": true,
222 "caption": "Active"
223 },
224 "name": "California Tax Authority",
225 "erpSystemId": 0,
226 "schema": "string",
227 "countryDisplayId": "string"
228 },
229 "taxCodeForNonLeasePayment": {
230 "id": 5001,
231 "displayId": "TC-001",
232 "status": {
233 "name": "ACTIVE",
234 "captionKey": "enum.objectStatus.active",
235 "active": true,
236 "caption": "Active"
237 },
238 "name": "VAT Standard Rate",
239 "erpSystemId": 0
240 },
241 "taxJurisdictionForNonLeasePayment": {
242 "id": 4001,
243 "displayId": "TJ-2025-001",
244 "status": {
245 "name": "ACTIVE",
246 "captionKey": "enum.objectStatus.active",
247 "active": true,
248 "caption": "Active"
249 },
250 "name": "California Tax Authority",
251 "erpSystemId": 0,
252 "schema": "string",
253 "countryDisplayId": "string"
254 },
255 "costCenter": {
256 "id": 14001,
257 "displayId": "CC-001",
258 "status": {
259 "name": "ACTIVE",
260 "captionKey": "enum.objectStatus.active",
261 "active": true,
262 "caption": "Active"
263 },
264 "name": "Cost Center A",
265 "erpSystemId": 0
266 },
267 "company": {
268 "id": 10000006,
269 "displayId": "1005",
270 "status": {
271 "name": "ACTIVE",
272 "captionKey": "enum.objectStatus.active",
273 "active": true,
274 "caption": "Active"
275 },
276 "erpSystemId": 10000001,
277 "erpSystemDisplayId": "FINQ8S-300",
278 "countryId": 10000095,
279 "countryDisplayId": "CA",
280 "name": "string",
281 "postingPeriodVariantId": 0,
282 "fiscalVariantId": 0
283 },
284 "taxJurisdiction": {
285 "id": 4001,
286 "displayId": "TJ-2025-001",
287 "status": {
288 "name": "ACTIVE",
289 "captionKey": "enum.objectStatus.active",
290 "active": true,
291 "caption": "Active"
292 },
293 "name": "California Tax Authority",
294 "erpSystemId": 0,
295 "schema": "string",
296 "countryDisplayId": "string"
297 },
298 "taxCode": {
299 "id": 5001,
300 "displayId": "TC-001",
301 "status": {
302 "name": "ACTIVE",
303 "captionKey": "enum.objectStatus.active",
304 "active": true,
305 "caption": "Active"
306 },
307 "name": "VAT Standard Rate",
308 "erpSystemId": 0
309 },
310 "responsibleCostCenter": {
311 "id": 14001,
312 "displayId": "CC-001",
313 "status": {
314 "name": "ACTIVE",
315 "captionKey": "enum.objectStatus.active",
316 "active": true,
317 "caption": "Active"
318 },
319 "name": "Cost Center A",
320 "erpSystemId": 0
321 },
322 "plant": {
323 "id": 10000001,
324 "displayId": "PLANT-001",
325 "status": {
326 "name": "ACTIVE",
327 "captionKey": "enum.objectStatus.active",
328 "active": true,
329 "caption": "Active"
330 },
331 "name": "Berlin Manufacturing Plant",
332 "companyId": 7001
333 },
334 "assetCostCenter": {
335 "id": 14001,
336 "displayId": "CC-001",
337 "status": {
338 "name": "ACTIVE",
339 "captionKey": "enum.objectStatus.active",
340 "active": true,
341 "caption": "Active"
342 },
343 "name": "Cost Center A",
344 "erpSystemId": 0
345 },
346 "assetProfitCenter": {
347 "id": 9001,
348 "displayId": "PC-001",
349 "status": {
350 "name": "ACTIVE",
351 "captionKey": "enum.objectStatus.active",
352 "active": true,
353 "caption": "Active"
354 },
355 "name": "North Region Profit Center",
356 "validTo": "2025-12-31",
357 "erpSystemId": 101,
358 "erpSystemDisplayId": "SAP-01"
359 },
360 "assetWorkBreakdownStructure": {
361 "id": 1001,
362 "displayId": "WBS-2025-001",
363 "status": {
364 "name": "ACTIVE",
365 "captionKey": "enum.objectStatus.active",
366 "active": true,
367 "caption": "Active"
368 },
369 "name": "Main Project WBS",
370 "erpSystemId": 0
371 },
372 "assetTaxJurisdiction": {
373 "id": 4001,
374 "displayId": "TJ-2025-001",
375 "status": {
376 "name": "ACTIVE",
377 "captionKey": "enum.objectStatus.active",
378 "active": true,
379 "caption": "Active"
380 },
381 "name": "California Tax Authority",
382 "erpSystemId": 0,
383 "schema": "string",
384 "countryDisplayId": "string"
385 },
386 "assetBusinessArea": {
387 "id": 3001,
388 "displayId": "BA-2025-001",
389 "status": {
390 "name": "ACTIVE",
391 "captionKey": "enum.objectStatus.active",
392 "active": true,
393 "caption": "Active"
394 },
395 "name": "North America Operations",
396 "erpSystemId": 0
397 },
398 "assetSegment": {
399 "id": 11001,
400 "displayId": "SEG-001",
401 "status": {
402 "name": "ACTIVE",
403 "captionKey": "enum.objectStatus.active",
404 "active": true,
405 "caption": "Active"
406 },
407 "name": "Segment Alpha",
408 "erpSystemId": 0
409 },
410 "activationGroupId": 101,
411 "activationGroupDisplayId": "AG-001",
412 "principalPositionType": {
413 "name": "LESSEE",
414 "captionKey": "enum.principalpositiontype.lessee",
415 "caption": "Lessee"
416 },
417 "effectiveDate": "2024-01-01",
418 "costCenterAllocations": [
419 {
420 "id": 10001,
421 "mainCostCenter": true,
422 "allocationPercentage": 75,
423 "costCenter": {
424 "id": 14001,
425 "displayId": "CC-001",
426 "status": {
427 "name": "ACTIVE",
428 "captionKey": "enum.objectStatus.active",
429 "active": true,
430 "caption": "Active"
431 },
432 "name": "Cost Center A",
433 "erpSystemId": 0
434 },
435 "profitCenter": {
436 "id": 9001,
437 "displayId": "PC-001",
438 "status": {
439 "name": "ACTIVE",
440 "captionKey": "enum.objectStatus.active",
441 "active": true,
442 "caption": "Active"
443 },
444 "name": "North Region Profit Center",
445 "validTo": "2025-12-31",
446 "erpSystemId": 101,
447 "erpSystemDisplayId": "SAP-01"
448 }
449 }
450 ],
451 "numberRangeIdentifierValue": "NR-0001",
452 "numberRangeIdentifierType": {
453 "name": "COMPANY_CODE"
454 },
455 "numberRangeType": {
456 "name": "CONTRACT"
457 },
458 "allowsSystemGenerateNewId": true
459 }
460 ],
461 "number": 0,
462 "sort": {
463 "unsorted": false,
464 "sorted": true,
465 "empty": false
466 },
467 "first": true,
468 "last": false,
469 "empty": false
470}
List Unit Cost Objects (Paginated)¶
HTTP Request
GET /api/v1/units/cost-objects/page/{unitId}/{companyId}/{erpSystemId}
📋 Description: Retrieves cost objects associated with a specific unit within the Nakisa Lease Accounting Suite, allowing users to access relevant lease, contract, and financial obligation data for accounting entries based on the provided unit ID, company ID, and ERP system ID.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
unitId |
path |
integer |
true |
Unique identifier for the unit |
companyId |
path |
integer |
true |
Unique identifier for the company |
erpSystemId |
path |
integer |
true |
Unique identifier for the erp system |
pageable |
query |
false |
Indicates whether the response should be paginated, facilitating efficient retrieval of cost object data related to leases and financial obligations within the Nakisa Lease Accounting Suite. |
Example Values¶
Parameter |
Example |
Type |
|---|---|---|
unitId |
|
path |
companyId |
|
path |
erpSystemId |
|
path |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
Successfully retrieved paginated cost objects for the unit. |
Example Responses
1{
2 "totalElements": 75,
3 "totalPages": 8,
4 "pageable": {
5 "pageNumber": 0,
6 "unpaged": false,
7 "paged": true,
8 "pageSize": 100,
9 "offset": 0,
10 "sort": {
11 "unsorted": false,
12 "sorted": true,
13 "empty": false
14 }
15 },
16 "numberOfElements": 10,
17 "size": 10,
18 "content": [
19 {
20 "id": 9001,
21 "effectiveDate": "2024-03-01",
22 "latest": true,
23 "costCenter": {
24 "id": 14001,
25 "displayId": "CC-001",
26 "status": {
27 "name": "ACTIVE",
28 "captionKey": "enum.objectStatus.active",
29 "active": true,
30 "caption": "Active"
31 },
32 "name": "Cost Center A",
33 "erpSystemId": 0
34 },
35 "profitCenter": {
36 "id": 9001,
37 "displayId": "PC-001",
38 "status": {
39 "name": "ACTIVE",
40 "captionKey": "enum.objectStatus.active",
41 "active": true,
42 "caption": "Active"
43 },
44 "name": "North Region Profit Center",
45 "validTo": "2025-12-31",
46 "erpSystemId": 101,
47 "erpSystemDisplayId": "SAP-01"
48 },
49 "responsibleCostCenter": {
50 "id": 14001,
51 "displayId": "CC-001",
52 "status": {
53 "name": "ACTIVE",
54 "captionKey": "enum.objectStatus.active",
55 "active": true,
56 "caption": "Active"
57 },
58 "name": "Cost Center A",
59 "erpSystemId": 0
60 },
61 "workBreakdownStructure": {
62 "id": 1001,
63 "displayId": "WBS-2025-001",
64 "status": {
65 "name": "ACTIVE",
66 "captionKey": "enum.objectStatus.active",
67 "active": true,
68 "caption": "Active"
69 },
70 "name": "Main Project WBS",
71 "erpSystemId": 0
72 },
73 "status": {
74 "name": "ACTIVE",
75 "captionKey": "enum.objectStatus.active",
76 "active": true,
77 "caption": "Active"
78 },
79 "allocations": [
80 {
81 "id": 10001,
82 "mainCostCenter": true,
83 "allocationPercentage": 75,
84 "costCenter": {
85 "id": 14001,
86 "displayId": "CC-001",
87 "status": {
88 "name": "ACTIVE",
89 "captionKey": "enum.objectStatus.active",
90 "active": true,
91 "caption": "Active"
92 },
93 "name": "Cost Center A",
94 "erpSystemId": 0
95 },
96 "profitCenter": {
97 "id": 9001,
98 "displayId": "PC-001",
99 "status": {
100 "name": "ACTIVE",
101 "captionKey": "enum.objectStatus.active",
102 "active": true,
103 "caption": "Active"
104 },
105 "name": "North Region Profit Center",
106 "validTo": "2025-12-31",
107 "erpSystemId": 101,
108 "erpSystemDisplayId": "SAP-01"
109 }
110 }
111 ],
112 "relationId": 56789,
113 "relationDisplayId": "REL-2024-001"
114 }
115 ],
116 "number": 0,
117 "sort": {
118 "unsorted": false,
119 "sorted": true,
120 "empty": false
121 },
122 "first": true,
123 "last": false,
124 "empty": false
125}
Retrieve Latest Unit Cost Object¶
HTTP Request
GET /api/v1/units/cost-objects/latest/{unitId}/{companyId}/{erpSystemId}
📋 Description: Fetches the latest cost object details for a specified unit within a given company and ERP system, facilitating accurate lease and contract management in financial obligations and accounting entries.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
unitId |
path |
integer |
true |
Unique identifier for the unit |
companyId |
path |
integer |
true |
Unique identifier for the company |
erpSystemId |
path |
integer |
true |
Unique identifier for the erp system |
Example Values¶
Parameter |
Example |
Type |
|---|---|---|
unitId |
|
path |
companyId |
|
path |
erpSystemId |
|
path |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
Successfully retrieved the latest cost object assignment for the unit. |
Example Responses
1{
2 "id": 9001,
3 "effectiveDate": "2024-03-01",
4 "latest": true,
5 "costCenter": {
6 "id": 14001,
7 "displayId": "CC-001",
8 "status": {
9 "name": "ACTIVE",
10 "captionKey": "enum.objectStatus.active",
11 "active": true,
12 "caption": "Active"
13 },
14 "name": "Cost Center A",
15 "erpSystemId": 0
16 },
17 "profitCenter": {
18 "id": 9001,
19 "displayId": "PC-001",
20 "status": {
21 "name": "ACTIVE",
22 "captionKey": "enum.objectStatus.active",
23 "active": true,
24 "caption": "Active"
25 },
26 "name": "North Region Profit Center",
27 "validTo": "2025-12-31",
28 "erpSystemId": 101,
29 "erpSystemDisplayId": "SAP-01"
30 },
31 "responsibleCostCenter": {
32 "id": 14001,
33 "displayId": "CC-001",
34 "status": {
35 "name": "ACTIVE",
36 "captionKey": "enum.objectStatus.active",
37 "active": true,
38 "caption": "Active"
39 },
40 "name": "Cost Center A",
41 "erpSystemId": 0
42 },
43 "workBreakdownStructure": {
44 "id": 1001,
45 "displayId": "WBS-2025-001",
46 "status": {
47 "name": "ACTIVE",
48 "captionKey": "enum.objectStatus.active",
49 "active": true,
50 "caption": "Active"
51 },
52 "name": "Main Project WBS",
53 "erpSystemId": 0
54 },
55 "status": {
56 "name": "ACTIVE",
57 "captionKey": "enum.objectStatus.active",
58 "active": true,
59 "caption": "Active"
60 },
61 "allocations": [
62 {
63 "id": 10001,
64 "mainCostCenter": true,
65 "allocationPercentage": 75,
66 "costCenter": {
67 "id": 14001,
68 "displayId": "CC-001",
69 "status": {
70 "name": "ACTIVE",
71 "captionKey": "enum.objectStatus.active",
72 "active": true,
73 "caption": "Active"
74 },
75 "name": "Cost Center A",
76 "erpSystemId": 0
77 },
78 "profitCenter": {
79 "id": 9001,
80 "displayId": "PC-001",
81 "status": {
82 "name": "ACTIVE",
83 "captionKey": "enum.objectStatus.active",
84 "active": true,
85 "caption": "Active"
86 },
87 "name": "North Region Profit Center",
88 "validTo": "2025-12-31",
89 "erpSystemId": 101,
90 "erpSystemDisplayId": "SAP-01"
91 }
92 }
93 ],
94 "relationId": 56789,
95 "relationDisplayId": "REL-2024-001"
96}
Retrieve Initial Data For Unit Cost Object Modification¶
HTTP Request
GET /api/v1/units/cost-objects-modification-initial-data/{unitId}
📋 Description: Retrieves initial data for cost object modifications associated with a specified unit, facilitating effective management of lease-related financial obligations and accounting entries within the Nakisa Lease Accounting Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
unitId |
path |
integer |
true |
Unique identifier for the unit |
Example Values¶
Parameter |
Example |
Type |
|---|---|---|
unitId |
|
path |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
Successfully retrieved initial cost object modification data for the unit. |
Example Responses
1{
2 "code": "OK",
3 "errors": {
4 "all": []
5 },
6 "object": {
7 "effectiveDateUpperLimit": "2025-12-31",
8 "effectiveDateLowerLimit": "2024-01-01",
9 "costCenterAllocations": [
10 {
11 "id": 10001,
12 "mainCostCenter": true,
13 "allocationPercentage": 75,
14 "costCenter": {
15 "id": 14001,
16 "displayId": "CC-001",
17 "status": {
18 "name": "ACTIVE",
19 "captionKey": "enum.objectStatus.active",
20 "active": true,
21 "caption": "Active"
22 },
23 "name": "Cost Center A",
24 "erpSystemId": 0
25 },
26 "profitCenter": {
27 "id": 9001,
28 "displayId": "PC-001",
29 "status": {
30 "name": "ACTIVE",
31 "captionKey": "enum.objectStatus.active",
32 "active": true,
33 "caption": "Active"
34 },
35 "name": "North Region Profit Center",
36 "validTo": "2025-12-31",
37 "erpSystemId": 101,
38 "erpSystemDisplayId": "SAP-01"
39 }
40 }
41 ],
42 "unit": {
43 "id": 10000001,
44 "displayId": "UNIT-10000001",
45 "name": "Office Laptop",
46 "description": "Laptop issued to employee",
47 "assetNumber": "A-123456",
48 "referenceId": "REF-001",
49 "serialNumber": "SN-987654321",
50 "licenseNumber": "LIC-2025-001",
51 "inventoryNumber": "INV-2025-001",
52 "room": "Room 101",
53 "location": "Head Office",
54 "evaluationGroup1": "EG1",
55 "evaluationGroup2": "EG2",
56 "evaluationGroup3": "EG3",
57 "investmentReason": "New Employee Onboarding",
58 "typeName": "Laptop",
59 "calculateGrossTax": true,
60 "shippingDate": "2025-01-01",
61 "deliveryDate": "2025-01-03",
62 "receptionDate": "2025-01-03",
63 "activationDate": "2025-01-05",
64 "rouEndDate": "2026-01-01",
65 "erpAssetRetirementDate": "2030-12-31",
66 "state": "UNIT_ACTIVE",
67 "activationGroupId": 10000001,
68 "activationGroupDisplayId": "AG-10000001",
69 "principalPositionType": {
70 "name": "LESSEE",
71 "captionKey": "enum.principalpositiontype.lessee",
72 "caption": "Lessee"
73 },
74 "internalAssetClass": {
75 "id": 10000001,
76 "displayId": "IAC-001",
77 "status": {
78 "name": "ACTIVE",
79 "captionKey": "enum.objectStatus.active",
80 "active": true,
81 "caption": "Active"
82 },
83 "name": "Machinery and Equipment",
84 "assetClassType": "PROPERTY",
85 "infiniteUsefulLife": false
86 },
87 "costCenterAllocations": [
88 {
89 "id": 10001,
90 "mainCostCenter": true,
91 "allocationPercentage": 75,
92 "costCenter": {
93 "id": 14001,
94 "displayId": "CC-001",
95 "status": {
96 "name": "ACTIVE",
97 "captionKey": "enum.objectStatus.active",
98 "active": true,
99 "caption": "Active"
100 },
101 "name": "Cost Center A",
102 "erpSystemId": 0
103 },
104 "profitCenter": {
105 "id": 9001,
106 "displayId": "PC-001",
107 "status": {
108 "name": "ACTIVE",
109 "captionKey": "enum.objectStatus.active",
110 "active": true,
111 "caption": "Active"
112 },
113 "name": "North Region Profit Center",
114 "validTo": "2025-12-31",
115 "erpSystemId": 101,
116 "erpSystemDisplayId": "SAP-01"
117 }
118 }
119 ],
120 "numberRangeIdentifierValue": "1000",
121 "numberRangeIdentifierType": {
122 "name": "COMPANY_CODE"
123 },
124 "numberRangeType": {
125 "name": "CONTRACT"
126 },
127 "allowsSystemGenerateNewId": false
128 }
129 }
130}