Lease Incentive

Get Lease Incentive

HTTP Request

GET /api/lease-incentives/{id}

📋 Description: Retrieves detailed information about a specific lease incentive within the Nakisa Portfolio Management Suite, enabling users to analyze and manage portfolio assets effectively in the context of real estate property.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource

Responses

Status	Meaning	Description	Schema
200	OK	OK	LeaseIncentiveDto

Example Responses

{
  "createdBy": "string",
  "lastModifiedBy": "string",
  "createdDate": "2019-08-24T14:15:22Z",
  "lastModifiedDate": "2019-08-24T14:15:22Z",
  "archived": true,
  "externalId": "string",
  "id": 0,
  "totalAmount": 0,
  "pageNumber": "string",
  "section": "string",
  "typeId": 0,
  "type": {
    "createdBy": "string",
    "lastModifiedBy": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "lastModifiedDate": "2019-08-24T14:15:22Z",
    "archived": true,
    "externalId": "string",
    "id": 0,
    "priority": 0,
    "internalId": 0,
    "pickListCode": "string",
    "pickListLabel": "string",
    "label": "string",
    "cultureId": 0,
    "labelDtos": [
      {
        "createdBy": "string",
        "lastModifiedBy": "string",
        "createdDate": "2019-08-24T14:15:22Z",
        "lastModifiedDate": "2019-08-24T14:15:22Z",
        "archived": true,
        "externalId": "string",
        "id": 0,
        "cultureId": 0,
        "value": "string"
      }
    ]
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Update Lease Incentive

HTTP Request

PUT /api/lease-incentives/{id}

📋 Description: Updates the details of a specific lease incentive identified by the provided ID, enabling users to manage and optimize portfolio asset performance within the Nakisa Portfolio Management Suite.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
body	body	LeaseIncentiveDto	true	Request body containing the updated lease incentive details, including financial terms and conditions, relevant to the management of real estate property within the portfolio.

Body Parameters

{
  "createdBy": "string",
  "lastModifiedBy": "string",
  "createdDate": "2019-08-24T14:15:22Z",
  "lastModifiedDate": "2019-08-24T14:15:22Z",
  "archived": true,
  "externalId": "string",
  "id": 0,
  "totalAmount": 0,
  "pageNumber": "string",
  "section": "string",
  "typeId": 0,
  "type": {
    "createdBy": "string",
    "lastModifiedBy": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "lastModifiedDate": "2019-08-24T14:15:22Z",
    "archived": true,
    "externalId": "string",
    "id": 0,
    "priority": 0,
    "internalId": 0,
    "pickListCode": "string",
    "pickListLabel": "string",
    "label": "string",
    "cultureId": 0,
    "labelDtos": [
      {
        "createdBy": "string",
        "lastModifiedBy": "string",
        "createdDate": "2019-08-24T14:15:22Z",
        "lastModifiedDate": "2019-08-24T14:15:22Z",
        "archived": true,
        "externalId": "string",
        "id": 0,
        "cultureId": 0,
        "value": "string"
      }
    ]
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	LeaseIncentiveDto

Example Responses

{
  "createdBy": "string",
  "lastModifiedBy": "string",
  "createdDate": "2019-08-24T14:15:22Z",
  "lastModifiedDate": "2019-08-24T14:15:22Z",
  "archived": true,
  "externalId": "string",
  "id": 0,
  "totalAmount": 0,
  "pageNumber": "string",
  "section": "string",
  "typeId": 0,
  "type": {
    "createdBy": "string",
    "lastModifiedBy": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "lastModifiedDate": "2019-08-24T14:15:22Z",
    "archived": true,
    "externalId": "string",
    "id": 0,
    "priority": 0,
    "internalId": 0,
    "pickListCode": "string",
    "pickListLabel": "string",
    "label": "string",
    "cultureId": 0,
    "labelDtos": [
      {
        "createdBy": "string",
        "lastModifiedBy": "string",
        "createdDate": "2019-08-24T14:15:22Z",
        "lastModifiedDate": "2019-08-24T14:15:22Z",
        "archived": true,
        "externalId": "string",
        "id": 0,
        "cultureId": 0,
        "value": "string"
      }
    ]
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Delete Lease Incentive

HTTP Request

DELETE /api/lease-incentives/{id}

📋 Description: Deletes a specified lease incentive from the Nakisa Portfolio Management Suite, facilitating the management of portfolio assets and enhancing real estate property analytics.

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

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Get Lease Incentive Documents

HTTP Request

GET /api/lease-incentives/{leaseIncentiveId}/documents

📋 Description: Retrieves documents associated with a specific lease incentive, enabling users to access relevant information for portfolio and asset management within the Nakisa Portfolio Management Suite.

Parameters

Name	In	Type	Required	Description
leaseIncentiveId	path	integer(int64)	true	Unique identifier for the lease incentive
pageable	query	Pageable	true	Indicates whether the results of the lease incentive documents retrieval should be paginated, facilitating efficient data management within the Nakisa Portfolio Management Suite.
search	query	string	false	Search term used to filter documents related to the specified lease incentive, enhancing portfolio and asset analytics 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 lease incentive document, facilitating effective tracking and management within the Nakisa Portfolio Management Suite.
signed-date	query	string	false	Specifies the date on which the lease incentive document was signed, providing essential context for portfolio and asset analytics 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 lease incentive documents are shareable within the Nakisa Portfolio Management Suite, 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 lease incentive, facilitating effective management and analysis within the Nakisa Portfolio Management Suite.
document-type-id-in	query	string	false	Unique identifier for the type of document associated with the specified lease incentive, facilitating accurate retrieval of relevant documentation within the Nakisa Portfolio Management Suite.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PagedModelEntityModelDocumentDto

Example Responses

{
  "_embedded": {
    "documents": [
      {
        "createdBy": "string",
        "lastModifiedBy": "string",
        "createdDate": "2019-08-24T14:15:22Z",
        "lastModifiedDate": "2019-08-24T14:15:22Z",
        "archived": true,
        "externalId": "string",
        "id": 0,
        "name": "string",
        "title": "string",
        "type": "string",
        "description": "string",
        "link": "string",
        "signedDate": "2019-08-24",
        "documentTypeId": 0,
        "statusId": 0,
        "shareable": true,
        "size": 0,
        "documentType": {
          "createdBy": "string",
          "lastModifiedBy": "string",
          "createdDate": "2019-08-24T14:15:22Z",
          "lastModifiedDate": "2019-08-24T14:15:22Z",
          "archived": true,
          "externalId": "string",
          "id": 0,
          "priority": 0,
          "internalId": 0,
          "pickListCode": "string",
          "pickListLabel": "string",
          "label": "string",
          "cultureId": 0,
          "labelDtos": [
            {
              "createdBy": "string",
              "lastModifiedBy": "string",
              "createdDate": "2019-08-24T14:15:22Z",
              "lastModifiedDate": "2019-08-24T14:15:22Z",
              "archived": true,
              "externalId": "string",
              "id": 0,
              "cultureId": 0,
              "value": "string"
            }
          ]
        },
        "status": {
          "createdBy": "string",
          "lastModifiedBy": "string",
          "createdDate": "2019-08-24T14:15:22Z",
          "lastModifiedDate": "2019-08-24T14:15:22Z",
          "archived": true,
          "externalId": "string",
          "id": 0,
          "priority": 0,
          "internalId": 0,
          "pickListCode": "string",
          "pickListLabel": "string",
          "label": "string",
          "cultureId": 0,
          "labelDtos": [
            {
              "createdBy": "string",
              "lastModifiedBy": "string",
              "createdDate": "2019-08-24T14:15:22Z",
              "lastModifiedDate": "2019-08-24T14:15:22Z",
              "archived": true,
              "externalId": "string",
              "id": 0,
              "cultureId": 0,
              "value": "string"
            }
          ]
        }
      }
    ]
  },
  "page": {
    "size": 0,
    "totalElements": 0,
    "totalPages": 0,
    "number": 0
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Upload Lease Incentive Document

HTTP Request

POST /api/lease-incentives/{leaseIncentiveId}/documents

📋 Description: Uploads documents associated with a specific lease incentive within the Nakisa Portfolio Management Suite, enhancing portfolio and asset management capabilities in real estate analytics.

Parameters

Name	In	Type	Required	Description
leaseIncentiveId	path	integer(int64)	true	Unique identifier for the lease incentive
body	body	object	false	Request body containing the document details associated with a specific lease incentive, including metadata and relevant analytics for effective portfolio management.
» file	body	string(binary)	false	none
» document	body	DocumentDto	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	PickListOptionDto	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	[LabelDto]	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	PickListOptionDto	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

{
    "document": {
        "archived": true,
        "createdBy": "string",
        "createdDate": "2019-08-24 14:15:22+00:00",
        "description": "string",
        "documentType": {
            "archived": true,
            "createdBy": "string",
            "createdDate": "2019-08-24 14:15:22+00:00",
            "cultureId": 0,
            "externalId": "string",
            "id": 0,
            "internalId": 0,
            "label": "string",
            "labelDtos": [
                {
                    "archived": true,
                    "createdBy": "string",
                    "createdDate": "2019-08-24 14:15:22+00:00",
                    "cultureId": 0,
                    "externalId": "string",
                    "id": 0,
                    "lastModifiedBy": "string",
                    "lastModifiedDate": "2019-08-24 14:15:22+00:00",
                    "value": "string"
                }
            ],
            "lastModifiedBy": "string",
            "lastModifiedDate": "2019-08-24 14:15:22+00:00",
            "pickListCode": "string",
            "pickListLabel": "string",
            "priority": 0
        },
        "documentTypeId": 0,
        "externalId": "string",
        "id": 0,
        "lastModifiedBy": "string",
        "lastModifiedDate": "2019-08-24 14:15:22+00:00",
        "link": "string",
        "name": "string",
        "shareable": true,
        "signedDate": "2019-08-24",
        "size": 0,
        "status": {
            "archived": true,
            "createdBy": "string",
            "createdDate": "2019-08-24 14:15:22+00:00",
            "cultureId": 0,
            "externalId": "string",
            "id": 0,
            "internalId": 0,
            "label": "string",
            "labelDtos": [
                {
                    "archived": true,
                    "createdBy": "string",
                    "createdDate": "2019-08-24 14:15:22+00:00",
                    "cultureId": 0,
                    "externalId": "string",
                    "id": 0,
                    "lastModifiedBy": "string",
                    "lastModifiedDate": "2019-08-24 14:15:22+00:00",
                    "value": "string"
                }
            ],
            "lastModifiedBy": "string",
            "lastModifiedDate": "2019-08-24 14:15:22+00:00",
            "pickListCode": "string",
            "pickListLabel": "string",
            "priority": 0
        },
        "statusId": 0,
        "title": "string",
        "type": "string"
    },
    "file": "string"
}

Responses

Status	Meaning	Description	Schema
201	Created	Created	DocumentDto

Example Responses

{
  "createdBy": "string",
  "lastModifiedBy": "string",
  "createdDate": "2019-08-24T14:15:22Z",
  "lastModifiedDate": "2019-08-24T14:15:22Z",
  "archived": true,
  "externalId": "string",
  "id": 0,
  "name": "string",
  "title": "string",
  "type": "string",
  "description": "string",
  "link": "string",
  "signedDate": "2019-08-24",
  "documentTypeId": 0,
  "statusId": 0,
  "shareable": true,
  "size": 0,
  "documentType": {
    "createdBy": "string",
    "lastModifiedBy": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "lastModifiedDate": "2019-08-24T14:15:22Z",
    "archived": true,
    "externalId": "string",
    "id": 0,
    "priority": 0,
    "internalId": 0,
    "pickListCode": "string",
    "pickListLabel": "string",
    "label": "string",
    "cultureId": 0,
    "labelDtos": [
      {
        "createdBy": "string",
        "lastModifiedBy": "string",
        "createdDate": "2019-08-24T14:15:22Z",
        "lastModifiedDate": "2019-08-24T14:15:22Z",
        "archived": true,
        "externalId": "string",
        "id": 0,
        "cultureId": 0,
        "value": "string"
      }
    ]
  },
  "status": {
    "createdBy": "string",
    "lastModifiedBy": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "lastModifiedDate": "2019-08-24T14:15:22Z",
    "archived": true,
    "externalId": "string",
    "id": 0,
    "priority": 0,
    "internalId": 0,
    "pickListCode": "string",
    "pickListLabel": "string",
    "label": "string",
    "cultureId": 0,
    "labelDtos": [
      {
        "createdBy": "string",
        "lastModifiedBy": "string",
        "createdDate": "2019-08-24T14:15:22Z",
        "lastModifiedDate": "2019-08-24T14:15:22Z",
        "archived": true,
        "externalId": "string",
        "id": 0,
        "cultureId": 0,
        "value": "string"
      }
    ]
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Get Lease Incentive Notes

HTTP Request

GET /api/lease-incentives/{id}/notes

📋 Description: Retrieves notes associated with a specific lease incentive, providing valuable insights for 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
pageable	query	Pageable	true	Indicates whether the results should be returned in a paginated format, facilitating efficient data retrieval for lease incentive notes within the Nakisa Portfolio Management Suite.
search	query	string	false	Search term used to filter notes related to the specified lease incentive, enhancing portfolio and asset analytics within the Nakisa Portfolio Management Suite.
message	query	string	false	Textual content of the note associated with the specified lease incentive, 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

{
  "_embedded": {
    "notes": [
      {
        "createdBy": "string",
        "lastModifiedBy": "string",
        "createdDate": "2019-08-24T14:15:22Z",
        "lastModifiedDate": "2019-08-24T14:15:22Z",
        "archived": true,
        "externalId": "string",
        "id": 0,
        "message": "string",
        "userIds": [
          0
        ],
        "redirectUrl": "string"
      }
    ]
  },
  "page": {
    "size": 0,
    "totalElements": 0,
    "totalPages": 0,
    "number": 0
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Create Lease Incentive Notes

HTTP Request

POST /api/lease-incentives/{id}/notes

📋 Description: Adds a new note to the specified lease incentive within the Nakisa Portfolio Management Suite, enhancing portfolio and asset management by facilitating detailed documentation and analytics for real estate properties.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
body	body	NoteDto	true	Request body containing the notes related to lease incentives, including details such as content, author, and timestamp, to enhance portfolio and asset management within the Nakisa Portfolio Management Suite.

Body Parameters

[
  {
    "createdBy": "string",
    "lastModifiedBy": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "lastModifiedDate": "2019-08-24T14:15:22Z",
    "archived": true,
    "externalId": "string",
    "id": 0,
    "message": "string",
    "userIds": [
      0
    ],
    "redirectUrl": "string"
  }
]

Responses

Status	Meaning	Description	Schema
201	Created	Created	Inline

Example Responses

[
  {
    "createdBy": "string",
    "lastModifiedBy": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "lastModifiedDate": "2019-08-24T14:15:22Z",
    "archived": true,
    "externalId": "string",
    "id": 0,
    "message": "string",
    "userIds": [
      0
    ],
    "redirectUrl": "string"
  }
]

Response Schema

Status Code 201

Name	Type	Required	Restrictions	Description
anonymous	[NoteDto]	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

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Create Draws

HTTP Request

POST /api/lease-incentives/{id}/draws

📋 Description: Creates a new draw for a specified lease incentive within the Nakisa Portfolio Management Suite, enabling users to effectively manage financial allocations related to real estate properties.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
body	body	DrawDto	true	Request body containing the draw details for lease incentives, including financial amounts and related metadata, to facilitate accurate portfolio and asset analytics within the Nakisa Portfolio Management Suite.

Body Parameters

[
  {
    "createdBy": "string",
    "lastModifiedBy": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "lastModifiedDate": "2019-08-24T14:15:22Z",
    "archived": true,
    "externalId": "string",
    "id": 0,
    "drawNumber": 0,
    "triggerId": 0,
    "followUpDate": "2019-08-24",
    "percentage": 0,
    "invoicedAmount": 0,
    "receivedAmount": 0,
    "invoicedDate": "2019-08-24",
    "receivedDate": "2019-08-24",
    "note": "string",
    "trigger": {
      "createdBy": "string",
      "lastModifiedBy": "string",
      "createdDate": "2019-08-24T14:15:22Z",
      "lastModifiedDate": "2019-08-24T14:15:22Z",
      "archived": true,
      "externalId": "string",
      "id": 0,
      "priority": 0,
      "internalId": 0,
      "pickListCode": "string",
      "pickListLabel": "string",
      "label": "string",
      "cultureId": 0,
      "labelDtos": [
        {
          "createdBy": "string",
          "lastModifiedBy": "string",
          "createdDate": "2019-08-24T14:15:22Z",
          "lastModifiedDate": "2019-08-24T14:15:22Z",
          "archived": true,
          "externalId": "string",
          "id": 0,
          "cultureId": 0,
          "value": "string"
        }
      ]
    }
  }
]

Responses

Status	Meaning	Description	Schema
201	Created	Created	Inline

Example Responses

[
  {
    "createdBy": "string",
    "lastModifiedBy": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "lastModifiedDate": "2019-08-24T14:15:22Z",
    "archived": true,
    "externalId": "string",
    "id": 0,
    "drawNumber": 0,
    "triggerId": 0,
    "followUpDate": "2019-08-24",
    "percentage": 0,
    "invoicedAmount": 0,
    "receivedAmount": 0,
    "invoicedDate": "2019-08-24",
    "receivedDate": "2019-08-24",
    "note": "string",
    "trigger": {
      "createdBy": "string",
      "lastModifiedBy": "string",
      "createdDate": "2019-08-24T14:15:22Z",
      "lastModifiedDate": "2019-08-24T14:15:22Z",
      "archived": true,
      "externalId": "string",
      "id": 0,
      "priority": 0,
      "internalId": 0,
      "pickListCode": "string",
      "pickListLabel": "string",
      "label": "string",
      "cultureId": 0,
      "labelDtos": [
        {
          "createdBy": "string",
          "lastModifiedBy": "string",
          "createdDate": "2019-08-24T14:15:22Z",
          "lastModifiedDate": "2019-08-24T14:15:22Z",
          "archived": true,
          "externalId": "string",
          "id": 0,
          "cultureId": 0,
          "value": "string"
        }
      ]
    }
  }
]

Response Schema

Status Code 201

Name	Type	Required	Restrictions	Description
anonymous	[DrawDto]	false	none	[Data transfer object representing a visual representation of portfolio assets, facilitating analytics and insights for real estate property management 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
» drawNumber	integer(int64)	false	none	Numeric value representing drawNumber
» triggerId	integer(int64)	false	none	Unique identifier for the trigger
» followUpDate	string(date)	false	none	Date of the follow up
» percentage	integer(int64)	false	none	Percentage value
» invoicedAmount	number	false	none	Amount of invoiced
» receivedAmount	number	false	none	Amount of received
» invoicedDate	string(date)	false	none	Date of the invoiced
» receivedDate	string(date)	false	none	Date of the received
» note	string	false	none	Text value for note in DrawDto
» trigger	PickListOptionDto	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	[LabelDto]	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

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Archive Lease Incentive

HTTP Request

POST /api/lease-incentives/{id}/archive

📋 Description: Archives the specified lease incentive within the Nakisa Portfolio Management Suite, enabling 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	OK	LeaseIncentiveDto

Example Responses

{
  "createdBy": "string",
  "lastModifiedBy": "string",
  "createdDate": "2019-08-24T14:15:22Z",
  "lastModifiedDate": "2019-08-24T14:15:22Z",
  "archived": true,
  "externalId": "string",
  "id": 0,
  "totalAmount": 0,
  "pageNumber": "string",
  "section": "string",
  "typeId": 0,
  "type": {
    "createdBy": "string",
    "lastModifiedBy": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "lastModifiedDate": "2019-08-24T14:15:22Z",
    "archived": true,
    "externalId": "string",
    "id": 0,
    "priority": 0,
    "internalId": 0,
    "pickListCode": "string",
    "pickListLabel": "string",
    "label": "string",
    "cultureId": 0,
    "labelDtos": [
      {
        "createdBy": "string",
        "lastModifiedBy": "string",
        "createdDate": "2019-08-24T14:15:22Z",
        "lastModifiedDate": "2019-08-24T14:15:22Z",
        "archived": true,
        "externalId": "string",
        "id": 0,
        "cultureId": 0,
        "value": "string"
      }
    ]
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Get Lease Incentives

HTTP Request

GET /api/lease-incentives

📋 Description: Retrieves a list of lease incentives associated with real estate properties within the Nakisa Portfolio Management Suite, enabling users to analyze and optimize portfolio performance.

Parameters

Name	In	Type	Required	Description
pageable	query	Pageable	true	Indicates whether the results of the lease incentives query should be returned in a paginated format, facilitating efficient data retrieval for portfolio and asset analysis.
lease-id	query	string	false	Unique identifier for the lease incentive within the Nakisa Portfolio Management Suite, facilitating targeted retrieval of lease-related analytics for real estate properties.
type-id	query	string	false	Specifies the unique identifier for the lease incentive type, enabling targeted retrieval of relevant portfolio and asset analytics within the Nakisa Portfolio Management Suite.
page-number	query	string	false	Specifies the page number for pagination in the retrieval of lease incentive data, facilitating efficient access to portfolio and asset analytics within the Nakisa Portfolio Management Suite.
section	query	string	false	Specifies the section of the lease incentives data to retrieve, enabling targeted analysis within the context of portfolio and asset management in real estate.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PagedModelEntityModelLeaseIncentiveDto

Example Responses

{
  "_embedded": {
    "leaseIncentives": [
      {
        "createdBy": "string",
        "lastModifiedBy": "string",
        "createdDate": "2019-08-24T14:15:22Z",
        "lastModifiedDate": "2019-08-24T14:15:22Z",
        "archived": true,
        "externalId": "string",
        "id": 0,
        "totalAmount": 0,
        "pageNumber": "string",
        "section": "string",
        "typeId": 0,
        "type": {
          "createdBy": "string",
          "lastModifiedBy": "string",
          "createdDate": "2019-08-24T14:15:22Z",
          "lastModifiedDate": "2019-08-24T14:15:22Z",
          "archived": true,
          "externalId": "string",
          "id": 0,
          "priority": 0,
          "internalId": 0,
          "pickListCode": "string",
          "pickListLabel": "string",
          "label": "string",
          "cultureId": 0,
          "labelDtos": [
            {
              "createdBy": "string",
              "lastModifiedBy": "string",
              "createdDate": "2019-08-24T14:15:22Z",
              "lastModifiedDate": "2019-08-24T14:15:22Z",
              "archived": true,
              "externalId": "string",
              "id": 0,
              "cultureId": 0,
              "value": "string"
            }
          ]
        }
      }
    ]
  },
  "page": {
    "size": 0,
    "totalElements": 0,
    "totalPages": 0,
    "number": 0
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Find Draws

HTTP Request

GET /api/lease-incentives/{leaseIncentiveId}/draws

📋 Description: Retrieves draw details associated with a specific lease incentive, enabling users to analyze financial impacts within the context of portfolio and asset management in real estate properties.

Parameters

Name	In	Type	Required	Description
pageable	query	Pageable	true	Indicates whether the results of the lease incentive draws should be returned in a paginated format, facilitating efficient data retrieval for portfolio and asset management analytics.
leaseIncentiveId	path	string	true	Unique identifier for the lease incentive

Responses

Status	Meaning	Description	Schema
200	OK	OK	PagedModelEntityModelDrawDto

Example Responses

{
  "_embedded": {
    "draws": [
      {
        "createdBy": "string",
        "lastModifiedBy": "string",
        "createdDate": "2019-08-24T14:15:22Z",
        "lastModifiedDate": "2019-08-24T14:15:22Z",
        "archived": true,
        "externalId": "string",
        "id": 0,
        "drawNumber": 0,
        "triggerId": 0,
        "followUpDate": "2019-08-24",
        "percentage": 0,
        "invoicedAmount": 0,
        "receivedAmount": 0,
        "invoicedDate": "2019-08-24",
        "receivedDate": "2019-08-24",
        "note": "string",
        "trigger": {
          "createdBy": "string",
          "lastModifiedBy": "string",
          "createdDate": "2019-08-24T14:15:22Z",
          "lastModifiedDate": "2019-08-24T14:15:22Z",
          "archived": true,
          "externalId": "string",
          "id": 0,
          "priority": 0,
          "internalId": 0,
          "pickListCode": "string",
          "pickListLabel": "string",
          "label": "string",
          "cultureId": 0,
          "labelDtos": [
            {
              "createdBy": "string",
              "lastModifiedBy": "string",
              "createdDate": "2019-08-24T14:15:22Z",
              "lastModifiedDate": "2019-08-24T14:15:22Z",
              "archived": true,
              "externalId": "string",
              "id": 0,
              "cultureId": 0,
              "value": "string"
            }
          ]
        }
      }
    ]
  },
  "page": {
    "size": 0,
    "totalElements": 0,
    "totalPages": 0,
    "number": 0
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Download Lease Incentive Document

HTTP Request

GET /api/lease-incentives/{leaseIncentiveId}/documents/{documentId}/download

📋 Description: Downloads the specified document associated with a lease incentive, enabling users to access critical documentation for portfolio and asset management within the Nakisa Portfolio Management Suite.

Parameters

Name	In	Type	Required	Description
leaseIncentiveId	path	integer(int64)	true	Unique identifier for the lease incentive
documentId	path	integer(int64)	true	Unique identifier for the document

Responses

Status	Meaning	Description	Schema
200	OK	OK	StreamingResponseBody

Example Responses

{}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Delete Lease Incentive Document

HTTP Request

DELETE /api/lease-incentives/{leaseIncentiveId}/documents/{documentId}

📋 Description: Deletes a specified document associated with a lease incentive within the Nakisa Portfolio Management Suite, ensuring accurate management of real estate property documentation.

Parameters

Name	In	Type	Required	Description
leaseIncentiveId	path	integer(int64)	true	Unique identifier for the lease incentive
documentId	path	integer(int64)	true	Unique identifier for the document

Responses

Status	Meaning	Description	Schema
200	OK	OK	None

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

---