CPI Mass Indexation

Get CPI Mass Indexation

HTTP Request

GET /api/cpi-mass-indexations/{id}

📋 Description: Fetches detailed information about a specific mass indexation event within the Nakisa Portfolio Management Suite, enabling users to analyze its impact on portfolio and asset performance in real estate properties.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

200

OK

OK

CpiMassIndexationDto

Update CPI Mass Indexation

HTTP Request

PUT /api/cpi-mass-indexations/{id}

📋 Description: Updates the mass indexation details for a specified asset within the Nakisa Portfolio Management Suite, enabling accurate portfolio analytics and real estate property management.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

body

body

CpiMassIndexationDto

true

Request body containing the updated mass indexation details for a specific asset, including portfolio identifiers, valuation metrics, and relevant analytics for real estate property management.

Responses

Status

Meaning

Description

Schema

200

OK

OK

CpiMassIndexationDto

Delete CPI Mass Indexation

HTTP Request

DELETE /api/cpi-mass-indexations/{id}

📋 Description: Deletes a specified mass indexation entry from the Nakisa Portfolio Management Suite, facilitating the management of portfolio and asset data within real estate property analytics.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

204

No Content

No Content

None

Get CPI Mass Indexations

HTTP Request

GET /api/cpi-mass-indexations

📋 Description: Retrieves mass indexation data for real estate properties within the portfolio, enabling users to analyze asset performance and make informed investment decisions.

Parameters

Name

In

Type

Required

Description

pageable

query

Pageable

true

Indicates whether the results of the portfolio mass indexations query should be returned in a paginated format, facilitating efficient data retrieval and analysis within the Nakisa Portfolio Management Suite.

search

query

string

false

Search term used to filter and retrieve specific portfolio, asset, or real estate property analytics from the CPI mass indexations data.

name

query

string

false

Name of the resource

description

query

string

false

Description of the resource

status-id

query

string

false

Unique identifier for the status of mass indexations within the Nakisa Portfolio Management Suite, facilitating efficient tracking and analytics of portfolio and asset performance in real estate properties.

status-id-is-not

query

string

false

Specifies a status identifier to exclude from the results when retrieving mass indexation data for portfolios and assets within the Nakisa Portfolio Management Suite.

Responses

Status

Meaning

Description

Schema

200

OK

OK

PagedModelEntityModelCpiMassIndexationDto

Create CPI Mass Indexations

HTTP Request

POST /api/cpi-mass-indexations

📋 Description: Initiates mass indexation processes for real estate properties within the Nakisa Portfolio Management Suite, enabling efficient updates to asset valuations and analytics across portfolios.

Parameters

Name

In

Type

Required

Description

body

body

CpiMassIndexationDto

true

Request body containing the mass indexation data for real estate properties, including portfolio identifiers and relevant asset metrics for analytical processing.

Responses

Status

Meaning

Description

Schema

201

Created

Created

Inline

Response Schema

Status Code 201

Name

Type

Required

Restrictions

Description

anonymous

[CpiMassIndexationDto]

false

none

[CpiMassIndexationDto is a data transfer object that encapsulates the details of mass indexation adjustments for assets within the Nakisa Portfolio Management Suite, facilitating analytics and portfolio management for real estate properties.]

» createdBy

string

false

none

Username of who created this resource

» lastModifiedBy

string

false

none

Username of who last modified this resource

» createdDate

string(date-time)

false

none

Date of the created

» lastModifiedDate

string(date-time)

false

none

Date of the last modified

» archived

boolean

false

none

Boolean flag indicating archived status

» externalId

string

false

none

Unique identifier for the external

» id

integer(int64)

false

none

Unique identifier for the resource

» name

string

true

none

Name of the resource

» description

string

false

none

Description of the resource

» statusId

integer(int64)

false

none

Unique identifier for the status

» preparedBy

string

false

none

Text value for preparedBy in CpiMassIndexationDto

» preparedDate

string(date)

false

none

Date of the prepared

» executedBy

string

false

none

Text value for executedBy in CpiMassIndexationDto

» executedDate

string(date)

false

none

Date of the executed

» generateJobId

integer(int64)

false

none

Unique identifier for the generate job

» numberOfItemsToProcess

integer(int64)

false

none

Numeric value representing numberOfItemsToProcess

» numberOfItemsProcessed

integer(int64)

false

none

Numeric value representing numberOfItemsProcessed

» cpiLeaseIndexationPreviewIdsToIndex

[integer]

false

none

List of cpiLeaseIndexationPreviewIdsToIndex items

» cpiLeasesProfileFilterIds

[integer]

false

none

List of cpiLeasesProfileFilterIds items

» status

PickListOptionDto

false

none

Data transfer object representing an option within a pick list, utilized for categorizing and managing portfolio assets and analytics in the Nakisa Portfolio Management Suite, particularly in the context of real estate property management.

»» createdBy

string

false

none

Username of who created this resource

»» lastModifiedBy

string

false

none

Username of who last modified this resource

»» createdDate

string(date-time)

false

none

Date of the created

»» lastModifiedDate

string(date-time)

false

none

Date of the last modified

»» archived

boolean

false

none

Boolean flag indicating archived status

»» externalId

string

false

none

Unique identifier for the external

»» id

integer(int64)

false

none

Unique identifier for the resource

»» priority

integer(int64)

false

none

Priority of the resource

»» internalId

integer(int64)

false

none

Unique identifier for the internal

»» pickListCode

string

false

none

Code for the pick list

»» pickListLabel

string

false

none

Label for the pick list

»» label

string

false

none

Label for the resource

»» cultureId

integer(int64)

false

none

Unique identifier for the culture

»» labelDtos

[LabelDto]

false

none

List of labelDtos items

»»» createdBy

string

false

none

Username of who created this resource

»»» lastModifiedBy

string

false

none

Username of who last modified this resource

»»» createdDate

string(date-time)

false

none

Date of the created

»»» lastModifiedDate

string(date-time)

false

none

Date of the last modified

»»» archived

boolean

false

none

Boolean flag indicating archived status

»»» externalId

string

false

none

Unique identifier for the external

»»» id

integer(int64)

false

none

Unique identifier for the resource

»»» cultureId

integer(int64)

false

none

Unique identifier for the culture

»»» value

string

true

none

Text value for value in LabelDto

» cpiLeasesProfileFilters

[MassProfileFilterDto]

false

none

List of cpiLeasesProfileFilters items

»» createdBy

string

false

none

none

»» lastModifiedBy

string

false

none

none

»» createdDate

string(date-time)

false

none

none

»» lastModifiedDate

string(date-time)

false

none

none

»» archived

boolean

false

none

none

»» externalId

string

false

none

none

»» id

integer(int64)

false

none

none

»» name

string

false

none

none

»» description

string

false

none

none

»» leaseList

boolean

false

none

none

»» leaseIds

[integer]

false

none

none

»» validFrom

string(date)

false

none

none

»» validTo

string(date)

false

none

none

»» cityIds

[integer]

false

none

none

»» provinceIds

[integer]

false

none

none

»» countryIds

[integer]

false

none

none

»» premiseIds

[integer]

false

none

none

»» locationIds

[integer]

false

none

none

»» businessUnitIds

[integer]

false

none

none

»» legalEntityIds

[integer]

false

none

none

»» groupIds

[string]

false

none

none

»» groupOptionIds

[integer]

false

none

none

»» masterAgreementIds

[integer]

false

none

none

»» contractIds

[integer]

false

none

none

»» statusIds

[integer]

false

none

none

»» cities

[CityDto]

false

none

[Data transfer object representing a city within the Nakisa Portfolio Management Suite, encapsulating essential information related to portfolio, asset management, and analytics for real estate properties.]

»»» createdBy

string

false

none

Username of who created this resource

»»» lastModifiedBy

string

false

none

Username of who last modified this resource

»»» createdDate

string(date-time)

false

none

Date of the created

»»» lastModifiedDate

string(date-time)

false

none

Date of the last modified

»»» archived

boolean

false

none

Boolean flag indicating archived status

»»» externalId

string

false

none

Unique identifier for the external

»»» id

integer(int64)

false

none

Unique identifier for the resource

»»» name

string

true

none

Name of the resource

»»» province

ProvinceDto

false

none

Data transfer object representing a province within the Nakisa Portfolio Management Suite, encapsulating essential information for portfolio analysis, asset management, and real estate property analytics.

»»»» createdBy

string

false

none

Username of who created this resource

»»»» lastModifiedBy

string

false

none

Username of who last modified this resource

»»»» createdDate

string(date-time)

false

none

Date of the created

»»»» lastModifiedDate

string(date-time)

false

none

Date of the last modified

»»»» archived

boolean

false

none

Boolean flag indicating archived status

»»»» externalId

string

false

none

Unique identifier for the external

»»»» id

integer(int64)

false

none

Unique identifier for the resource

»»»» name

string

true

none

Name of the resource

»»»» country

CountryDto

false

none

Data transfer object representing a country within the Nakisa Portfolio Management Suite, providing essential information for portfolio analysis, asset management, and real estate property evaluations.

»»»»» createdBy

string

false

none

Username of who created this resource

»»»»» lastModifiedBy

string

false

none

Username of who last modified this resource

»»»»» createdDate

string(date-time)

false

none

Date of the created

»»»»» lastModifiedDate

string(date-time)

false

none

Date of the last modified

»»»»» archived

boolean

false

none

Boolean flag indicating archived status

»»»»» externalId

string

false

none

Unique identifier for the external

»»»»» id

integer(int64)

false

none

Unique identifier for the resource

»»»»» name

string

true

none

Name of the resource

»»»»» code

string

false

none

Code identifier for the resource

»»»» code

string

false

none

Code identifier for the resource

»»»» countryId

integer(int64)

true

none

Unique identifier for the country

»»» provinceId

integer(int64)

true

none

Unique identifier for the province

»» provinces

[ProvinceDto]

false

none

[Data transfer object representing a province within the Nakisa Portfolio Management Suite, encapsulating essential information for portfolio analysis, asset management, and real estate property analytics.]

»» countries

[CountryDto]

false

none

[Data transfer object representing a country within the Nakisa Portfolio Management Suite, providing essential information for portfolio analysis, asset management, and real estate property evaluations.]

»» locations

[LocationDto]

false

none

[Data transfer object representing a location within the Nakisa Portfolio Management Suite, encapsulating essential details related to real estate properties, assets, and portfolio analytics.]

»»» createdBy

string

false

none

Username of who created this resource

»»» lastModifiedBy

string

false

none

Username of who last modified this resource

»»» createdDate

string(date-time)

false

none

Date of the created

»»» lastModifiedDate

string(date-time)

false

none

Date of the last modified

»»» archived

boolean

false

none

Boolean flag indicating archived status

»»» externalId

string

false

none

Unique identifier for the external

»»» id

integer(int64)

false

none

Unique identifier for the resource

»»» number

string

false

none

Text value for number in LocationDto

»»» name

string

true

none

Name of the resource

»»» storeNumber

string

true

none

Text value for storeNumber in LocationDto

»»» defaultCurrencyId

integer(int64)

true

none

Unique identifier for the default currency

»»» defaultMeasureId

integer(int64)

true

none

Unique identifier for the default measure

»»» typeId

integer(int64)

true

none

Unique identifier for the type

»»» qualityId

integer(int64)

false

none

Unique identifier for the quality

»»» propertyTypeId

integer(int64)

false

none

Unique identifier for the property type

»»» categoryId

integer(int64)

false

none

Unique identifier for the category

»»» statusId

integer(int64)

false

none

Unique identifier for the status

»»» businessUnitId

integer(int64)

false

none

Unique identifier for the business unit

»»» groupIds

[integer]

false

none

List of groupIds items

»»» legalEntityIds

[integer]

false

none

List of legalEntityIds items

»»» defaultCurrency

CurrencyDto

false

none

Data transfer object representing currency details utilized within the Nakisa Portfolio Management Suite, facilitating accurate financial analysis and reporting for portfolio, asset, and real estate property management.

»»»» id

integer(int64)

false

none

Unique identifier for the resource

»»»» status

string

false

none

Status of the resource

»»»» displayId

string

true

none

Unique identifier for the display

»»»» erpSystemId

integer(int64)

false

none

Unique identifier for the erp system

»»»» erpSystemDisplayId

string

false

none

Unique identifier for the erp system display

»»»» name

string

false

none

Name of the resource

»»»» decimalPoints

integer(int32)

true

none

Numeric value representing decimalPoints

»»»» depreciationAreaId

integer(int64)

false

none

Unique identifier for the depreciation area

»»» defaultUnitValue

UnitDefaultValueDto

false

none

Data transfer object representing the default values for units within the Nakisa Portfolio Management Suite, facilitating effective portfolio and asset analytics for real estate properties.

»»»» createdBy

string

false

none

Username of who created this resource

»»»» lastModifiedBy

string

false

none

Username of who last modified this resource

»»»» createdDate

string(date-time)

false

none

Date of the created

»»»» lastModifiedDate

string(date-time)

false

none

Date of the last modified

»»»» archived

boolean

false

none

Boolean flag indicating archived status

»»»» externalId

string

false

none

Unique identifier for the external

»»»» id

integer(int64)

false

none

Unique identifier for the resource

»»»» unitId

integer(int64)

false

none

Unique identifier for the unit

»»»» unitOfMeasureId

integer(int64)

false

none

Unique identifier for the unit of measure

»»»» erpSystemId

integer(int64)

false

none

Unique identifier for the erp system

»»»» unit

PickListOptionDto

false

none

Data transfer object representing an option within a pick list, utilized for categorizing and managing portfolio assets and analytics in the Nakisa Portfolio Management Suite, particularly in the context of real estate property management.

»»»» unitOfMeasure

UnitOfMeasureDto

false

none

Data transfer object representing the unit of measure utilized within the Nakisa Portfolio Management Suite, essential for accurately quantifying and analyzing assets in the context of portfolio management and real estate property analytics.

»»»»» id

integer(int64)

false

none

Unique identifier for the resource

»»»»» status

string

false

none

Status of the resource

»»»»» displayId

string

true

none

Unique identifier for the display

»»»»» erpSystemId

integer(int64)

false

none

Unique identifier for the erp system

»»»»» erpSystemDisplayId

string

false

none

Unique identifier for the erp system display

»»»»» name

string

false

none

Name of the resource

»»» type

PickListOptionDto

false

none

Data transfer object representing an option within a pick list, utilized for categorizing and managing portfolio assets and analytics in the Nakisa Portfolio Management Suite, particularly in the context of real estate property management.

»»» quality

PickListOptionDto

false

none

Data transfer object representing an option within a pick list, utilized for categorizing and managing portfolio assets and analytics in the Nakisa Portfolio Management Suite, particularly in the context of real estate property management.

»»» propertyType

PickListOptionDto

false

none

Data transfer object representing an option within a pick list, utilized for categorizing and managing portfolio assets and analytics in the Nakisa Portfolio Management Suite, particularly in the context of real estate property management.

»»» category

PickListOptionDto

false

none

Data transfer object representing an option within a pick list, utilized for categorizing and managing portfolio assets and analytics in the Nakisa Portfolio Management Suite, particularly in the context of real estate property management.

»»» status

PickListOptionDto

false

none

Data transfer object representing an option within a pick list, utilized for categorizing and managing portfolio assets and analytics in the Nakisa Portfolio Management Suite, particularly in the context of real estate property management.

»»» addressDto

AddressDto

true

none

Data transfer object representing the address details associated with real estate properties within the Nakisa Portfolio Management Suite, facilitating accurate portfolio and asset analytics.

»»»» createdBy

string

false

none

Username of who created this resource

»»»» lastModifiedBy

string

false

none

Username of who last modified this resource

»»»» createdDate

string(date-time)

false

none

Date of the created

»»»» lastModifiedDate

string(date-time)

false

none

Date of the last modified

»»»» archived

boolean

false

none

Boolean flag indicating archived status

»»»» externalId

string

false

none

Unique identifier for the external

»»»» id

integer(int64)

false

none

Unique identifier for the resource

»»»» street

string

false

none

Text value for street in AddressDto

»»»» civicNumber

string

false

none

Text value for civicNumber in AddressDto

»»»» suite

string

false

none

Text value for suite in AddressDto

»»»» postalCode

string

false

none

Code for the postal

»»»» lon

number(double)

false

none

Value for lon field

»»»» lat

number(double)

false

none

Value for lat field

»»»» city

City

false

none

Data transfer object representing a city within the Nakisa Portfolio Management Suite, encapsulating essential information related to real estate properties, portfolio management, and asset analytics. This object facilitates informed decision-making and strategic planning in urban asset management.

»»»»» createdBy

string

false

none

Username of who created this resource

»»»»» lastModifiedBy

string

false

none

Username of who last modified this resource

»»»»» createdDate

string(date-time)

false

none

Date of the created

»»»»» lastModifiedDate

string(date-time)

false

none

Date of the last modified

»»»»» archived

boolean

false

none

Boolean flag indicating archived status

»»»»» externalId

string

false

none

Unique identifier for the external

»»»»» id

integer(int64)

false

none

Unique identifier for the resource

»»»»» name

string

true

none

Name of the resource

»»»»» province

Province

false

none

Data transfer object representing a province within the Nakisa Portfolio Management Suite, encapsulating essential details for portfolio analysis and asset management in the context of real estate properties.

»»»»»» createdBy

string

false

none

Username of who created this resource

»»»»»» lastModifiedBy

string

false

none

Username of who last modified this resource

»»»»»» createdDate

string(date-time)

false

none

Date of the created

»»»»»» lastModifiedDate

string(date-time)

false

none

Date of the last modified

»»»»»» archived

boolean

false

none

Boolean flag indicating archived status

»»»»»» externalId

string

false

none

Unique identifier for the external

»»»»»» id

integer(int64)

false

none

Unique identifier for the resource

»»»»»» name

string

true

none

Name of the resource

»»»»»» code

string

false

none

Code identifier for the resource

»»»»»» country

Country

false

none

Data transfer object representing a country within the Nakisa Portfolio Management Suite, utilized for portfolio analysis and asset management in the context of real estate properties and analytics.

»»»»»»» createdBy

string

false

none

Username of who created this resource

»»»»»»» lastModifiedBy

string

false

none

Username of who last modified this resource

»»»»»»» createdDate

string(date-time)

false

none

Date of the created

»»»»»»» lastModifiedDate

string(date-time)

false

none

Date of the last modified

»»»»»»» archived

boolean

false

none

Boolean flag indicating archived status

»»»»»»» externalId

string

false

none

Unique identifier for the external

»»»»»»» id

integer(int64)

false

none

Unique identifier for the resource

»»»»»»» name

string

true

none

Name of the resource

»»»»»»» code

string

false

none

Code identifier for the resource

»»»» district

District

false

none

Data transfer object representing a district within the Nakisa Portfolio Management Suite, encompassing key attributes related to portfolio management, asset allocation, and real estate property analytics.

»»»»» createdBy

string

false

none

Username of who created this resource

»»»»» lastModifiedBy

string

false

none

Username of who last modified this resource

»»»»» createdDate

string(date-time)

false

none

Date of the created

»»»»» lastModifiedDate

string(date-time)

false

none

Date of the last modified

»»»»» archived

boolean

false

none

Boolean flag indicating archived status

»»»»» externalId

string

false

none

Unique identifier for the external

»»»»» id

integer(int64)

false

none

Unique identifier for the resource

»»»»» name

string

true

none

Name of the resource

»»»»» city

City

false

none

Data transfer object representing a city within the Nakisa Portfolio Management Suite, encapsulating essential information related to real estate properties, portfolio management, and asset analytics. This object facilitates informed decision-making and strategic planning in urban asset management.

»»»» cityId

integer(int64)

false

none

Unique identifier for the city

»»»» districtId

integer(int64)

false

none

Unique identifier for the district

»»» secondAddressDto

AddressDto

false

none

Data transfer object representing the address details associated with real estate properties within the Nakisa Portfolio Management Suite, facilitating accurate portfolio and asset analytics.

»» premises

[PremiseDto]

false

none

[Data transfer object representing a premise within the Nakisa Portfolio Management Suite, encompassing essential details related to portfolio assets and analytics for real estate properties.]

»»» createdBy

string

false

none

Username of who created this resource

»»» lastModifiedBy

string

false

none

Username of who last modified this resource

»»» createdDate

string(date-time)

false

none

Date of the created

»»» lastModifiedDate

string(date-time)

false

none

Date of the last modified

»»» archived

boolean

false

none

Boolean flag indicating archived status

»»» externalId

string

false

none

Unique identifier for the external

»»» id

integer(int64)

false

none

Unique identifier for the resource

»»» number

string

true

none

Text value for number in PremiseDto

»»» name

string

true

none

Name of the resource

»»» headPremise

boolean

false

none

Boolean flag indicating headPremise status

»»» possessionDate

string(date)

false

none

Date of the possession

»»» openingDate

string(date)

false

none

Date of the opening

»»» closingDate

string(date)

false

none

Date of the closing

»»» relocationDate

string(date)

false

none

Date of the relocation

»»» vacatingDate

string(date)

false

none

Date of the vacating

»»» expansionDate

string(date)

false

none

Date of the expansion

»»» statusId

integer(int64)

false

none

Unique identifier for the status

»»» usageId

integer(int64)

false

none

Unique identifier for the usage

»»» parentPremiseId

integer(int64)

false

none

Unique identifier for the parent premise

»»» costCenterId

integer(int64)

true

none

Unique identifier for the cost center

»»» profitCenterId

integer(int64)

false

none

Unique identifier for the profit center

»»» legalEntityId

integer(int64)

true

none

Unique identifier for the legal entity

»»» occupancyIds

[integer]

false

none

List of occupancyIds items

»»» locationId

integer(int64)

true

none

Unique identifier for the location

»»» locationDto

LocationDto

false

none

Data transfer object representing a location within the Nakisa Portfolio Management Suite, encapsulating essential details related to real estate properties, assets, and portfolio analytics.

»»» status

PickListOptionDto

false

none

Data transfer object representing an option within a pick list, utilized for categorizing and managing portfolio assets and analytics in the Nakisa Portfolio Management Suite, particularly in the context of real estate property management.

»»» usage

PickListOptionDto

false

none

Data transfer object representing an option within a pick list, utilized for categorizing and managing portfolio assets and analytics in the Nakisa Portfolio Management Suite, particularly in the context of real estate property management.

»»» occupanciesDto

[PickListOptionDto]

false

none

List of occupanciesDto items

»» groups

[PickListDto]

false

none

[Data transfer object representing a selection of options within the Nakisa Portfolio Management Suite, specifically designed to facilitate the management and analysis of portfolios, assets, and real estate properties.]

»»» createdBy

string

false

none

Username of who created this resource

»»» lastModifiedBy

string

false

none

Username of who last modified this resource

»»» createdDate

string(date-time)

false

none

Date of the created

»»» lastModifiedDate

string(date-time)

false

none

Date of the last modified

»»» archived

boolean

false

none

Boolean flag indicating archived status

»»» externalId

string

false

none

Unique identifier for the external

»»» id

string

false

none

Unique identifier for the resource

»»» code

string

false

none

Code identifier for the resource

»»» priority

integer(int64)

false

none

Priority of the resource

»»» pickListType

string

false

none

Type of the pick list

»»» label

string

false

none

Label for the resource

»»» cultureId

integer(int64)

false

none

Unique identifier for the culture

»»» reportable

boolean

false

none

Boolean flag indicating reportable status

»»» labelDtos

[LabelDto]

false

none

List of labelDtos items

»» groupOptions

[PickListOptionDto]

false

none

[Data transfer object representing an option within a pick list, utilized for categorizing and managing portfolio assets and analytics in the Nakisa Portfolio Management Suite, particularly in the context of real estate property management.]

»» businessUnits

[BusinessUnitDto]

false

none

[Data transfer object representing a business unit within the Nakisa Portfolio Management Suite, encapsulating essential information related to portfolio management, asset tracking, analytics, and real estate properties.]

»»» id

integer(int64)

false

none

Unique identifier for the resource

»»» status

string

false

none

Status of the resource

»»» displayId

string

true

none

Unique identifier for the display

»»» name

string

true

none

Name of the resource

»»» leaseAreaId

integer(int64)

false

none

Unique identifier for the lease area

»»» companyId

integer(int64)

false

none

Unique identifier for the company

»» legalEntities

[CompanyDto]

false

none

[Data transfer object representing a company within the Nakisa Portfolio Management Suite, encapsulating essential information related to portfolio assets, analytics, and real estate properties.]

»»» id

integer(int64)

false

none

Unique identifier for the resource

»»» status

string

false

none

Status of the resource

»»» displayId

string

true

none

Unique identifier for the display

»»» erpSystemId

integer(int64)

false

none

Unique identifier for the erp system

»»» erpSystemDisplayId

string

false

none

Unique identifier for the erp system display

»»» countryId

integer(int64)

false

none

Unique identifier for the country

»»» countryDisplayId

string

false

none

Unique identifier for the country display

»»» postingPeriodVariantId

integer(int64)

false

none

Unique identifier for the posting period variant

»»» postingPeriodVariantDisplayId

string

false

none

Unique identifier for the posting period variant display

»»» controllingAreaId

integer(int64)

false

none

Unique identifier for the controlling area

»»» controllingAreaDisplayId

string

false

none

Unique identifier for the controlling area display

»»» chartOfAccountId

integer(int64)

false

none

Unique identifier for the chart of account

»»» chartOfAccountDisplayId

string

false

none

Unique identifier for the chart of account display

»»» fiscalVariantId

integer(int64)

false

none

Unique identifier for the fiscal variant

»»» fiscalVariantDisplayId

string

false

none

Unique identifier for the fiscal variant display

»»» chartOfDepreciationId

integer(int64)

false

none

Unique identifier for the chart of depreciation

»»» chartOfDepreciationDisplayId

string

false

none

Unique identifier for the chart of depreciation display

»»» purchasingOrganizationId

integer(int64)

false

none

Unique identifier for the purchasing organization

»»» assetId

integer(int64)

false

none

Unique identifier for the asset

»»» exchangeRateTypeId

integer(int64)

false

none

Unique identifier for the exchange rate type

»»» plantId

integer(int64)

false

none

Unique identifier for the plant

»»» incrementalBorrowingRateId

integer(int64)

false

none

Unique identifier for the incremental borrowing rate

»»» businessUnitId

integer(int64)

false

none

Unique identifier for the business unit

»»» projectId

integer(int64)

false

none

Unique identifier for the project

»»» transferVariantId

integer(int64)

false

none

Unique identifier for the transfer variant

»»» partnerId

integer(int64)

false

none

Unique identifier for the partner

»»» departmentId

integer(int64)

false

none

Unique identifier for the department

»»» accountingStandardId

integer(int64)

false

none

Unique identifier for the accounting standard

»»» generalLedgerAccountId

integer(int64)

false

none

Unique identifier for the general ledger account

»»» consumerPriceIndexCategoryId

integer(int64)

false

none

Unique identifier for the consumer price index category

»»» costCenterId

integer(int64)

false

none

Unique identifier for the cost center

»»» costCenterRelationValidFrom

string(date)

false

none

Text value for costCenterRelationValidFrom in CompanyDto

»»» costCenterRelationValidTo

string(date)

false

none

Text value for costCenterRelationValidTo in CompanyDto

»» statusOptions

[PickListOptionDto]

false

none

[Data transfer object representing an option within a pick list, utilized for categorizing and managing portfolio assets and analytics in the Nakisa Portfolio Management Suite, particularly in the context of real estate property management.]

»» masterAgreements

[MasterAgreementDto]

false

none

[Data transfer object representing a comprehensive master agreement within the Nakisa Portfolio Management Suite, encapsulating critical details related to portfolio assets and analytics for real estate properties.]

»»» id

integer(int64)

false

none

Unique identifier for the resource

»»» displayId

string

false

none

Unique identifier for the display

»»» year

integer(int32)

true

none

Numeric value representing year

»»» name

string

true

none

Name of the resource

»»» description

string

false

none

Description of the resource

»»» validFrom

string(date)

false

none

Date from which the resource is valid

»»» validTo

string(date)

false

none

Date until which the resource is valid

»»» targetValue

number(double)

false

none

Value for targetValue field

»»» legalJurisdiction

string

false

none

Text value for legalJurisdiction in MasterAgreementDto

»»» approverComment

string

false

none

Text value for approverComment in MasterAgreementDto

»»» signingPerson

string

false

none

Text value for signingPerson in MasterAgreementDto

»»» placeOfSignature

string

false

none

Text value for placeOfSignature in MasterAgreementDto

»»» dateOfSignature

string(date)

false

none

Text value for dateOfSignature in MasterAgreementDto

»»» state

string

false

none

Current state of the portfolio

»»» dataCreationInfo

DataCreationSettingLite

false

none

none

»»»» id

integer(int64)

true

none

none

»»»» idGenerationType

string

true

none

none

»»»» source

string

false

none

none

»»»» type

string

true

none

none

»»»» startDateTime

string(date-time)

true

none

none

»»»» endDateTime

string(date-time)

false

none

none

»»» agreementGroup

AgreementGroupLite

false

none

Data transfer object representing a collection of agreements related to portfolio management, enabling streamlined analytics and insights for real estate assets within the Nakisa Portfolio Management Suite.

»»»» id

integer(int64)

false

none

Unique identifier for the resource

»»»» displayId

string

false

none

Unique identifier for the display

»»»» status

string

false

none

Status of the resource

»»»» name

string

false

none

Name of the resource

»»» currency

CurrencyLite

false

none

Data transfer object representing currency information within the Nakisa Portfolio Management Suite, facilitating financial analysis and reporting for real estate assets and portfolios.

»»»» id

integer(int64)

false

none

Unique identifier for the resource

»»»» displayId

string

false

none

Unique identifier for the display

»»»» status

string

false

none

Status of the resource

»»»» name

string

false

none

Name of the resource

»»»» decimalPoints

integer(int32)

false

none

Numeric value representing decimalPoints

»»» internalAssetClass

InternalAssetClassLite

false

none

Data transfer object representing a simplified classification of assets within the Nakisa Portfolio Management Suite, facilitating portfolio analytics and management of real estate properties.

»»»» id

integer(int64)

false

none

Unique identifier for the resource

»»»» displayId

string

false

none

Unique identifier for the display

»»»» status

string

false

none

Status of the resource

»»»» name

string

false

none

Name of the resource

»»»» assetClassType

string

false

none

Type of the asset class

»»»» infiniteUsefulLife

boolean

false

none

Boolean flag indicating infiniteUsefulLife status

»»» leaseArea

LeaseAreaLite

false

none

Data transfer object representing a simplified view of lease areas within the Nakisa Portfolio Management Suite, facilitating portfolio analysis and asset management for real estate properties.

»»»» id

integer(int64)

false

none

Unique identifier for the resource

»»»» displayId

string

false

none

Unique identifier for the display

»»»» status

string

false

none

Status of the resource

»»»» name

string

false

none

Name of the resource

»»» businessUnit

BusinessUnitLite

false

none

Data transfer object representing a simplified view of a business unit within the Nakisa Portfolio Management Suite, encompassing key attributes relevant to portfolio management, asset tracking, analytics, and real estate properties.

»»»» id

integer(int64)

false

none

Unique identifier for the resource

»»»» displayId

string

false

none

Unique identifier for the display

»»»» status

string

false

none

Status of the resource

»»»» name

string

false

none

Name of the resource

»»» companyCode

CompanyLite

false

none

Data transfer object representing a streamlined view of a company within the Nakisa Portfolio Management Suite, encompassing essential details related to portfolio assets, analytics, and real estate properties.

»»»» id

integer(int64)

false

none

Unique identifier for the resource

»»»» displayId

string

false

none

Unique identifier for the display

»»»» status

string

false

none

Status of the resource

»»»» erpSystemId

integer(int64)

false

none

Unique identifier for the erp system

»»»» erpSystemDisplayId

string

false

none

Unique identifier for the erp system display

»»»» countryId

integer(int64)

false

none

Unique identifier for the country

»»»» countryDisplayId

string

false

none

Unique identifier for the country display

»»»» postingPeriodVariantId

integer(int64)

false

none

Unique identifier for the posting period variant

»»»» fiscalVariantId

integer(int64)

false

none

Unique identifier for the fiscal variant

»»» department

DepartmentLite

false

none

Data transfer object representing a department within the Nakisa Portfolio Management Suite, encapsulating essential information for portfolio and asset analytics in the context of real estate property management.

»»»» id

integer(int64)

false

none

Unique identifier for the resource

»»»» displayId

string

false

none

Unique identifier for the display

»»»» status

string

false

none

Status of the resource

»»»» name

string

false

none

Name of the resource

»»» leaseGroup

LeaseGroupLite

false

none

Data transfer object representing a collection of lease agreements within the Nakisa Portfolio Management Suite, facilitating portfolio analysis and asset management for real estate properties.

»»»» id

integer(int64)

false

none

Unique identifier for the resource

»»»» displayId

string

false

none

Unique identifier for the display

»»»» status

string

false

none

Status of the resource

»»»» name

string

false

none

Name of the resource

»»» allowsSystemGenerateNewId

boolean

false

none

Unique identifier for the allows system generate new

»»» numberRangeIdentifierType

INumberRangeIdentifierType

false

none

Data transfer object representing a numerical range identifier used for categorizing and analyzing assets within the Nakisa Portfolio Management Suite, specifically in the context of portfolio management, asset tracking, and real estate property analytics.

»»»» name

string

false

none

Name of the resource

»»» numberRangeIdentifierValue

string

false

none

Text value for numberRangeIdentifierValue in MasterAgreementDto

»»» numberRangeType

INumberRangeType

false

none

Data transfer object representing a numerical range utilized in the Nakisa Portfolio Management Suite, specifically designed for portfolio and asset analytics within the real estate property domain. This schema facilitates precise data representation and analysis of asset values and performance metrics.

»»»» name

string

false

none

Name of the resource

»» contracts

[ContractDto]

false

none

[Data transfer object representing a contract within the Nakisa Portfolio Management Suite, encapsulating essential details related to portfolio management, asset tracking, and real estate property analytics.]

»»» id

integer(int64)

false

none

Unique identifier for the resource

»»» displayId

string

false

none

Unique identifier for the display

»»» name

string

true

none

Name of the resource

»»» principalPositionType

string

true

none

Type of the principal position

»»» validFrom

string(date)

false

none

Date from which the resource is valid

»»» validTo

string(date)

false

none

Date until which the resource is valid

»»» amendmentDate

string(date)

false

none

Date of the amendment

»»» approverComment

string

false

none

Text value for approverComment in ContractDto

»»» contractPhase

string

false

none

Text value for contractPhase in ContractDto

»»» dataCreationInfo

DataCreationSettingLite

false

none

none

»»» leaseType

string

false

none

Type of the lease

»»» revision

ContractRevisionDto

false

none

Data transfer object representing a revision of a contract within the Nakisa Portfolio Management Suite, encompassing essential details for portfolio and asset management in the context of real estate property analytics.

»»»» id

integer(int64)

false

none

Unique identifier for the resource

»»»» displayId

string

false

none

Unique identifier for the display

»»»» name

string

true

none

Name of the resource

»»»» inception

boolean

false

none

Boolean flag indicating inception status

»»»» revisionType

string

false

none

Type of the revision

»»»» state

string

false

none

Current state of the portfolio

»»»» approvedBy

string

false

none

Text value for approvedBy in ContractRevisionDto

»»»» approvedAt

string(date-time)

false

none

Text value for approvedAt in ContractRevisionDto

»»»» parentRevisionId

integer(int64)

false

none

Unique identifier for the parent revision

»»»» approverComment

string

false

none

Text value for approverComment in ContractRevisionDto

»»»» contractId

integer(int64)

false

none

Unique identifier for the contract

»»»» contractDisplayId

string

false

none

Unique identifier for the contract display

»»»» contractName

string

false

none

Name of the contract

»»»» principalPositionType

string

false

none

Type of the principal position

»»»» mlaId

integer(int64)

false

none

Unique identifier for the mla

»»»» companyId

integer(int64)

false

none

Unique identifier for the company

»»»» description

string

false

none

Description of the resource

»»»» externalReference

string

false

none

Text value for externalReference in ContractRevisionDto

»»»» internalReference

string

false

none

Text value for internalReference in ContractRevisionDto

»»»» formOfLease

string

false

none

Text value for formOfLease in ContractRevisionDto

»»»» jointVentureLeaseType

string

false

none

Type of the joint venture lease

»»»» businessPlace

string

false

none

Text value for businessPlace in ContractRevisionDto

»»»» tradingPartner

TradingPartnerLite

false

none

Data transfer object representing a trading partner within the Nakisa Portfolio Management Suite, encapsulating essential information related to portfolio, asset, and analytics for real estate property management.

»»»»» id

integer(int64)

false

none

Unique identifier for the resource

»»»»» displayId

string

false

none

Unique identifier for the display

»»»»» status

string

false

none

Status of the resource

»»»»» name

string

false

none

Name of the resource

»»»»» erpSystemId

integer(int64)

false

none

Unique identifier for the erp system

»»»»» erpSystemDisplayId

string

false

none

Unique identifier for the erp system display

»»»» contractCategoryGroup

ContractCategoryGroupLite

false

none

Data transfer object representing a grouping of contract categories within the Nakisa Portfolio Management Suite, facilitating streamlined portfolio and asset analytics for real estate properties.

»»»»» id

integer(int64)

false

none

Unique identifier for the resource

»»»»» displayId

string

false

none

Unique identifier for the display

»»»»» status

string

false

none

Status of the resource

»»»»» name

string

false

none

Name of the resource

»»»» contractGroup1

ContractGroup1Lite

false

none

Data transfer object representing a simplified grouping of contracts within the Nakisa Portfolio Management Suite, facilitating streamlined analytics and management of real estate assets in the portfolio.

»»»»» id

integer(int64)

false

none

Unique identifier for the resource

»»»»» displayId

string

false

none

Unique identifier for the display

»»»»» status

string

false

none

Status of the resource

»»»»» name

string

false

none

Name of the resource

»»»» contractGroup2

ContractGroup2Lite

false

none

Data transfer object representing a collection of contracts within the Nakisa Portfolio Management Suite, designed to facilitate portfolio analysis and asset management for real estate properties.

»»»»» id

integer(int64)

false

none

Unique identifier for the resource

»»»»» displayId

string

false

none

Unique identifier for the display

»»»»» status

string

false

none

Status of the resource

»»»»» name

string

false

none

Name of the resource

»»»» group3

string

false

none

Text value for group3 in ContractRevisionDto

»»»» group4

string

false

none

Text value for group4 in ContractRevisionDto

»»»» signingPerson

string

false

none

Text value for signingPerson in ContractRevisionDto

»»»» placeOfSignature

string

false

none

Text value for placeOfSignature in ContractRevisionDto

»»»» dateOfSignature

string(date)

false

none

Text value for dateOfSignature in ContractRevisionDto

»»»» numberRangeIdentifierType

INumberRangeIdentifierType

false

none

Data transfer object representing a numerical range identifier used for categorizing and analyzing assets within the Nakisa Portfolio Management Suite, specifically in the context of portfolio management, asset tracking, and real estate property analytics.

»»»» numberRangeIdentifierValue

string

false

none

Text value for numberRangeIdentifierValue in ContractRevisionDto

»»»» allowsSystemGenerateNewId

boolean

false

none

Unique identifier for the allows system generate new

»»»» numberRangeType

INumberRangeType

false

none

Data transfer object representing a numerical range utilized in the Nakisa Portfolio Management Suite, specifically designed for portfolio and asset analytics within the real estate property domain. This schema facilitates precise data representation and analysis of asset values and performance metrics.

»»» currency

CurrencyLite

false

none

Data transfer object representing currency information within the Nakisa Portfolio Management Suite, facilitating financial analysis and reporting for real estate assets and portfolios.

»»» companyCurrency

CurrencyLite

false

none

Data transfer object representing currency information within the Nakisa Portfolio Management Suite, facilitating financial analysis and reporting for real estate assets and portfolios.

»»» indexedCurrency

boolean

false

none

Boolean flag indicating indexedCurrency status

»»» assetValueCurrencyType

string

false

none

Type of the asset value currency

»»» currencyLocked

boolean

false

none

Boolean flag indicating currencyLocked status

»»» leaseArea

LeaseAreaLite

true

none

Data transfer object representing a simplified view of lease areas within the Nakisa Portfolio Management Suite, facilitating portfolio analysis and asset management for real estate properties.

»»» businessUnit

BusinessUnitLite

true

none

Data transfer object representing a simplified view of a business unit within the Nakisa Portfolio Management Suite, encompassing key attributes relevant to portfolio management, asset tracking, analytics, and real estate properties.

»»» businessUnitLocked

boolean

false

none

Boolean flag indicating businessUnitLocked status

»»» companyCode

CompanyLite

true

none

Data transfer object representing a streamlined view of a company within the Nakisa Portfolio Management Suite, encompassing essential details related to portfolio assets, analytics, and real estate properties.

»»» companyCodeLocked

boolean

false

none

Boolean flag indicating companyCodeLocked status

»»» department

DepartmentLite

false

none

Data transfer object representing a department within the Nakisa Portfolio Management Suite, encapsulating essential information for portfolio and asset analytics in the context of real estate property management.

»»» departmentLocked

boolean

false

none

Boolean flag indicating departmentLocked status

»»» leaseGroup

LeaseGroupLite

false

none

Data transfer object representing a collection of lease agreements within the Nakisa Portfolio Management Suite, facilitating portfolio analysis and asset management for real estate properties.

»»» leaseGroupLocked

boolean

false

none

Boolean flag indicating leaseGroupLocked status

»»» subleasingInternalAssetClass

InternalAssetClassLite

false

none

Data transfer object representing a simplified classification of assets within the Nakisa Portfolio Management Suite, facilitating portfolio analytics and management of real estate properties.

»»» contractGroup1

ContractGroup1Lite

false

none

Data transfer object representing a simplified grouping of contracts within the Nakisa Portfolio Management Suite, facilitating streamlined analytics and management of real estate assets in the portfolio.

»»» contractGroup2

ContractGroup2Lite

false

none

Data transfer object representing a collection of contracts within the Nakisa Portfolio Management Suite, designed to facilitate portfolio analysis and asset management for real estate properties.

»»» subleasing

boolean

false

none

Boolean flag indicating subleasing status

»»» subleasingContractRevisionInfo

SubleasingContractRevisionLite

false

none

Data transfer object representing a simplified version of a subleasing contract revision, capturing essential details for portfolio and asset management within the Nakisa Portfolio Management Suite, facilitating analytics and decision-making in real estate property management.

»»»» id

integer(int64)

true

none

Unique identifier for the resource

»»»» contractId

integer(int64)

true

none

Unique identifier for the contract

»»»» contractDisplayId

string

true

none

Unique identifier for the contract display

»»»» contractName

string

true

none

Name of the contract

»»» subleasingLeaseComponentRevisionInfo

SubleasingLeaseComponentRevisionLite

false

none

Data transfer object representing a revision of a subleasing lease component within the Nakisa Portfolio Management Suite, facilitating the management and analysis of real estate assets in the context of portfolio optimization.

»»»» id

integer(int64)

true

none

Unique identifier for the resource

»»»» leaseComponentId

integer(int64)

true

none

Unique identifier for the lease component

»»»» leaseComponentDisplayId

string

true

none

Unique identifier for the lease component display

»»»» leaseComponentName

string

true

none

Name of the lease component

»»» subleasingActivationGroupRevisionInfo

SubleasingActivationGroupRevisionLite

false

none

Data transfer object representing a revision of a subleasing activation group within the Nakisa Portfolio Management Suite, providing essential insights for portfolio and asset management in the real estate sector.

»»»» id

integer(int64)

true

none

Unique identifier for the resource

»»»» activationGroupId

integer(int64)

true

none

Unique identifier for the activation group

»»»» activationGroupDisplayId

string

true

none

Unique identifier for the activation group display

»»»» activationGroupName

string

true

none

Name of the activation group

»»» notifications

[ContractSubscriptionDto]

false

none

List of notifications items

»»»» id

integer(int64)

false

none

Unique identifier for the resource

»»»» topic

INotificationTopicType

false

none

Data transfer object representing a notification topic type within the Nakisa Portfolio Management Suite, facilitating communication and updates related to portfolio, asset, analytics, and real estate property management.

»»»»» enCaption

string

false

none

Text value for enCaption in INotificationTopicType

»»»»» frCaption

string

false

none

Text value for frCaption in INotificationTopicType

»»»»» name

string

false

none

Name of the resource

»»»»» priority

string

false

none

Priority of the resource

»»»» username

string

false

none

Human-readable name of the portfolio

»»»» contractId

integer(int64)

false

none

Unique identifier for the contract

»»»» contractDisplayId

string

false

none

Unique identifier for the contract display

»»»» targetId

string

false

none

Unique identifier for the target

»»»» targetType

string

false

none

Type of the target

»»» masterAgreementId

integer(int64)

true

none

Unique identifier for the master agreement

»»» masterAgreementDisplayId

string

false

none

Unique identifier for the master agreement display

»»» allowsSystemGenerateNewId

boolean

false

none

Unique identifier for the allows system generate new

»»» transferInfo

MassInterCompanyTransferInfo

false

none

Data transfer object representing the details of mass inter-company asset transfers within the Nakisa Portfolio Management Suite, facilitating portfolio management and analytics for real estate properties.

»»»» transferredFromDisplayId

string

false

none

Unique identifier for the transferred from display

»»»» transferredFromRevisionId

integer(int64)

false

none

Unique identifier for the transferred from revision

»»»» transferredToDisplayId

string

false

none

Unique identifier for the transferred to display

»»»» transferredToRevisionId

integer(int64)

false

none

Unique identifier for the transferred to revision

»»» numberRangeIdentifierType

INumberRangeIdentifierType

false

none

Data transfer object representing a numerical range identifier used for categorizing and analyzing assets within the Nakisa Portfolio Management Suite, specifically in the context of portfolio management, asset tracking, and real estate property analytics.

»»» numberRangeIdentifierValue

string

false

none

Text value for numberRangeIdentifierValue in ContractDto

»»» numberRangeType

INumberRangeType

false

none

Data transfer object representing a numerical range utilized in the Nakisa Portfolio Management Suite, specifically designed for portfolio and asset analytics within the real estate property domain. This schema facilitates precise data representation and analysis of asset values and performance metrics.

»» listingCitiesValue

string

false

none

none

»» listingCitiesValues

[string]

false

none

none

»» listingProvincesValue

string

false

none

none

»» listingProvincesValues

[string]

false

none

none

»» listingCountriesValue

string

false

none

none

»» listingCountriesValues

[string]

false

none

none

»» listingLocationsValue

string

false

none

none

»» listingLocationsValues

[string]

false

none

none

»» listingPremisesValue

string

false

none

none

»» listingPremisesValues

[string]

false

none

none

»» listingGroupsValue

string

false

none

none

»» listingGroupsValues

[string]

false

none

none

»» listingGroupOptionsValue

string

false

none

none

»» listingGroupOptionsValues

[string]

false

none

none

»» listingBusinessUnitsValue

string

false

none

none

»» listingBusinessUnitsValues

[string]

false

none

none

»» listingLegalEntitiesValue

string

false

none

none

»» listingLegalEntitiesValues

[string]

false

none

none

»» listingMasterAgreementsValue

string

false

none

none

»» listingMasterAgreementsValues

[string]

false

none

none

»» listingContractsValue

string

false

none

none

»» listingContractsValues

[string]

false

none

none

»» listingStatusOptionsValue

string

false

none

none

»» listingStatusOptionsValues

[string]

false

none

none

» leaseIds

[integer]

false

none

List of leaseIds items

Enumerated Values

Attribute

Value

assetClassType

EQUIPMENT, PLANT, PROPERTY

assetValueCurrencyType

COMPANY_CURRENCY, CONTRACT_CURRENCY

contractPhase

CLOSED, DRAFT, INITIAL, REJECTED, SETUP

formOfLease

FULL, NET

idGenerationType

AUTO, MANUAL

jointVentureLeaseType

GROSS_LEASE, NET_LEASE

leaseType

LEASE_CONTRACT_FIX, LEASE_CONTRACT_FIXED_PART_A, LEASE_CONTRACT_FIXED_PART_B, LEASE_CONTRACT_FIX_VARIABLE, LEASE_CONTRACT_FULLY_VARIABLE, LEASE_CONTRACT_LOW_VALUE, LEASE_CONTRACT_OPERATING_SHORT_TERM, LEASE_CONTRACT_SERVICE_CONTRACT, LEASE_CONTRACT_SHORT_TERM, NON_LEASE

principalPositionType

LESSEE, LESSOR

priority

HIGH, LOW, MEDIUM

revisionType

ACTIVE, DRAFT, INACTIVE, REVERTED, REVISION

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

status

ACTIVE, CREATED, DECOMMISSIONED, DISABLED

type

MIGRATION, TESTING

Unarchive CPI Mass Indexation

HTTP Request

POST /api/cpi-mass-indexations/{id}/unarchive

📋 Description: Unarchives a specified mass indexation within the Nakisa Portfolio Management Suite, enabling the reactivation of portfolio analytics for real estate properties and assets.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

200

OK

OK

CpiMassIndexationDto

Prepare CPI Mass Indexation Reopen Job

HTTP Request

POST /api/cpi-mass-indexations/{id}/reopen

📋 Description: Reopens a specified mass indexation process for a portfolio asset, allowing for adjustments and updates within the Nakisa Portfolio Management Suite.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

200

OK

OK

CpiMassIndexationDto

Prepare CPI Mass Indexation Preview Job

HTTP Request

POST /api/cpi-mass-indexations/{id}/preview

📋 Description: Submits a request to preview mass indexations for a specified asset within the Nakisa Portfolio Management Suite, enabling users to analyze potential adjustments before final implementation.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

200

OK

OK

CpiMassIndexationDto

Get CPI Mass Indexation Notes

HTTP Request

GET /api/cpi-mass-indexations/{id}/notes

📋 Description: Fetches notes associated with a specific mass indexation in the Nakisa Portfolio Management Suite, providing insights relevant to portfolio and asset analytics in real estate property management.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

pageable

query

Pageable

true

Indicates whether the results of the GET request for notes related to a specific mass indexation are to be returned in a paginated format, facilitating efficient data retrieval within the Nakisa Portfolio Management Suite.

search

query

string

false

Search term used to filter notes related to the specified mass indexation within the Nakisa Portfolio Management Suite, enhancing portfolio and asset analytics for real estate properties.

message

query

string

false

Textual content of the note associated with the specified mass indexation, providing relevant insights for portfolio and asset analytics within the Nakisa Portfolio Management Suite.

Responses

Status

Meaning

Description

Schema

200

OK

OK

PagedModelEntityModelNoteDto

Create CPI Mass Indexation Notes

HTTP Request

POST /api/cpi-mass-indexations/{id}/notes

📋 Description: Adds notes to a specified mass indexation within the Nakisa Portfolio Management Suite, enhancing asset management and analytics capabilities for real estate properties.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

body

body

NoteDto

true

Request body containing the notes related to the specified mass indexation, including relevant details and annotations for portfolio and asset analytics within the Nakisa Portfolio Management Suite.

Responses

Status

Meaning

Description

Schema

201

Created

Created

Inline

Response Schema

Status Code 201

Name

Type

Required

Restrictions

Description

anonymous

[NoteDto]

false

none

[Data transfer object representing a note associated with portfolio management, asset analytics, and real estate properties, facilitating effective communication and documentation within the Nakisa Portfolio Management Suite.]

» createdBy

string

false

none

Username of who created this resource

» lastModifiedBy

string

false

none

Username of who last modified this resource

» createdDate

string(date-time)

false

none

Date of the created

» lastModifiedDate

string(date-time)

false

none

Date of the last modified

» archived

boolean

false

none

Boolean flag indicating archived status

» externalId

string

false

none

Unique identifier for the external

» id

integer(int64)

false

none

Unique identifier for the resource

» message

string

true

none

Text value for message in NoteDto

» userIds

[integer]

false

none

User information related to portfolio management

» redirectUrl

string

false

none

Text value for redirectUrl in NoteDto

Prepare CPI Mass Indexation Execute Job

HTTP Request

POST /api/cpi-mass-indexations/{id}/execute

📋 Description: Executes a mass indexation process for a specified asset within the Nakisa Portfolio Management Suite, enabling efficient updates to portfolio valuations and analytics for real estate properties.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

200

OK

OK

CpiMassIndexationDto

Archive CPI Mass Indexation

HTTP Request

POST /api/cpi-mass-indexations/{id}/archive

📋 Description: Archives a specified mass indexation within the Nakisa Portfolio Management Suite, enabling users to manage portfolio and asset data effectively while maintaining a comprehensive history for analytics and real estate property management.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

200

OK

OK

CpiMassIndexationDto

Get CPI Lease Indexation Previews

HTTP Request

GET /api/cpi-mass-indexations/{id}/cpi-lease-indexations

📋 Description: Retrieves CPI lease indexations associated with a specific mass indexation identified by the provided ID, facilitating informed decision-making in portfolio and asset management within the real estate sector.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

file-number-like

query

string

false

Specifies a string pattern to filter CPI lease indexations based on the associated file number, facilitating targeted analytics within the Nakisa Portfolio Management Suite.

cpi-lease-indexation-preview-status-internal-ids

query

array[integer]

false

Array of internal IDs representing the status of CPI lease indexation previews, utilized for analytics within the Nakisa Portfolio Management Suite’s real estate property management.

cpi-lease-indexation-result-status-internal-ids

query

array[integer]

false

Array of internal identifiers representing the status of CPI lease indexation results, utilized for portfolio and asset analytics within the Nakisa Portfolio Management Suite.

listing

query

boolean

false

Indicates whether to include detailed lease indexation data in the CPI mass indexations response for the specified asset within the Nakisa Portfolio Management Suite.

pageable

query

Pageable

true

Indicates whether the response should be paginated, allowing users to efficiently manage and analyze large sets of CPI lease indexation data within the Nakisa Portfolio Management Suite.

lease-id

query

string

false

Unique identifier for the lease associated with the specified CPI lease indexations within the Nakisa Portfolio Management Suite, facilitating precise portfolio and asset analytics in real estate property management.

lease-id-in

query

string

false

Unique identifier for the lease associated with the specified CPI lease indexation, facilitating precise asset and portfolio analytics within the Nakisa Portfolio Management Suite.

Responses

Status

Meaning

Description

Schema

200

OK

OK

PagedModelEntityModelCpiLeaseIndexationDto