Charge

Charge - Create NRE Charges (With Percentage Rent Charges)

HTTP Request

POST /api/percentage-rent-charges

📋 Description: Creates a new percentage rent charge entry within the Nakisa Portfolio Management Suite, enabling accurate tracking and analytics of rental agreements for real estate properties in your portfolio.

Parameters

Name

In

Type

Required

Description

body

body

NreChargeDto

true

Request body containing the percentage rent charge details, including asset identifiers and financial metrics, essential for portfolio analytics within the Nakisa Portfolio Management Suite.

Responses

Status

Meaning

Description

Schema

201

Created

Created

Inline

Response Schema

Status Code 201

Name

Type

Required

Restrictions

Description

anonymous

[ChargeDto]

false

none

[Data transfer object representing a charge associated with a portfolio asset within the Nakisa Portfolio Management Suite, facilitating analytics and reporting 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

» description

string

false

none

Description of the resource

» dueDate

string(date)

true

none

Due date of the resource

» amount

number(double)

true

none

Amount value

» hasPostedDocument

boolean

false

none

Whether the resource has has posted document

» fiscalYear

integer(int64)

false

none

Numeric value representing fiscalYear

» fiscalPeriod

integer(int64)

false

none

Numeric value representing fiscalPeriod

» expenseCategory

ExpenseCategoryLite

true

none

Data transfer object representing a simplified categorization of expenses within the Nakisa Portfolio Management Suite, facilitating effective 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

»» expenseCategoryType

string

false

none

Type of the expense category

» unitId

integer(int64)

true

none

Unique identifier for the unit

» unitDisplayId

string

false

none

Unique identifier for the unit display

» activationGroupId

integer(int64)

true

none

Unique identifier for the activation group

» vendorPaymentSplits

[VendorPaymentSplitDto]

false

none

List of vendorPaymentSplits items

»» percentage

number

false

none

Percentage value

»» calculateTax

boolean

false

none

Boolean flag indicating calculateTax status

»» taxExemptionPercentage

number

false

none

Percentage of tax exemption

»» partner

PartnerLite

false

none

Data transfer object representing a streamlined partner profile within the Nakisa Portfolio Management Suite, encompassing essential details for portfolio, asset, and analytics management in the real estate property sector.

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

»»» erpSystemDisplayId

string

false

none

Unique identifier for the erp system display

»» partnerRole

PartnerRoleLite

false

none

Data transfer object representing a simplified view of a partner’s role within the Nakisa Portfolio Management Suite, facilitating insights into portfolio, asset, and real estate property analytics.

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

»» taxCodeDetermination

TaxCodeDeterminationDetails

false

none

Data transfer object representing the details of tax code determination for assets within the Nakisa Portfolio Management Suite, facilitating accurate tax analytics and compliance for real estate properties in the portfolio.

»»» id

integer(int64)

false

none

Unique identifier for the resource

»»» displayId

string

false

none

Unique identifier for the display

»»» companyId

integer(int64)

false

none

Unique identifier for the company

»»» partnerId

integer(int64)

false

none

none

»»» taxJurisdictionId

integer(int64)

false

none

Unique identifier for the tax jurisdiction

»»» taxJurisdictionDisplayId

string

false

none

Unique identifier for the tax jurisdiction display

»»» defaultTaxCodeId

integer(int64)

false

none

Unique identifier for the default tax code

»»» defaultTaxCodeDisplayId

string

false

none

Unique identifier for the default tax code display

»»» defaultExemptionTaxCodeId

integer(int64)

false

none

Unique identifier for the default exemption tax code

»»» defaultExemptionTaxCodeDisplayId

string

false

none

Unique identifier for the default exemption tax code display

»»» defaultExemptionPercentage

number

false

none

Percentage of default exemption

»»» mapping

TaxCodeExpenseCategoryMappingDetails

false

none

Data transfer object representing the mapping of tax codes to expense categories within the Nakisa Portfolio Management Suite, facilitating accurate financial analytics and reporting for real estate property portfolios.

»»»» isLeaseExpense

boolean

false

none

Whether the resource is lease expense

»»»» nonLeaseTaxCodeId

integer(int64)

false

none

Unique identifier for the non lease tax code

»»»» nonLeaseTaxCodeDisplayId

string

false

none

Unique identifier for the non lease tax code display

»»»» nonLeaseExemptionTaxCodeId

integer(int64)

false

none

Unique identifier for the non lease exemption tax code

»»»» nonLeaseExemptionTaxCodeDisplayId

string

false

none

Unique identifier for the non lease exemption tax code display

»»»» nonLeaseExemptionTaxPercentage

number(double)

false

none

Percentage of non lease exemption tax

»»»» principalTaxCodeId

integer(int64)

false

none

Unique identifier for the principal tax code

»»»» principalTaxCodeDisplayId

string

false

none

Unique identifier for the principal tax code display

»»»» principalExemptionTaxCodeId

integer(int64)

false

none

Unique identifier for the principal exemption tax code

»»»» principalExemptionTaxCodeDisplayId

string

false

none

Unique identifier for the principal exemption tax code display

»»»» principalExemptionTaxPercentage

number(double)

false

none

Percentage of principal exemption tax

» 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 value that identifies 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.

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

»» name

string

true

none

Name of the resource

Enumerated Values

Attribute

Value

expenseCategoryType

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

status

ACTIVE, CREATED, DECOMMISSIONED, DISABLED

Charge - Create NRE Charges

HTTP Request

POST /api/nre-charges

📋 Description: Creates new non-revenue expense charges within the Nakisa Portfolio Management Suite, enabling users to effectively manage and analyze costs associated with real estate properties and assets in their portfolio.

Parameters

Name

In

Type

Required

Description

body

body

NreChargeDto

true

Request body containing the details of non-revenue expenses associated with portfolio assets, including relevant financial metrics and analytics for real estate properties.

Responses

Status

Meaning

Description

Schema

201

Created

Created

Inline

Response Schema

Status Code 201

Name

Type

Required

Restrictions

Description

anonymous

[ChargeDto]

false

none

[Data transfer object representing a charge associated with a portfolio asset within the Nakisa Portfolio Management Suite, facilitating analytics and reporting 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

» description

string

false

none

Description of the resource

» dueDate

string(date)

true

none

Due date of the resource

» amount

number(double)

true

none

Amount value

» hasPostedDocument

boolean

false

none

Whether the resource has has posted document

» fiscalYear

integer(int64)

false

none

Numeric value representing fiscalYear

» fiscalPeriod

integer(int64)

false

none

Numeric value representing fiscalPeriod

» expenseCategory

ExpenseCategoryLite

true

none

Data transfer object representing a simplified categorization of expenses within the Nakisa Portfolio Management Suite, facilitating effective 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

»» expenseCategoryType

string

false

none

Type of the expense category

» unitId

integer(int64)

true

none

Unique identifier for the unit

» unitDisplayId

string

false

none

Unique identifier for the unit display

» activationGroupId

integer(int64)

true

none

Unique identifier for the activation group

» vendorPaymentSplits

[VendorPaymentSplitDto]

false

none

List of vendorPaymentSplits items

»» percentage

number

false

none

Percentage value

»» calculateTax

boolean

false

none

Boolean flag indicating calculateTax status

»» taxExemptionPercentage

number

false

none

Percentage of tax exemption

»» partner

PartnerLite

false

none

Data transfer object representing a streamlined partner profile within the Nakisa Portfolio Management Suite, encompassing essential details for portfolio, asset, and analytics management in the real estate property sector.

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

»»» erpSystemDisplayId

string

false

none

Unique identifier for the erp system display

»» partnerRole

PartnerRoleLite

false

none

Data transfer object representing a simplified view of a partner’s role within the Nakisa Portfolio Management Suite, facilitating insights into portfolio, asset, and real estate property analytics.

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

»» taxCodeDetermination

TaxCodeDeterminationDetails

false

none

Data transfer object representing the details of tax code determination for assets within the Nakisa Portfolio Management Suite, facilitating accurate tax analytics and compliance for real estate properties in the portfolio.

»»» id

integer(int64)

false

none

Unique identifier for the resource

»»» displayId

string

false

none

Unique identifier for the display

»»» companyId

integer(int64)

false

none

Unique identifier for the company

»»» partnerId

integer(int64)

false

none

none

»»» taxJurisdictionId

integer(int64)

false

none

Unique identifier for the tax jurisdiction

»»» taxJurisdictionDisplayId

string

false

none

Unique identifier for the tax jurisdiction display

»»» defaultTaxCodeId

integer(int64)

false

none

Unique identifier for the default tax code

»»» defaultTaxCodeDisplayId

string

false

none

Unique identifier for the default tax code display

»»» defaultExemptionTaxCodeId

integer(int64)

false

none

Unique identifier for the default exemption tax code

»»» defaultExemptionTaxCodeDisplayId

string

false

none

Unique identifier for the default exemption tax code display

»»» defaultExemptionPercentage

number

false

none

Percentage of default exemption

»»» mapping

TaxCodeExpenseCategoryMappingDetails

false

none

Data transfer object representing the mapping of tax codes to expense categories within the Nakisa Portfolio Management Suite, facilitating accurate financial analytics and reporting for real estate property portfolios.

»»»» isLeaseExpense

boolean

false

none

Whether the resource is lease expense

»»»» nonLeaseTaxCodeId

integer(int64)

false

none

Unique identifier for the non lease tax code

»»»» nonLeaseTaxCodeDisplayId

string

false

none

Unique identifier for the non lease tax code display

»»»» nonLeaseExemptionTaxCodeId

integer(int64)

false

none

Unique identifier for the non lease exemption tax code

»»»» nonLeaseExemptionTaxCodeDisplayId

string

false

none

Unique identifier for the non lease exemption tax code display

»»»» nonLeaseExemptionTaxPercentage

number(double)

false

none

Percentage of non lease exemption tax

»»»» principalTaxCodeId

integer(int64)

false

none

Unique identifier for the principal tax code

»»»» principalTaxCodeDisplayId

string

false

none

Unique identifier for the principal tax code display

»»»» principalExemptionTaxCodeId

integer(int64)

false

none

Unique identifier for the principal exemption tax code

»»»» principalExemptionTaxCodeDisplayId

string

false

none

Unique identifier for the principal exemption tax code display

»»»» principalExemptionTaxPercentage

number(double)

false

none

Percentage of principal exemption tax

» 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 value that identifies 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.

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

»» name

string

true

none

Name of the resource

Enumerated Values

Attribute

Value

expenseCategoryType

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

status

ACTIVE, CREATED, DECOMMISSIONED, DISABLED

Charge - Create NRE Charges (With Lease Reconciliation Charges)

HTTP Request

POST /api/lease-reconciliation-charges

📋 Description: Submits lease reconciliation charges for assets within the Nakisa Portfolio Management Suite, enabling accurate financial analytics and portfolio management for real estate properties.

Parameters

Name

In

Type

Required

Description

body

body

NreChargeDto

true

Request body containing the lease reconciliation charge details, including asset identifiers, charge amounts, and associated metadata for effective portfolio and asset management analytics.

Responses

Status

Meaning

Description

Schema

201

Created

Created

Inline

Response Schema

Status Code 201

Name

Type

Required

Restrictions

Description

anonymous

[ChargeDto]

false

none

[Data transfer object representing a charge associated with a portfolio asset within the Nakisa Portfolio Management Suite, facilitating analytics and reporting 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

» description

string

false

none

Description of the resource

» dueDate

string(date)

true

none

Due date of the resource

» amount

number(double)

true

none

Amount value

» hasPostedDocument

boolean

false

none

Whether the resource has has posted document

» fiscalYear

integer(int64)

false

none

Numeric value representing fiscalYear

» fiscalPeriod

integer(int64)

false

none

Numeric value representing fiscalPeriod

» expenseCategory

ExpenseCategoryLite

true

none

Data transfer object representing a simplified categorization of expenses within the Nakisa Portfolio Management Suite, facilitating effective 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

»» expenseCategoryType

string

false

none

Type of the expense category

» unitId

integer(int64)

true

none

Unique identifier for the unit

» unitDisplayId

string

false

none

Unique identifier for the unit display

» activationGroupId

integer(int64)

true

none

Unique identifier for the activation group

» vendorPaymentSplits

[VendorPaymentSplitDto]

false

none

List of vendorPaymentSplits items

»» percentage

number

false

none

Percentage value

»» calculateTax

boolean

false

none

Boolean flag indicating calculateTax status

»» taxExemptionPercentage

number

false

none

Percentage of tax exemption

»» partner

PartnerLite

false

none

Data transfer object representing a streamlined partner profile within the Nakisa Portfolio Management Suite, encompassing essential details for portfolio, asset, and analytics management in the real estate property sector.

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

»»» erpSystemDisplayId

string

false

none

Unique identifier for the erp system display

»» partnerRole

PartnerRoleLite

false

none

Data transfer object representing a simplified view of a partner’s role within the Nakisa Portfolio Management Suite, facilitating insights into portfolio, asset, and real estate property analytics.

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

»» taxCodeDetermination

TaxCodeDeterminationDetails

false

none

Data transfer object representing the details of tax code determination for assets within the Nakisa Portfolio Management Suite, facilitating accurate tax analytics and compliance for real estate properties in the portfolio.

»»» id

integer(int64)

false

none

Unique identifier for the resource

»»» displayId

string

false

none

Unique identifier for the display

»»» companyId

integer(int64)

false

none

Unique identifier for the company

»»» partnerId

integer(int64)

false

none

none

»»» taxJurisdictionId

integer(int64)

false

none

Unique identifier for the tax jurisdiction

»»» taxJurisdictionDisplayId

string

false

none

Unique identifier for the tax jurisdiction display

»»» defaultTaxCodeId

integer(int64)

false

none

Unique identifier for the default tax code

»»» defaultTaxCodeDisplayId

string

false

none

Unique identifier for the default tax code display

»»» defaultExemptionTaxCodeId

integer(int64)

false

none

Unique identifier for the default exemption tax code

»»» defaultExemptionTaxCodeDisplayId

string

false

none

Unique identifier for the default exemption tax code display

»»» defaultExemptionPercentage

number

false

none

Percentage of default exemption

»»» mapping

TaxCodeExpenseCategoryMappingDetails

false

none

Data transfer object representing the mapping of tax codes to expense categories within the Nakisa Portfolio Management Suite, facilitating accurate financial analytics and reporting for real estate property portfolios.

»»»» isLeaseExpense

boolean

false

none

Whether the resource is lease expense

»»»» nonLeaseTaxCodeId

integer(int64)

false

none

Unique identifier for the non lease tax code

»»»» nonLeaseTaxCodeDisplayId

string

false

none

Unique identifier for the non lease tax code display

»»»» nonLeaseExemptionTaxCodeId

integer(int64)

false

none

Unique identifier for the non lease exemption tax code

»»»» nonLeaseExemptionTaxCodeDisplayId

string

false

none

Unique identifier for the non lease exemption tax code display

»»»» nonLeaseExemptionTaxPercentage

number(double)

false

none

Percentage of non lease exemption tax

»»»» principalTaxCodeId

integer(int64)

false

none

Unique identifier for the principal tax code

»»»» principalTaxCodeDisplayId

string

false

none

Unique identifier for the principal tax code display

»»»» principalExemptionTaxCodeId

integer(int64)

false

none

Unique identifier for the principal exemption tax code

»»»» principalExemptionTaxCodeDisplayId

string

false

none

Unique identifier for the principal exemption tax code display

»»»» principalExemptionTaxPercentage

number(double)

false

none

Percentage of principal exemption tax

» 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 value that identifies 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.

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

»» name

string

true

none

Name of the resource

Enumerated Values

Attribute

Value

expenseCategoryType

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

status

ACTIVE, CREATED, DECOMMISSIONED, DISABLED

Charge - Create Charge

HTTP Request

POST /api/charges

📋 Description: Creates a new charge entry within the Nakisa Portfolio Management Suite, enabling users to associate costs with specific assets and enhance financial analytics for real estate properties.

Parameters

Name

In

Type

Required

Description

body

body

ChargeDto

true

Request body containing charge details, including portfolio identifiers, asset information, and relevant analytics for real estate property management.

Responses

Status

Meaning

Description

Schema

201

Created

Created

ChargeDto

Charge - Reverse Charge For Main Accounting Standard

HTTP Request

POST /api/charges/{chargeId}/reverse/main-accounting-standard

📋 Description: Reverses a charge associated with a specific asset in the Nakisa Portfolio Management Suite, ensuring accurate financial reporting and compliance within the main accounting standard framework. This operation is essential for maintaining the integrity of portfolio analytics and real estate property management.

Parameters

Name

In

Type

Required

Description

chargeId

path

integer(int64)

true

Unique identifier for the charge

body

body

JournalPostingRequest

true

Request body containing the reversal details for the specified charge, including relevant financial data and metadata necessary for accurate main accounting adjustments within the Nakisa Portfolio Management Suite.

Responses

Status

Meaning

Description

Schema

200

OK

OK

PostingResultDto

Charge - Post Charge For Main Accounting Standard

HTTP Request

POST /api/charges/{chargeId}/post/main-accounting-standard

📋 Description: Posts the main accounting standard for a specified charge within the Nakisa Portfolio Management Suite, facilitating accurate financial reporting and compliance for portfolio and asset management in the real estate sector.

Parameters

Name

In

Type

Required

Description

chargeId

path

integer(int64)

true

Unique identifier for the charge

body

body

JournalPostingRequest

true

Request body containing the main accounting standard details for the specified charge, including relevant financial metrics and compliance information for effective portfolio and asset management.

Responses

Status

Meaning

Description

Schema

200

OK

OK

PostingResultDto

Charge - Search Charge

HTTP Request

POST /api/charges/search

📋 Description: Submits a request to search for charges related to assets within the Nakisa Portfolio Management Suite, enabling users to analyze financial data associated with real estate properties and portfolios.

Parameters

Name

In

Type

Required

Description

body

body

ChargeDtoFilter

true

Request body containing search criteria and filters for retrieving portfolio and asset analytics related to real estate properties.

Responses

Status

Meaning

Description

Schema

200

OK

OK

PageChargeDto

Charge - Delete Charge

HTTP Request

DELETE /api/charges/{id}

📋 Description: Deletes a specified charge from the Nakisa Portfolio Management Suite, enabling users to maintain accurate financial records within their portfolio and asset management processes.

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