Project Cost

Update Project Cost

HTTP Request

PUT /api/project-costs/{id}

📋 Description: Updates the cost details of a specified project within the Nakisa Portfolio Management Suite, enabling accurate financial tracking and analysis for portfolio and asset management in real estate properties.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

body

body

ProjectCostDto

true

Request body containing the updated project cost details, including budget allocations and financial metrics relevant to portfolio and asset management.

Responses

Status

Meaning

Description

Schema

200

OK

OK

None

Create Project Cost

HTTP Request

POST /api/project-costs

📋 Description: Creates a new project cost entry within the Nakisa Portfolio Management Suite, enabling users to effectively manage and analyze financial data related to portfolio assets and real estate properties.

Parameters

Name

In

Type

Required

Description

body

body

ProjectCostDto

true

Request body containing detailed project cost data, including estimates, allocations, and relevant metadata for effective portfolio and asset management within the Nakisa Portfolio Management Suite.

Responses

Status

Meaning

Description

Schema

201

Created

Created

integer

Get Documents For Milestone Cost

HTTP Request

GET /api/project-costs/milestone-costs/{milestoneCostId}/documents

📋 Description: Retrieves documents associated with a specific milestone cost, enabling users to access relevant documentation for enhanced portfolio and asset management within the Nakisa Portfolio Management Suite.

Parameters

Name

In

Type

Required

Description

milestoneCostId

path

integer(int64)

true

Unique identifier for the milestone cost

pageable

query

Pageable

true

Indicates whether the results of the document retrieval for a specific milestone cost should be paginated, facilitating efficient data management within the Nakisa Portfolio Management Suite.

search

query

string

false

Search term used to filter and retrieve specific documents related to milestone costs 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 milestone cost document, facilitating effective tracking and management within the Nakisa Portfolio Management Suite.

signed-date

query

string

false

Specifies the date on which the document was signed, relevant for tracking milestones in 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 associated documents for the specified milestone cost can be shared 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 milestone cost within the Nakisa Portfolio Management Suite, facilitating efficient asset and portfolio management.

document-type-id-in

query

string

false

Unique identifier for the type of document associated with the specified milestone cost, facilitating precise retrieval of relevant documents within the Nakisa Portfolio Management Suite.

Responses

Status

Meaning

Description

Schema

200

OK

OK

PagedModelEntityModelDocumentDto

Upload Milestone Cost Document

HTTP Request

POST /api/project-costs/milestone-costs/{milestoneCostId}/documents

📋 Description: Uploads documents associated with a specific milestone cost in the Nakisa Portfolio Management Suite, enabling enhanced asset and portfolio analytics for real estate properties.

Parameters

Name

In

Type

Required

Description

milestoneCostId

path

integer(int64)

true

Unique identifier for the milestone cost

body

body

object

false

Request body containing the document details associated with a specific milestone cost, including relevant metadata for portfolio and asset management analysis.

» 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.

Responses

Status

Meaning

Description

Schema

201

Created

Created

DocumentDto

Get Project Cost

HTTP Request

GET /api/project-costs/{projectId}

📋 Description: Retrieves the cost details associated with a specific project identified by the projectId, enabling users to analyze financial performance within the context of portfolio and asset management in real estate.

Parameters

Name

In

Type

Required

Description

projectId

path

integer(int64)

true

Unique identifier for the project

Responses

Status

Meaning

Description

Schema

200

OK

OK

ProjectCostDto

Download Milestone Cost Document

HTTP Request

GET /api/project-costs/milestone-costs/{milestoneCostId}/documents/{documentId}/download

📋 Description: Downloads the specified document associated with a milestone cost in the Nakisa Portfolio Management Suite, enabling users to access critical documentation related to portfolio and asset management in real estate analytics.

Parameters

Name

In

Type

Required

Description

milestoneCostId

path

integer(int64)

true

Unique identifier for the milestone cost

documentId

path

integer(int64)

true

Unique identifier for the document

Responses

Status

Meaning

Description

Schema

200

OK

OK

StreamingResponseBody

Get All Project Costs By Budget Id

HTTP Request

GET /api/project-costs/budgets/{budgetId}

📋 Description: Retrieves detailed budget information for a specified project within the Nakisa Portfolio Management Suite, enabling users to analyze financial allocations related to portfolio, asset, and real estate property management.

Parameters

Name

In

Type

Required

Description

budgetId

path

integer(int64)

true

Unique identifier for the budget

Responses

Status

Meaning

Description

Schema

200

OK

OK

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[ProjectCostDto]

false

none

[Data transfer object representing the financial metrics associated with a project within the Nakisa Portfolio Management Suite, facilitating portfolio analysis and asset management for real estate properties.]

» 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

» totalBudget

number

false

none

Value for totalBudget field

» totalEstimated

number

false

none

Value for totalEstimated field

» grandTotalActual

number

false

none

Value for grandTotalActual field

» projectId

integer(int64)

false

none

Unique identifier for the project

» projectDisplayId

string

false

none

Unique identifier for the project display

» projectName

string

false

none

Name of the project

» milestoneCostDtos

[MilestoneCostDto]

false

none

List of milestoneCostDtos 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

»» totalActual

number

false

none

Value for totalActual field

»» estimated

number

false

none

Value for estimated field

»» sourceId

integer(int64)

false

none

Unique identifier for the source

»» milestoneId

integer(int64)

false

none

Unique identifier for the milestone

»» milestoneDisplayId

string

false

none

Unique identifier for the milestone display

»» milestoneName

string

false

none

Name of the milestone

»» milestoneStatusId

integer(int64)

false

none

Unique identifier for the milestone status

»» milestoneTaskCostDtos

[MilestoneTaskCostDto]

false

none

List of milestoneTaskCostDtos 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

»»» actual

number

false

none

Value for actual field

»»» milestoneTaskId

integer(int64)

false

none

Unique identifier for the milestone task

»»» milestoneTaskDisplayId

string

false

none

Unique identifier for the milestone task display

»»» milestoneTaskName

string

false

none

Name of the milestone task

»»» status

string

false

none

Status of the resource

Delete Milestone Cost Document

HTTP Request

DELETE /api/project-costs/milestone-costs/{milestoneCostId}/documents/{documentId}

📋 Description: Deletes a specified document associated with a milestone cost in the Nakisa Portfolio Management Suite, facilitating effective management of project-related documentation within the context of portfolio and asset analytics in real estate properties.

Parameters

Name

In

Type

Required

Description

milestoneCostId

path

integer(int64)

true

Unique identifier for the milestone cost

documentId

path

integer(int64)

true

Unique identifier for the document

Responses

Status

Meaning

Description

Schema

204

No Content

No Content

None