Percentage Rent Report

Get Percentage Rent Report

HTTP Request

GET /api/percentage-rent-reports/{id}

📋 Description: Retrieves the percentage rent report associated with the specified asset ID, providing critical analytics for portfolio management 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

PercentageRentReportDto

Update Percentage Rent Report

HTTP Request

PUT /api/percentage-rent-reports/{id}

📋 Description: Updates the specified percentage rent report within the Nakisa Portfolio Management Suite, enabling users to refine analytics and insights related to portfolio and asset performance in real estate properties.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

body

body

PercentageRentReportDto

true

Request body containing the updated percentage rent report data, including relevant metrics and analytics for the specified asset within the portfolio.

Responses

Status

Meaning

Description

Schema

200

OK

OK

PercentageRentReportDto

Delete Percentage Rent Report

HTTP Request

DELETE /api/percentage-rent-reports/{id}

📋 Description: Deletes a specified percentage rent report from the Nakisa Portfolio Management Suite, enabling users to maintain accurate and relevant analytics within their real estate property portfolio.

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

Unarchive Percentage Rent Report

HTTP Request

POST /api/percentage-rent-reports/{id}/unarchive

📋 Description: Unarchives a specified percentage rent report within the Nakisa Portfolio Management Suite, allowing users to restore visibility and access to valuable analytics related to portfolio and asset management 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

PercentageRentReportDto

Regenerate Percentage Rent Report

HTTP Request

POST /api/percentage-rent-reports/{id}/regenerate

📋 Description: Regenerates the percentage rent report for a specified asset within the Nakisa Portfolio Management Suite, enabling users to obtain updated analytics for enhanced portfolio management and decision-making.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

200

OK

OK

None

Get Percentage Rent Report Notes

HTTP Request

GET /api/percentage-rent-reports/{id}/notes

📋 Description: Fetches notes associated with a specific percentage rent report, providing valuable insights for portfolio and asset management within the Nakisa Portfolio Management Suite.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

pageable

query

Pageable

true

Indicates whether the results of the percentage rent reports notes retrieval should be paginated, facilitating efficient data management within the Nakisa Portfolio Management Suite.

search

query

string

false

Search term used to filter notes related to the specified percentage rent report, enhancing the analytics capabilities within the Nakisa Portfolio Management Suite.

message

query

string

false

Textual content of the note associated with the specified percentage rent report, providing insights relevant to portfolio and asset management within the Nakisa Portfolio Management Suite.

Responses

Status

Meaning

Description

Schema

200

OK

OK

PagedModelEntityModelNoteDto

Create Percentage Rent Report Notes

HTTP Request

POST /api/percentage-rent-reports/{id}/notes

📋 Description: Adds notes to a specified percentage rent report within the Nakisa Portfolio Management Suite, enhancing asset analytics and portfolio management 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 percentage rent report identified by the specified ID, including relevant commentary and metadata for enhanced portfolio and asset analytics.

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

Generate Percentage Rent Report

HTTP Request

POST /api/percentage-rent-reports/{id}/generate

📋 Description: Generates a percentage rent report for the specified asset within the Nakisa Portfolio Management Suite, enabling users to analyze rental performance and optimize portfolio management strategies.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

200

OK

OK

None

Archive Percentage Rent Report

HTTP Request

POST /api/percentage-rent-reports/{id}/archive

📋 Description: Archives the specified percentage rent report within the Nakisa Portfolio Management Suite, facilitating effective asset management 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

PercentageRentReportDto

Create Percentage Rent Reports

HTTP Request

POST /api/percentage-rent-report

📋 Description: Generates a detailed percentage rent report for real estate properties within the portfolio, enabling enhanced asset analytics and informed decision-making.

Parameters

Name

In

Type

Required

Description

body

body

PercentageRentReportDto

true

Request body containing the percentage rent report data, including asset identifiers and relevant financial metrics for portfolio analytics within the real estate property context.

Responses

Status

Meaning

Description

Schema

201

Created

Created

Inline

Response Schema

Status Code 201

Name

Type

Required

Restrictions

Description

anonymous

[PercentageRentReportDto]

false

none

[Data transfer object representing a detailed report on percentage rent calculations within the Nakisa Portfolio Management Suite, facilitating analytics and insights for real estate property portfolios and assets.]

» 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

» startDate

string(date)

false

none

Start date of the resource

» endDate

string(date)

false

none

End date of the resource

» statusId

integer(int64)

false

none

Unique identifier for the status

» generatedDate

string(date)

false

none

Date of the generated

» generateJobId

integer(int64)

false

none

Unique identifier for the generate job

» numberOfLeaseEntriesToProcess

integer(int64)

false

none

Numeric value representing numberOfLeaseEntriesToProcess

» numberOfLeaseEntriesProcessed

integer(int64)

false

none

Numeric value representing numberOfLeaseEntriesProcessed

» leaseIds

[integer]

false

none

List of leaseIds items

» massProfileFilterIds

[integer]

false

none

none

» percentageRentGenerationPeriodIds

[integer]

false

none

List of percentageRentGenerationPeriodIds items

» notes

[Note]

false

none

List of notes 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

»» message

string

true

none

Text value for message in Note

»» preserveOriginalAudit

boolean

false

none

none

»» originalCreatedBy

string

false

none

none

»» originalCreatedDate

string(date-time)

false

none

none

»» originalLastModifiedBy

string

false

none

none

»» originalLastModifiedDate

string(date-time)

false

none

none

» 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

» massProfileFilters

[MassProfileFilterDto]

false

none

none

»» 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

»» leases

[LeaseDto]

false

none

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

»»» createdBy

string

false

none

Username of who created this resource

»»» lastModifiedBy

string

false

none

Username of who last modified this resource

»»» createdDate

string(date-time)

false

none

Date of the created

»»» lastModifiedDate

string(date-time)

false

none

Date of the last modified

»»» archived

boolean

false

none

Boolean flag indicating archived status

»»» externalId

string

false

none

Unique identifier for the external

»»» id

integer(int64)

false

none

Unique identifier for the resource

»»» typeId

integer(int64)

false

none

Unique identifier for the type

»»» terminatingLease

string(date)

false

none

Text value for terminatingLease in LeaseDto

»»» maximumDateTo

string(date)

false

none

Text value for maximumDateTo in LeaseDto

»»» number

string

false

none

Text value for number in LeaseDto

»»» validFrom

string(date)

true

none

Date from which the resource is valid

»»» validTo

string(date)

true

none

Date until which the resource is valid

»»» categoryId

integer(int64)

false

none

Unique identifier for the category

»»» registrationNumber

string

false

none

Text value for registrationNumber in LeaseDto

»»» statusId

integer(int64)

false

none

Unique identifier for the status

»»» stateId

integer(int64)

false

none

Unique identifier for the state

»»» calculateTax

boolean

false

none

Boolean flag indicating calculateTax status

»»» autoMonthToMonth

boolean

false

none

Boolean flag indicating autoMonthToMonth status

»»» originalLeaseId

integer(int64)

false

none

Unique identifier for the original lease

»»» scenario

boolean

false

none

Boolean flag indicating scenario status

»»» parentLeaseId

integer(int64)

false

none

Unique identifier for the parent lease

»»» areasHistoryVersionId

integer(int64)

false

none

none

»»» provisioningFrequencyName

string

false

none

Name of the provisioning frequency

»»» accountingApproved

boolean

false

none

Boolean flag indicating accountingApproved status

»»» indexationType

string

true

none

Type of the indexation

»»» cpiGlobalCategoryId

integer(int64)

false

none

Unique identifier for the cpi global category

»»» indexationReferenceDate

string(date)

false

none

Date of the indexation reference

»»» currentIndexLevel

number(double)

false

none

Value for currentIndexLevel field

»»» conditionallyIndexed

boolean

false

none

Indicates whether the lease is subject to conditional indexing, impacting portfolio analytics and asset valuation within the Nakisa Portfolio Management Suite.

»»» applicableCurrentIndexLevel

number(double)

false

none

Value for applicableCurrentIndexLevel field

»»» indexLevelPercentageChangeLowerBound

number(double)

false

none

Value for indexLevelPercentageChangeLowerBound field

»»» indexLevelPercentageChangeUpperBound

number(double)

false

none

Value for indexLevelPercentageChangeUpperBound field

»»» indexationTypeNonLease

string

true

none

Text value for indexationTypeNonLease in LeaseDto

»»» cpiGlobalCategoryIdNonLease

integer(int64)

false

none

Numeric value representing cpiGlobalCategoryIdNonLease

»»» indexationReferenceDateNonLease

string(date)

false

none

Text value for indexationReferenceDateNonLease in LeaseDto

»»» currentIndexLevelNonLease

number(double)

false

none

Value for currentIndexLevelNonLease field

»»» conditionallyIndexedNonLease

boolean

false

none

Indicates whether the asset is conditionally indexed, providing critical insights for portfolio analytics and real estate property management within the Nakisa Portfolio Management Suite.

»»» applicableCurrentIndexLevelNonLease

number(double)

false

none

Value for applicableCurrentIndexLevelNonLease field

»»» indexLevelPercentageChangeLowerBoundNonLease

number(double)

false

none

Value for indexLevelPercentageChangeLowerBoundNonLease field

»»» indexLevelPercentageChangeUpperBoundNonLease

number(double)

false

none

Value for indexLevelPercentageChangeUpperBoundNonLease field

»»» signatureDate

string(date)

false

none

Date of the signature

»»» premiseId

integer(int64)

false

none

Unique identifier for the premise

»»» 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.

»»» 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.

»»» state

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.

»»» version

VersionDto

false

none

Data transfer object representing the versioning information of assets within the Nakisa Portfolio Management Suite, facilitating effective portfolio analytics and management 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

false

none

Name of the resource

»»»» description

string

false

none

Description of the resource

»»»» modificationDate

string(date)

false

none

Date of the modification

»»»» updateContractRate

boolean

false

none

Rate of update contract

»»»» leaseEvent

EventDto

false

none

Data transfer object representing an event within the Nakisa Portfolio Management Suite, encapsulating key details related to portfolio management, asset tracking, and real estate property analytics.

»»»»» createdBy

string

false

none

Username of who created this resource

»»»»» lastModifiedBy

string

false

none

Username of who last modified this resource

»»»»» createdDate

string(date-time)

false

none

Date of the created

»»»»» lastModifiedDate

string(date-time)

false

none

Date of the last modified

»»»»» archived

boolean

false

none

Boolean flag indicating archived status

»»»»» externalId

string

false

none

Unique identifier for the external

»»»»» id

integer(int64)

false

none

Unique identifier for the resource

»»»»» typeId

integer(int64)

false

none

Unique identifier for the type

»»»»» code

string

false

none

Code identifier for the resource

»»»»» reviewedBy

string

false

none

Text value for reviewedBy in EventDto

»»»»» reviewedDate

string(date)

false

none

Date of the reviewed

»»»»» reviewedStatusId

integer(int64)

false

none

Unique identifier for the reviewed status

»»»»» activityDate

string(date)

false

none

Date of the activity

»»»»» relatedPickListOptionId

integer(int64)

false

none

Unique identifier for the related pick list option

»»»»» detail

string

false

none

Text value for detail in EventDto

»»»»» note

Note

false

none

Data transfer object representing a note associated with a portfolio or asset within the Nakisa Portfolio Management Suite, facilitating enhanced analytics and insights for real estate property management.

»»»»» 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.

»»»»» reviewedStatus

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.

»»»»» relatedPickListOption

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.

»»»»» isVisiblePartnerPortal

boolean

false

none

none

»»»» scenario

boolean

false

write-only

Boolean flag indicating scenario status

»»»» isVisibleVendorPortal

boolean

false

none

Whether the resource is visible vendor portal

»»»» isTerminationVersion

boolean

false

none

Whether the resource is termination version

»»»» terminationDate

string(date)

false

none

Date of the termination

»»»» penaltyAmount

number(double)

false

none

Amount of penalty

»»»» areasHistoryVersionId

integer(int64)

false

none

none

»»» premiseDto

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.

»»»»» 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

false

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

»»»»»»»» provinceCountryKey

string

false

none

none

»»»»»»» cityProvinceCountryKey

string

false

none

none

»»»»»» 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.

»»»» 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

»»» isTerminationVersion

boolean

false

none

Whether the resource is termination version

»» leaseFileNumbers

[string]

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.]

»» 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.]

»» 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

»»» name

string

false

none

none

»»» 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

»»»» name

string

false

none

none

»»»» 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

true

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

»»»» 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.

»»»» allowsSystemGenerateNewId

boolean

false

none

Unique identifier for the allows system generate new

»»» 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

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

Get Percentage Rent Reports

HTTP Request

GET /api/percentage-rent-reports

📋 Description: Fetches percentage rent reports for assets within the Nakisa Portfolio Management Suite, enabling users to analyze real estate property performance and optimize portfolio management strategies.

Parameters

Name

In

Type

Required

Description

pageable

query

Pageable

true

Indicates whether the results of the percentage rent reports should be returned in a paginated format, facilitating efficient data retrieval for portfolio and asset analytics within the Nakisa Portfolio Management Suite.

search

query

string

false

Search term used to filter and retrieve specific percentage rent reports related to portfolio and asset analytics within the Nakisa Portfolio Management Suite.

name

query

string

false

Name of the resource

description

query

string

false

Description of the resource

start-date

query

string

false

Specifies the start date for generating percentage rent reports within the Nakisa Portfolio Management Suite, enabling users to analyze rental performance over a defined period.

end-date

query

string

false

Specifies the end date for generating percentage rent reports within the Nakisa Portfolio Management Suite, enabling users to analyze financial performance over a defined period for real estate assets.

status-id

query

string

false

Unique identifier for the status of percentage rent reports, facilitating targeted analytics within the Nakisa Portfolio Management Suite for effective portfolio and asset management.

status-id-is-not

query

string

false

Excludes reports associated with the specified status ID, allowing users to filter percentage rent reports within the Nakisa Portfolio Management Suite for enhanced portfolio and asset analytics.

Responses

Status

Meaning

Description

Schema

200

OK

OK

PagedModelEntityModelPercentageRentReportDto

Get Percentage Rent Report Charges Info

HTTP Request

GET /api/percentage-rent-reports/{id}/charges-info

📋 Description: Retrieves detailed charges information associated with a specific percentage rent report, enabling users to analyze financial data related to real estate assets 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

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[PercentageRentReportChargeInfo]

false

none

[Data transfer object representing the charge information related to percentage rent within the Nakisa Portfolio Management Suite, facilitating analytics and reporting for real estate property portfolios and assets.]

» percentageRentRuleId

integer(int64)

false

none

Unique identifier for the percentage rent rule

» name

string

false

none

Name of the resource

» balance

number

false

none

Value for balance field

» dueDate

string(date)

false

none

Due date of the resource

» saleCurrency

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

» calculateTax

boolean

false

none

Boolean flag indicating calculateTax status

» nfsLinks

[NfsLinkDto]

false

none

List of nfsLinks 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

»» masterAgreementId

integer(int64)

false

none

Unique identifier for the master agreement

»» contractId

integer(int64)

false

none

Unique identifier for the contract

»» leaseComponentId

integer(int64)

false

none

Unique identifier for the lease component

»» contractRevisionId

integer(int64)

false

none

Unique identifier for the contract revision

»» leaseComponentRevisionId

integer(int64)

false

none

Unique identifier for the lease component revision

»» activationGroupRevisionId

integer(int64)

false

none

Unique identifier for the activation group revision

»» contractDto

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

»»»» 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

»»» 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.

»»»»» name

string

false

none

Name of the resource

»»»» numberRangeIdentifierValue

string

false

none

Text value for numberRangeIdentifierValue in ContractRevisionDto

»»»» 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

true

none

Name of the resource

»»»» allowsSystemGenerateNewId

boolean

false

none

Unique identifier for the allows system generate new

»»» 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

»»» 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.

»»»» 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

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.

»»»» 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

»»» 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.

»»»» 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

»»»» name

string

false

none

none

»»»» postingPeriodVariantId

integer(int64)

false

none

Unique identifier for the posting period variant

»»»» fiscalVariantId

integer(int64)

false

none

Unique identifier for the fiscal variant

»»» 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.

»»»» 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

»»» 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.

»»»» 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

»»» 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.

»»»» 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

»»» 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.

»» masterAgreementDto

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

»»» 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.

»»» 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.

»»» 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.

»»» 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.

»»» 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.

»»» 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.

»»» 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.

»»» 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.

»»» 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.

»» leaseComponentDto

any

false

none

Value for leaseComponentDto field

oneOf - discriminator: type

Name

Type

Required

Restrictions

Description

»»» anonymous

LeaseComponentDto

false

none

Data transfer object representing a lease component within the Nakisa Portfolio Management Suite, encapsulating 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

»»»» principalPositionType

string

true

none

Type of the principal position

»»»» name

string

true

none

Name of the resource

»»»» description

string

false

none

Description of the resource

»»»» bulkAsset

boolean

false

none

Boolean flag indicating bulkAsset status

»»»» rouStartDate

string(date)

false

none

Date of the rou start

»»»» rouEndDate

string(date)

false

none

Date of the rou end

»»»» approverComment

string

false

none

Text value for approverComment in LeaseComponentDto

»»»» fairMarketValue

number(double)

false

none

Value for fairMarketValue field

»»»» allocationNumber

string

false

none

Text value for allocationNumber in LeaseComponentDto

»»»» guaranteedResidualValue

number(double)

false

none

Value for guaranteedResidualValue field

»»»» unitDistributions

[UnitsDistributionDto]

false

none

List of unitDistributions items

»»»»» id

integer(int64)

false

none

Unique identifier for the resource

»»»»» leaseComponentId

integer(int64)

false

none

Unique identifier for the lease component

»»»»» leaseComponentDisplayId

string

false

none

Unique identifier for the lease component display

»»»»» activationGroupName

string

false

none

Name of the activation group

»»»»» activationGroupDisplayId

string

false

none

Unique identifier for the activation group display

»»»»» numberOfUnits

integer(int64)

false

none

Numeric value representing numberOfUnits

»»»»» unitDisplayIds

[string]

false

none

List of unitDisplayIds items

»»»» revision

LeaseComponentRevisionDto

false

none

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

»»»»» 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 LeaseComponentRevisionDto

»»»»» approvedAt

string(date-time)

false

none

Text value for approvedAt in LeaseComponentRevisionDto

»»»»» parentRevisionId

integer(int64)

false

none

Unique identifier for the parent revision

»»»»» approverComment

string

false

none

Text value for approverComment in LeaseComponentRevisionDto

»»»»» leaseComponentId

integer(int64)

false

none

Unique identifier for the lease component

»»»»» leaseComponentDisplayId

string

false

none

Unique identifier for the lease component display

»»»»» leaseComponentName

string

false

none

Name of the lease component

»»»»» contractRevisionId

integer(int64)

false

none

Unique identifier for the contract revision

»»»»» contractRevisionDisplayId

string

false

none

Unique identifier for the contract revision display

»»»»» 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 LeaseComponentRevisionDto

»»»»» 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.

»»»»» allowsSystemGenerateNewId

boolean

false

none

Unique identifier for the allows system generate new

»»»» 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.

»»»» unitOfMeasure

UnitOfMeasureLite

false

none

Data transfer object representing a unit of measure within the Nakisa Portfolio Management Suite, utilized for quantifying and analyzing assets in the context of portfolio management 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

»»»»» erpSystemId

integer(int64)

false

none

Unique identifier for the erp system

»»»» notifications

[LeaseComponentSubscriptionDto]

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.

»»»»» username

string

false

none

Human-readable name of the portfolio

»»»»» leaseComponentId

integer(int64)

false

none

Unique identifier for the lease component

»»»»» leaseComponentDisplayId

string

false

none

Unique identifier for the lease component display

»»»»» targetId

string

false

none

Unique identifier for the target

»»»»» targetType

string

false

none

Type of the target

»»»» spreadingFrequency

string

false

none

Text value for spreadingFrequency in LeaseComponentDto

»»»» contractId

integer(int64)

true

none

Unique identifier for the contract

»»»» contractDisplayId

string

false

none

Unique identifier for the contract display

»»»» companyCodeId

integer(int64)

false

none

Unique identifier for the company code

»»»» companyCodeDisplayId

string

false

none

Unique identifier for the company code display

»»»» userDeterminedLeaseType

string

false

none

Type of the user determined lease

»»»» endOfTermDate

string(date)

false

none

Date of the end of term

»»»» endOfTermPeriod

integer(int32)

false

none

Numeric value representing endOfTermPeriod

»»»» 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.

»»»» 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 LeaseComponentDto

»»»» 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.

»»»» type

string

false

none

Type of the resource

xor

Name

Type

Required

Restrictions

Description

»»» anonymous

LesseeLeaseComponentDto

false

none

Data transfer object representing the details of a lessee’s lease component within the Nakisa Portfolio Management Suite, facilitating insights into portfolio management, asset utilization, and real estate analytics.

allOf - discriminator: type

Name

Type

Required

Restrictions

Description

»»»» anonymous

LeaseComponentDto

false

none

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

and

Name

Type

Required

Restrictions

Description

»»»» anonymous

object

false

none

none

»»»»» residualValue

number

false

none

none

xor

Name

Type

Required

Restrictions

Description

»»» anonymous

LessorLeaseComponentDto

false

none

LessorLeaseComponentDto is a data transfer object that encapsulates essential details of lease agreements within the Nakisa Portfolio Management Suite, facilitating effective portfolio and asset management for real estate properties and supporting analytical insights.

allOf - discriminator: type

Name

Type

Required

Restrictions

Description

»»»» anonymous

LeaseComponentDto

false

none

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

and

Name

Type

Required

Restrictions

Description

»»»» anonymous

object

false

none

none

»»»»» unguaranteedResidualValue

number(double)

false

none

none

»»»»» grossBookValue

number(double)

false

none

none

»»»»» totalResidualValue

number(double)

false

none

none

»»»»» subleasing

boolean

false

none

none

continued

Name

Type

Required

Restrictions

Description

»» activationGroupDto

ActivationGroupDto

false

none

Data transfer object representing an activation group within the Nakisa Portfolio Management Suite, encapsulating relevant details for managing portfolio assets and analytics related to real estate properties.

»»» id

integer(int64)

false

none

Unique identifier for the resource

»»» displayId

string

false

none

Unique identifier for the display

»»» principalPositionType

string

false

none

Type of the principal position

»»» name

string

true

none

Name of the resource

»»» description

string

false

none

Description of the resource

»»» approverComment

string

false

none

Text value for approverComment in ActivationGroupDto

»»» snapshotData

ActivationGroupSnapshotData

false

none

Data transfer object representing a snapshot of activation group metrics within the Nakisa Portfolio Management Suite, providing insights into portfolio performance, asset utilization, and real estate property analytics.

»»»» isParallelCurrencyEnabled

boolean

false

none

Whether the resource is parallel currency enabled

»»»» isCostCenterAllocationEnabled

boolean

false

none

Whether the resource is cost center allocation enabled

»»»» useSpotRateForGroupCurrency

boolean

false

none

Boolean flag indicating useSpotRateForGroupCurrency status

»»»» usePostingOrDocumentDateForCurrency

boolean

false

none

none

»»»» exchangeRateTypes

[ExchangeRateTypeSnapshot]

false

none

List of exchangeRateTypes items

»»»»» currencyDefinitionType

string

false

none

Type of the currency definition

»»»»» sourceCurrencyType

string

false

none

Type of the source currency

»»»»» translationDateType

string

false

none

Type of the translation date

»»»»» targetCurrency

CurrencyBaseId

false

none

Data transfer object representing the unique identifier for currency within the Nakisa Portfolio Management Suite, facilitating accurate financial analytics and reporting across portfolio assets and real estate properties.

»»»»»» id

integer(int64)

false

none

Unique identifier for the resource

»»»»»» displayId

string

false

none

Unique identifier for the display

»»»»»» decimalPoints

integer(int32)

true

none

Numeric value representing decimalPoints

»»»»» referenceCurrency

BaseId

false

none

Data transfer object representing a unique identifier for assets within the Nakisa Portfolio Management Suite, facilitating effective 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

»»»»» currencyType

string

false

none

Type of the currency

»»»»» exchangeRateType

string

false

none

Type of the exchange rate

»»» revision

ActivationGroupRevisionDto

false

none

Data transfer object representing a revision of an activation group within the Nakisa Portfolio Management Suite, encompassing critical information related to portfolio, asset management, analytics, and real estate property.

»»»» 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 ActivationGroupRevisionDto

»»»» approvedAt

string(date-time)

false

none

Text value for approvedAt in ActivationGroupRevisionDto

»»»» parentRevisionId

integer(int64)

false

none

Unique identifier for the parent revision

»»»» approverComment

string

false

none

Text value for approverComment in ActivationGroupRevisionDto

»»»» rouStartDate

string(date)

true

none

Date of the rou start

»»»» rouEndDate

string(date)

true

none

Date of the rou end

»»»» activationGroupModification

ActivationGroupModification

false

none

Data transfer object representing modifications to an activation group within the Nakisa Portfolio Management Suite, facilitating the management of portfolio assets and enhancing analytics for real estate property performance.

»»»»» modificationDate

string(date)

false

none

Date of the modification

»»»»» terminationType

string

false

none

Type of the termination

»»»»» terminationDate

TimeOfDay

false

none

Data transfer object representing the specific time of day relevant to portfolio and asset management activities within the Nakisa Portfolio Management Suite, facilitating analytics and decision-making for real estate properties.

»»»»»» timing

string

false

none

Text value for timing in TimeOfDay

»»»»»» year

integer(int32)

false

none

Numeric value representing year

»»»»»» monthValue

integer(int32)

false

none

Numeric value representing monthValue

»»»»»» dayOfMonth

integer(int32)

false

none

Numeric value representing dayOfMonth

»»»»»» leapYear

boolean

false

none

Boolean flag indicating leapYear status

»»»»»» month

string

false

none

Text value for month in TimeOfDay

»»»»»» dayOfWeek

string

false

none

Text value for dayOfWeek in TimeOfDay

»»»»»» dayOfYear

integer(int32)

false

none

Numeric value representing dayOfYear

»»»»» useManualFmvValue

boolean

false

none

Boolean flag indicating useManualFmvValue status

»»»»» useManualAssetValues

boolean

false

none

Boolean flag indicating useManualAssetValues status

»»»»» enforceNonLeaseOnIndexation

boolean

false

none

Boolean flag indicating enforceNonLeaseOnIndexation status

»»»»» applyIndexationLease

boolean

false

none

Boolean flag indicating applyIndexationLease status

»»»»» applyIndexationNonLease

boolean

false

none

Boolean flag indicating applyIndexationNonLease status

»»»»» indexationTreatmentType

string

false

none

Type of the indexation treatment

»»»»» indexationStartDate

string(date)

false

none

Date of the indexation start

»»»»» indexationDateType

string

false

none

Type of the indexation date

»»»»» indexationStartDateNonLease

string(date)

false

none

Text value for indexationStartDateNonLease in ActivationGroupModification

»»»»» indexationDateTypeNonLease

string

false

none

Text value for indexationDateTypeNonLease in ActivationGroupModification

»»»»» modificationReasons

[string]

false

none

List of modificationReasons items

»»»»» modificationPerClassificationList

[ModificationPerActivationGroupClassification]

false

none

List of modificationPerClassificationList items

»»»»»» accountingStandardId

integer(int64)

false

none

Unique identifier for the accounting standard

»»»»»» classificationType

string

false

none

Type of the classification

»»»»»» accountingStandardType

string

false

none

Type of the accounting standard

»»»»»» impairmentAmount

number(double)

false

none

Amount of impairment

»»»»»» recoverableAmount

number(double)

false

none

Amount of recoverable

»»»»»» decreaseInAsset

number(double)

false

none

Value for decreaseInAsset field

»»»»»» decreaseInTerm

number(double)

false

none

Value for decreaseInTerm field

»»»»» massIndexationTaskId

integer(int64)

false

none

Unique identifier for the mass indexation task

»»»» activationGroupId

integer(int64)

false

none

Unique identifier for the activation group

»»»» activationGroupDisplayId

string

false

none

Unique identifier for the activation group display

»»»» activationGroupName

string

false

none

Name of the activation group

»»»» leaseComponentRevisionId

integer(int64)

false

none

Unique identifier for the lease component revision

»»»» leaseComponentRevisionDisplayId

string

false

none

Unique identifier for the lease component revision display

»»»» lastLeaseComponentRevisionId

integer(int64)

false

none

Unique identifier for the last lease component revision

»»»» lastLeaseComponentRevisionDisplayId

string

false

none

Unique identifier for the last lease component revision display

»»»» clonedFromRevisionId

integer(int64)

false

none

Unique identifier for the cloned from revision

»»»» clonedFromRevisionDisplayId

string

false

none

Unique identifier for the cloned from revision display

»»»» lockReason

string

false

none

Text value for lockReason in ActivationGroupRevisionDto

»»»» infiniteUsefulLife

boolean

false

none

Boolean flag indicating infiniteUsefulLife status

»»»» transferOfOwnership

boolean

false

none

Boolean flag indicating transferOfOwnership status

»»»» specializedAsset

boolean

false

none

Boolean flag indicating specializedAsset status

»»»» fairMarketValue

number(double)

false

none

Value for fairMarketValue field

»»»» residualValue

number

false

none

Value for residualValue field

»»»» endOfTermIntention

string

false

none

Text value for endOfTermIntention in ActivationGroupRevisionDto

»»»» endOfTermDate

string(date)

false

none

Date of the end of term

»»»» endOfTermPeriod

integer(int32)

false

none

Numeric value representing endOfTermPeriod

»»»» activationDocumentDate

string(date)

false

none

none

»»»» activationPostingDate

string(date)

false

none

none

»»»» closingDocumentDate

string(date)

false

none

none

»»»» closingPostingDate

string(date)

false

none

none

»»»» 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 ActivationGroupRevisionDto

»»»» 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.

»»»» allowsSystemGenerateNewId

boolean

false

none

Unique identifier for the allows system generate new

»»» leaseComponentId

integer(int64)

false

none

Unique identifier for the lease component

»»» leaseComponentDisplayId

string

false

none

Unique identifier for the lease component display

»»» companyCodeId

integer(int64)

false

none

Unique identifier for the company code

»»» companyCodeDisplayId

string

false

none

Unique identifier for the company code display

»»» splittedFromActivationGroupRevisionId

ActivationGroupRevisionDto

false

none

Data transfer object representing a revision of an activation group within the Nakisa Portfolio Management Suite, encompassing critical information related to portfolio, asset management, analytics, and real estate property.

»»» notifications

[ActivationGroupSubscriptionDto]

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.

»»»» username

string

false

none

Human-readable name of the portfolio

»»»» activationGroupId

integer(int64)

false

none

Unique identifier for the activation group

»»»» activationGroupDisplayId

string

false

none

Unique identifier for the activation group display

»»»» targetId

string

false

none

Unique identifier for the target

»»»» targetType

string

false

none

Type of the target

»»» 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.

»»» 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 ActivationGroupDto

»»» 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.

»»» allowsSystemGenerateNewId

boolean

false

none

Unique identifier for the allows system generate new

» expenseCategories

[ExpenseCategoryDto]

false

none

List of expenseCategories items

»» 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

»» editable

boolean

true

none

Boolean flag indicating editable status

»» expenseCategoryType

string

true

none

Type of the expense category

» calculationId

integer(int64)

false

none

Unique identifier for the calculation

Enumerated Values

Attribute

Value

accountingStandardType

GAAP, GASB_87, IFRS, OFF_BALANCE_SHEET

assetClassType

EQUIPMENT, PLANT, PROPERTY

assetValueCurrencyType

COMPANY_CURRENCY, CONTRACT_CURRENCY

classificationType

DIRECT_FINANCING, FINANCE, LOW_VALUE, NON_LEASE, OFF_BALANCE_SHEET, OPERATING, PROVISIONING, SALES_TYPE, SERVICE_CONTRACT, SHORT_TERM

contractPhase

CLOSED, DRAFT, INITIAL, REJECTED, SETUP

currencyDefinitionType

COMPANY_CURRENCY, CONTRACT_CURRENCY, MONTH_END_CURRENCY, REPORTING_CURRENCY, SECOND_LOCAL_CURRENCY, THIRD_LOCAL_CURRENCY

dayOfWeek

FRIDAY, MONDAY, SATURDAY, SUNDAY, THURSDAY, TUESDAY, WEDNESDAY

endOfTermIntention

NATURAL_LEASE_END, NOT_APPLICABLE, PURCHASE, RETURN, TO_BE_DETERMINED

expenseCategoryType

CASH_INCENTIVE, CASUALTY, EXPECTED_GRV, INCENTIVE, NON_LEASE, PAYMENT, PURCHASE_OPTION, TERMINATION_OPTION

formOfLease

FULL, NET

idGenerationType

AUTO, MANUAL

indexationDateType

JOB_DATE, MODIFICATION_DATE, NEXT_AVAILABLE_PAYMENT_DATE, ROU_ANNIVERSARY_DATE, USER_DEFINED

indexationDateTypeNonLease

JOB_DATE, MODIFICATION_DATE, NEXT_AVAILABLE_PAYMENT_DATE, ROU_ANNIVERSARY_DATE, USER_DEFINED

indexationTreatmentType

DEFAULT, ENFORCE_LEASE, ENFORCE_NON_LEASE, STANDARD

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

lockReason

CLOSED_CLOSING_RECLOSE_REJECTED, PENDING_TERMINATION

month

APRIL, AUGUST, DECEMBER, FEBRUARY, JANUARY, JULY, JUNE, MARCH, MAY, NOVEMBER, OCTOBER, SEPTEMBER

principalPositionType

LESSEE, LESSOR

priority

HIGH, LOW, MEDIUM

revisionType

ACTIVE, DRAFT, INACTIVE, REVERTED, REVISION

sourceCurrencyType

COMPANY_CURRENCY, CONTRACT_CURRENCY, N_A

spreadingFrequency

NONE, PERIODIC, STRAIGHT_LINE

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

terminationType

CASUALTY, EARLY_TERMINATION, INTERCOMPANY_TRANSFER, PURCHASING_OPTION

timing

END_OF_DAY, START_OF_DAY

translationDateType

, DOCUMENT_DATE, POSTING_DATE, TRANSLATION_DATE

type

MIGRATION, TESTING

userDeterminedLeaseType

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

Get Percentage Rent Report Calculations

HTTP Request

GET /api/percentage-rent-reports/{id}/calculations

📋 Description: Retrieves calculations related to percentage rent reports for a specified asset within the Nakisa Portfolio Management Suite, enabling users to analyze financial performance and optimize portfolio management strategies.

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 percentage rent calculations should be returned in a paginated format, facilitating efficient data retrieval for portfolio and asset analytics within the Nakisa Portfolio Management Suite.

Responses

Status

Meaning

Description

Schema

200

OK

OK

PagedModelEntityModelPercentageRentReportCalculationGroupDto