Separate Agreement

Get Separate Agreements

HTTP Request

GET /api/separate-agreements

📋 Description: Retrieves a list of separate agreements related to portfolio assets within the Nakisa Portfolio Management Suite, enabling users to analyze and manage real estate property agreements effectively.

Parameters

Name

In

Type

Required

Description

pageable

query

Pageable

true

Indicates whether the results of the separate agreements query should be returned in a paginated format, facilitating efficient data retrieval for portfolio and asset analytics within the Nakisa Portfolio Management Suite.

search

query

string

false

Search term used to filter and retrieve specific separate agreements related to portfolio, asset, and real estate property analytics within the Nakisa Portfolio Management Suite.

type-id

query

string

false

Unique identifier for the type of agreement being retrieved, facilitating targeted access to specific portfolio, asset, or real estate property analytics within the Nakisa Portfolio Management Suite.

status-id

query

string

false

Unique identifier for the status of separate agreements within the Nakisa Portfolio Management Suite, facilitating effective portfolio and asset analytics in real estate property management.

account-number

query

string

false

Unique identifier for the account associated with the portfolio, enabling retrieval of specific separate agreements within the Nakisa Portfolio Management Suite.

meter-number

query

string

false

Unique identifier for the meter associated with a real estate property, used to retrieve specific separate agreements within the Nakisa Portfolio Management Suite.

other-reference

query

string

false

An optional string parameter used to specify an additional reference for portfolio or asset analytics within the Nakisa Portfolio Management Suite.

start-date

query

string

false

Specifies the starting date for retrieving separate agreements within the Nakisa Portfolio Management Suite, enabling users to analyze portfolio and asset data effectively.

end-date

query

string

false

Specifies the end date for filtering separate agreements within the portfolio management suite, enabling users to analyze agreements relevant to a defined timeframe in the context of real estate property and asset management.

latest-notice

query

string

false

Specifies the most recent notice related to the portfolio or asset, providing critical updates for analytics within the Nakisa Portfolio Management Suite.

Responses

Status

Meaning

Description

Schema

200

OK

OK

PagedModelEntityModelSeparateAgreementDto

Example Responses

 1{
 2  "_embedded": {
 3    "separateAgreements": [
 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        "accountNumber": "string",
15        "meterNumber": "string",
16        "otherReference": "string",
17        "startDate": "2019-08-24",
18        "endDate": "2019-08-24",
19        "latestNotice": "2019-08-24",
20        "cost": 0,
21        "depositAmount": 0,
22        "type": {
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}

Get Separate Agreement Documents

HTTP Request

GET /api/separate-agreements/{separateAgreementId}/documents

📋 Description: Retrieves documents associated with a specific separate agreement in the Nakisa Portfolio Management Suite, facilitating enhanced asset and portfolio analytics for real estate properties.

Parameters

Name

In

Type

Required

Description

separateAgreementId

path

integer(int64)

true

Unique identifier for the separate agreement

pageable

query

Pageable

true

Indicates whether the response should be paginated, allowing users to efficiently retrieve and manage documents associated with a specific separate agreement within the Nakisa Portfolio Management Suite.

search

query

string

false

Search term used to filter documents related to a specific separate agreement within the Nakisa Portfolio Management Suite, enhancing portfolio and asset analytics for real estate properties.

id

query

string

false

Unique identifier for the resource

status-id

query

string

false

Unique identifier for the status of the document associated with a specific separate agreement, facilitating effective portfolio and asset management within the Nakisa Portfolio Management Suite.

signed-date

query

string

false

Specifies the date on which the document was signed, providing critical 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 separate agreement are shareable within the Nakisa Portfolio Management Suite, facilitating collaboration in portfolio and asset management.

document-type-id

query

string

false

Unique identifier for the type of document associated with a specific separate agreement, facilitating efficient management and retrieval within the Nakisa Portfolio Management Suite.

document-type-id-in

query

string

false

Identifier for the specific document type associated with the separate agreement, facilitating targeted retrieval of relevant documents within the Nakisa Portfolio Management Suite.

Responses

Status

Meaning

Description

Schema

200

OK

OK

PagedModelEntityModelDocumentDto

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}

Download Separate Agreement Document

HTTP Request

GET /api/separate-agreements/{separateAgreementId}/documents/{documentId}/download

📋 Description: Downloads the specified document associated with a separate agreement in the Nakisa Portfolio Management Suite, facilitating access to critical documentation for portfolio and asset management within the real estate property analytics context.

Parameters

Name

In

Type

Required

Description

separateAgreementId

path

integer(int64)

true

Unique identifier for the separate agreement

documentId

path

integer(int64)

true

Unique identifier for the document

Responses

Status

Meaning

Description

Schema

200

OK

OK

StreamingResponseBody

Example Responses

1{}

Get Separate Agreement

HTTP Request

GET /api/separate-agreements/{id}

📋 Description: Retrieves detailed information about a specific separate agreement by its unique identifier, enabling users to analyze portfolio and asset data 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

OK

SeparateAgreementDto

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  "accountNumber": "string",
12  "meterNumber": "string",
13  "otherReference": "string",
14  "startDate": "2019-08-24",
15  "endDate": "2019-08-24",
16  "latestNotice": "2019-08-24",
17  "cost": 0,
18  "depositAmount": 0,
19  "type": {
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}

Get Separate Agreement Notes

HTTP Request

GET /api/separate-agreements/{id}/notes

📋 Description: Retrieves notes associated with a specific separate agreement identified by the provided ID, facilitating enhanced portfolio and asset analytics within the Nakisa Portfolio Management Suite.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

pageable

query

Pageable

true

Indicates whether the response should be paginated, allowing users to efficiently retrieve notes associated with a specific agreement within the Nakisa Portfolio Management Suite.

search

query

string

false

Search term used to filter notes associated with a specific agreement in the Nakisa Portfolio Management Suite, enhancing asset and portfolio analytics within the real estate property domain.

message

query

string

false

Textual content of the note associated with the specified agreement, providing insights relevant to portfolio and asset management within the Nakisa Portfolio Management Suite.

Responses

Status

Meaning

Description

Schema

200

OK

OK

PagedModelEntityModelNoteDto

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}