UnitDto

Example Json Object

  1{
  2  "id": 0,
  3  "displayId": "string",
  4  "name": "string",
  5  "description": "string",
  6  "assetNumber": "string",
  7  "referenceId": "string",
  8  "serialNumber": "string",
  9  "licenseNumber": "string",
 10  "inventoryNumber": "string",
 11  "room": "string",
 12  "location": "string",
 13  "evaluationGroup1": "string",
 14  "evaluationGroup2": "string",
 15  "evaluationGroup3": "string",
 16  "investmentReason": "string",
 17  "typeName": "string",
 18  "calculateGrossTax": true,
 19  "bulkAsset": true,
 20  "bulkAssetQuantity": 0,
 21  "shippingDate": "2019-08-24",
 22  "deliveryDate": "2019-08-24",
 23  "receptionDate": "2019-08-24",
 24  "activationDate": "2019-08-24",
 25  "rouEndDate": "2019-08-24",
 26  "erpAssetRetirementDate": "2019-08-24",
 27  "state": "MLA_DEFINE",
 28  "taxCalculationType": "NET",
 29  "internalAssetClass": {
 30    "id": 0,
 31    "displayId": "string",
 32    "status": "CREATED",
 33    "name": "string",
 34    "assetClassType": "PROPERTY",
 35    "infiniteUsefulLife": true
 36  },
 37  "profitCenter": {
 38    "id": 0,
 39    "displayId": "string",
 40    "status": "CREATED",
 41    "name": "string",
 42    "validTo": "2019-08-24",
 43    "erpSystemId": 0,
 44    "erpSystemDisplayId": "string"
 45  },
 46  "workBreakdownStructure": {
 47    "id": 0,
 48    "displayId": "string",
 49    "status": "CREATED",
 50    "name": "string",
 51    "erpSystemId": 0
 52  },
 53  "functionalArea": {
 54    "id": 0,
 55    "displayId": "string",
 56    "status": "CREATED",
 57    "name": "string",
 58    "erpSystemId": 0
 59  },
 60  "businessArea": {
 61    "id": 0,
 62    "displayId": "string",
 63    "status": "CREATED",
 64    "name": "string",
 65    "erpSystemId": 0
 66  },
 67  "network": {
 68    "id": 0,
 69    "displayId": "string",
 70    "status": "CREATED",
 71    "name": "string",
 72    "erpSystemId": 0
 73  },
 74  "segment": {
 75    "id": 0,
 76    "displayId": "string",
 77    "status": "CREATED",
 78    "name": "string",
 79    "erpSystemId": 0
 80  },
 81  "internalOrder": {
 82    "id": 0,
 83    "status": "CREATED",
 84    "displayId": "string",
 85    "erpSystemId": 0,
 86    "erpSystemDisplayId": "string",
 87    "name": "string",
 88    "internalOrderTypeId": 0,
 89    "internalOrderTypeDisplayId": "string",
 90    "controllingAreaId": 0,
 91    "controllingAreaDisplayId": "string"
 92  },
 93  "internalOrderType": {
 94    "id": 0,
 95    "status": "CREATED",
 96    "displayId": "string",
 97    "erpSystemId": 0,
 98    "erpSystemDisplayId": "string",
 99    "name": "string",
100    "internalOrderId": 0
101  },
102  "currency": {
103    "id": 0,
104    "displayId": "string",
105    "status": "CREATED",
106    "name": "string",
107    "decimalPoints": 0
108  },
109  "taxCodeForPrincipalPayment": {
110    "id": 0,
111    "displayId": "string",
112    "status": "CREATED",
113    "name": "string",
114    "erpSystemId": 0
115  },
116  "taxJurisdictionForPrincipalPayment": {
117    "id": 0,
118    "displayId": "string",
119    "status": "CREATED",
120    "name": "string",
121    "erpSystemId": 0,
122    "schema": "string",
123    "countryDisplayId": "string"
124  },
125  "taxCodeForInterestPayment": {
126    "id": 0,
127    "displayId": "string",
128    "status": "CREATED",
129    "name": "string",
130    "erpSystemId": 0
131  },
132  "taxJurisdictionForInterestPayment": {
133    "id": 0,
134    "displayId": "string",
135    "status": "CREATED",
136    "name": "string",
137    "erpSystemId": 0,
138    "schema": "string",
139    "countryDisplayId": "string"
140  },
141  "taxCodeForNonLeasePayment": {
142    "id": 0,
143    "displayId": "string",
144    "status": "CREATED",
145    "name": "string",
146    "erpSystemId": 0
147  },
148  "taxJurisdictionForNonLeasePayment": {
149    "id": 0,
150    "displayId": "string",
151    "status": "CREATED",
152    "name": "string",
153    "erpSystemId": 0,
154    "schema": "string",
155    "countryDisplayId": "string"
156  },
157  "costCenter": {
158    "id": 0,
159    "displayId": "string",
160    "status": "CREATED",
161    "name": "string",
162    "erpSystemId": 0
163  },
164  "company": {
165    "id": 0,
166    "displayId": "string",
167    "status": "CREATED",
168    "erpSystemId": 0,
169    "erpSystemDisplayId": "string",
170    "countryId": 0,
171    "countryDisplayId": "string",
172    "name": "string",
173    "postingPeriodVariantId": 0,
174    "fiscalVariantId": 0
175  },
176  "taxJurisdiction": {
177    "id": 0,
178    "displayId": "string",
179    "status": "CREATED",
180    "name": "string",
181    "erpSystemId": 0,
182    "schema": "string",
183    "countryDisplayId": "string"
184  },
185  "taxCode": {
186    "id": 0,
187    "displayId": "string",
188    "status": "CREATED",
189    "name": "string",
190    "erpSystemId": 0
191  },
192  "responsibleCostCenter": {
193    "id": 0,
194    "displayId": "string",
195    "status": "CREATED",
196    "name": "string",
197    "erpSystemId": 0
198  },
199  "plant": {
200    "id": 0,
201    "displayId": "string",
202    "status": "CREATED",
203    "name": "string",
204    "companyId": 0
205  },
206  "assetCostCenter": {
207    "id": 0,
208    "displayId": "string",
209    "status": "CREATED",
210    "name": "string",
211    "erpSystemId": 0
212  },
213  "assetProfitCenter": {
214    "id": 0,
215    "displayId": "string",
216    "status": "CREATED",
217    "name": "string",
218    "validTo": "2019-08-24",
219    "erpSystemId": 0,
220    "erpSystemDisplayId": "string"
221  },
222  "assetWorkBreakdownStructure": {
223    "id": 0,
224    "displayId": "string",
225    "status": "CREATED",
226    "name": "string",
227    "erpSystemId": 0
228  },
229  "assetTaxJurisdiction": {
230    "id": 0,
231    "displayId": "string",
232    "status": "CREATED",
233    "name": "string",
234    "erpSystemId": 0,
235    "schema": "string",
236    "countryDisplayId": "string"
237  },
238  "assetBusinessArea": {
239    "id": 0,
240    "displayId": "string",
241    "status": "CREATED",
242    "name": "string",
243    "erpSystemId": 0
244  },
245  "assetSegment": {
246    "id": 0,
247    "displayId": "string",
248    "status": "CREATED",
249    "name": "string",
250    "erpSystemId": 0
251  },
252  "activationGroupId": 0,
253  "activationGroupDisplayId": "string",
254  "principalPositionType": "LESSEE",
255  "effectiveDate": "2019-08-24",
256  "costCenterAllocations": [
257    {
258      "id": 0,
259      "mainCostCenter": true,
260      "allocationPercentage": 0.1,
261      "costCenter": {
262        "id": 0,
263        "displayId": "string",
264        "status": "CREATED",
265        "name": "string",
266        "erpSystemId": 0
267      },
268      "profitCenter": {
269        "id": 0,
270        "displayId": "string",
271        "status": "CREATED",
272        "name": "string",
273        "validTo": "2019-08-24",
274        "erpSystemId": 0,
275        "erpSystemDisplayId": "string"
276      }
277    }
278  ],
279  "numberRangeIdentifierType": {
280    "name": "string"
281  },
282  "numberRangeIdentifierValue": "string",
283  "numberRangeType": {
284    "name": "string"
285  },
286  "allowsSystemGenerateNewId": true
287}

📄 Description: Data transfer object representing a unit within the Nakisa Portfolio Management Suite, encapsulating key details related to portfolio, asset, and analytics for real estate properties.

Properties

Name

Type

Required

Restrictions

Description

id

integer(int64)

false

none

Unique identifier for the resource

displayId

string

false

none

Unique identifier for the display

name

string

false

none

Name of the resource

description

string

false

none

Description of the resource

assetNumber

string

false

none

Unique identifier for each asset within the Nakisa Portfolio Management Suite, facilitating efficient tracking and management of real estate properties in portfolio analytics.

referenceId

string

false

none

Unique identifier for the reference

serialNumber

string

false

none

Unique identifier for each asset within the Nakisa Portfolio Management Suite, facilitating effective tracking and management of real estate properties and portfolio analytics.

licenseNumber

string

false

none

Unique identifier for the license associated with a real estate property within the Nakisa Portfolio Management Suite, facilitating asset tracking and portfolio analytics.

inventoryNumber

string

false

none

Unique identifier for the asset within the Nakisa Portfolio Management Suite, facilitating efficient tracking and management of real estate properties in the portfolio.

room

string

false

none

Represents the designated room associated with a real estate property within the Nakisa Portfolio Management Suite, facilitating effective portfolio and asset management.

location

string

false

none

Specifies the geographical location of the real estate property within the portfolio, facilitating asset management and analytics in the Nakisa Portfolio Management Suite.

evaluationGroup1

string

false

none

Identifier for the first evaluation group associated with portfolio analytics and asset management within the Nakisa Portfolio Management Suite.

evaluationGroup2

string

false

none

Identifier for the second evaluation group associated with portfolio analytics and asset management within the Nakisa Portfolio Management Suite.

evaluationGroup3

string

false

none

Identifier for the third evaluation group within the Nakisa Portfolio Management Suite, used to categorize and analyze real estate property assets in portfolio analytics.

investmentReason

string

false

none

Specifies the rationale behind an investment decision within the Nakisa Portfolio Management Suite, providing critical insights for portfolio, asset, and real estate property analytics.

typeName

string

false

none

Name of the type

calculateGrossTax

boolean

false

none

Boolean flag indicating calculateGrossTax status

bulkAsset

boolean

false

none

none

bulkAssetQuantity

integer(int64)

false

none

none

shippingDate

string(date)

false

none

Date of the shipping

deliveryDate

string(date)

false

none

Date of the delivery

receptionDate

string(date)

false

none

Date of the reception

activationDate

string(date)

false

none

Date of the activation

rouEndDate

string(date)

false

none

Date of the rou end

erpAssetRetirementDate

string(date)

false

none

Date of the erp asset retirement

state

string

false

none

Current state of the portfolio

taxCalculationType

string

false

none

Type of the tax calculation

internalAssetClass

InternalAssetClassLite

false

none

Value for internalAssetClass field

profitCenter

ProfitCenterLite

false

none

Value for profitCenter field

workBreakdownStructure

WorkBreakdownStructureLite

false

none

Value for workBreakdownStructure field

functionalArea

FunctionalAreaLite

false

none

Value for functionalArea field

businessArea

BusinessAreaLite

false

none

Value for businessArea field

network

NetworkLite

false

none

Value for network field

segment

SegmentLite

false

none

Value for segment field

internalOrder

InternalOrderDto

false

none

Value for internalOrder field

internalOrderType

InternalOrderTypeDto

false

none

Type of the internal order

currency

CurrencyLite

false

none

Value for currency field

taxCodeForPrincipalPayment

TaxCodeLite

false

none

Value for taxCodeForPrincipalPayment field

taxJurisdictionForPrincipalPayment

TaxJurisdictionLite

false

none

Value for taxJurisdictionForPrincipalPayment field

taxCodeForInterestPayment

TaxCodeLite

false

none

Value for taxCodeForInterestPayment field

taxJurisdictionForInterestPayment

TaxJurisdictionLite

false

none

Value for taxJurisdictionForInterestPayment field

taxCodeForNonLeasePayment

TaxCodeLite

false

none

Value for taxCodeForNonLeasePayment field

taxJurisdictionForNonLeasePayment

TaxJurisdictionLite

false

none

Value for taxJurisdictionForNonLeasePayment field

costCenter

CostCenterLite

false

none

Value for costCenter field

company

CompanyLite

false

none

Value for company field

taxJurisdiction

TaxJurisdictionLite

false

none

Value for taxJurisdiction field

taxCode

TaxCodeLite

false

none

Code for the tax

responsibleCostCenter

CostCenterLite

false

none

Value for responsibleCostCenter field

plant

PlantLite

false

none

Value for plant field

assetCostCenter

CostCenterLite

false

none

Value for assetCostCenter field

assetProfitCenter

ProfitCenterLite

false

none

Value for assetProfitCenter field

assetWorkBreakdownStructure

WorkBreakdownStructureLite

false

none

Value for assetWorkBreakdownStructure field

assetTaxJurisdiction

TaxJurisdictionLite

false

none

Value for assetTaxJurisdiction field

assetBusinessArea

BusinessAreaLite

false

none

Value for assetBusinessArea field

assetSegment

SegmentLite

false

none

Value for assetSegment field

activationGroupId

integer(int64)

false

none

Unique identifier for the activation group

activationGroupDisplayId

string

false

none

Unique identifier for the activation group display

principalPositionType

string

false

none

Type of the principal position

effectiveDate

string(date)

false

none

Date of the effective

costCenterAllocations

[CostCenterAllocationsItemDto]

false

none

List of costCenterAllocations items

numberRangeIdentifierType

INumberRangeIdentifierType

false

none

Type of the number range identifier

numberRangeIdentifierValue

string

false

none

Represents a unique string value that identifies a specific range of numbers associated with assets within the Nakisa Portfolio Management Suite, facilitating effective portfolio and real estate property analytics.

numberRangeType

INumberRangeType

false

none

Type of the number range

allowsSystemGenerateNewId

boolean

false

none

Unique identifier for the allows system generate new

Enumerated Values

Attribute

Value

principalPositionType

LESSEE, LESSOR

state

AG_ACTIVATING, AG_ACTIVE, AG_CLASSIFIED, AG_CLOSED, AG_CLOSING, AG_DEFINE, AG_GENERATING_SCHEDULE, AG_GENERATING_SCHEDULE_2, AG_INACTIVE, AG_LEASE_END, AG_LEASE_ENDING, AG_PENDING_ASSESSMENT, AG_PENDING_CLASSIFICATION, AG_RECLOSE, AG_REJECTED, AG_REPROCESS, AG_REVERSING, AG_REVERTED, AG_REVERTING, AG_REVISION, AG_SPLITTING, CONTRACT_ACTIVE, CONTRACT_CLOSED, CONTRACT_DEFINE, CONTRACT_REJECTED, CONTRACT_REVISION, CONTRACT_WAITING_FOR_APPROVAL, LC_ACTIVATING, LC_ACTIVE, LC_CLOSED, LC_DEFINE, LC_REJECTED, LC_REVISION, LC_WAITING_FOR_APPROVAL, MLA_ACTIVE, MLA_CLOSED, MLA_DEFINE, MLA_DISCARDED, MLA_WAITING_FOR_APPROVAL, UNIT_ACTIVE, UNIT_CASUALTY, UNIT_DELIVERED, UNIT_DRAFT, UNIT_INITIAL, UNIT_PURCHASED, UNIT_REACQUIRED, UNIT_RECEIVED, UNIT_RELINQUISHED, UNIT_RETURNED, UNIT_SHIPPED

taxCalculationType

NET