Draw

Draw - Get Draw

HTTP Request

GET /api/draws/{id}

📋 Description: Retrieves detailed information about a specific draw within the Nakisa Portfolio Management Suite, providing insights into portfolio and asset performance related to 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

DrawDto

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  "drawNumber": 0,
10  "triggerId": 0,
11  "followUpDate": "2019-08-24",
12  "percentage": 0,
13  "invoicedAmount": 0,
14  "receivedAmount": 0,
15  "invoicedDate": "2019-08-24",
16  "receivedDate": "2019-08-24",
17  "note": "string",
18  "trigger": {
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}

Draw - Update Draw

HTTP Request

PUT /api/draws/{id}

📋 Description: Updates the details of a specific draw within the Nakisa Portfolio Management Suite, enabling users to manage portfolio assets and analytics related to real estate properties effectively.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

body

body

DrawDto

true

Request body containing the updated asset draw information, including financial metrics and portfolio allocation details, for effective real estate property management.

Body Parameters

 1{
 2  "createdBy": "string",
 3  "lastModifiedBy": "string",
 4  "createdDate": "2019-08-24T14:15:22Z",
 5  "lastModifiedDate": "2019-08-24T14:15:22Z",
 6  "archived": true,
 7  "externalId": "string",
 8  "id": 0,
 9  "drawNumber": 0,
10  "triggerId": 0,
11  "followUpDate": "2019-08-24",
12  "percentage": 0,
13  "invoicedAmount": 0,
14  "receivedAmount": 0,
15  "invoicedDate": "2019-08-24",
16  "receivedDate": "2019-08-24",
17  "note": "string",
18  "trigger": {
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}

Responses

Status

Meaning

Description

Schema

200

OK

OK

DrawDto

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  "drawNumber": 0,
10  "triggerId": 0,
11  "followUpDate": "2019-08-24",
12  "percentage": 0,
13  "invoicedAmount": 0,
14  "receivedAmount": 0,
15  "invoicedDate": "2019-08-24",
16  "receivedDate": "2019-08-24",
17  "note": "string",
18  "trigger": {
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}

Draw - Delete Draw

HTTP Request

DELETE /api/draws/{id}

📋 Description: Deletes a specified draw from the Nakisa Portfolio Management Suite, enabling effective management of portfolio assets and analytics related to 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

None

Draw - Archive Draw

HTTP Request

POST /api/draws/{id}/archive

📋 Description: Archives a specified draw within the Nakisa Portfolio Management Suite, facilitating enhanced 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

DrawDto

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  "drawNumber": 0,
10  "triggerId": 0,
11  "followUpDate": "2019-08-24",
12  "percentage": 0,
13  "invoicedAmount": 0,
14  "receivedAmount": 0,
15  "invoicedDate": "2019-08-24",
16  "receivedDate": "2019-08-24",
17  "note": "string",
18  "trigger": {
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}

Draw - Get Draws

HTTP Request

GET /api/draws

📋 Description: Fetches a list of draws associated with real estate properties within the Nakisa Portfolio Management Suite, enabling users to analyze portfolio performance and asset allocation.

Parameters

Name

In

Type

Required

Description

pageable

query

Pageable

true

Indicates whether the results of the asset draws query should be returned in a paginated format, facilitating efficient data retrieval for portfolio and real estate property analytics.

search

query

string

false

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

lease-incentive-id

query

string

false

Unique identifier for the lease incentive associated with a real estate property, used to retrieve relevant portfolio and asset analytics.

draw-number

query

string

false

Specifies the unique identifier for a draw within the Nakisa Portfolio Management Suite, enabling users to retrieve detailed analytics related to portfolio assets and real estate properties.

follow-up-date

query

string

false

Specifies the date for follow-up actions related to portfolio analytics and asset management within the Nakisa Portfolio Management Suite.

percentage

query

string

false

Percentage value

invoiced-amount

query

string

false

Represents the total amount invoiced for a specific draw within the Nakisa Portfolio Management Suite, providing essential financial insights for portfolio and asset analytics in real estate property management.

received-amount

query

string

false

Specifies the total amount received for a draw within the Nakisa Portfolio Management Suite, relevant for portfolio and asset analytics in real estate property management.

invoiced-date

query

string

false

Specifies the date on which the invoice was issued, facilitating accurate financial tracking and reporting within the portfolio management context.

received-date

query

string

false

Specifies the date on which the asset draw was received, facilitating portfolio analysis and reporting within the Nakisa Portfolio Management Suite.

note

query

string

false

Optional text note associated with the draws, providing additional context for portfolio, asset, or real estate property analytics.

Responses

Status

Meaning

Description

Schema

200

OK

OK

PagedModelEntityModelDrawDto

Example Responses

 1{
 2  "_embedded": {
 3    "draws": [
 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        "drawNumber": 0,
13        "triggerId": 0,
14        "followUpDate": "2019-08-24",
15        "percentage": 0,
16        "invoicedAmount": 0,
17        "receivedAmount": 0,
18        "invoicedDate": "2019-08-24",
19        "receivedDate": "2019-08-24",
20        "note": "string",
21        "trigger": {
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      }
50    ]
51  },
52  "page": {
53    "size": 0,
54    "totalElements": 0,
55    "totalPages": 0,
56    "number": 0
57  }
58}