Master Agreement

Master Agreement - Update Master Agreement

HTTP Request

PUT /api/master-agreements/update

📋 Description: Updates existing master agreements within the Nakisa Portfolio Management Suite, enabling users to modify portfolio, asset, and real estate property details for enhanced analytics and decision-making.

Parameters

Name

In

Type

Required

Description

body

body

MasterAgreementDto

true

Request body containing the updated master agreement details, including portfolio identifiers, asset specifications, and relevant analytics for real estate property management.

Body Parameters

 1{
 2  "id": 0,
 3  "displayId": "string",
 4  "year": 1900,
 5  "name": "string",
 6  "description": "string",
 7  "validFrom": "2019-08-24",
 8  "validTo": "2019-08-24",
 9  "targetValue": 0.1,
10  "legalJurisdiction": "string",
11  "approverComment": "string",
12  "signingPerson": "string",
13  "placeOfSignature": "string",
14  "dateOfSignature": "2019-08-24",
15  "state": "MLA_DEFINE",
16  "dataCreationInfo": {
17    "id": 0,
18    "idGenerationType": "AUTO",
19    "source": "string",
20    "type": "MIGRATION",
21    "startDateTime": "2019-08-24T14:15:22Z",
22    "endDateTime": "2019-08-24T14:15:22Z"
23  },
24  "agreementGroup": {
25    "id": 0,
26    "displayId": "string",
27    "status": "CREATED",
28    "name": "string"
29  },
30  "currency": {
31    "id": 0,
32    "displayId": "string",
33    "status": "CREATED",
34    "name": "string",
35    "decimalPoints": 0
36  },
37  "internalAssetClass": {
38    "id": 0,
39    "displayId": "string",
40    "status": "CREATED",
41    "name": "string",
42    "assetClassType": "PROPERTY",
43    "infiniteUsefulLife": true
44  },
45  "leaseArea": {
46    "id": 0,
47    "displayId": "string",
48    "status": "CREATED",
49    "name": "string"
50  },
51  "businessUnit": {
52    "id": 0,
53    "displayId": "string",
54    "status": "CREATED",
55    "name": "string"
56  },
57  "companyCode": {
58    "id": 0,
59    "displayId": "string",
60    "status": "CREATED",
61    "erpSystemId": 0,
62    "erpSystemDisplayId": "string",
63    "countryId": 0,
64    "countryDisplayId": "string",
65    "name": "string",
66    "postingPeriodVariantId": 0,
67    "fiscalVariantId": 0
68  },
69  "department": {
70    "id": 0,
71    "displayId": "string",
72    "status": "CREATED",
73    "name": "string"
74  },
75  "leaseGroup": {
76    "id": 0,
77    "displayId": "string",
78    "status": "CREATED",
79    "name": "string"
80  },
81  "allowsSystemGenerateNewId": true,
82  "numberRangeIdentifierType": {
83    "name": "string"
84  },
85  "numberRangeIdentifierValue": "string",
86  "numberRangeType": {
87    "name": "string"
88  }
89}

Responses

Status

Meaning

Description

Schema

200

OK

OK

MasterAgreementDto

Example Responses

 1{
 2  "id": 0,
 3  "displayId": "string",
 4  "year": 1900,
 5  "name": "string",
 6  "description": "string",
 7  "validFrom": "2019-08-24",
 8  "validTo": "2019-08-24",
 9  "targetValue": 0.1,
10  "legalJurisdiction": "string",
11  "approverComment": "string",
12  "signingPerson": "string",
13  "placeOfSignature": "string",
14  "dateOfSignature": "2019-08-24",
15  "state": "MLA_DEFINE",
16  "dataCreationInfo": {
17    "id": 0,
18    "idGenerationType": "AUTO",
19    "source": "string",
20    "type": "MIGRATION",
21    "startDateTime": "2019-08-24T14:15:22Z",
22    "endDateTime": "2019-08-24T14:15:22Z"
23  },
24  "agreementGroup": {
25    "id": 0,
26    "displayId": "string",
27    "status": "CREATED",
28    "name": "string"
29  },
30  "currency": {
31    "id": 0,
32    "displayId": "string",
33    "status": "CREATED",
34    "name": "string",
35    "decimalPoints": 0
36  },
37  "internalAssetClass": {
38    "id": 0,
39    "displayId": "string",
40    "status": "CREATED",
41    "name": "string",
42    "assetClassType": "PROPERTY",
43    "infiniteUsefulLife": true
44  },
45  "leaseArea": {
46    "id": 0,
47    "displayId": "string",
48    "status": "CREATED",
49    "name": "string"
50  },
51  "businessUnit": {
52    "id": 0,
53    "displayId": "string",
54    "status": "CREATED",
55    "name": "string"
56  },
57  "companyCode": {
58    "id": 0,
59    "displayId": "string",
60    "status": "CREATED",
61    "erpSystemId": 0,
62    "erpSystemDisplayId": "string",
63    "countryId": 0,
64    "countryDisplayId": "string",
65    "name": "string",
66    "postingPeriodVariantId": 0,
67    "fiscalVariantId": 0
68  },
69  "department": {
70    "id": 0,
71    "displayId": "string",
72    "status": "CREATED",
73    "name": "string"
74  },
75  "leaseGroup": {
76    "id": 0,
77    "displayId": "string",
78    "status": "CREATED",
79    "name": "string"
80  },
81  "allowsSystemGenerateNewId": true,
82  "numberRangeIdentifierType": {
83    "name": "string"
84  },
85  "numberRangeIdentifierValue": "string",
86  "numberRangeType": {
87    "name": "string"
88  }
89}

Master Agreement - Create Master Agreement

HTTP Request

POST /api/master-agreements

📋 Description: Creates a new master agreement within the Nakisa Portfolio Management Suite, enabling users to manage and analyze real estate property assets effectively.

Parameters

Name

In

Type

Required

Description

body

body

MasterAgreementDto

true

Request body containing the master agreement details, including portfolio identifiers, asset specifications, and relevant analytics for real estate property management.

Body Parameters

 1{
 2  "id": 0,
 3  "displayId": "string",
 4  "year": 1900,
 5  "name": "string",
 6  "description": "string",
 7  "validFrom": "2019-08-24",
 8  "validTo": "2019-08-24",
 9  "targetValue": 0.1,
10  "legalJurisdiction": "string",
11  "approverComment": "string",
12  "signingPerson": "string",
13  "placeOfSignature": "string",
14  "dateOfSignature": "2019-08-24",
15  "state": "MLA_DEFINE",
16  "dataCreationInfo": {
17    "id": 0,
18    "idGenerationType": "AUTO",
19    "source": "string",
20    "type": "MIGRATION",
21    "startDateTime": "2019-08-24T14:15:22Z",
22    "endDateTime": "2019-08-24T14:15:22Z"
23  },
24  "agreementGroup": {
25    "id": 0,
26    "displayId": "string",
27    "status": "CREATED",
28    "name": "string"
29  },
30  "currency": {
31    "id": 0,
32    "displayId": "string",
33    "status": "CREATED",
34    "name": "string",
35    "decimalPoints": 0
36  },
37  "internalAssetClass": {
38    "id": 0,
39    "displayId": "string",
40    "status": "CREATED",
41    "name": "string",
42    "assetClassType": "PROPERTY",
43    "infiniteUsefulLife": true
44  },
45  "leaseArea": {
46    "id": 0,
47    "displayId": "string",
48    "status": "CREATED",
49    "name": "string"
50  },
51  "businessUnit": {
52    "id": 0,
53    "displayId": "string",
54    "status": "CREATED",
55    "name": "string"
56  },
57  "companyCode": {
58    "id": 0,
59    "displayId": "string",
60    "status": "CREATED",
61    "erpSystemId": 0,
62    "erpSystemDisplayId": "string",
63    "countryId": 0,
64    "countryDisplayId": "string",
65    "name": "string",
66    "postingPeriodVariantId": 0,
67    "fiscalVariantId": 0
68  },
69  "department": {
70    "id": 0,
71    "displayId": "string",
72    "status": "CREATED",
73    "name": "string"
74  },
75  "leaseGroup": {
76    "id": 0,
77    "displayId": "string",
78    "status": "CREATED",
79    "name": "string"
80  },
81  "allowsSystemGenerateNewId": true,
82  "numberRangeIdentifierType": {
83    "name": "string"
84  },
85  "numberRangeIdentifierValue": "string",
86  "numberRangeType": {
87    "name": "string"
88  }
89}

Responses

Status

Meaning

Description

Schema

201

Created

Created

MasterAgreementDto

Example Responses

 1{
 2  "id": 0,
 3  "displayId": "string",
 4  "year": 1900,
 5  "name": "string",
 6  "description": "string",
 7  "validFrom": "2019-08-24",
 8  "validTo": "2019-08-24",
 9  "targetValue": 0.1,
10  "legalJurisdiction": "string",
11  "approverComment": "string",
12  "signingPerson": "string",
13  "placeOfSignature": "string",
14  "dateOfSignature": "2019-08-24",
15  "state": "MLA_DEFINE",
16  "dataCreationInfo": {
17    "id": 0,
18    "idGenerationType": "AUTO",
19    "source": "string",
20    "type": "MIGRATION",
21    "startDateTime": "2019-08-24T14:15:22Z",
22    "endDateTime": "2019-08-24T14:15:22Z"
23  },
24  "agreementGroup": {
25    "id": 0,
26    "displayId": "string",
27    "status": "CREATED",
28    "name": "string"
29  },
30  "currency": {
31    "id": 0,
32    "displayId": "string",
33    "status": "CREATED",
34    "name": "string",
35    "decimalPoints": 0
36  },
37  "internalAssetClass": {
38    "id": 0,
39    "displayId": "string",
40    "status": "CREATED",
41    "name": "string",
42    "assetClassType": "PROPERTY",
43    "infiniteUsefulLife": true
44  },
45  "leaseArea": {
46    "id": 0,
47    "displayId": "string",
48    "status": "CREATED",
49    "name": "string"
50  },
51  "businessUnit": {
52    "id": 0,
53    "displayId": "string",
54    "status": "CREATED",
55    "name": "string"
56  },
57  "companyCode": {
58    "id": 0,
59    "displayId": "string",
60    "status": "CREATED",
61    "erpSystemId": 0,
62    "erpSystemDisplayId": "string",
63    "countryId": 0,
64    "countryDisplayId": "string",
65    "name": "string",
66    "postingPeriodVariantId": 0,
67    "fiscalVariantId": 0
68  },
69  "department": {
70    "id": 0,
71    "displayId": "string",
72    "status": "CREATED",
73    "name": "string"
74  },
75  "leaseGroup": {
76    "id": 0,
77    "displayId": "string",
78    "status": "CREATED",
79    "name": "string"
80  },
81  "allowsSystemGenerateNewId": true,
82  "numberRangeIdentifierType": {
83    "name": "string"
84  },
85  "numberRangeIdentifierValue": "string",
86  "numberRangeType": {
87    "name": "string"
88  }
89}

Master Agreement - Send Master Agreement To Approval

HTTP Request

POST /api/master-agreements/{id}/send-to-approval

📋 Description: Submits the specified master agreement for approval within the Nakisa Portfolio Management Suite, facilitating streamlined asset management and enhancing decision-making in real estate property analytics.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

body

body

MasterAgreementTransitionInput

true

Request body containing the details of the master agreement, including approval status and relevant metadata, for submission in the Nakisa Portfolio Management Suite.

Body Parameters

1{
2  "objectType": "string",
3  "comment": "string",
4  "processingTaskId": 0,
5  "processingJobType": "string",
6  "objectId": 0
7}

Responses

Status

Meaning

Description

Schema

200

OK

OK

StateProcessResult

Example Responses

1{
2  "id": 0,
3  "success": true,
4  "cancelled": true,
5  "failureMessage": "string",
6  "warningMessage": "string"
7}

Master Agreement - Rework Master Agreement

HTTP Request

POST /api/master-agreements/{id}/rework

📋 Description: Initiates the rework process for a specified master agreement, enabling users to update and refine portfolio and asset details within the Nakisa Portfolio Management Suite.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

body

body

MasterAgreementTransitionInput

true

Request body containing the rework details for the specified master agreement, including updated terms and conditions relevant to portfolio and asset management.

Body Parameters

1{
2  "objectType": "string",
3  "comment": "string",
4  "processingTaskId": 0,
5  "processingJobType": "string",
6  "objectId": 0
7}

Responses

Status

Meaning

Description

Schema

200

OK

OK

StateProcessResult

Example Responses

1{
2  "id": 0,
3  "success": true,
4  "cancelled": true,
5  "failureMessage": "string",
6  "warningMessage": "string"
7}

Master Agreement - Discard Master Agreement

HTTP Request

POST /api/master-agreements/{id}/discard

📋 Description: Discards the specified master agreement within the Nakisa Portfolio Management Suite, allowing users to effectively manage portfolio assets and maintain accurate real estate property analytics.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

body

body

MasterAgreementTransitionInput

true

Request body containing the details necessary to discard a master agreement, including the reason for discarding and any relevant metadata related to the portfolio and asset management context.

Body Parameters

1{
2  "objectType": "string",
3  "comment": "string",
4  "processingTaskId": 0,
5  "processingJobType": "string",
6  "objectId": 0
7}

Responses

Status

Meaning

Description

Schema

200

OK

OK

StateProcessResult

Example Responses

1{
2  "id": 0,
3  "success": true,
4  "cancelled": true,
5  "failureMessage": "string",
6  "warningMessage": "string"
7}

Master Agreement - Close Master Agreement

HTTP Request

POST /api/master-agreements/{id}/close

📋 Description: Closes the specified master agreement identified by the {id}, effectively finalizing the terms and conditions associated with the agreement within the Nakisa Portfolio Management Suite, thereby enhancing portfolio and asset management capabilities in real estate analytics.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

body

body

MasterAgreementTransitionInput

true

Request body containing the closure details of the master agreement, including relevant status updates and metadata for effective portfolio and asset management.

Body Parameters

1{
2  "objectType": "string",
3  "comment": "string",
4  "processingTaskId": 0,
5  "processingJobType": "string",
6  "objectId": 0
7}

Responses

Status

Meaning

Description

Schema

200

OK

OK

StateProcessResult

Example Responses

1{
2  "id": 0,
3  "success": true,
4  "cancelled": true,
5  "failureMessage": "string",
6  "warningMessage": "string"
7}

Master Agreement - Callback Master Agreement

HTTP Request

POST /api/master-agreements/{id}/callback

📋 Description: Submits a callback request for the specified master agreement, enabling integration with portfolio analytics and asset management processes within the Nakisa Portfolio Management Suite.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

body

body

MasterAgreementTransitionInput

true

Request body containing callback data related to the specified master agreement, including relevant portfolio and asset analytics for real estate property management.

Body Parameters

1{
2  "objectType": "string",
3  "comment": "string",
4  "processingTaskId": 0,
5  "processingJobType": "string",
6  "objectId": 0
7}

Responses

Status

Meaning

Description

Schema

200

OK

OK

StateProcessResult

Example Responses

1{
2  "id": 0,
3  "success": true,
4  "cancelled": true,
5  "failureMessage": "string",
6  "warningMessage": "string"
7}

Master Agreement - Approve Master Agreement

HTTP Request

POST /api/master-agreements/{id}/approve

📋 Description: Approves a master agreement identified by the specified ID, facilitating the progression of portfolio and asset management processes within the Nakisa Portfolio Management Suite.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

body

body

MasterAgreementTransitionInput

true

Request body containing the approval details for the specified master agreement, including relevant metadata and status updates related to portfolio and asset management.

Body Parameters

1{
2  "objectType": "string",
3  "comment": "string",
4  "processingTaskId": 0,
5  "processingJobType": "string",
6  "objectId": 0
7}

Responses

Status

Meaning

Description

Schema

200

OK

OK

StateProcessResult

Example Responses

1{
2  "id": 0,
3  "success": true,
4  "cancelled": true,
5  "failureMessage": "string",
6  "warningMessage": "string"
7}

Master Agreement - Search Master Agreements

HTTP Request

POST /api/master-agreements/search

📋 Description: Submits a search request for master agreements within the Nakisa Portfolio Management Suite, enabling users to efficiently locate and analyze relevant portfolio and asset data related to real estate properties.

Parameters

Name

In

Type

Required

Description

body

body

MasterAgreementDtoFilter

true

Request body containing search criteria and filters for retrieving master agreements related to portfolio, asset, and real estate property analytics.

Body Parameters

 1{
 2  "idIn": [
 3    0
 4  ],
 5  "idEqual": 0,
 6  "idLike": "string",
 7  "createdAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
 8  "createdAtLessThanOrEqual": "2019-08-24T14:15:22Z",
 9  "createdByLike": "string",
10  "createdByEqual": "string",
11  "modifiedAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
12  "modifiedAtLessThanOrEqual": "2019-08-24T14:15:22Z",
13  "modifiedByLike": "string",
14  "modifiedByEqual": "string",
15  "displayIdIn": [
16    "string"
17  ],
18  "displayIdLike": "string",
19  "nameOrDisplayIdLike": "string",
20  "yearGreaterThanOrEqual": 0,
21  "yearLessThanOrEqual": 0,
22  "nameLike": "string",
23  "stateIn": [
24    "MLA_DEFINE"
25  ],
26  "agreementGroupIdEqual": 0,
27  "currencyIdEqual": 0,
28  "internalAssetClassIdEqual": 0,
29  "leaseAreaIdIn": [
30    0
31  ],
32  "leaseAreaIdEqual": 0,
33  "businessUnitIdIn": [
34    0
35  ],
36  "businessUnitIdEqual": 0,
37  "companyCodeIdIn": [
38    0
39  ],
40  "companyCodeIdEqual": 0,
41  "departmentIdIn": [
42    0
43  ],
44  "departmentIdEqual": 0,
45  "leaseGroupIdIn": [
46    0
47  ],
48  "leaseGroupIdEqual": 0
49}

Responses

Status

Meaning

Description

Schema

200

OK

OK

PageMasterAgreementDto

Example Responses

  1{
  2  "totalElements": 0,
  3  "totalPages": 0,
  4  "pageable": {
  5    "pageNumber": 0,
  6    "pageSize": 0,
  7    "unpaged": true,
  8    "paged": true,
  9    "offset": 0,
 10    "sort": {
 11      "sorted": true,
 12      "unsorted": true,
 13      "empty": true
 14    }
 15  },
 16  "numberOfElements": 0,
 17  "size": 0,
 18  "content": [
 19    {
 20      "id": 0,
 21      "displayId": "string",
 22      "year": 1900,
 23      "name": "string",
 24      "description": "string",
 25      "validFrom": "2019-08-24",
 26      "validTo": "2019-08-24",
 27      "targetValue": 0.1,
 28      "legalJurisdiction": "string",
 29      "approverComment": "string",
 30      "signingPerson": "string",
 31      "placeOfSignature": "string",
 32      "dateOfSignature": "2019-08-24",
 33      "state": "MLA_DEFINE",
 34      "dataCreationInfo": {
 35        "id": 0,
 36        "idGenerationType": "AUTO",
 37        "source": "string",
 38        "type": "MIGRATION",
 39        "startDateTime": "2019-08-24T14:15:22Z",
 40        "endDateTime": "2019-08-24T14:15:22Z"
 41      },
 42      "agreementGroup": {
 43        "id": 0,
 44        "displayId": "string",
 45        "status": "CREATED",
 46        "name": "string"
 47      },
 48      "currency": {
 49        "id": 0,
 50        "displayId": "string",
 51        "status": "CREATED",
 52        "name": "string",
 53        "decimalPoints": 0
 54      },
 55      "internalAssetClass": {
 56        "id": 0,
 57        "displayId": "string",
 58        "status": "CREATED",
 59        "name": "string",
 60        "assetClassType": "PROPERTY",
 61        "infiniteUsefulLife": true
 62      },
 63      "leaseArea": {
 64        "id": 0,
 65        "displayId": "string",
 66        "status": "CREATED",
 67        "name": "string"
 68      },
 69      "businessUnit": {
 70        "id": 0,
 71        "displayId": "string",
 72        "status": "CREATED",
 73        "name": "string"
 74      },
 75      "companyCode": {
 76        "id": 0,
 77        "displayId": "string",
 78        "status": "CREATED",
 79        "erpSystemId": 0,
 80        "erpSystemDisplayId": "string",
 81        "countryId": 0,
 82        "countryDisplayId": "string",
 83        "name": "string",
 84        "postingPeriodVariantId": 0,
 85        "fiscalVariantId": 0
 86      },
 87      "department": {
 88        "id": 0,
 89        "displayId": "string",
 90        "status": "CREATED",
 91        "name": "string"
 92      },
 93      "leaseGroup": {
 94        "id": 0,
 95        "displayId": "string",
 96        "status": "CREATED",
 97        "name": "string"
 98      },
 99      "allowsSystemGenerateNewId": true,
100      "numberRangeIdentifierType": {
101        "name": "string"
102      },
103      "numberRangeIdentifierValue": "string",
104      "numberRangeType": {
105        "name": "string"
106      }
107    }
108  ],
109  "number": 0,
110  "sort": {
111    "sorted": true,
112    "unsorted": true,
113    "empty": true
114  },
115  "first": true,
116  "last": true,
117  "empty": true
118}

Master Agreement - Get Master Agreement

HTTP Request

GET /api/master-agreements/{id}

📋 Description: Retrieves detailed information about a specific master agreement identified by the provided ID, facilitating effective portfolio and asset management 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

MasterAgreementDto

Example Responses

 1{
 2  "id": 0,
 3  "displayId": "string",
 4  "year": 1900,
 5  "name": "string",
 6  "description": "string",
 7  "validFrom": "2019-08-24",
 8  "validTo": "2019-08-24",
 9  "targetValue": 0.1,
10  "legalJurisdiction": "string",
11  "approverComment": "string",
12  "signingPerson": "string",
13  "placeOfSignature": "string",
14  "dateOfSignature": "2019-08-24",
15  "state": "MLA_DEFINE",
16  "dataCreationInfo": {
17    "id": 0,
18    "idGenerationType": "AUTO",
19    "source": "string",
20    "type": "MIGRATION",
21    "startDateTime": "2019-08-24T14:15:22Z",
22    "endDateTime": "2019-08-24T14:15:22Z"
23  },
24  "agreementGroup": {
25    "id": 0,
26    "displayId": "string",
27    "status": "CREATED",
28    "name": "string"
29  },
30  "currency": {
31    "id": 0,
32    "displayId": "string",
33    "status": "CREATED",
34    "name": "string",
35    "decimalPoints": 0
36  },
37  "internalAssetClass": {
38    "id": 0,
39    "displayId": "string",
40    "status": "CREATED",
41    "name": "string",
42    "assetClassType": "PROPERTY",
43    "infiniteUsefulLife": true
44  },
45  "leaseArea": {
46    "id": 0,
47    "displayId": "string",
48    "status": "CREATED",
49    "name": "string"
50  },
51  "businessUnit": {
52    "id": 0,
53    "displayId": "string",
54    "status": "CREATED",
55    "name": "string"
56  },
57  "companyCode": {
58    "id": 0,
59    "displayId": "string",
60    "status": "CREATED",
61    "erpSystemId": 0,
62    "erpSystemDisplayId": "string",
63    "countryId": 0,
64    "countryDisplayId": "string",
65    "name": "string",
66    "postingPeriodVariantId": 0,
67    "fiscalVariantId": 0
68  },
69  "department": {
70    "id": 0,
71    "displayId": "string",
72    "status": "CREATED",
73    "name": "string"
74  },
75  "leaseGroup": {
76    "id": 0,
77    "displayId": "string",
78    "status": "CREATED",
79    "name": "string"
80  },
81  "allowsSystemGenerateNewId": true,
82  "numberRangeIdentifierType": {
83    "name": "string"
84  },
85  "numberRangeIdentifierValue": "string",
86  "numberRangeType": {
87    "name": "string"
88  }
89}

Master Agreement - Delete Master Agreement

HTTP Request

DELETE /api/master-agreements/{id}

📋 Description: Deletes a specified master agreement from the Nakisa Portfolio Management Suite, enabling effective management of portfolio and asset data within the real estate property analytics framework.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

204

No Content

No Content

None

Master Agreement - Check Master Agreement State

HTTP Request

GET /api/master-agreements/check/{id}

📋 Description: Retrieves the details of a specific master agreement by its unique identifier, enabling users to access critical information related to portfolio and asset management 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

StateMachineState

Example Responses

 1{
 2  "id": "string",
 3  "name": "string",
 4  "captionKey": "string",
 5  "latestStateHistoryFailureMessage": "string",
 6  "latestStateHistoryWarningMessage": "string",
 7  "initial": true,
 8  "final": true,
 9  "transitionState": true,
10  "caption": "string"
11}