ActivationGroupFinancialTermDto

Example Json Object

  1{
  2  "id": 0,
  3  "displayId": "string",
  4  "name": "string",
  5  "expenseCategory": {
  6    "id": 0,
  7    "displayId": "string",
  8    "status": "CREATED",
  9    "name": "string",
 10    "expenseCategoryType": "PAYMENT"
 11  },
 12  "amount": 0.1,
 13  "amountFrequency": "DAY",
 14  "paymentMode": "ADVANCE",
 15  "paymentCalculationMode": "ONE_TIME",
 16  "firstSpecialPaymentDate": "2019-08-24",
 17  "lastSpecialPaymentDate": "2019-08-24",
 18  "paymentFrequency": "ONE_TIME",
 19  "firstPaymentDate": "2019-08-24",
 20  "lastPaymentDate": "2019-08-24",
 21  "firstPaymentAmount": 0.1,
 22  "lastPaymentAmount": 0.1,
 23  "months": 0,
 24  "days": 0,
 25  "notificationDate": "2019-08-24",
 26  "monthEnd": true,
 27  "paymentTiming": "START_OF_DAY",
 28  "escalatingRent": true,
 29  "stopEscalatingAtZero": true,
 30  "escalatingRentAmount": 0.1,
 31  "escalatingRentType": "FIXED",
 32  "escalationFrequencyOffset": 0,
 33  "escalationFrequency": 0,
 34  "escalationFastForward": 0,
 35  "termStartDate": "2019-08-24",
 36  "termEndDate": "2019-08-24",
 37  "expenseCategoryType": "PAYMENT",
 38  "spreadingFrequency": "NONE",
 39  "firstSpreadingAmount": 0.1,
 40  "lastSpreadingAmount": 0.1,
 41  "valid": true,
 42  "parentFinancialTermId": 0,
 43  "termStatus": "EDITABLE",
 44  "lockReason": "EXERCISED_IN_ACTIVATION_GROUP",
 45  "vendorPaymentSplits": [
 46    {
 47      "percentage": 0,
 48      "calculateTax": true,
 49      "taxExemptionPercentage": 0,
 50      "partner": {
 51        "id": 0,
 52        "displayId": "string",
 53        "status": "CREATED",
 54        "name": "string",
 55        "erpSystemDisplayId": "string"
 56      },
 57      "partnerRole": {
 58        "id": 0,
 59        "displayId": "string",
 60        "status": "CREATED",
 61        "name": "string"
 62      },
 63      "taxCodeDetermination": {
 64        "id": 0,
 65        "displayId": "string",
 66        "companyId": 0,
 67        "partnerId": 0,
 68        "taxJurisdictionId": 0,
 69        "taxJurisdictionDisplayId": "string",
 70        "defaultTaxCodeId": 0,
 71        "defaultTaxCodeDisplayId": "string",
 72        "defaultExemptionTaxCodeId": 0,
 73        "defaultExemptionTaxCodeDisplayId": "string",
 74        "defaultExemptionPercentage": 0,
 75        "mapping": {
 76          "isLeaseExpense": true,
 77          "nonLeaseTaxCodeId": 0,
 78          "nonLeaseTaxCodeDisplayId": "string",
 79          "nonLeaseExemptionTaxCodeId": 0,
 80          "nonLeaseExemptionTaxCodeDisplayId": "string",
 81          "nonLeaseExemptionTaxPercentage": 0.1,
 82          "principalTaxCodeId": 0,
 83          "principalTaxCodeDisplayId": "string",
 84          "principalExemptionTaxCodeId": 0,
 85          "principalExemptionTaxCodeDisplayId": "string",
 86          "principalExemptionTaxPercentage": 0.1
 87        }
 88      }
 89    }
 90  ],
 91  "revisionDisplayId": "string",
 92  "termType": "PAYMENT_TERM",
 93  "exercise": true,
 94  "leaseComponentFinancialTermId": 0,
 95  "revisionId": 0,
 96  "activationGroupDisplayId": "string",
 97  "activationGroupId": 0,
 98  "applyIndexation": true,
 99  "indexationType": "NONE",
100  "indexationTypeNonLease": "NONE",
101  "consumerPriceIndexCategory": {
102    "id": 0,
103    "displayId": "string",
104    "status": "CREATED",
105    "name": "string",
106    "city": "string",
107    "country": "string",
108    "province": "string",
109    "erpSystemId": 0
110  },
111  "consumerPriceIndexCategoryNonLease": {
112    "id": 0,
113    "displayId": "string",
114    "status": "CREATED",
115    "name": "string",
116    "city": "string",
117    "country": "string",
118    "province": "string",
119    "erpSystemId": 0
120  },
121  "baseIndexationDate": "2019-08-24",
122  "baseIndexationDateNonLease": "2019-08-24",
123  "baseIndexationRate": 0.1,
124  "baseIndexationRateNonLease": 0.1,
125  "referenceIndexationDate": "2019-08-24",
126  "referenceIndexationDateNonLease": "2019-08-24",
127  "referenceIndexationRate": 0.1,
128  "referenceIndexationRateNonLease": 0.1,
129  "indexationStartDate": "2019-08-24",
130  "indexationStartDateNonLease": "2019-08-24",
131  "indexationLeasePercentage": 0.1,
132  "indexationNonLeasePercentage": 0.1,
133  "termState": "HISTORICAL",
134  "type": "string",
135  "numberRangeIdentifierType": {
136    "name": "string"
137  },
138  "numberRangeIdentifierValue": "string",
139  "allowsSystemGenerateNewId": true,
140  "numberRangeType": {
141    "name": "string"
142  }
143}

📄 Description: Data transfer object representing the financial terms associated with an activation group within the Nakisa Portfolio Management Suite, facilitating informed decision-making in portfolio and asset management for real estate properties.

Properties

Name

Type

Required

Restrictions

Description

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

expenseCategory

ExpenseCategoryLite

false

none

Category of the expense

amount

number(double)

true

none

Amount value

amountFrequency

string

true

none

Specifies the frequency at which financial amounts are assessed or reported within the context of portfolio and asset management in the Nakisa Portfolio Management Suite.

paymentMode

string

true

none

Indicates the method of payment utilized for financial transactions within the Nakisa Portfolio Management Suite, relevant to portfolio, asset, analytics, and real estate property management.

paymentCalculationMode

string

true

none

Specifies the method used to calculate payments within the financial terms of an activation group, relevant for portfolio and asset management in the Nakisa Portfolio Management Suite.

firstSpecialPaymentDate

string(date)

false

none

Date of the first special payment

lastSpecialPaymentDate

string(date)

false

none

Date of the last special payment

paymentFrequency

string

true

none

Specifies the frequency of payments associated with financial terms for assets within the Nakisa Portfolio Management Suite, relevant to portfolio and real estate property analytics.

firstPaymentDate

string(date)

true

none

Date of the first payment

lastPaymentDate

string(date)

true

none

Date of the last payment

firstPaymentAmount

number(double)

false

none

Amount of first payment

lastPaymentAmount

number(double)

false

none

Amount of last payment

months

integer(int64)

false

none

Numeric value representing months

days

integer(int32)

false

none

Numeric value representing days

notificationDate

string(date)

false

none

Date of the notification

monthEnd

boolean

false

none

Boolean flag indicating monthEnd status

paymentTiming

string

false

none

Specifies the timing of payment obligations associated with financial terms for assets within the Nakisa Portfolio Management Suite, aiding in portfolio and real estate property analytics.

escalatingRent

boolean

false

none

Boolean flag indicating escalatingRent status

stopEscalatingAtZero

boolean

false

none

Boolean flag indicating stopEscalatingAtZero status

escalatingRentAmount

number(double)

false

none

Amount of escalating rent

escalatingRentType

string

false

none

Type of the escalating rent

escalationFrequencyOffset

integer(int32)

false

none

Numeric value representing escalationFrequencyOffset

escalationFrequency

integer(int32)

false

none

Numeric value representing escalationFrequency

escalationFastForward

integer(int32)

false

none

Numeric value representing escalationFastForward

termStartDate

string(date)

false

none

Date of the term start

termEndDate

string(date)

false

none

Date of the term end

expenseCategoryType

string

false

none

Type of the expense category

spreadingFrequency

string

false

none

Specifies the frequency at which financial terms are spread across the portfolio, facilitating accurate asset analytics within the Nakisa Portfolio Management Suite.

firstSpreadingAmount

number(double)

false

none

Amount of first spreading

lastSpreadingAmount

number(double)

false

none

Amount of last spreading

valid

boolean

false

none

Unique identifier for the portfolio

parentFinancialTermId

integer(int64)

false

none

Unique identifier for the parent financial term

termStatus

string

false

none

Status of the term

lockReason

string

false

none

Specifies the reason for locking an activation group within the Nakisa Portfolio Management Suite, providing essential context for portfolio, asset, and real estate property analytics.

vendorPaymentSplits

[VendorPaymentSplitDto]

false

none

List of vendorPaymentSplits items

revisionDisplayId

string

false

none

Unique identifier for the revision display

termType

string

false

none

Type of the term

exercise

boolean

false

none

Boolean flag indicating exercise status

leaseComponentFinancialTermId

integer(int64)

true

none

Unique identifier for the lease component financial term

revisionId

integer(int64)

true

none

Unique identifier for the revision

activationGroupDisplayId

string

true

none

Unique identifier for the activation group display

activationGroupId

integer(int64)

true

none

Unique identifier for the activation group

applyIndexation

boolean

false

none

Boolean flag indicating applyIndexation status

indexationType

string

false

none

Type of the indexation

indexationTypeNonLease

string

false

none

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

consumerPriceIndexCategory

ConsumerPriceIndexCategoryLite

false

none

Category of the consumer price index

consumerPriceIndexCategoryNonLease

ConsumerPriceIndexCategoryLite

false

none

Value for consumerPriceIndexCategoryNonLease field

baseIndexationDate

string(date)

false

none

Date of the base indexation

baseIndexationDateNonLease

string(date)

false

none

Represents the base date for indexation adjustments applicable to non-lease financial terms within the portfolio management framework.

baseIndexationRate

number(double)

false

none

Rate of base indexation

baseIndexationRateNonLease

number(double)

false

none

Value for baseIndexationRateNonLease field

referenceIndexationDate

string(date)

false

none

Date of the reference indexation

referenceIndexationDateNonLease

string(date)

false

none

Date indicating when the reference indexation for non-lease assets was last updated, relevant for portfolio and asset analytics within the Nakisa Portfolio Management Suite.

referenceIndexationRate

number(double)

false

none

Rate of reference indexation

referenceIndexationRateNonLease

number(double)

false

none

Value for referenceIndexationRateNonLease field

indexationStartDate

string(date)

false

none

Date of the indexation start

indexationStartDateNonLease

string(date)

false

none

Specifies the start date for indexation of financial terms related to non-lease assets within the Nakisa Portfolio Management Suite, facilitating accurate portfolio and asset analytics in real estate property management.

indexationLeasePercentage

number(double)

false

none

Percentage of indexation lease

indexationNonLeasePercentage

number(double)

false

none

Percentage of indexation non lease

termState

string

false

none

Current state of the portfolio

type

string

false

none

Type of the resource

numberRangeIdentifierType

INumberRangeIdentifierType

false

none

Type of the number range identifier

numberRangeIdentifierValue

string

false

none

Represents a unique string identifier for the range of numbers associated with financial terms within an activation group in 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

Type of the number range

Enumerated Values

Attribute

Value

amountFrequency

DAY, MONTH, ONE_TIME, YEAR

escalatingRentType

FIXED, PERCENTAGE

expenseCategoryType

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

indexationType

CPI_GLOBAL, CPI_LOCAL, NONE

indexationTypeNonLease

CPI_GLOBAL, CPI_LOCAL, NONE

lockReason

ENDS_BEFORE_MODIFICATION_DATE, EXERCISED_IN_ACTIVATION_GROUP, NO_PAYMENT

paymentCalculationMode

DAILY, ONE_TIME, PAYMENT_FOR_MONTH

paymentFrequency

ANNUALLY, BI_MONTHLY, BI_WEEKLY, DAILY, MONTHLY, ONE_TIME, QUARTERLY, SEMI_ANNUALLY, SEMI_MONTHLY, WEEKLY

paymentMode

ADVANCE, ARREARS

paymentTiming

END_OF_DAY, START_OF_DAY

spreadingFrequency

NONE, PERIODIC, STRAIGHT_LINE

termState

ACTIVE, HISTORICAL, INACTIVE

termStatus

EDITABLE, LOCKED

termType

INITIAL_DIRECT_COST, NON_LEASE_TERM, PAYMENT_TERM