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 "taxJurisdictionId": 0,
68 "taxJurisdictionDisplayId": "string",
69 "defaultTaxCodeId": 0,
70 "defaultTaxCodeDisplayId": "string",
71 "defaultExemptionTaxCodeId": 0,
72 "defaultExemptionTaxCodeDisplayId": "string",
73 "defaultExemptionPercentage": 0,
74 "mapping": {
75 "isLeaseExpense": true,
76 "nonLeaseTaxCodeId": 0,
77 "nonLeaseTaxCodeDisplayId": "string",
78 "nonLeaseExemptionTaxCodeId": 0,
79 "nonLeaseExemptionTaxCodeDisplayId": "string",
80 "nonLeaseExemptionTaxPercentage": 0.1,
81 "principalTaxCodeId": 0,
82 "principalTaxCodeDisplayId": "string",
83 "principalExemptionTaxCodeId": 0,
84 "principalExemptionTaxCodeDisplayId": "string",
85 "principalExemptionTaxPercentage": 0.1
86 }
87 }
88 }
89 ],
90 "revisionDisplayId": "string",
91 "termType": "PAYMENT_TERM",
92 "exercise": true,
93 "leaseComponentFinancialTermId": 0,
94 "revisionId": 0,
95 "activationGroupDisplayId": "string",
96 "activationGroupId": 0,
97 "applyIndexation": true,
98 "indexationType": "NONE",
99 "indexationTypeNonLease": "NONE",
100 "consumerPriceIndexCategory": {
101 "id": 0,
102 "displayId": "string",
103 "status": "CREATED",
104 "name": "string",
105 "city": "string",
106 "country": "string",
107 "province": "string"
108 },
109 "consumerPriceIndexCategoryNonLease": {
110 "id": 0,
111 "displayId": "string",
112 "status": "CREATED",
113 "name": "string",
114 "city": "string",
115 "country": "string",
116 "province": "string"
117 },
118 "baseIndexationDate": "2019-08-24",
119 "baseIndexationDateNonLease": "2019-08-24",
120 "baseIndexationRate": 0.1,
121 "baseIndexationRateNonLease": 0.1,
122 "referenceIndexationDate": "2019-08-24",
123 "referenceIndexationDateNonLease": "2019-08-24",
124 "referenceIndexationRate": 0.1,
125 "referenceIndexationRateNonLease": 0.1,
126 "indexationStartDate": "2019-08-24",
127 "indexationStartDateNonLease": "2019-08-24",
128 "indexationLeasePercentage": 0.1,
129 "indexationNonLeasePercentage": 0.1,
130 "termState": "HISTORICAL",
131 "type": "string",
132 "allowsSystemGenerateNewId": true,
133 "numberRangeIdentifierType": {
134 "name": "string"
135 },
136 "numberRangeIdentifierValue": "string",
137 "numberRangeType": {
138 "name": "string"
139 }
140}
📄 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 |
false |
none |
Category of the expense |
|
amount |
number(double) |
true |
none |
Amount value |
amountFrequency |
string |
true |
none |
Text value for amountFrequency in ActivationGroupFinancialTermDto |
paymentMode |
string |
true |
none |
Text value for paymentMode in ActivationGroupFinancialTermDto |
paymentCalculationMode |
string |
true |
none |
Text value for paymentCalculationMode in ActivationGroupFinancialTermDto |
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 |
Text value for paymentFrequency in ActivationGroupFinancialTermDto |
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 |
Text value for paymentTiming in ActivationGroupFinancialTermDto |
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 |
Text value for spreadingFrequency in ActivationGroupFinancialTermDto |
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 |
Text value for lockReason in ActivationGroupFinancialTermDto |
vendorPaymentSplits |
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 |
Text value for indexationTypeNonLease in ActivationGroupFinancialTermDto |
consumerPriceIndexCategory |
false |
none |
Category of the consumer price index |
|
consumerPriceIndexCategoryNonLease |
false |
none |
Value for consumerPriceIndexCategoryNonLease field |
|
baseIndexationDate |
string(date) |
false |
none |
Date of the base indexation |
baseIndexationDateNonLease |
string(date) |
false |
none |
Text value for baseIndexationDateNonLease in ActivationGroupFinancialTermDto |
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 |
Text value for referenceIndexationDateNonLease in ActivationGroupFinancialTermDto |
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 |
Text value for indexationStartDateNonLease in ActivationGroupFinancialTermDto |
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 |
allowsSystemGenerateNewId |
boolean |
false |
none |
Unique identifier for the allows system generate new |
numberRangeIdentifierType |
false |
none |
Type of the number range identifier |
|
numberRangeIdentifierValue |
string |
false |
none |
Text value for numberRangeIdentifierValue in ActivationGroupFinancialTermDto |
numberRangeType |
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 |