Percentage Rent Period¶
Get Percentage Rent Period¶
HTTP Request
GET /api/percentage-rent-periods/{id}
📋 Description: Retrieves detailed information about a specific percentage rent period associated with a real estate asset within the Nakisa Portfolio Management Suite, enabling enhanced portfolio analytics and management.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "createdBy": "string",
3 "lastModifiedBy": "string",
4 "createdDate": "2019-08-24T14:15:22Z",
5 "lastModifiedDate": "2019-08-24T14:15:22Z",
6 "archived": true,
7 "externalId": "string",
8 "id": 0,
9 "startDate": "2019-08-24",
10 "endDate": "2019-08-24"
11}
Update Percentage Rent Period¶
HTTP Request
PUT /api/percentage-rent-periods/{id}
📋 Description: Updates the specified percentage rent period in the Nakisa Portfolio Management Suite, enabling users to manage and analyze real estate property financial metrics effectively.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing the updated percentage rent period details, including relevant financial metrics and metadata for effective portfolio and asset management. |
Body Parameters
1{
2 "createdBy": "string",
3 "lastModifiedBy": "string",
4 "createdDate": "2019-08-24T14:15:22Z",
5 "lastModifiedDate": "2019-08-24T14:15:22Z",
6 "archived": true,
7 "externalId": "string",
8 "id": 0,
9 "startDate": "2019-08-24",
10 "endDate": "2019-08-24"
11}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "createdBy": "string",
3 "lastModifiedBy": "string",
4 "createdDate": "2019-08-24T14:15:22Z",
5 "lastModifiedDate": "2019-08-24T14:15:22Z",
6 "archived": true,
7 "externalId": "string",
8 "id": 0,
9 "startDate": "2019-08-24",
10 "endDate": "2019-08-24"
11}
Delete Percentage Rent Period¶
HTTP Request
DELETE /api/percentage-rent-periods/{id}
📋 Description: Deletes a specified percentage rent period from the Nakisa Portfolio Management Suite, enabling effective management of real estate property financials within the portfolio.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
204 |
No Content |
None |
Update Percentage Rent Exclusions¶
HTTP Request
PUT /api/percentage-rent-periods/{id}/percentage-rent-exclusions
📋 Description: Updates the percentage rent exclusions for a specified percentage rent period within the Nakisa Portfolio Management Suite, enabling precise management of rental agreements in the context of portfolio and asset analytics for real estate properties.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing the percentage rent exclusion details, including applicable dates and conditions, for the specified rent period within the Nakisa Portfolio Management Suite. |
Body Parameters
1[
2 {
3 "createdBy": "string",
4 "lastModifiedBy": "string",
5 "createdDate": "2019-08-24T14:15:22Z",
6 "lastModifiedDate": "2019-08-24T14:15:22Z",
7 "archived": true,
8 "externalId": "string",
9 "id": 0,
10 "saleCategoryCode": "string",
11 "saleSubCategoryId": 0,
12 "saleCategory": {
13 "createdBy": "string",
14 "lastModifiedBy": "string",
15 "createdDate": "2019-08-24T14:15:22Z",
16 "lastModifiedDate": "2019-08-24T14:15:22Z",
17 "archived": true,
18 "externalId": "string",
19 "id": "string",
20 "code": "string",
21 "priority": 0,
22 "pickListType": "string",
23 "label": "string",
24 "cultureId": 0,
25 "reportable": true,
26 "labelDtos": [
27 {
28 "createdBy": "string",
29 "lastModifiedBy": "string",
30 "createdDate": "2019-08-24T14:15:22Z",
31 "lastModifiedDate": "2019-08-24T14:15:22Z",
32 "archived": true,
33 "externalId": "string",
34 "id": 0,
35 "cultureId": 0,
36 "value": "string"
37 }
38 ]
39 },
40 "saleSubCategory": {
41 "createdBy": "string",
42 "lastModifiedBy": "string",
43 "createdDate": "2019-08-24T14:15:22Z",
44 "lastModifiedDate": "2019-08-24T14:15:22Z",
45 "archived": true,
46 "externalId": "string",
47 "id": 0,
48 "priority": 0,
49 "internalId": 0,
50 "pickListCode": "string",
51 "pickListLabel": "string",
52 "label": "string",
53 "cultureId": 0,
54 "labelDtos": [
55 {
56 "createdBy": "string",
57 "lastModifiedBy": "string",
58 "createdDate": "2019-08-24T14:15:22Z",
59 "lastModifiedDate": "2019-08-24T14:15:22Z",
60 "archived": true,
61 "externalId": "string",
62 "id": 0,
63 "cultureId": 0,
64 "value": "string"
65 }
66 ]
67 }
68 }
69]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
201 |
Created |
Inline |
Example Responses
1[
2 {
3 "createdBy": "string",
4 "lastModifiedBy": "string",
5 "createdDate": "2019-08-24T14:15:22Z",
6 "lastModifiedDate": "2019-08-24T14:15:22Z",
7 "archived": true,
8 "externalId": "string",
9 "id": 0,
10 "saleCategoryCode": "string",
11 "saleSubCategoryId": 0,
12 "saleCategory": {
13 "createdBy": "string",
14 "lastModifiedBy": "string",
15 "createdDate": "2019-08-24T14:15:22Z",
16 "lastModifiedDate": "2019-08-24T14:15:22Z",
17 "archived": true,
18 "externalId": "string",
19 "id": "string",
20 "code": "string",
21 "priority": 0,
22 "pickListType": "string",
23 "label": "string",
24 "cultureId": 0,
25 "reportable": true,
26 "labelDtos": [
27 {
28 "createdBy": "string",
29 "lastModifiedBy": "string",
30 "createdDate": "2019-08-24T14:15:22Z",
31 "lastModifiedDate": "2019-08-24T14:15:22Z",
32 "archived": true,
33 "externalId": "string",
34 "id": 0,
35 "cultureId": 0,
36 "value": "string"
37 }
38 ]
39 },
40 "saleSubCategory": {
41 "createdBy": "string",
42 "lastModifiedBy": "string",
43 "createdDate": "2019-08-24T14:15:22Z",
44 "lastModifiedDate": "2019-08-24T14:15:22Z",
45 "archived": true,
46 "externalId": "string",
47 "id": 0,
48 "priority": 0,
49 "internalId": 0,
50 "pickListCode": "string",
51 "pickListLabel": "string",
52 "label": "string",
53 "cultureId": 0,
54 "labelDtos": [
55 {
56 "createdBy": "string",
57 "lastModifiedBy": "string",
58 "createdDate": "2019-08-24T14:15:22Z",
59 "lastModifiedDate": "2019-08-24T14:15:22Z",
60 "archived": true,
61 "externalId": "string",
62 "id": 0,
63 "cultureId": 0,
64 "value": "string"
65 }
66 ]
67 }
68 }
69]
Response Schema
Status Code 201
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing the criteria and parameters for percentage rent exclusions within the Nakisa Portfolio Management Suite, facilitating effective portfolio and asset management in 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 |
» saleCategoryCode |
string |
false |
none |
Code for the sale category |
» saleSubCategoryId |
integer(int64) |
false |
none |
Unique identifier for the sale sub category |
» saleCategory |
false |
none |
Data transfer object representing a selection of options within the Nakisa Portfolio Management Suite, specifically designed to facilitate the management and analysis of 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 |
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 |
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 |
Text value for value in LabelDto |
» saleSubCategory |
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 |
false |
none |
List of labelDtos items |
Create Percentage Rent Rules¶
HTTP Request
POST /api/percentage-rent-periods/{id}/percentage-rent-rules
📋 Description: Creates new percentage rent rules for a specified percentage rent period within the Nakisa Portfolio Management Suite, enabling enhanced management and analytics of real estate property assets.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing the percentage rent rule data, including applicable percentages and conditions for the specified rent period within the Nakisa Portfolio Management Suite. |
Body Parameters
1[
2 {
3 "createdBy": "string",
4 "lastModifiedBy": "string",
5 "createdDate": "2019-08-24T14:15:22Z",
6 "lastModifiedDate": "2019-08-24T14:15:22Z",
7 "archived": true,
8 "externalId": "string",
9 "id": 0,
10 "paymentFrequencyId": 0,
11 "adjustmentFrequencyId": 0,
12 "minimum": 0,
13 "maximum": 0,
14 "calculationModeId": 0,
15 "breakevenPointTypeId": 0,
16 "breakevenPointPercentage": 0,
17 "formula": "string",
18 "note": "string",
19 "chargeExpenseCategoryIds": [
20 0
21 ],
22 "expenseCategoryIds": [
23 0
24 ],
25 "paymentFrequency": {
26 "createdBy": "string",
27 "lastModifiedBy": "string",
28 "createdDate": "2019-08-24T14:15:22Z",
29 "lastModifiedDate": "2019-08-24T14:15:22Z",
30 "archived": true,
31 "externalId": "string",
32 "id": 0,
33 "priority": 0,
34 "internalId": 0,
35 "pickListCode": "string",
36 "pickListLabel": "string",
37 "label": "string",
38 "cultureId": 0,
39 "labelDtos": [
40 {
41 "createdBy": "string",
42 "lastModifiedBy": "string",
43 "createdDate": "2019-08-24T14:15:22Z",
44 "lastModifiedDate": "2019-08-24T14:15:22Z",
45 "archived": true,
46 "externalId": "string",
47 "id": 0,
48 "cultureId": 0,
49 "value": "string"
50 }
51 ]
52 },
53 "adjustmentFrequency": {
54 "createdBy": "string",
55 "lastModifiedBy": "string",
56 "createdDate": "2019-08-24T14:15:22Z",
57 "lastModifiedDate": "2019-08-24T14:15:22Z",
58 "archived": true,
59 "externalId": "string",
60 "id": 0,
61 "priority": 0,
62 "internalId": 0,
63 "pickListCode": "string",
64 "pickListLabel": "string",
65 "label": "string",
66 "cultureId": 0,
67 "labelDtos": [
68 {
69 "createdBy": "string",
70 "lastModifiedBy": "string",
71 "createdDate": "2019-08-24T14:15:22Z",
72 "lastModifiedDate": "2019-08-24T14:15:22Z",
73 "archived": true,
74 "externalId": "string",
75 "id": 0,
76 "cultureId": 0,
77 "value": "string"
78 }
79 ]
80 },
81 "calculationMode": {
82 "createdBy": "string",
83 "lastModifiedBy": "string",
84 "createdDate": "2019-08-24T14:15:22Z",
85 "lastModifiedDate": "2019-08-24T14:15:22Z",
86 "archived": true,
87 "externalId": "string",
88 "id": 0,
89 "priority": 0,
90 "internalId": 0,
91 "pickListCode": "string",
92 "pickListLabel": "string",
93 "label": "string",
94 "cultureId": 0,
95 "labelDtos": [
96 {
97 "createdBy": "string",
98 "lastModifiedBy": "string",
99 "createdDate": "2019-08-24T14:15:22Z",
100 "lastModifiedDate": "2019-08-24T14:15:22Z",
101 "archived": true,
102 "externalId": "string",
103 "id": 0,
104 "cultureId": 0,
105 "value": "string"
106 }
107 ]
108 },
109 "breakevenPointType": {
110 "createdBy": "string",
111 "lastModifiedBy": "string",
112 "createdDate": "2019-08-24T14:15:22Z",
113 "lastModifiedDate": "2019-08-24T14:15:22Z",
114 "archived": true,
115 "externalId": "string",
116 "id": 0,
117 "priority": 0,
118 "internalId": 0,
119 "pickListCode": "string",
120 "pickListLabel": "string",
121 "label": "string",
122 "cultureId": 0,
123 "labelDtos": [
124 {
125 "createdBy": "string",
126 "lastModifiedBy": "string",
127 "createdDate": "2019-08-24T14:15:22Z",
128 "lastModifiedDate": "2019-08-24T14:15:22Z",
129 "archived": true,
130 "externalId": "string",
131 "id": 0,
132 "cultureId": 0,
133 "value": "string"
134 }
135 ]
136 }
137 }
138]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
201 |
Created |
Inline |
Example Responses
1[
2 {
3 "createdBy": "string",
4 "lastModifiedBy": "string",
5 "createdDate": "2019-08-24T14:15:22Z",
6 "lastModifiedDate": "2019-08-24T14:15:22Z",
7 "archived": true,
8 "externalId": "string",
9 "id": 0,
10 "paymentFrequencyId": 0,
11 "adjustmentFrequencyId": 0,
12 "minimum": 0,
13 "maximum": 0,
14 "calculationModeId": 0,
15 "breakevenPointTypeId": 0,
16 "breakevenPointPercentage": 0,
17 "formula": "string",
18 "note": "string",
19 "chargeExpenseCategoryIds": [
20 0
21 ],
22 "expenseCategoryIds": [
23 0
24 ],
25 "paymentFrequency": {
26 "createdBy": "string",
27 "lastModifiedBy": "string",
28 "createdDate": "2019-08-24T14:15:22Z",
29 "lastModifiedDate": "2019-08-24T14:15:22Z",
30 "archived": true,
31 "externalId": "string",
32 "id": 0,
33 "priority": 0,
34 "internalId": 0,
35 "pickListCode": "string",
36 "pickListLabel": "string",
37 "label": "string",
38 "cultureId": 0,
39 "labelDtos": [
40 {
41 "createdBy": "string",
42 "lastModifiedBy": "string",
43 "createdDate": "2019-08-24T14:15:22Z",
44 "lastModifiedDate": "2019-08-24T14:15:22Z",
45 "archived": true,
46 "externalId": "string",
47 "id": 0,
48 "cultureId": 0,
49 "value": "string"
50 }
51 ]
52 },
53 "adjustmentFrequency": {
54 "createdBy": "string",
55 "lastModifiedBy": "string",
56 "createdDate": "2019-08-24T14:15:22Z",
57 "lastModifiedDate": "2019-08-24T14:15:22Z",
58 "archived": true,
59 "externalId": "string",
60 "id": 0,
61 "priority": 0,
62 "internalId": 0,
63 "pickListCode": "string",
64 "pickListLabel": "string",
65 "label": "string",
66 "cultureId": 0,
67 "labelDtos": [
68 {
69 "createdBy": "string",
70 "lastModifiedBy": "string",
71 "createdDate": "2019-08-24T14:15:22Z",
72 "lastModifiedDate": "2019-08-24T14:15:22Z",
73 "archived": true,
74 "externalId": "string",
75 "id": 0,
76 "cultureId": 0,
77 "value": "string"
78 }
79 ]
80 },
81 "calculationMode": {
82 "createdBy": "string",
83 "lastModifiedBy": "string",
84 "createdDate": "2019-08-24T14:15:22Z",
85 "lastModifiedDate": "2019-08-24T14:15:22Z",
86 "archived": true,
87 "externalId": "string",
88 "id": 0,
89 "priority": 0,
90 "internalId": 0,
91 "pickListCode": "string",
92 "pickListLabel": "string",
93 "label": "string",
94 "cultureId": 0,
95 "labelDtos": [
96 {
97 "createdBy": "string",
98 "lastModifiedBy": "string",
99 "createdDate": "2019-08-24T14:15:22Z",
100 "lastModifiedDate": "2019-08-24T14:15:22Z",
101 "archived": true,
102 "externalId": "string",
103 "id": 0,
104 "cultureId": 0,
105 "value": "string"
106 }
107 ]
108 },
109 "breakevenPointType": {
110 "createdBy": "string",
111 "lastModifiedBy": "string",
112 "createdDate": "2019-08-24T14:15:22Z",
113 "lastModifiedDate": "2019-08-24T14:15:22Z",
114 "archived": true,
115 "externalId": "string",
116 "id": 0,
117 "priority": 0,
118 "internalId": 0,
119 "pickListCode": "string",
120 "pickListLabel": "string",
121 "label": "string",
122 "cultureId": 0,
123 "labelDtos": [
124 {
125 "createdBy": "string",
126 "lastModifiedBy": "string",
127 "createdDate": "2019-08-24T14:15:22Z",
128 "lastModifiedDate": "2019-08-24T14:15:22Z",
129 "archived": true,
130 "externalId": "string",
131 "id": 0,
132 "cultureId": 0,
133 "value": "string"
134 }
135 ]
136 }
137 }
138]
Response Schema
Status Code 201
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing the percentage rent rule applicable to real estate properties within the Nakisa Portfolio Management Suite, facilitating 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 |
» paymentFrequencyId |
integer(int64) |
false |
none |
Unique identifier for the payment frequency |
» adjustmentFrequencyId |
integer(int64) |
false |
none |
Unique identifier for the adjustment frequency |
» minimum |
number |
false |
none |
Value for minimum field |
» maximum |
number |
false |
none |
Value for maximum field |
» calculationModeId |
integer(int64) |
false |
none |
Unique identifier for the calculation mode |
» breakevenPointTypeId |
integer(int64) |
false |
none |
Unique identifier for the breakeven point type |
» breakevenPointPercentage |
number |
false |
none |
Percentage of breakeven point |
» formula |
string |
false |
none |
Text value for formula in PercentageRentRuleDto |
» note |
string |
false |
none |
Text value for note in PercentageRentRuleDto |
» chargeExpenseCategoryIds |
[integer] |
false |
none |
List of chargeExpenseCategoryIds items |
» expenseCategoryIds |
[integer] |
false |
none |
List of expenseCategoryIds items |
» paymentFrequency |
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 |
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 |
Text value for value in LabelDto |
» adjustmentFrequency |
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. |
|
» calculationMode |
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. |
|
» breakevenPointType |
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. |
Archive Percentage Rent Period¶
HTTP Request
POST /api/percentage-rent-periods/{id}/archive
📋 Description: Archives a specified percentage rent period within the Nakisa Portfolio Management Suite, facilitating effective asset management and analytics for real estate properties.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "createdBy": "string",
3 "lastModifiedBy": "string",
4 "createdDate": "2019-08-24T14:15:22Z",
5 "lastModifiedDate": "2019-08-24T14:15:22Z",
6 "archived": true,
7 "externalId": "string",
8 "id": 0,
9 "startDate": "2019-08-24",
10 "endDate": "2019-08-24"
11}
Get Percentage Rent Periods¶
HTTP Request
GET /api/percentage-rent-periods
📋 Description: Retrieves a list of percentage rent periods associated with real estate assets within the Nakisa Portfolio Management Suite, enabling portfolio managers to analyze rental structures and optimize asset performance.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
Indicates whether the results of the percentage rent periods query should be returned in a paginated format, facilitating efficient data retrieval for portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
|
start-date |
query |
string |
false |
Specifies the starting date for retrieving percentage rent periods within the Nakisa Portfolio Management Suite, facilitating analytics and reporting for real estate property portfolios. |
payment-frequency-id |
query |
string |
false |
Unique identifier for the payment frequency associated with percentage rent periods in the Nakisa Portfolio Management Suite, facilitating accurate portfolio and asset analytics in real estate property management. |
adjustment-frequency-id |
query |
string |
false |
Unique identifier for the adjustment frequency associated with percentage rent periods in the Nakisa Portfolio Management Suite, facilitating accurate portfolio and asset analytics in real estate property management. |
reporting-frequency-id |
query |
string |
false |
Unique identifier for the reporting frequency associated with percentage rent periods, facilitating analytics and portfolio management within real estate assets. |
end-date |
query |
string |
false |
Specifies the end date for the percentage rent period being queried, enabling users to analyze financial performance within the Nakisa Portfolio Management Suite. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "_embedded": {
3 "percentageRentPeriods": [
4 {
5 "createdBy": "string",
6 "lastModifiedBy": "string",
7 "createdDate": "2019-08-24T14:15:22Z",
8 "lastModifiedDate": "2019-08-24T14:15:22Z",
9 "archived": true,
10 "externalId": "string",
11 "id": 0,
12 "startDate": "2019-08-24",
13 "endDate": "2019-08-24"
14 }
15 ]
16 },
17 "page": {
18 "size": 0,
19 "totalElements": 0,
20 "totalPages": 0,
21 "number": 0
22 }
23}
Get Percentage Rent Rules¶
HTTP Request
GET /api/percentage-rent-periods/{percentageRentPeriodId}/percentage-rent-rules
📋 Description: Fetches the percentage rent rules associated with a specified percentage rent period, enabling users to analyze and manage rental agreements within the Nakisa Portfolio Management Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
Indicates whether the results of the percentage rent rules associated with the specified percentage rent period should be returned in a paginated format, facilitating efficient data retrieval for portfolio and asset management analytics. |
|
percentageRentPeriodId |
path |
string |
true |
Unique identifier for the percentage rent period |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "_embedded": {
3 "percentageRentRules": [
4 {
5 "createdBy": "string",
6 "lastModifiedBy": "string",
7 "createdDate": "2019-08-24T14:15:22Z",
8 "lastModifiedDate": "2019-08-24T14:15:22Z",
9 "archived": true,
10 "externalId": "string",
11 "id": 0,
12 "paymentFrequencyId": 0,
13 "adjustmentFrequencyId": 0,
14 "minimum": 0,
15 "maximum": 0,
16 "calculationModeId": 0,
17 "breakevenPointTypeId": 0,
18 "breakevenPointPercentage": 0,
19 "formula": "string",
20 "note": "string",
21 "chargeExpenseCategoryIds": [
22 0
23 ],
24 "expenseCategoryIds": [
25 0
26 ],
27 "paymentFrequency": {
28 "createdBy": "string",
29 "lastModifiedBy": "string",
30 "createdDate": "2019-08-24T14:15:22Z",
31 "lastModifiedDate": "2019-08-24T14:15:22Z",
32 "archived": true,
33 "externalId": "string",
34 "id": 0,
35 "priority": 0,
36 "internalId": 0,
37 "pickListCode": "string",
38 "pickListLabel": "string",
39 "label": "string",
40 "cultureId": 0,
41 "labelDtos": [
42 {
43 "createdBy": "string",
44 "lastModifiedBy": "string",
45 "createdDate": "2019-08-24T14:15:22Z",
46 "lastModifiedDate": "2019-08-24T14:15:22Z",
47 "archived": true,
48 "externalId": "string",
49 "id": 0,
50 "cultureId": 0,
51 "value": "string"
52 }
53 ]
54 },
55 "adjustmentFrequency": {
56 "createdBy": "string",
57 "lastModifiedBy": "string",
58 "createdDate": "2019-08-24T14:15:22Z",
59 "lastModifiedDate": "2019-08-24T14:15:22Z",
60 "archived": true,
61 "externalId": "string",
62 "id": 0,
63 "priority": 0,
64 "internalId": 0,
65 "pickListCode": "string",
66 "pickListLabel": "string",
67 "label": "string",
68 "cultureId": 0,
69 "labelDtos": [
70 {
71 "createdBy": "string",
72 "lastModifiedBy": "string",
73 "createdDate": "2019-08-24T14:15:22Z",
74 "lastModifiedDate": "2019-08-24T14:15:22Z",
75 "archived": true,
76 "externalId": "string",
77 "id": 0,
78 "cultureId": 0,
79 "value": "string"
80 }
81 ]
82 },
83 "calculationMode": {
84 "createdBy": "string",
85 "lastModifiedBy": "string",
86 "createdDate": "2019-08-24T14:15:22Z",
87 "lastModifiedDate": "2019-08-24T14:15:22Z",
88 "archived": true,
89 "externalId": "string",
90 "id": 0,
91 "priority": 0,
92 "internalId": 0,
93 "pickListCode": "string",
94 "pickListLabel": "string",
95 "label": "string",
96 "cultureId": 0,
97 "labelDtos": [
98 {
99 "createdBy": "string",
100 "lastModifiedBy": "string",
101 "createdDate": "2019-08-24T14:15:22Z",
102 "lastModifiedDate": "2019-08-24T14:15:22Z",
103 "archived": true,
104 "externalId": "string",
105 "id": 0,
106 "cultureId": 0,
107 "value": "string"
108 }
109 ]
110 },
111 "breakevenPointType": {
112 "createdBy": "string",
113 "lastModifiedBy": "string",
114 "createdDate": "2019-08-24T14:15:22Z",
115 "lastModifiedDate": "2019-08-24T14:15:22Z",
116 "archived": true,
117 "externalId": "string",
118 "id": 0,
119 "priority": 0,
120 "internalId": 0,
121 "pickListCode": "string",
122 "pickListLabel": "string",
123 "label": "string",
124 "cultureId": 0,
125 "labelDtos": [
126 {
127 "createdBy": "string",
128 "lastModifiedBy": "string",
129 "createdDate": "2019-08-24T14:15:22Z",
130 "lastModifiedDate": "2019-08-24T14:15:22Z",
131 "archived": true,
132 "externalId": "string",
133 "id": 0,
134 "cultureId": 0,
135 "value": "string"
136 }
137 ]
138 }
139 }
140 ]
141 },
142 "page": {
143 "size": 0,
144 "totalElements": 0,
145 "totalPages": 0,
146 "number": 0
147 }
148}
Get Percentage Rent Exclusions¶
HTTP Request
GET /api/percentage-rent-periods/{percentageRentPeriodId}/percentage-rent-exclusions
📋 Description: Retrieves a list of percentage rent exclusions associated with a specified percentage rent period, enabling users to analyze and manage exclusions within their real estate property portfolios.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
Indicates whether the results of the percentage rent exclusions for the specified percentage rent period should be returned in a paginated format, facilitating efficient data retrieval within the Nakisa Portfolio Management Suite. |
|
percentageRentPeriodId |
path |
string |
true |
Unique identifier for the percentage rent period |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "_embedded": {
3 "percentageRentExclusions": [
4 {
5 "createdBy": "string",
6 "lastModifiedBy": "string",
7 "createdDate": "2019-08-24T14:15:22Z",
8 "lastModifiedDate": "2019-08-24T14:15:22Z",
9 "archived": true,
10 "externalId": "string",
11 "id": 0,
12 "saleCategoryCode": "string",
13 "saleSubCategoryId": 0,
14 "saleCategory": {
15 "createdBy": "string",
16 "lastModifiedBy": "string",
17 "createdDate": "2019-08-24T14:15:22Z",
18 "lastModifiedDate": "2019-08-24T14:15:22Z",
19 "archived": true,
20 "externalId": "string",
21 "id": "string",
22 "code": "string",
23 "priority": 0,
24 "pickListType": "string",
25 "label": "string",
26 "cultureId": 0,
27 "reportable": true,
28 "labelDtos": [
29 {
30 "createdBy": "string",
31 "lastModifiedBy": "string",
32 "createdDate": "2019-08-24T14:15:22Z",
33 "lastModifiedDate": "2019-08-24T14:15:22Z",
34 "archived": true,
35 "externalId": "string",
36 "id": 0,
37 "cultureId": 0,
38 "value": "string"
39 }
40 ]
41 },
42 "saleSubCategory": {
43 "createdBy": "string",
44 "lastModifiedBy": "string",
45 "createdDate": "2019-08-24T14:15:22Z",
46 "lastModifiedDate": "2019-08-24T14:15:22Z",
47 "archived": true,
48 "externalId": "string",
49 "id": 0,
50 "priority": 0,
51 "internalId": 0,
52 "pickListCode": "string",
53 "pickListLabel": "string",
54 "label": "string",
55 "cultureId": 0,
56 "labelDtos": [
57 {
58 "createdBy": "string",
59 "lastModifiedBy": "string",
60 "createdDate": "2019-08-24T14:15:22Z",
61 "lastModifiedDate": "2019-08-24T14:15:22Z",
62 "archived": true,
63 "externalId": "string",
64 "id": 0,
65 "cultureId": 0,
66 "value": "string"
67 }
68 ]
69 }
70 }
71 ]
72 },
73 "page": {
74 "size": 0,
75 "totalElements": 0,
76 "totalPages": 0,
77 "number": 0
78 }
79}