Batch

Batch - Get Batch

HTTP Request

GET /api/batches/{id}

📋 Description: Retrieves detailed information about a specific batch within the Nakisa Portfolio Management Suite, enabling users to analyze portfolio and asset performance 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

BatchDto

Batch - Update Batch

HTTP Request

PUT /api/batches/{id}

📋 Description: Updates the details of a specified batch within the Nakisa Portfolio Management Suite, enabling users to manage portfolio assets and analytics related to real estate properties effectively.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

body

body

BatchDto

true

Request body containing the updated batch details, including portfolio identifiers, asset allocations, and analytics parameters relevant to real estate property management.

Responses

Status

Meaning

Description

Schema

200

OK

OK

BatchDto

Batch - Delete Batch

HTTP Request

DELETE /api/batches/{id}

📋 Description: Deletes a specified batch from the Nakisa Portfolio Management Suite, facilitating the management of portfolio assets and 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

Batch - Get Batches

HTTP Request

GET /api/batches

📋 Description: Retrieves a list of asset batches within the Nakisa Portfolio Management Suite, enabling users to analyze and manage real estate property portfolios effectively.

Parameters

Name

In

Type

Required

Description

pageable

query

Pageable

true

Indicates whether the results of the batch retrieval should be paginated, facilitating efficient data management and analysis within the Nakisa Portfolio Management Suite.

listing

query

boolean

false

Indicates whether to include detailed listing information in the response for portfolio and asset analytics within the Nakisa Portfolio Management Suite.

search

query

string

false

Search term used to filter and retrieve specific batches related to portfolio, asset, analytics, or real estate property within the Nakisa Portfolio Management Suite.

name

query

string

false

Name of the resource

name-like

query

string

false

Filters the results to include only batches whose names resemble the specified string, facilitating targeted searches within the Nakisa Portfolio Management Suite for portfolio, asset, and real estate property analytics.

start-date

query

string

false

Specifies the starting date for retrieving batch data related to portfolio, asset, and real estate property analytics.

end-date

query

string

false

Specifies the end date for the batch retrieval, allowing users to filter portfolio and asset analytics within the Nakisa Portfolio Management Suite.

from

query

string

false

Specifies the starting point for retrieving batches of portfolio-related data, enabling users to filter results based on asset and real estate property analytics.

to

query

string

false

Specifies the end date for filtering batches in the portfolio management analytics, allowing users to retrieve data relevant to a defined time frame for real estate properties and assets.

posting-date

query

string

false

Specifies the date for which portfolio and asset analytics are retrieved, enabling users to analyze real estate property performance over time.

prepared-by

query

string

false

Identifies the individual or entity responsible for preparing the batch, facilitating accountability and traceability within the portfolio management process.

approved-by

query

string

false

Identifier of the user or entity that approved the batch, facilitating tracking and accountability within the Nakisa Portfolio Management Suite’s asset and portfolio analytics.

completed-by

query

string

false

Specifies the individual or entity responsible for completing the batch process within the Nakisa Portfolio Management Suite, facilitating accountability in portfolio and asset analytics.

executed-date

query

string

false

Specifies the date on which the batch execution occurred, enabling users to filter and analyze portfolio and asset data within the Nakisa Portfolio Management Suite.

prepared-date

query

string

false

Specifies the date on which the batch was prepared, enabling users to filter and analyze portfolio and asset data within the Nakisa Portfolio Management Suite.

approved-date

query

string

false

Specifies the date on which the batch was approved, relevant for tracking portfolio and asset analytics within the Nakisa Portfolio Management Suite.

completed-date

query

string

false

Specifies the date on which the batch process was completed, enabling users to filter and analyze portfolio and asset data within the Nakisa Portfolio Management Suite.

document-date

query

string

false

Specifies the date of the document for filtering portfolio, asset, and analytics data related to real estate properties in the Nakisa Portfolio Management Suite.

principal-position-type

query

string

false

Specifies the type of principal position to filter results related to portfolio, asset, analytics, and real estate property within the Nakisa Portfolio Management Suite.

posting-transaction-type

query

string

false

Specifies the type of posting transaction to filter the results in the batch retrieval process, relevant for portfolio, asset, analytics, and real estate property management.

status-id-in

query

string

false

Specifies the unique identifier for the status of batches within the Nakisa Portfolio Management Suite, facilitating targeted retrieval of portfolio, asset, and real estate property analytics.

Responses

Status

Meaning

Description

Schema

200

OK

OK

PagedModelEntityModelBatchDto

Batch - Create Batches

HTTP Request

POST /api/batches

📋 Description: Creates a new batch for processing portfolio analytics related to real estate assets within the Nakisa Portfolio Management Suite.

Parameters

Name

In

Type

Required

Description

body

body

BatchDto

true

Request body containing batch processing data for portfolio assets, including details for analytics and real estate property management.

Responses

Status

Meaning

Description

Schema

201

Created

Created

Inline

Response Schema

Status Code 201

Name

Type

Required

Restrictions

Description

anonymous

[BatchDto]

false

none

[Data transfer object representing a collection of assets within the Nakisa Portfolio Management Suite, facilitating the analysis and management of real estate properties and their associated portfolios.]

» 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

» startDate

string(date)

false

none

Start date of the resource

» endDate

string(date)

false

none

End date of the resource

» postingDate

string(date)

false

none

Date of the posting

» documentDate

string(date)

false

none

Date of the document

» preparedBy

string

false

none

Identifier of the individual or entity responsible for preparing the batch within the Nakisa Portfolio Management Suite, relevant to portfolio, asset, analytics, and real estate property management.

» preparedDate

string(date)

false

none

Date of the prepared

» approvedBy

string

false

none

Identifier of the individual or entity that has authorized the batch processing within the Nakisa Portfolio Management Suite, relevant for portfolio, asset, and real estate property analytics.

» approvedDate

string(date)

false

none

Date of the approved

» executedBy

string

false

none

Identifier of the user or system process that executed the batch operation within the Nakisa Portfolio Management Suite, relevant for tracking actions related to portfolio, asset, analytics, and real estate property management.

» executedDate

string(date)

false

none

Date of the executed

» postingNote

string

false

none

none

» usePostingNote

boolean

false

none

none

» statusId

integer(int64)

false

none

Unique identifier for the status

» processingStatus

string

false

none

Status of the processing

» batchPreviewGenerationStatus

string

false

none

Status of the batch preview generation

» leaseIds

[integer]

false

none

List of leaseIds items

» massProfileFilterIds

[integer]

false

none

none

» principalPositionType

string

true

none

Type of the principal position

» postingTransactionType

string

true

none

Type of the posting transaction

» reversalReasonType

string

false

none

Type of the reversal reason

» journalTypes

[string]

false

none

List of journalTypes items

» jobPostingStatuses

[string]

false

none

List of jobPostingStatuses items

» internalPostingDateType

string

true

none

Type of the internal posting date

» operationalPostingJobId

integer(int64)

false

none

Unique identifier for the operational posting job

» jobComplete

boolean

false

none

Boolean flag indicating jobComplete status

» approvedPaymentIds

[integer]

false

none

List of approvedPaymentIds items

» approvedChargeIds

[integer]

false

none

List of approvedChargeIds items

» approvedProvisionIds

[integer]

false

none

List of approvedProvisionIds items

» status

PickListOptionDto

false

none

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

»» createdBy

string

false

none

Username of who created this resource

»» lastModifiedBy

string

false

none

Username of who last modified this resource

»» createdDate

string(date-time)

false

none

Date of the created

»» lastModifiedDate

string(date-time)

false

none

Date of the last modified

»» archived

boolean

false

none

Boolean flag indicating archived status

»» externalId

string

false

none

Unique identifier for the external

»» id

integer(int64)

false

none

Unique identifier for the resource

»» priority

integer(int64)

false

none

Priority of the resource

»» internalId

integer(int64)

false

none

Unique identifier for the internal

»» pickListCode

string

false

none

Code for the pick list

»» pickListLabel

string

false

none

Label for the pick list

»» label

string

false

none

Label for the resource

»» cultureId

integer(int64)

false

none

Unique identifier for the culture

»» labelDtos

[LabelDto]

false

none

List of labelDtos items

»»» createdBy

string

false

none

Username of who created this resource

»»» lastModifiedBy

string

false

none

Username of who last modified this resource

»»» createdDate

string(date-time)

false

none

Date of the created

»»» lastModifiedDate

string(date-time)

false

none

Date of the last modified

»»» archived

boolean

false

none

Boolean flag indicating archived status

»»» externalId

string

false

none

Unique identifier for the external

»»» id

integer(int64)

false

none

Unique identifier for the resource

»»» cultureId

integer(int64)

false

none

Unique identifier for the culture

»»» value

string

true

none

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

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

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

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

»»»»»» id

integer(int64)

false

none

Unique identifier for the resource

»»»»»» status

string

false

none

Status of the resource

»»»»»» displayId

string

true

none

Unique identifier for the display

»»»»»» erpSystemId

integer(int64)

false

none

Unique identifier for the erp system

»»»»»» erpSystemDisplayId

string

false

none

Unique identifier for the erp system display

»»»»»» name

string

false

none

Name of the resource

»»»»»» decimalPoints

integer(int32)

true

none

Numeric value representing decimalPoints

»»»»»» depreciationAreaId

integer(int64)

false

none

Unique identifier for the depreciation area

»»»»» defaultUnitValue

UnitDefaultValueDto

false

none

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

»»»»»» createdBy

string

false

none

Username of who created this resource

»»»»»» lastModifiedBy

string

false

none

Username of who last modified this resource

»»»»»» createdDate

string(date-time)

false

none

Date of the created

»»»»»» lastModifiedDate

string(date-time)

false

none

Date of the last modified

»»»»»» archived

boolean

false

none

Boolean flag indicating archived status

»»»»»» externalId

string

false

none

Unique identifier for the external

»»»»»» id

integer(int64)

false

none

Unique identifier for the resource

»»»»»» unitId

integer(int64)

false

none

Unique identifier for the unit

»»»»»» unitOfMeasureId

integer(int64)

false

none

Unique identifier for the unit of measure

»»»»»» erpSystemId

integer(int64)

false

none

Unique identifier for the erp system

»»»»»» unit

PickListOptionDto

false

none

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

»»»»»» unitOfMeasure

UnitOfMeasureDto

false

none

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

»»»»»»» id

integer(int64)

false

none

Unique identifier for the resource

»»»»»»» status

string

false

none

Status of the resource

»»»»»»» displayId

string

true

none

Unique identifier for the display

»»»»»»» erpSystemId

integer(int64)

false

none

Unique identifier for the erp system

»»»»»»» erpSystemDisplayId

string

false

none

Unique identifier for the erp system display

»»»»»»» name

string

false

none

Name of the resource

»»»»» type

PickListOptionDto

false

none

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

»»»»» quality

PickListOptionDto

false

none

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

»»»»» propertyType

PickListOptionDto

false

none

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

»»»»» category

PickListOptionDto

false

none

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

»»»»» status

PickListOptionDto

false

none

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

»»»»» addressDto

AddressDto

true

none

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

»»»»»» createdBy

string

false

none

Username of who created this resource

»»»»»» lastModifiedBy

string

false

none

Username of who last modified this resource

»»»»»» createdDate

string(date-time)

false

none

Date of the created

»»»»»» lastModifiedDate

string(date-time)

false

none

Date of the last modified

»»»»»» archived

boolean

false

none

Boolean flag indicating archived status

»»»»»» externalId

string

false

none

Unique identifier for the external

»»»»»» id

integer(int64)

false

none

Unique identifier for the resource

»»»»»» street

string

false

none

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.

Enumerated Values

Attribute

Value

assetClassType

EQUIPMENT, PLANT, PROPERTY

assetValueCurrencyType

COMPANY_CURRENCY, CONTRACT_CURRENCY

batchPreviewGenerationStatus

ERROR, NOT_STARTED, PROCESSED, PROCESSING

contractPhase

CLOSED, DRAFT, INITIAL, REJECTED, SETUP

formOfLease

FULL, NET

idGenerationType

AUTO, MANUAL

jointVentureLeaseType

GROSS_LEASE, NET_LEASE

leaseType

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

principalPositionType

LESSEE, LESSOR

priority

HIGH, LOW, MEDIUM

processingStatus

ERROR, PROCESSED, PROCESSING

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

Batch - Update Payments

HTTP Request

POST /api/batches/{id}/update-payments

📋 Description: Updates payment information for a specified batch within the Nakisa Portfolio Management Suite, enabling enhanced financial tracking and analytics for real estate property portfolios.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

200

OK

OK

BatchDto

Batch - Review Batch

HTTP Request

POST /api/batches/{id}/review

📋 Description: Submits a review for the specified batch within the Nakisa Portfolio Management Suite, enabling stakeholders to evaluate and analyze portfolio assets and real estate properties effectively.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

201

Created

Created

BatchDto

Batch - Reject Review Batch

HTTP Request

POST /api/batches/{id}/reject

📋 Description: Rejects a specified batch within the Nakisa Portfolio Management Suite, allowing users to manage portfolio assets and analytics effectively in the context of 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

201

Created

Created

BatchDto

Batch - Get Batch Notes

HTTP Request

GET /api/batches/{id}/notes

📋 Description: Fetches notes associated with a specific batch identified by the provided ID, enabling users to access detailed insights related to portfolio and asset management within the Nakisa Portfolio Management Suite.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

pageable

query

Pageable

true

Indicates whether the results of the notes associated with a specific batch should be returned in a paginated format, facilitating efficient data retrieval for portfolio and asset management analytics.

search

query

string

false

Search term used to filter notes related to a specific batch within the Nakisa Portfolio Management Suite, enhancing the ability to analyze portfolio and asset information in the context of real estate property.

message

query

string

false

Textual content of the note associated with a specific batch, providing insights relevant to portfolio and asset management within the Nakisa Portfolio Management Suite.

Responses

Status

Meaning

Description

Schema

200

OK

OK

PagedModelEntityModelNoteDto

Batch - Create Batch Notes

HTTP Request

POST /api/batches/{id}/notes

📋 Description: Adds a note to the specified batch within the Nakisa Portfolio Management Suite, enabling users to enhance 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

body

body

NoteDto

true

Request body containing notes related to the specified batch, including details pertinent to portfolio and asset management 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.

Batch - Execute Batch

HTTP Request

POST /api/batches/{id}/execute

📋 Description: Executes the specified batch process for the given portfolio asset, enabling real-time analytics and insights within the Nakisa Portfolio Management Suite.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

body

body

BatchExecutionRequest

false

none

Responses

Status

Meaning

Description

Schema

201

Created

Created

BatchDto

Batch - Approve Review Batch

HTTP Request

POST /api/batches/{id}/approve

📋 Description: Approves a specified batch of portfolio assets within the Nakisa Portfolio Management Suite, facilitating streamlined 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

201

Created

Created

BatchDto

Batch - Get Batch View

HTTP Request

GET /api/batches/{id}/view

📋 Description: Fetches detailed information about a specific batch identified by its ID, providing 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

lease-id-in

query

array[integer]

false

Array of unique identifiers for leases associated with the specified batch, used to retrieve detailed analytics and insights within the Nakisa Portfolio Management Suite.

status-in

query

array[string]

false

Array of status filters to refine the retrieval of batch details within the Nakisa Portfolio Management Suite, applicable to portfolio, asset, analytics, and real estate property contexts.

Responses

Status

Meaning

Description

Schema

200

OK

OK

BatchView

Batch - Get NFS Schedule Payments For Lease IDs

HTTP Request

GET /api/batches/{id}/payments

📋 Description: Retrieves payment details associated with a specific batch in the Nakisa Portfolio Management Suite, providing insights into financial transactions related to portfolio and asset management.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

pageable

query

Pageable

true

Indicates whether the results for payments associated with the specified batch ID should be returned in a paginated format, facilitating efficient data retrieval in the context of portfolio and asset management analytics.

payment-status

query

string

false

Specifies the current status of payments associated with a particular batch in the Nakisa Portfolio Management Suite, facilitating effective portfolio and asset analysis within real estate property management.

lease-id-in

query

array[integer]

false

Array of unique identifiers for leases, used to filter payment records associated with specific assets within the Nakisa Portfolio Management Suite.

accounting-standard-id-in

query

array[integer]

false

Array of accounting standard identifiers used to filter payment records associated with a specific batch in the Nakisa Portfolio Management Suite.

Enumerated Values

Attribute

Value

payment-status

FAILED, FAILED_POST, FAILED_REVERSE, NOT_POSTED, POSTED, POSTED_AND_SCHEDULED, REVERSED, REVERSED_AND_SCHEDULED

Responses

Status

Meaning

Description

Schema

200

OK

OK

PagedModelEntityModelNfsBatchPayment

Batch - Get Batch Leases

HTTP Request

GET /api/batches/{id}/leases

📋 Description: Retrieves lease information associated with a specific batch in the Nakisa Portfolio Management Suite, enabling users to analyze real estate property data within their 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 lease retrieval for a specified batch should be paginated, enhancing the efficiency of data management within the Nakisa Portfolio Management Suite.

listing

query

boolean

false

Indicates whether to include detailed listing information for leases associated with the specified batch in the Nakisa Portfolio Management Suite.

file-number-like

query

string

false

Specifies a string pattern to filter lease records associated with a particular batch in the Nakisa Portfolio Management Suite, facilitating targeted asset and portfolio analytics in real estate management.

search

query

string

false

Search term used to filter lease records associated with a specific batch in the Nakisa Portfolio Management Suite.

premise-id

query

string

false

Unique identifier for the specific premise associated with the leases in the Nakisa Portfolio Management Suite, facilitating efficient portfolio and asset management.

premise-id-in

query

string

false

Unique identifier for the premise associated with the specified lease batch, facilitating targeted retrieval of real estate property data within the Nakisa Portfolio Management Suite.

premise-id-not-null

query

string

false

Unique identifier for the premise associated with the lease, ensuring that only valid premises are retrieved in the context of portfolio and asset management within the Nakisa Portfolio Management Suite.

premise-number

query

string

false

Unique identifier for the specific premise associated with the lease in the Nakisa Portfolio Management Suite, facilitating accurate retrieval of portfolio and asset analytics within real estate property management.

premise-number-like

query

string

false

Specifies a string pattern to filter lease records by premise number within the Nakisa Portfolio Management Suite, facilitating targeted asset and portfolio analytics in real estate management.

premise-external-id

query

string

false

Unique identifier for the external premise associated with the lease, facilitating accurate portfolio and asset management within the Nakisa Portfolio Management Suite.

location-id

query

string

false

Unique identifier for the specific location associated with the leases in the portfolio management system.

location-number

query

string

false

Specifies the location number associated with the lease in the Nakisa Portfolio Management Suite, facilitating accurate retrieval of portfolio and asset analytics for real estate properties.

location-number-like

query

string

false

Specifies a string pattern to filter lease records by location number within the Nakisa Portfolio Management Suite, facilitating targeted analytics for real estate property management.

location-external-id

query

string

false

Unique identifier for the external location associated with the lease, facilitating accurate tracking and management of real estate assets within the Nakisa Portfolio Management Suite.

address-id

query

string

false

Unique identifier for the specific lease associated with a batch in the Nakisa Portfolio Management Suite, facilitating efficient retrieval of lease-related data within the context of portfolio and asset management.

city-id

query

string

false

Unique identifier for the city associated with the leases in the portfolio, enabling targeted analytics and asset management within the Nakisa Portfolio Management Suite.

province-id

query

string

false

Unique identifier for the province associated with the leases in the specified batch, facilitating targeted analytics within the Nakisa Portfolio Management Suite.

country-id

query

string

false

Unique identifier for the country associated with the leases in the specified batch, facilitating targeted portfolio and asset analytics within the Nakisa Portfolio Management Suite.

contract-id

query

string

false

Unique identifier for the specific contract associated with the leases in the Nakisa Portfolio Management Suite, facilitating efficient portfolio and asset analytics within real estate property management.

number

query

string

false

Specifies the lease number associated with the batch ID in the Nakisa Portfolio Management Suite, facilitating the retrieval of relevant real estate property data for portfolio and asset analysis.

number-like

query

string

false

Represents a numeric value or identifier associated with leases within a specified batch in the Nakisa Portfolio Management Suite, facilitating portfolio and asset analytics for real estate properties.

number-in

query

string

false

none

id

query

string

false

none

id-in

query

string

false

none

type-id

query

string

false

Identifier for the specific lease type associated with the asset batch, facilitating targeted analytics within the Nakisa Portfolio Management Suite.

terminating-lease

query

string

false

Specifies the terminating lease associated with a particular batch of real estate assets, enabling detailed portfolio and asset analytics.

signature-date

query

string

false

Specifies the date for which lease data is requested, enabling accurate portfolio and asset analytics within the Nakisa Portfolio Management Suite.

category-id

query

string

false

Unique identifier for the category of leases associated with a specific batch in the Nakisa Portfolio Management Suite, facilitating targeted analytics within the portfolio and asset management context.

registration-number

query

string

false

Unique identifier for the registration of a lease within the Nakisa Portfolio Management Suite, facilitating efficient tracking and management of real estate assets.

status-id

query

string

false

Unique identifier for the status of leases associated with a specific batch in the Nakisa Portfolio Management Suite, facilitating effective portfolio and asset analytics in real estate property management.

status-id-is-not

query

string

false

Excludes leases with the specified status ID from the results when retrieving lease information for a given batch in the Nakisa Portfolio Management Suite.

status-id-in

query

string

false

Specifies the unique identifier for the status of leases associated with a particular batch in the Nakisa Portfolio Management Suite, facilitating targeted analytics within the portfolio and asset management context.

original-lease-id

query

string

false

Unique identifier for the original lease associated with the specified batch, facilitating accurate retrieval of lease data within the Nakisa Portfolio Management Suite.

parent-lease-id-is-null

query

string

false

none

state-id

query

string

false

Unique identifier for the specific state associated with the leases in the portfolio, enabling targeted analytics and management of real estate assets.

areas-history-version-id

query

string

false

none

valid-from

query

string

false

Specifies the start date for the lease validity period, enabling users to filter lease data relevant to portfolio and asset management within the Nakisa Portfolio Management Suite.

valid-to

query

string

false

Specifies the expiration date of the lease associated with the asset in the portfolio, enabling effective management and analytics of real estate properties.

valid-to-greater-than

query

string

false

Specifies a date string that filters leases to only include those with a valid-to date greater than the provided value, enhancing portfolio and asset analytics within the Nakisa Portfolio Management Suite.

valid-to-less-than

query

string

false

Specifies the upper limit for the validity period of leases associated with a particular batch, enabling precise filtering for portfolio and asset analytics in real estate management.

Responses

Status

Meaning

Description

Schema

200

OK

OK

PagedModelEntityModelLeaseDto

Batch - Generate Batch Preview

HTTP Request

GET /api/batches/{id}/generate

📋 Description: Generates a batch report for the specified portfolio asset, providing valuable analytics insights 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

JobBatchPreviewDto

Batch - Generate Batch Preview Status

HTTP Request

GET /api/batches/{id}/generate-preview-status

📋 Description: Retrieves the generation status of a preview for a specified batch within the Nakisa Portfolio Management Suite, enabling users to assess the progress of 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

200

OK

OK

string

Batch - Get Batch Accounting Standards

HTTP Request

GET /api/batches/{id}/accounting-standards

📋 Description: Retrieves accounting standards associated with a specific batch in the Nakisa Portfolio Management Suite, enabling users to analyze financial compliance and reporting 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

Responses

Status

Meaning

Description

Schema

200

OK

OK

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[AccountingStandardDto]

false

none

[Data transfer object representing the accounting standards applicable to assets within the Nakisa Portfolio Management Suite, facilitating compliance and analytics for real estate property portfolios.]

» 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

true

none

Name of the resource

» standardType

string

false

none

Type of the standard

» companyId

integer(int64)

false

none

Unique identifier for the company

Enumerated Values

Attribute

Value

standardType

GAAP, GASB_87, IFRS, OFF_BALANCE_SHEET

status

ACTIVE, CREATED, DECOMMISSIONED, DISABLED