Sale Lease¶
Get Sale Lease¶
HTTP Request
GET /api/sale-leases/{id}
📋 Description: Fetches detailed information about a specific sale lease identified by the provided ID, enabling users to analyze asset performance within the Nakisa Portfolio Management Suite.
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 "typeId": 0,
10 "statusId": 0,
11 "firm": "string",
12 "startDate": "2019-08-24",
13 "endDate": "2019-08-24",
14 "criticalDate": "2019-08-24",
15 "askingPrice": 0,
16 "targetPrice": 0,
17 "brokerageCost": 0,
18 "type": {
19 "createdBy": "string",
20 "lastModifiedBy": "string",
21 "createdDate": "2019-08-24T14:15:22Z",
22 "lastModifiedDate": "2019-08-24T14:15:22Z",
23 "archived": true,
24 "externalId": "string",
25 "id": 0,
26 "priority": 0,
27 "internalId": 0,
28 "pickListCode": "string",
29 "pickListLabel": "string",
30 "label": "string",
31 "cultureId": 0,
32 "labelDtos": [
33 {
34 "createdBy": "string",
35 "lastModifiedBy": "string",
36 "createdDate": "2019-08-24T14:15:22Z",
37 "lastModifiedDate": "2019-08-24T14:15:22Z",
38 "archived": true,
39 "externalId": "string",
40 "id": 0,
41 "cultureId": 0,
42 "value": "string"
43 }
44 ]
45 },
46 "status": {
47 "createdBy": "string",
48 "lastModifiedBy": "string",
49 "createdDate": "2019-08-24T14:15:22Z",
50 "lastModifiedDate": "2019-08-24T14:15:22Z",
51 "archived": true,
52 "externalId": "string",
53 "id": 0,
54 "priority": 0,
55 "internalId": 0,
56 "pickListCode": "string",
57 "pickListLabel": "string",
58 "label": "string",
59 "cultureId": 0,
60 "labelDtos": [
61 {
62 "createdBy": "string",
63 "lastModifiedBy": "string",
64 "createdDate": "2019-08-24T14:15:22Z",
65 "lastModifiedDate": "2019-08-24T14:15:22Z",
66 "archived": true,
67 "externalId": "string",
68 "id": 0,
69 "cultureId": 0,
70 "value": "string"
71 }
72 ]
73 }
74}
Update Sale Lease¶
HTTP Request
PUT /api/sale-leases/{id}
📋 Description: Updates the details of a specific sale lease identified by its ID within the Nakisa Portfolio Management Suite, enabling users to manage portfolio and asset information effectively in the context of real estate property analytics.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing updated lease details, including asset information and financial terms, for the specified real estate property within the Nakisa Portfolio Management Suite. |
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 "typeId": 0,
10 "statusId": 0,
11 "firm": "string",
12 "startDate": "2019-08-24",
13 "endDate": "2019-08-24",
14 "criticalDate": "2019-08-24",
15 "askingPrice": 0,
16 "targetPrice": 0,
17 "brokerageCost": 0,
18 "type": {
19 "createdBy": "string",
20 "lastModifiedBy": "string",
21 "createdDate": "2019-08-24T14:15:22Z",
22 "lastModifiedDate": "2019-08-24T14:15:22Z",
23 "archived": true,
24 "externalId": "string",
25 "id": 0,
26 "priority": 0,
27 "internalId": 0,
28 "pickListCode": "string",
29 "pickListLabel": "string",
30 "label": "string",
31 "cultureId": 0,
32 "labelDtos": [
33 {
34 "createdBy": "string",
35 "lastModifiedBy": "string",
36 "createdDate": "2019-08-24T14:15:22Z",
37 "lastModifiedDate": "2019-08-24T14:15:22Z",
38 "archived": true,
39 "externalId": "string",
40 "id": 0,
41 "cultureId": 0,
42 "value": "string"
43 }
44 ]
45 },
46 "status": {
47 "createdBy": "string",
48 "lastModifiedBy": "string",
49 "createdDate": "2019-08-24T14:15:22Z",
50 "lastModifiedDate": "2019-08-24T14:15:22Z",
51 "archived": true,
52 "externalId": "string",
53 "id": 0,
54 "priority": 0,
55 "internalId": 0,
56 "pickListCode": "string",
57 "pickListLabel": "string",
58 "label": "string",
59 "cultureId": 0,
60 "labelDtos": [
61 {
62 "createdBy": "string",
63 "lastModifiedBy": "string",
64 "createdDate": "2019-08-24T14:15:22Z",
65 "lastModifiedDate": "2019-08-24T14:15:22Z",
66 "archived": true,
67 "externalId": "string",
68 "id": 0,
69 "cultureId": 0,
70 "value": "string"
71 }
72 ]
73 }
74}
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 "typeId": 0,
10 "statusId": 0,
11 "firm": "string",
12 "startDate": "2019-08-24",
13 "endDate": "2019-08-24",
14 "criticalDate": "2019-08-24",
15 "askingPrice": 0,
16 "targetPrice": 0,
17 "brokerageCost": 0,
18 "type": {
19 "createdBy": "string",
20 "lastModifiedBy": "string",
21 "createdDate": "2019-08-24T14:15:22Z",
22 "lastModifiedDate": "2019-08-24T14:15:22Z",
23 "archived": true,
24 "externalId": "string",
25 "id": 0,
26 "priority": 0,
27 "internalId": 0,
28 "pickListCode": "string",
29 "pickListLabel": "string",
30 "label": "string",
31 "cultureId": 0,
32 "labelDtos": [
33 {
34 "createdBy": "string",
35 "lastModifiedBy": "string",
36 "createdDate": "2019-08-24T14:15:22Z",
37 "lastModifiedDate": "2019-08-24T14:15:22Z",
38 "archived": true,
39 "externalId": "string",
40 "id": 0,
41 "cultureId": 0,
42 "value": "string"
43 }
44 ]
45 },
46 "status": {
47 "createdBy": "string",
48 "lastModifiedBy": "string",
49 "createdDate": "2019-08-24T14:15:22Z",
50 "lastModifiedDate": "2019-08-24T14:15:22Z",
51 "archived": true,
52 "externalId": "string",
53 "id": 0,
54 "priority": 0,
55 "internalId": 0,
56 "pickListCode": "string",
57 "pickListLabel": "string",
58 "label": "string",
59 "cultureId": 0,
60 "labelDtos": [
61 {
62 "createdBy": "string",
63 "lastModifiedBy": "string",
64 "createdDate": "2019-08-24T14:15:22Z",
65 "lastModifiedDate": "2019-08-24T14:15:22Z",
66 "archived": true,
67 "externalId": "string",
68 "id": 0,
69 "cultureId": 0,
70 "value": "string"
71 }
72 ]
73 }
74}
Delete Sale Lease¶
HTTP Request
DELETE /api/sale-leases/{id}
📋 Description: Deletes a specified sale lease from the Nakisa Portfolio Management Suite, ensuring accurate portfolio management and asset tracking within 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 |
None |
Get Sale Lease Documents¶
HTTP Request
GET /api/sale-leases/{saleLeaseId}/documents
📋 Description: Retrieves documents associated with a specific sale lease, enabling users to access critical information related to portfolio management and asset analytics within the Nakisa Portfolio Management Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
saleLeaseId |
path |
integer(int64) |
true |
Unique identifier for the sale lease |
pageable |
query |
true |
Indicates whether the results should be returned in a paginated format, facilitating efficient retrieval of documents associated with a specific sale lease within the Nakisa Portfolio Management Suite. |
|
search |
query |
string |
false |
Search term used to filter and retrieve specific documents related to the sale lease identified by {saleLeaseId} within the Nakisa Portfolio Management Suite. |
id |
query |
string |
false |
Unique identifier for the resource |
status-id |
query |
string |
false |
Unique identifier for the status of the sale lease document, facilitating efficient tracking and management within the Nakisa Portfolio Management Suite. |
signed-date |
query |
string |
false |
Specifies the date on which the document was signed, providing essential context for portfolio and asset management within the Nakisa Portfolio Management Suite. |
name |
query |
string |
false |
Name of the resource |
title |
query |
string |
false |
Title of the resource |
type |
query |
string |
false |
Type of the resource |
shareable |
query |
string |
false |
Indicates whether the documents associated with the specified sale lease can be shared, facilitating collaboration and transparency in portfolio and asset management. |
document-type-id |
query |
string |
false |
Unique identifier for the type of document associated with a specific sale lease, facilitating effective management and analytics within the Nakisa Portfolio Management Suite. |
document-type-id-in |
query |
string |
false |
Unique identifier for the type of document associated with the specified sale lease, facilitating precise retrieval within the Nakisa Portfolio Management Suite. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "_embedded": {
3 "documents": [
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 "name": "string",
13 "title": "string",
14 "type": "string",
15 "description": "string",
16 "link": "string",
17 "signedDate": "2019-08-24",
18 "documentTypeId": 0,
19 "statusId": 0,
20 "shareable": true,
21 "size": 0,
22 "documentType": {
23 "createdBy": "string",
24 "lastModifiedBy": "string",
25 "createdDate": "2019-08-24T14:15:22Z",
26 "lastModifiedDate": "2019-08-24T14:15:22Z",
27 "archived": true,
28 "externalId": "string",
29 "id": 0,
30 "priority": 0,
31 "internalId": 0,
32 "pickListCode": "string",
33 "pickListLabel": "string",
34 "label": "string",
35 "cultureId": 0,
36 "labelDtos": [
37 {
38 "createdBy": "string",
39 "lastModifiedBy": "string",
40 "createdDate": "2019-08-24T14:15:22Z",
41 "lastModifiedDate": "2019-08-24T14:15:22Z",
42 "archived": true,
43 "externalId": "string",
44 "id": 0,
45 "cultureId": 0,
46 "value": "string"
47 }
48 ]
49 },
50 "status": {
51 "createdBy": "string",
52 "lastModifiedBy": "string",
53 "createdDate": "2019-08-24T14:15:22Z",
54 "lastModifiedDate": "2019-08-24T14:15:22Z",
55 "archived": true,
56 "externalId": "string",
57 "id": 0,
58 "priority": 0,
59 "internalId": 0,
60 "pickListCode": "string",
61 "pickListLabel": "string",
62 "label": "string",
63 "cultureId": 0,
64 "labelDtos": [
65 {
66 "createdBy": "string",
67 "lastModifiedBy": "string",
68 "createdDate": "2019-08-24T14:15:22Z",
69 "lastModifiedDate": "2019-08-24T14:15:22Z",
70 "archived": true,
71 "externalId": "string",
72 "id": 0,
73 "cultureId": 0,
74 "value": "string"
75 }
76 ]
77 }
78 }
79 ]
80 },
81 "page": {
82 "size": 0,
83 "totalElements": 0,
84 "totalPages": 0,
85 "number": 0
86 }
87}
Upload Sale Lease Document¶
HTTP Request
POST /api/sale-leases/{saleLeaseId}/documents
📋 Description: Uploads documents associated with a specific sale lease, enabling enhanced portfolio management and asset analytics within the Nakisa Portfolio Management Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
saleLeaseId |
path |
integer(int64) |
true |
Unique identifier for the sale lease |
body |
body |
object |
false |
Request body containing the document details, including type, description, and associated metadata, relevant to the specified sale lease within the Nakisa Portfolio Management Suite. |
» file |
body |
string(binary) |
false |
none |
» document |
body |
true |
Data transfer object representing a document within the Nakisa Portfolio Management Suite, encapsulating essential information related to portfolio assets, analytics, and real estate properties. |
|
»» createdBy |
body |
string |
false |
Username of who created this resource |
»» lastModifiedBy |
body |
string |
false |
Username of who last modified this resource |
»» createdDate |
body |
string(date-time) |
false |
Date of the created |
»» lastModifiedDate |
body |
string(date-time) |
false |
Date of the last modified |
»» archived |
body |
boolean |
false |
Boolean flag indicating archived status |
»» externalId |
body |
string |
false |
Unique identifier for the external |
»» id |
body |
integer(int64) |
false |
Unique identifier for the resource |
»» name |
body |
string |
false |
Name of the resource |
»» title |
body |
string |
false |
Title of the resource |
»» type |
body |
string |
false |
Type of the resource |
»» description |
body |
string |
false |
Description of the resource |
»» link |
body |
string |
false |
Text value for link in DocumentDto |
»» signedDate |
body |
string(date) |
false |
Date of the signed |
»» documentTypeId |
body |
integer(int64) |
false |
Unique identifier for the document type |
»» statusId |
body |
integer(int64) |
false |
Unique identifier for the status |
»» shareable |
body |
boolean |
false |
Boolean flag indicating shareable status |
»» size |
body |
integer(int64) |
false |
Number of items per page |
»» documentType |
body |
false |
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 |
body |
string |
false |
Username of who created this resource |
»»» lastModifiedBy |
body |
string |
false |
Username of who last modified this resource |
»»» createdDate |
body |
string(date-time) |
false |
Date of the created |
»»» lastModifiedDate |
body |
string(date-time) |
false |
Date of the last modified |
»»» archived |
body |
boolean |
false |
Boolean flag indicating archived status |
»»» externalId |
body |
string |
false |
Unique identifier for the external |
»»» id |
body |
integer(int64) |
false |
Unique identifier for the resource |
»»» priority |
body |
integer(int64) |
false |
Priority of the resource |
»»» internalId |
body |
integer(int64) |
false |
Unique identifier for the internal |
»»» pickListCode |
body |
string |
false |
Code for the pick list |
»»» pickListLabel |
body |
string |
false |
Label for the pick list |
»»» label |
body |
string |
false |
Label for the resource |
»»» cultureId |
body |
integer(int64) |
false |
Unique identifier for the culture |
»»» labelDtos |
body |
false |
List of labelDtos items |
|
»»»» createdBy |
body |
string |
false |
Username of who created this resource |
»»»» lastModifiedBy |
body |
string |
false |
Username of who last modified this resource |
»»»» createdDate |
body |
string(date-time) |
false |
Date of the created |
»»»» lastModifiedDate |
body |
string(date-time) |
false |
Date of the last modified |
»»»» archived |
body |
boolean |
false |
Boolean flag indicating archived status |
»»»» externalId |
body |
string |
false |
Unique identifier for the external |
»»»» id |
body |
integer(int64) |
false |
Unique identifier for the resource |
»»»» cultureId |
body |
integer(int64) |
false |
Unique identifier for the culture |
»»»» value |
body |
string |
true |
Text value for value in LabelDto |
»» status |
body |
false |
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. |
Body Parameters
1{
2 "document": {
3 "archived": true,
4 "createdBy": "string",
5 "createdDate": "2019-08-24 14:15:22+00:00",
6 "description": "string",
7 "documentType": {
8 "archived": true,
9 "createdBy": "string",
10 "createdDate": "2019-08-24 14:15:22+00:00",
11 "cultureId": 0,
12 "externalId": "string",
13 "id": 0,
14 "internalId": 0,
15 "label": "string",
16 "labelDtos": [
17 {
18 "archived": true,
19 "createdBy": "string",
20 "createdDate": "2019-08-24 14:15:22+00:00",
21 "cultureId": 0,
22 "externalId": "string",
23 "id": 0,
24 "lastModifiedBy": "string",
25 "lastModifiedDate": "2019-08-24 14:15:22+00:00",
26 "value": "string"
27 }
28 ],
29 "lastModifiedBy": "string",
30 "lastModifiedDate": "2019-08-24 14:15:22+00:00",
31 "pickListCode": "string",
32 "pickListLabel": "string",
33 "priority": 0
34 },
35 "documentTypeId": 0,
36 "externalId": "string",
37 "id": 0,
38 "lastModifiedBy": "string",
39 "lastModifiedDate": "2019-08-24 14:15:22+00:00",
40 "link": "string",
41 "name": "string",
42 "shareable": true,
43 "signedDate": "2019-08-24",
44 "size": 0,
45 "status": {
46 "archived": true,
47 "createdBy": "string",
48 "createdDate": "2019-08-24 14:15:22+00:00",
49 "cultureId": 0,
50 "externalId": "string",
51 "id": 0,
52 "internalId": 0,
53 "label": "string",
54 "labelDtos": [
55 {
56 "archived": true,
57 "createdBy": "string",
58 "createdDate": "2019-08-24 14:15:22+00:00",
59 "cultureId": 0,
60 "externalId": "string",
61 "id": 0,
62 "lastModifiedBy": "string",
63 "lastModifiedDate": "2019-08-24 14:15:22+00:00",
64 "value": "string"
65 }
66 ],
67 "lastModifiedBy": "string",
68 "lastModifiedDate": "2019-08-24 14:15:22+00:00",
69 "pickListCode": "string",
70 "pickListLabel": "string",
71 "priority": 0
72 },
73 "statusId": 0,
74 "title": "string",
75 "type": "string"
76 },
77 "file": "string"
78}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
201 |
Created |
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 "name": "string",
10 "title": "string",
11 "type": "string",
12 "description": "string",
13 "link": "string",
14 "signedDate": "2019-08-24",
15 "documentTypeId": 0,
16 "statusId": 0,
17 "shareable": true,
18 "size": 0,
19 "documentType": {
20 "createdBy": "string",
21 "lastModifiedBy": "string",
22 "createdDate": "2019-08-24T14:15:22Z",
23 "lastModifiedDate": "2019-08-24T14:15:22Z",
24 "archived": true,
25 "externalId": "string",
26 "id": 0,
27 "priority": 0,
28 "internalId": 0,
29 "pickListCode": "string",
30 "pickListLabel": "string",
31 "label": "string",
32 "cultureId": 0,
33 "labelDtos": [
34 {
35 "createdBy": "string",
36 "lastModifiedBy": "string",
37 "createdDate": "2019-08-24T14:15:22Z",
38 "lastModifiedDate": "2019-08-24T14:15:22Z",
39 "archived": true,
40 "externalId": "string",
41 "id": 0,
42 "cultureId": 0,
43 "value": "string"
44 }
45 ]
46 },
47 "status": {
48 "createdBy": "string",
49 "lastModifiedBy": "string",
50 "createdDate": "2019-08-24T14:15:22Z",
51 "lastModifiedDate": "2019-08-24T14:15:22Z",
52 "archived": true,
53 "externalId": "string",
54 "id": 0,
55 "priority": 0,
56 "internalId": 0,
57 "pickListCode": "string",
58 "pickListLabel": "string",
59 "label": "string",
60 "cultureId": 0,
61 "labelDtos": [
62 {
63 "createdBy": "string",
64 "lastModifiedBy": "string",
65 "createdDate": "2019-08-24T14:15:22Z",
66 "lastModifiedDate": "2019-08-24T14:15:22Z",
67 "archived": true,
68 "externalId": "string",
69 "id": 0,
70 "cultureId": 0,
71 "value": "string"
72 }
73 ]
74 }
75}
Add Sale Lease Notes¶
HTTP Request
POST /api/sale-leases/{id}/notes
📋 Description: Adds a new note to the specified sale lease, enhancing portfolio management by allowing users to document important insights and observations related to real estate assets.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing the note details associated with the specified sale lease, including relevant commentary and metadata for portfolio and asset management. |
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 "message": "string",
11 "userIds": [
12 0
13 ],
14 "redirectUrl": "string"
15 }
16]
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 "message": "string",
11 "userIds": [
12 0
13 ],
14 "redirectUrl": "string"
15 }
16]
Response Schema
Status Code 201
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
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 |
Text value for message in NoteDto |
» userIds |
[integer] |
false |
none |
User information related to portfolio management |
» redirectUrl |
string |
false |
none |
Text value for redirectUrl in NoteDto |
Archive Sale Lease¶
HTTP Request
POST /api/sale-leases/{id}/archive
📋 Description: Archives a specified sale lease within the Nakisa Portfolio Management Suite, enabling effective portfolio management and asset 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 "typeId": 0,
10 "statusId": 0,
11 "firm": "string",
12 "startDate": "2019-08-24",
13 "endDate": "2019-08-24",
14 "criticalDate": "2019-08-24",
15 "askingPrice": 0,
16 "targetPrice": 0,
17 "brokerageCost": 0,
18 "type": {
19 "createdBy": "string",
20 "lastModifiedBy": "string",
21 "createdDate": "2019-08-24T14:15:22Z",
22 "lastModifiedDate": "2019-08-24T14:15:22Z",
23 "archived": true,
24 "externalId": "string",
25 "id": 0,
26 "priority": 0,
27 "internalId": 0,
28 "pickListCode": "string",
29 "pickListLabel": "string",
30 "label": "string",
31 "cultureId": 0,
32 "labelDtos": [
33 {
34 "createdBy": "string",
35 "lastModifiedBy": "string",
36 "createdDate": "2019-08-24T14:15:22Z",
37 "lastModifiedDate": "2019-08-24T14:15:22Z",
38 "archived": true,
39 "externalId": "string",
40 "id": 0,
41 "cultureId": 0,
42 "value": "string"
43 }
44 ]
45 },
46 "status": {
47 "createdBy": "string",
48 "lastModifiedBy": "string",
49 "createdDate": "2019-08-24T14:15:22Z",
50 "lastModifiedDate": "2019-08-24T14:15:22Z",
51 "archived": true,
52 "externalId": "string",
53 "id": 0,
54 "priority": 0,
55 "internalId": 0,
56 "pickListCode": "string",
57 "pickListLabel": "string",
58 "label": "string",
59 "cultureId": 0,
60 "labelDtos": [
61 {
62 "createdBy": "string",
63 "lastModifiedBy": "string",
64 "createdDate": "2019-08-24T14:15:22Z",
65 "lastModifiedDate": "2019-08-24T14:15:22Z",
66 "archived": true,
67 "externalId": "string",
68 "id": 0,
69 "cultureId": 0,
70 "value": "string"
71 }
72 ]
73 }
74}
Get Sale Leases¶
HTTP Request
GET /api/sale-leases
📋 Description: Retrieves a list of sale leases within the Nakisa Portfolio Management Suite, providing insights into portfolio and asset performance for real estate properties.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
Indicates whether the results of the sale leases query should be returned in a paginated format, facilitating efficient data retrieval for portfolio and asset analysis within the Nakisa Portfolio Management Suite. |
|
search |
query |
string |
false |
Search term used to filter and retrieve specific sale lease records within the Nakisa Portfolio Management Suite, enhancing portfolio and asset analytics for real estate properties. |
premise-id |
query |
string |
false |
Unique identifier for the real estate property within the portfolio, used to retrieve specific sale lease information from the Nakisa Portfolio Management Suite. |
type-id |
query |
string |
false |
Unique identifier for the type of sale lease, facilitating targeted retrieval of lease data within the Nakisa Portfolio Management Suite for portfolio and asset analytics. |
status-id |
query |
string |
false |
Unique identifier for the status of a sale lease, enabling users to filter and analyze portfolio performance within the Nakisa Portfolio Management Suite. |
firm |
query |
string |
false |
Identifier for the firm associated with the sale leases, enabling targeted analytics and portfolio management within the Nakisa Portfolio Management Suite. |
start-date |
query |
string |
false |
Specifies the starting date for retrieving sale lease data within the Nakisa Portfolio Management Suite, enabling users to analyze portfolio performance over a defined time period. |
end-date |
query |
string |
false |
Specifies the end date for filtering sale leases within the Nakisa Portfolio Management Suite, enabling users to analyze portfolio performance and asset management over a defined period. |
critical-date |
query |
string |
false |
Specifies the critical date for retrieving sale lease data, enabling users to analyze portfolio performance and asset valuation within the real estate property context. |
asking-price |
query |
string |
false |
Specifies the asking price of the real estate property within the portfolio, facilitating asset valuation and analytics in the Nakisa Portfolio Management Suite. |
target-price |
query |
string |
false |
Specifies the target price for sale leases within the Nakisa Portfolio Management Suite, enabling users to analyze and manage real estate property assets effectively. |
brokerage-cost |
query |
string |
false |
Specifies the brokerage cost associated with the sale or lease of real estate properties within the Nakisa Portfolio Management Suite. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "_embedded": {
3 "saleLeases": [
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 "typeId": 0,
13 "statusId": 0,
14 "firm": "string",
15 "startDate": "2019-08-24",
16 "endDate": "2019-08-24",
17 "criticalDate": "2019-08-24",
18 "askingPrice": 0,
19 "targetPrice": 0,
20 "brokerageCost": 0,
21 "type": {
22 "createdBy": "string",
23 "lastModifiedBy": "string",
24 "createdDate": "2019-08-24T14:15:22Z",
25 "lastModifiedDate": "2019-08-24T14:15:22Z",
26 "archived": true,
27 "externalId": "string",
28 "id": 0,
29 "priority": 0,
30 "internalId": 0,
31 "pickListCode": "string",
32 "pickListLabel": "string",
33 "label": "string",
34 "cultureId": 0,
35 "labelDtos": [
36 {
37 "createdBy": "string",
38 "lastModifiedBy": "string",
39 "createdDate": "2019-08-24T14:15:22Z",
40 "lastModifiedDate": "2019-08-24T14:15:22Z",
41 "archived": true,
42 "externalId": "string",
43 "id": 0,
44 "cultureId": 0,
45 "value": "string"
46 }
47 ]
48 },
49 "status": {
50 "createdBy": "string",
51 "lastModifiedBy": "string",
52 "createdDate": "2019-08-24T14:15:22Z",
53 "lastModifiedDate": "2019-08-24T14:15:22Z",
54 "archived": true,
55 "externalId": "string",
56 "id": 0,
57 "priority": 0,
58 "internalId": 0,
59 "pickListCode": "string",
60 "pickListLabel": "string",
61 "label": "string",
62 "cultureId": 0,
63 "labelDtos": [
64 {
65 "createdBy": "string",
66 "lastModifiedBy": "string",
67 "createdDate": "2019-08-24T14:15:22Z",
68 "lastModifiedDate": "2019-08-24T14:15:22Z",
69 "archived": true,
70 "externalId": "string",
71 "id": 0,
72 "cultureId": 0,
73 "value": "string"
74 }
75 ]
76 }
77 }
78 ]
79 },
80 "page": {
81 "size": 0,
82 "totalElements": 0,
83 "totalPages": 0,
84 "number": 0
85 }
86}
Get Sale Lease Notes¶
HTTP Request
GET /api/sale-leases/{saleLeaseId}/notes
📋 Description: Retrieves notes associated with a specific sale lease identified by the saleLeaseId, providing valuable insights for portfolio and asset management within the Nakisa Portfolio Management Suite. This operation enhances analytics capabilities related to real estate properties.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
saleLeaseId |
path |
integer(int64) |
true |
Unique identifier for the sale lease |
pageable |
query |
true |
Indicates whether the results of the notes associated with a specific sale lease should be returned in a paginated format, facilitating efficient data retrieval for portfolio and asset management analysis. |
|
search |
query |
string |
false |
Search term used to filter notes associated with a specific sale lease, enhancing portfolio and asset management within the Nakisa Portfolio Management Suite. |
message |
query |
string |
false |
Textual content of the note associated with the specified sale lease, providing insights relevant to portfolio and asset management within the Nakisa Portfolio Management Suite. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "_embedded": {
3 "notes": [
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 "message": "string",
13 "userIds": [
14 0
15 ],
16 "redirectUrl": "string"
17 }
18 ]
19 },
20 "page": {
21 "size": 0,
22 "totalElements": 0,
23 "totalPages": 0,
24 "number": 0
25 }
26}
Download Sale Lease Document¶
HTTP Request
GET /api/sale-leases/{saleLeaseId}/documents/{documentId}/download
📋 Description: Downloads the specified document associated with a sale lease, enabling users to access critical documentation for portfolio and asset management within the Nakisa Portfolio Management Suite. This operation supports effective analytics and decision-making in real estate property management.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
saleLeaseId |
path |
integer(int64) |
true |
Unique identifier for the sale lease |
documentId |
path |
integer(int64) |
true |
Unique identifier for the document |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{}
Delete Sale Lease Document¶
HTTP Request
DELETE /api/sale-leases/{saleLeaseId}/documents/{documentId}
📋 Description: Deletes a specified document associated with a sale lease within the Nakisa Portfolio Management Suite, facilitating effective management of portfolio and asset documentation in the real estate sector.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
saleLeaseId |
path |
integer(int64) |
true |
Unique identifier for the sale lease |
documentId |
path |
integer(int64) |
true |
Unique identifier for the document |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |