Financial Obligation Reportยถ

Financial Obligation Report - Get Foreportยถ

HTTP Request

GET /api/financial-obligation-reports/{id}

๐Ÿ“‹ Description: Retrieves detailed financial obligation reports for a specified asset within the Nakisa Portfolio Management Suite, enabling users to analyze portfolio performance and make informed real estate investment decisions.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

200

OK

OK

FOReportDto

Financial Obligation Report - Update Foreportยถ

HTTP Request

PUT /api/financial-obligation-reports/{id}

๐Ÿ“‹ Description: Updates the financial obligation report identified by the specified ID, enabling users to refine asset analytics within the Nakisa Portfolio Management Suite for enhanced portfolio management and real estate property insights.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

body

body

FOReportDto

true

Request body containing the updated financial obligation report data, including asset details, portfolio metrics, and analytics relevant to real estate property management.

Responses

Status

Meaning

Description

Schema

200

OK

OK

FOReportDto

Financial Obligation Report - Delete Foreportยถ

HTTP Request

DELETE /api/financial-obligation-reports/{id}

๐Ÿ“‹ Description: Deletes a specified financial obligation report from the Nakisa Portfolio Management Suite, enabling users to manage and streamline their portfolio and asset analytics related to real estate properties.

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

Financial Obligation Report - Get Assumptionsยถ

HTTP Request

GET /api/financial-obligation-reports/{id}/assumptions

๐Ÿ“‹ Description: Fetches the assumptions associated with a specific financial obligation report, providing insights for portfolio and asset analytics 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

[ExpenseCategoryAssumptionDto]

false

none

[Data transfer object representing the assumptions related to expense categories within the Nakisa Portfolio Management Suite, facilitating effective portfolio and asset analytics for 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

ยป foReportId

integer(int64)

false

none

Unique identifier for the fo report

ยป expenseCategoryId

integer(int64)

false

none

Unique identifier for the expense category

ยป percentageChange

number

false

none

Value for percentageChange field

ยป source

string

false

none

Indicates the origin of the expense category assumption within the Nakisa Portfolio Management Suite, facilitating accurate portfolio, asset, and real estate property analytics.

ยป startDate

string(date)

false

none

Start date of the resource

ยป endDate

string(date)

false

none

End date of the resource

Financial Obligation Report - Update Assumptionsยถ

HTTP Request

PUT /api/financial-obligation-reports/{id}/assumptions

๐Ÿ“‹ Description: Updates the assumptions associated with a specific financial obligation report in the Nakisa Portfolio Management Suite, enabling enhanced analytics and insights for portfolio and asset management in real estate properties.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

body

body

ExpenseCategoryAssumptionDto

true

Request body containing the updated assumptions data for the specified financial obligation report, including relevant portfolio and asset analytics for real estate property management.

Responses

Status

Meaning

Description

Schema

200

OK

OK

None

Financial Obligation Report - Unarchive Foreportยถ

HTTP Request

POST /api/financial-obligation-reports/{id}/unarchive

๐Ÿ“‹ Description: Unarchives a specified financial obligation report within the Nakisa Portfolio Management Suite, allowing users to reintegrate valuable analytics related to portfolio and asset management 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

FOReportDto

Financial Obligation Report - Review Foreportยถ

HTTP Request

POST /api/financial-obligation-reports/{id}/review

๐Ÿ“‹ Description: Submits a review for the specified financial obligation report, facilitating enhanced analytics and decision-making within the Nakisa Portfolio Management Suite for real estate property and asset management.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

200

OK

OK

FOReportDto

Financial Obligation Report - Reopen Foreportยถ

HTTP Request

POST /api/financial-obligation-reports/{id}/reopen

๐Ÿ“‹ Description: Reopens a previously closed financial obligation report identified by the specified ID, enabling users to make necessary adjustments within the Nakisa Portfolio Management Suite for enhanced portfolio and asset analytics in real estate property management.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

200

OK

OK

FOReportDto

Financial Obligation Report - Reject Foreportยถ

HTTP Request

POST /api/financial-obligation-reports/{id}/reject

๐Ÿ“‹ Description: Rejects a specified financial obligation report within the Nakisa Portfolio Management Suite, enabling users to manage and streamline portfolio analytics related to real estate assets.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

200

OK

OK

FOReportDto

Financial Obligation Report - Regenerate Foreportยถ

HTTP Request

POST /api/financial-obligation-reports/{id}/regenerate

๐Ÿ“‹ Description: Regenerates the financial obligation report associated with the specified ID, enabling users to refresh data for enhanced accuracy in portfolio and asset analytics 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

FOReportDto

Financial Obligation Report - Get Foreport Notesยถ

HTTP Request

GET /api/financial-obligation-reports/{id}/notes

๐Ÿ“‹ Description: Fetches notes associated with a specific financial obligation report, enabling users to gain insights into portfolio and asset analytics 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 financial obligation report notes 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 notes related to a specific financial obligation report, enhancing portfolio and asset analytics within the Nakisa Portfolio Management Suite.

message

query

string

false

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

Responses

Status

Meaning

Description

Schema

200

OK

OK

PagedModelEntityModelNoteDto

Financial Obligation Report - Create Foreport Notesยถ

HTTP Request

POST /api/financial-obligation-reports/{id}/notes

๐Ÿ“‹ Description: Adds notes to a specified financial obligation report within the Nakisa Portfolio Management Suite, enhancing portfolio and asset analytics 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 financial obligation report notes data, including relevant annotations and metadata to enhance portfolio and asset analytics within the Nakisa Portfolio Management Suite.

Responses

Status

Meaning

Description

Schema

201

Created

Created

Inline

Response Schema

Status Code 201

Name

Type

Required

Restrictions

Description

anonymous

[NoteDto]

false

none

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

ยป createdBy

string

false

none

Username of who created this resource

ยป lastModifiedBy

string

false

none

Username of who last modified this resource

ยป createdDate

string(date-time)

false

none

Date of the created

ยป lastModifiedDate

string(date-time)

false

none

Date of the last modified

ยป archived

boolean

false

none

Boolean flag indicating archived status

ยป externalId

string

false

none

Unique identifier for the external

ยป id

integer(int64)

false

none

Unique identifier for the resource

ยป message

string

true

none

Textual content providing detailed information or commentary related to the portfolio, asset, or real estate property within the Nakisa Portfolio Management Suite.

ยป userIds

[integer]

false

none

User information related to portfolio management

ยป redirectUrl

string

false

none

URL to which users will be redirected after completing a specific action within the Nakisa Portfolio Management Suite, facilitating seamless navigation in the context of portfolio, asset, and real estate property management.

Financial Obligation Report - Generate Foreportยถ

HTTP Request

POST /api/financial-obligation-reports/{id}/generate

๐Ÿ“‹ Description: Generates a financial obligation report for a specified asset within the Nakisa Portfolio Management Suite, enabling stakeholders to analyze portfolio performance and financial commitments related to 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

FOReportDto

Financial Obligation Report - Archive Foreportยถ

HTTP Request

POST /api/financial-obligation-reports/{id}/archive

๐Ÿ“‹ Description: Archives the specified financial obligation report within the Nakisa Portfolio Management Suite, enabling streamlined asset management and enhanced 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

FOReportDto

Financial Obligation Report - Approve Foreportยถ

HTTP Request

POST /api/financial-obligation-reports/{id}/approve

๐Ÿ“‹ Description: Approves a specified financial obligation report within the Nakisa Portfolio Management Suite, facilitating enhanced 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

FOReportDto

Financial Obligation Report - Get Foreportsยถ

HTTP Request

GET /api/financial-obligation-report

๐Ÿ“‹ Description: Fetches the financial obligation report for assets within the Nakisa Portfolio Management Suite, providing critical analytics for real estate properties and portfolio management.

Parameters

Name

In

Type

Required

Description

pageable

query

Pageable

true

Indicates whether the results of the financial obligation report should be returned in a paginated format, facilitating efficient data retrieval for portfolio and asset analysis within the Nakisa Portfolio Management Suite.

search

query

string

false

Search term used to filter financial obligation reports based on portfolio, asset, or real estate property criteria 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 the financial obligation report, allowing users to analyze portfolio and asset performance within a defined time frame.

end-date

query

string

false

Specifies the end date for the financial obligation report, allowing users to filter data relevant to portfolio and asset analytics within the real estate property context.

status-id

query

string

false

Unique identifier for the status of a financial obligation report, facilitating targeted analytics within the Nakisa Portfolio Management Suite for portfolio and asset management in real estate properties.

status-id-is-not

query

string

false

Excludes financial obligations from the report based on the specified status ID, enabling targeted analysis of portfolio assets within the Nakisa Portfolio Management Suite.

Responses

Status

Meaning

Description

Schema

200

OK

OK

PagedModelEntityModelFOReportDto

Financial Obligation Report - Create Foreportsยถ

HTTP Request

POST /api/financial-obligation-report

๐Ÿ“‹ Description: Generates a comprehensive financial obligation report for real estate properties within the portfolio, enabling enhanced analytics and informed decision-making.

Parameters

Name

In

Type

Required

Description

body

body

FOReportDto

true

Request body containing detailed financial obligation data for portfolio analysis, including asset identification and real estate property metrics.

Responses

Status

Meaning

Description

Schema

201

Created

Created

Inline

Response Schema

Status Code 201

Name

Type

Required

Restrictions

Description

anonymous

[FOReportDto]

false

none

[Data transfer object representing a comprehensive financial and performance report for real estate assets within the Nakisa Portfolio Management Suite, facilitating portfolio analytics and strategic decision-making.]

ยป 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

ยป fiscalStartDate

string(date)

false

none

Date of the fiscal start

ยป startDate

string(date)

false

none

Start date of the resource

ยป endDate

string(date)

false

none

End date of the resource

ยป userSelectedEndDate

boolean

false

none

Date of the user selected end

ยป statusId

integer(int64)

false

none

Unique identifier for the status

ยป frequencyId

integer(int64)

true

none

Unique identifier for the frequency

ยป generatedBy

string

false

none

Identifies the user or system process that generated the report, providing context for portfolio and asset analytics within the Nakisa Portfolio Management Suite.

ยป generatedDate

string(date-time)

false

none

Date of the generated

ยป approvedBy

string

false

none

Identifier of the individual or entity that has approved the report, ensuring accountability and traceability within the Nakisa Portfolio Management Suiteโ€™s asset and portfolio analytics.

ยป approvedDate

string(date-time)

false

none

Date of the approved

ยป 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

ยป reportCurrencyDisplayId

string

true

none

Unique identifier for the report currency display

ยป expenseCategoryIds

[integer]

false

none

List of expenseCategoryIds items

ยป leaseIds

[integer]

false

none

List of leaseIds items

ยป massProfileFilterIds

[integer]

false

none

none

ยป 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

Textual content providing detailed insights or commentary related to the portfolio, asset, or real estate property within the Nakisa Portfolio Management Suite.

ยปยป preserveOriginalAudit

boolean

false

none

Indicates whether to retain the original audit trail for portfolio and asset analytics within the Nakisa Portfolio Management Suite.

ยปยป originalCreatedBy

string

false

none

Identifies the original creator of the note within the Nakisa Portfolio Management Suite, providing essential context for portfolio, asset, and real estate property analytics.

ยปยป originalCreatedDate

string(date-time)

false

none

Date of the original created

ยปยป originalLastModifiedBy

string

false

none

Identifier of the user who last modified the note, providing accountability and traceability within the context of portfolio, asset, and real estate property management.

ยปยป originalLastModifiedDate

string(date-time)

false

none

Date of the original last modified

ยป 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

Represents the descriptive value associated with a portfolio asset, facilitating analytics and insights within the Nakisa Portfolio Management Suite.

ยป frequency

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.

ยป reportCurrency

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

ยป 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

ยป massProfileFilters

[MassProfileFilterDto]

false

none

[Data transfer object representing a filter for mass profile queries within the Nakisa Portfolio Management Suite, enabling users to refine analytics related to 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

Indicates whether the portfolio asset has been archived, facilitating effective management and analytics within the Nakisa Portfolio Management Suite.

ยปยป 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

ยปยป leaseList

boolean

false

none

Indicates whether to include lease-related assets in the portfolio analytics for real estate properties within the Nakisa Portfolio Management Suite.

ยปยป leaseIds

[integer]

false

none

An array of unique identifiers representing the leases associated with the portfolio, asset, or real estate property for analytical purposes within the Nakisa Portfolio Management Suite.

ยปยป 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

Indicates the status of the lease termination within the Nakisa Portfolio Management Suite, providing critical insights for portfolio and asset analytics in real estate management.

ยปยปยป maximumDateTo

string(date)

false

none

Specifies the latest date through which lease data can be analyzed within the Nakisa Portfolio Management Suite, facilitating effective portfolio and asset management in real estate analytics.

ยปยปยป number

string

false

none

Represents the unique identification number assigned to a lease within the Nakisa Portfolio Management Suite, facilitating effective portfolio and asset management in real estate analytics.

ยปยปยป 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

Unique identifier assigned to a lease agreement, facilitating asset tracking and portfolio management within the Nakisa Portfolio Management Suite.

ยปยปยป 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

Specifies the type of indexation applied to non-lease assets within the Nakisa Portfolio Management Suite, facilitating accurate portfolio and asset analytics in real estate property management.

ยปยปยป cpiGlobalCategoryIdNonLease

integer(int64)

false

none

Numeric value representing cpiGlobalCategoryIdNonLease

ยปยปยป indexationReferenceDateNonLease

string(date)

false

none

Represents the reference date for indexation adjustments related to non-lease assets within the Nakisa Portfolio Management Suite, facilitating accurate portfolio and asset analytics in real estate property management.

ยปยปยป 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

Identifier of the user or entity that has reviewed the event, providing accountability and transparency within the portfolio management process.

ยปยปยปยปยป 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

Detailed description of the event, providing insights relevant to portfolio, asset, and real estate property analytics within the Nakisa Portfolio Management Suite.

ยปยปยปยปยป 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

Represents the unique identification number assigned to a real estate property within the Nakisa Portfolio Management Suite, facilitating effective portfolio and asset analytics.

ยปยปยปยป 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

Represents the numerical designation of a real estate property within the Nakisa Portfolio Management Suite, facilitating asset tracking and analytics within the portfolio.

ยปยปยปยปยป name

string

true

none

Name of the resource

ยปยปยปยปยป storeNumber

string

false

none

Unique identifier for the store within the Nakisa Portfolio Management Suite, facilitating asset tracking and analytics related to real estate properties.

ยปยปยปยปยป 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.

ยปยปยปยปยป 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

Represents the street address of a real estate property within the Nakisa Portfolio Management Suite, facilitating accurate portfolio and asset analytics.

ยปยปยปยปยปยป civicNumber

string

false

none

The civicNumber field represents the official identification number assigned to a real estate property, facilitating accurate portfolio management and asset analytics within the Nakisa Portfolio Management Suite.

ยปยปยปยปยปยป suite

string

false

none

Represents the name of the suite associated with the portfolio, asset, or real estate property within the Nakisa Portfolio Management Suite, facilitating comprehensive analytics and management.

ยปยปยปยปยปยป 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

Date from which the resource is valid

ยปยป validTo

string(date)

false

none

Date until which the resource is valid

ยปยป cityIds

[integer]

false

none

An array of unique identifiers representing the cities associated with the portfolio, asset, or real estate property analytics within the Nakisa Portfolio Management Suite.

ยปยป provinceIds

[integer]

false

none

An array of unique identifiers representing the provinces associated with the portfolio, asset, or real estate property within the Nakisa Portfolio Management Suite.

ยปยป countryIds

[integer]

false

none

An array of unique identifiers representing the countries associated with the portfolio, asset, or analytics within the Nakisa Portfolio Management Suite.

ยปยป premiseIds

[integer]

false

none

Array of unique identifiers for premises associated with the portfolio, asset, and analytics within the Nakisa Portfolio Management Suite, facilitating targeted real estate property management.

ยปยป locationIds

[integer]

false

none

Array of unique identifiers representing specific locations within the Nakisa Portfolio Management Suite, utilized for filtering portfolios, assets, analytics, and real estate properties.

ยปยป businessUnitIds

[integer]

false

none

Array of unique identifiers representing the business units associated with the portfolio, asset, analytics, or real estate property within the Nakisa Portfolio Management Suite.

ยปยป legalEntityIds

[integer]

false

none

Array of unique identifiers representing the legal entities associated with the portfolio, asset, or real estate property within the Nakisa Portfolio Management Suite.

ยปยป groupIds

[string]

false

none

An array of unique identifiers representing the groups associated with the portfolio, asset, analytics, or real estate property within the Nakisa Portfolio Management Suite.

ยปยป groupOptionIds

[integer]

false

none

Array of unique identifiers for group options used to filter profiles within the Nakisa Portfolio Management Suite, applicable across portfolio, asset, analytics, and real estate property contexts.

ยปยป masterAgreementIds

[integer]

false

none

Array of unique identifiers for master agreements associated with portfolios, assets, and real estate properties within the Nakisa Portfolio Management Suite.

ยปยป contractIds

[integer]

false

none

Array of unique identifiers for contracts associated with the portfolio, asset, analytics, and real estate property within the Nakisa Portfolio Management Suite.

ยปยป statusIds

[integer]

false

none

Array of unique identifiers representing the status of various entities within the Nakisa Portfolio Management Suite, applicable across portfolio, asset, analytics, and real estate property domains.

ยปยป cities

[CityDto]

false

none

An array of cities used to filter and analyze real estate properties 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

ยปยปยป 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

An array of provinces used to filter and analyze real estate property data within the Nakisa Portfolio Management Suite.

ยปยป countries

[CountryDto]

false

none

An array of country identifiers used to filter and analyze portfolios, assets, and real estate properties within the Nakisa Portfolio Management Suite.

ยปยป locations

[LocationDto]

false

none

An array of location identifiers used to filter and analyze assets within the Nakisa Portfolio Management Suite, relevant for portfolio management, asset tracking, and real estate analytics.

ยปยป premises

[PremiseDto]

false

none

An array of premises associated with the portfolio, asset, or real estate property, used for filtering analytics within the Nakisa Portfolio Management Suite.

ยปยป groups

[PickListDto]

false

none

An array of group identifiers used to filter and categorize assets within the Nakisa Portfolio Management Suite, facilitating enhanced 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

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

An array of options for filtering mass profiles within the Nakisa Portfolio Management Suite, applicable across portfolio, asset, analytics, and real estate property contexts.

ยปยป businessUnits

[BusinessUnitDto]

false

none

An array representing the various business units associated with the portfolio, asset, analytics, and real estate property within the Nakisa Portfolio Management Suite.

ยปยปยป 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

An array of legal entities associated with the portfolio, asset, or real estate property, used for analytics within the Nakisa Portfolio Management Suite.

ยปยปยป 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

Indicates the effective date from which the cost center relationship is valid, facilitating accurate portfolio and asset analytics within the Nakisa Portfolio Management Suite.

ยปยปยป costCenterRelationValidTo

string(date)

false

none

Indicates the expiration date of the cost center relationship, essential for managing portfolio and asset allocations within the Nakisa Portfolio Management Suite.

ยปยป statusOptions

[PickListOptionDto]

false

none

Array of available status options for filtering mass profiles within the Nakisa Portfolio Management Suite, applicable across portfolio, asset, analytics, and real estate property contexts.

ยปยป masterAgreements

[MasterAgreementDto]

false

none

An array of master agreements that facilitates the filtering of mass profile data within the Nakisa Portfolio Management Suite, supporting portfolio, asset, analytics, and real estate property management.

ยปยปยป 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

Specifies the legal jurisdiction applicable to the assets within the portfolio, ensuring compliance with relevant regulations in the context of real estate property management and analytics.

ยปยปยป approverComment

string

false

none

Comments provided by the approver regarding the Master Agreement, facilitating clarity and communication within the context of portfolio and asset management in the Nakisa Portfolio Management Suite.

ยปยปยป signingPerson

string

false

none

Represents the name of the individual authorized to sign the master agreement, essential for validating contractual commitments within the Nakisa Portfolio Management Suite.

ยปยปยป placeOfSignature

string

false

none

Indicates the location where the signature for the master agreement is obtained, relevant for portfolio and asset management within the Nakisa Portfolio Management Suite.

ยปยปยป dateOfSignature

string(date)

false

none

Represents the date on which the master agreement was signed, providing critical context for portfolio and asset management within the Nakisa Portfolio Management Suite.

ยปยปยป state

string

false

none

Current state of the portfolio

ยปยปยป dataCreationInfo

DataCreationSettingLite

false

none

DataCreationSettingLite is a streamlined data transfer object that encapsulates essential settings for creating and managing portfolio and asset data within the Nakisa Portfolio Management Suite, facilitating enhanced analytics for real estate properties.

ยปยปยปยป id

integer(int64)

true

none

Unique identifier for the resource

ยปยปยปยป idGenerationType

string

true

none

Type of the id generation

ยปยปยปยป source

string

false

none

Indicates the origin of the data entry within the Nakisa Portfolio Management Suite, relevant for portfolio, asset, analytics, and real estate property management.

ยปยปยปยป type

string

true

none

Type of the resource

ยปยปยปยป startDateTime

string(date-time)

true

none

Time of the start date

ยปยปยปยป endDateTime

string(date-time)

false

none

Time of the end date

ยปยปยป 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

Represents a unique string identifier for a specific range of numbers associated with assets within the Nakisa Portfolio Management Suite, facilitating effective portfolio and asset analytics in real estate property management.

ยปยปยป 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

An array of contract details relevant to the portfolio, asset, and analytics management within the Nakisa Portfolio Management Suite, specifically for real estate properties.

ยปยปยป 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

Comment provided by the approver regarding the contract, facilitating transparency and communication within the portfolio management process.

ยปยปยป contractPhase

string

false

none

Indicates the current phase of the contract within the Nakisa Portfolio Management Suite, facilitating effective portfolio and asset management in the context of real estate property analytics.

ยปยปยป dataCreationInfo

DataCreationSettingLite

false

none

DataCreationSettingLite is a streamlined data transfer object that encapsulates essential settings for creating and managing portfolio and asset data within the Nakisa Portfolio Management Suite, facilitating enhanced analytics for real estate properties.

ยปยปยป 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

Identifier of the individual or entity that has approved the contract revision, ensuring compliance and accountability within the portfolio management process.

ยปยปยปยป approvedAt

string(date-time)

false

none

Timestamp indicating when the contract revision was approved, relevant for portfolio and asset management analytics within the Nakisa Portfolio Management Suite.

ยปยปยปยป parentRevisionId

integer(int64)

false

none

Unique identifier for the parent revision

ยปยปยปยป approverComment

string

false

none

Comment provided by the approver to offer feedback or rationale regarding the contract revision within the Nakisa Portfolio Management Suite.

ยปยปยปยป 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

String representing an external reference associated with the contract revision, facilitating integration and tracking within the Nakisa Portfolio Management Suite for portfolio, asset, and real estate property analytics.

ยปยปยปยป internalReference

string

false

none

Unique identifier for the internal reference associated with a contract revision, facilitating streamlined management and analytics of portfolio assets within the Nakisa Portfolio Management Suite.

ยปยปยปยป formOfLease

string

false

none

Indicates the type of lease agreement associated with the real estate property within the portfolio, facilitating asset management and analytics in the Nakisa Portfolio Management Suite.

ยปยปยปยป jointVentureLeaseType

string

false

none

Type of the joint venture lease

ยปยปยปยป businessPlace

string

false

none

Represents the designated location of the business entity within the Nakisa Portfolio Management Suite, facilitating effective portfolio and asset management in the context of real estate analytics.

ยปยปยปยป 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

Represents a categorization or classification within the portfolio management framework, facilitating enhanced analytics and reporting for real estate assets.

ยปยปยปยป group4

string

false

none

Represents a categorization label for a specific group within the portfolio, asset, or analytics domains in the Nakisa Portfolio Management Suite.

ยปยปยปยป signingPerson

string

false

none

Represents the name of the individual authorized to sign the contract, essential for validating agreements within the Nakisa Portfolio Management Suiteโ€™s real estate property and asset management processes.

ยปยปยปยป placeOfSignature

string

false

none

Indicates the location where the contract revision is signed, relevant for portfolio and asset management within the Nakisa Portfolio Management Suite.

ยปยปยปยป dateOfSignature

string(date)

false

none

Date of signature indicating when the contract revision was formally executed, relevant for portfolio and asset management within the Nakisa Portfolio Management Suite.

ยปยปยปยป leaseType

string

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

Represents a unique string identifier for a specific range of numbers associated with portfolio assets within the Nakisa Portfolio Management Suite.

ยปยปยปยป allowsSystemGenerateNewId

boolean

false

none

Unique identifier for the allows system generate new

ยปยปยปยป numberRangeType

INumberRangeType

false

none

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

ยปยปยป currency

CurrencyLite

false

none

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

ยปยปยป companyCurrency

CurrencyLite

false

none

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

ยปยปยป indexedCurrency

boolean

false

none

Boolean flag indicating indexedCurrency status

ยปยปยป assetValueCurrencyType

string

false

none

Type of the asset value currency

ยปยปยป currencyLocked

boolean

false

none

Boolean flag indicating currencyLocked status

ยปยปยป leaseArea

LeaseAreaLite

true

none

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

ยปยปยป businessUnit

BusinessUnitLite

true

none

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

ยปยปยป businessUnitLocked

boolean

false

none

Boolean flag indicating businessUnitLocked status

ยปยปยป companyCode

CompanyLite

true

none

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

ยปยปยป companyCodeLocked

boolean

false

none

Boolean flag indicating companyCodeLocked status

ยปยปยป department

DepartmentLite

false

none

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

ยปยปยป departmentLocked

boolean

false

none

Boolean flag indicating departmentLocked status

ยปยปยป leaseGroup

LeaseGroupLite

false

none

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

ยปยปยป leaseGroupLocked

boolean

false

none

Boolean flag indicating leaseGroupLocked status

ยปยปยป subleasingInternalAssetClass

InternalAssetClassLite

false

none

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

ยปยปยป contractGroup1

ContractGroup1Lite

false

none

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

ยปยปยป contractGroup2

ContractGroup2Lite

false

none

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

ยปยปยป subleasing

boolean

false

none

Boolean flag indicating subleasing status

ยปยปยป subleasingContractRevisionInfo

SubleasingContractRevisionLite

false

none

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

ยปยปยปยป id

integer(int64)

true

none

Unique identifier for the resource

ยปยปยปยป contractId

integer(int64)

true

none

Unique identifier for the contract

ยปยปยปยป contractDisplayId

string

true

none

Unique identifier for the contract display

ยปยปยปยป contractName

string

true

none

Name of the contract

ยปยปยป subleasingLeaseComponentRevisionInfo

SubleasingLeaseComponentRevisionLite

false

none

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

ยปยปยปยป id

integer(int64)

true

none

Unique identifier for the resource

ยปยปยปยป leaseComponentId

integer(int64)

true

none

Unique identifier for the lease component

ยปยปยปยป leaseComponentDisplayId

string

true

none

Unique identifier for the lease component display

ยปยปยปยป leaseComponentName

string

true

none

Name of the lease component

ยปยปยป subleasingActivationGroupRevisionInfo

SubleasingActivationGroupRevisionLite

false

none

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

ยปยปยปยป id

integer(int64)

true

none

Unique identifier for the resource

ยปยปยปยป activationGroupId

integer(int64)

true

none

Unique identifier for the activation group

ยปยปยปยป activationGroupDisplayId

string

true

none

Unique identifier for the activation group display

ยปยปยปยป activationGroupName

string

true

none

Name of the activation group

ยปยปยป notifications

[ContractSubscriptionDto]

false

none

List of notifications items

ยปยปยปยป id

integer(int64)

false

none

Unique identifier for the resource

ยปยปยปยป topic

INotificationTopicType

false

none

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

ยปยปยปยปยป enCaption

string

false

none

Textual representation of the English caption associated with a notification topic, relevant for portfolio and asset analytics within the Nakisa Portfolio Management Suite.

ยปยปยปยปยป frCaption

string

false

none

Descriptive label for the notification topic, facilitating clear communication regarding portfolio, asset, and real estate property analytics within the Nakisa Portfolio Management Suite.

ยปยปยปยปยป 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

ยปยปยปยป targetType

string

false

none

Type of the target

ยปยปยปยป targetId

string

false

none

Unique identifier for 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

Represents a unique string identifier for a specific range of numbers associated with portfolio assets within the Nakisa Portfolio Management Suite.

ยปยปยป 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

Represents the selected cities for filtering real estate property listings within the Nakisa Portfolio Management Suite, facilitating targeted portfolio and asset analytics.

ยปยป listingCitiesValues

[string]

false

none

An array of cities associated with the listings, utilized for portfolio analysis and asset management within the Nakisa Portfolio Management Suite.

ยปยป listingProvincesValue

string

false

none

Specifies the provinces associated with the real estate properties in the portfolio, facilitating targeted analytics and asset management within the Nakisa Portfolio Management Suite.

ยปยป listingProvincesValues

[string]

false

none

Array of province values used to filter listings within the Nakisa Portfolio Management Suite, enhancing analytics and insights for real estate property management.

ยปยป listingCountriesValue

string

false

none

Specifies the countries associated with the asset listings in the Nakisa Portfolio Management Suite, facilitating targeted portfolio analytics and real estate property management.

ยปยป listingCountriesValues

[string]

false

none

Array of country values used to filter listings within the Nakisa Portfolio Management Suite, relevant for portfolio, asset, analytics, and real estate property management.

ยปยป listingLocationsValue

string

false

none

Represents the specific locations associated with a real estate property listing, facilitating portfolio analysis and asset management within the Nakisa Portfolio Management Suite.

ยปยป listingLocationsValues

[string]

false

none

An array of location values used to filter and analyze listings within the Nakisa Portfolio Management Suite, relevant to portfolio, asset, analytics, and real estate property management.

ยปยป listingPremisesValue

string

false

none

Represents the estimated value of the real estate property within the portfolio, facilitating informed asset management and analytics.

ยปยป listingPremisesValues

[string]

false

none

Array of premises values associated with real estate properties, utilized for portfolio analysis and asset management within the Nakisa Portfolio Management Suite.

ยปยป listingGroupsValue

string

false

none

Represents the specific value associated with listing groups within the Nakisa Portfolio Management Suite, facilitating effective portfolio and asset analytics in the context of real estate property management.

ยปยป listingGroupsValues

[string]

false

none

Array of values representing the listing groups associated with portfolio, asset, analytics, and real estate property filters within the Nakisa Portfolio Management Suite.

ยปยป listingGroupOptionsValue

string

false

none

Specifies the selected options for the listing group within the Nakisa Portfolio Management Suite, facilitating effective portfolio and asset analytics in real estate property management.

ยปยป listingGroupOptionsValues

[string]

false

none

Array of values representing the options for listing groups, utilized in the Nakisa Portfolio Management Suite to enhance portfolio, asset, and real estate property analytics.

ยปยป listingBusinessUnitsValue

string

false

none

Represents the specific business units associated with a listing in the Nakisa Portfolio Management Suite, facilitating portfolio, asset, and analytics management within the real estate property domain.

ยปยป listingBusinessUnitsValues

[string]

false

none

Array of business unit values associated with the listing, utilized for filtering in portfolio, asset, analytics, and real estate property contexts within the Nakisa Portfolio Management Suite.

ยปยป listingLegalEntitiesValue

string

false

none

Represents the legal entities associated with a portfolio asset, facilitating compliance and regulatory analysis within the Nakisa Portfolio Management Suite.

ยปยป listingLegalEntitiesValues

[string]

false

none

Array of legal entity values associated with the portfolio, asset, and analytics components within the Nakisa Portfolio Management Suite, facilitating comprehensive real estate property management.

ยปยป listingMasterAgreementsValue

string

false

none

Represents the value of master agreements associated with listings within the Nakisa Portfolio Management Suite, facilitating portfolio and asset analytics for real estate properties.

ยปยป listingMasterAgreementsValues

[string]

false

none

Array of values representing the master agreements associated with listings in the Nakisa Portfolio Management Suite, essential for portfolio, asset, analytics, and real estate property management.

ยปยป listingContractsValue

string

false

none

Represents the total value of listing contracts associated with real estate properties within the Nakisa Portfolio Management Suite, facilitating portfolio and asset analytics.

ยปยป listingContractsValues

[string]

false

none

An array of values representing the listing contracts associated with portfolio assets, enabling comprehensive analytics within the Nakisa Portfolio Management Suite.

ยปยป listingStatusOptionsValue

string

false

none

Represents the current status options for listings within the Nakisa Portfolio Management Suite, facilitating effective portfolio, asset, and real estate property management.

ยปยป listingStatusOptionsValues

[string]

false

none

Array of available status options for listings within the Nakisa Portfolio Management Suite, facilitating effective portfolio, asset, and real estate property management and analytics.

ยป expenseCategoryAssumptions

[ExpenseCategoryAssumptionDto]

false

none

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

ยปยป foReportId

integer(int64)

false

none

Unique identifier for the fo report

ยปยป expenseCategoryId

integer(int64)

false

none

Unique identifier for the expense category

ยปยป percentageChange

number

false

none

Value for percentageChange field

ยปยป source

string

false

none

Indicates the origin of the expense category assumption within the Nakisa Portfolio Management Suite, facilitating accurate portfolio, asset, and real estate property analytics.

ยปยป startDate

string(date)

false

none

Start date of the resource

ยปยป endDate

string(date)

false

none

End date of the resource

ยป includeCharges

boolean

false

none

Boolean flag indicating includeCharges status

Enumerated Values

Attribute

Value

assetClassType

EQUIPMENT, PLANT, PROPERTY

assetValueCurrencyType

COMPANY_CURRENCY, CONTRACT_CURRENCY

contractPhase

CLOSED, DRAFT, INITIAL, REJECTED, SETUP

expenseCategoryType

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

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

Financial Obligation Report - Poll Foreport Statusยถ

HTTP Request

GET /api/financial-obligation-reports/{id}/poll

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

OK

FOReportDto

Financial Obligation Report - Get Foreport Period Optionsยถ

HTTP Request

GET /api/financial-obligation-reports/{id}/period-options

๐Ÿ“‹ Description: Retrieves available period options for a specified financial obligation report, enabling users to analyze and manage portfolio and asset data effectively 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

Financial Obligation Report - Is Export Disabledยถ

HTTP Request

GET /api/financial-obligation-reports/{id}/is-export-disabled

๐Ÿ“‹ Description: Retrieves the export status of a specific financial obligation report, indicating whether the report is disabled for export within the Nakisa Portfolio Management Suite, facilitating informed decision-making in portfolio and asset management.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

200

OK

OK

boolean

Financial Obligation Report - Get Folease Entriesยถ

HTTP Request

GET /api/financial-obligation-reports/{id}/financial-obligation-lease-entries

๐Ÿ“‹ Description: Retrieves financial obligation lease entries associated with a specified financial obligation report, enabling users to analyze lease-related data within their real estate portfolio.

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 financial obligation lease entries should be returned in a paginated format, facilitating efficient data retrieval for portfolio and asset analysis within the Nakisa Portfolio Management Suite.

basis-type-internal-id

query

integer(int64)

false

Unique identifier for the basis type associated with financial obligation lease entries, facilitating precise analytics within the Nakisa Portfolio Management Suite.

start-date

query

string(date)

false

Specifies the starting date for retrieving financial obligation lease entries associated with a particular asset, enabling users to analyze portfolio performance over a defined timeframe.

end-date

query

string(date)

false

Specifies the end date for retrieving financial obligation lease entries associated with a particular asset within the Nakisa Portfolio Management Suite.

listing

query

boolean

false

Indicates whether to include lease entries in the financial obligation report for the specified asset, enhancing portfolio analytics within the Nakisa Portfolio Management Suite.

file-number-like

query

string

false

Specifies a string pattern to filter financial obligation lease entries by their associated file number within the Nakisa Portfolio Management Suite.

f-o-report-id

query

string

false

Unique identifier for the financial obligation report, used to retrieve associated lease entries within the Nakisa Portfolio Management Suite.

file-number-in

query

string

false

Identifier for the specific financial obligation lease entry, facilitating the retrieval of detailed analytics related to portfolio and asset management within the Nakisa Portfolio Management Suite.

Responses

Status

Meaning

Description

Schema

200

OK

OK

PagedModelEntityModelFOLeaseEntryDto

Financial Obligation Report - Get Foreport Exchange Ratesยถ

HTTP Request

GET /api/financial-obligation-reports/{id}/exchange-rates

๐Ÿ“‹ Description: Fetches the exchange rates associated with a specific financial obligation report, enabling users to analyze portfolio and asset valuations in the context of real estate property analytics.

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 financial obligation reportโ€™s exchange rates should be returned in a paginated format, enhancing data accessibility for portfolio and asset analytics within the Nakisa Portfolio Management Suite.

search

query

string

false

Search term used to filter exchange rate results related to the specified financial obligation report within the Nakisa Portfolio Management Suite.

source-currency-display-id

query

string

false

Unique identifier for the display of the source currency in financial obligation reports, facilitating accurate exchange rate analytics within the Nakisa Portfolio Management Suite.

identical-source-and-target

query

string

false

Indicates whether the source and target currencies for the financial obligation report are identical, facilitating accurate exchange rate analysis within the Nakisa Portfolio Management Suite.

Responses

Status

Meaning

Description

Schema

200

OK

OK

PagedModelEntityModelFOExchangeRateDto