Financial Obligation Report

Get Foreport

HTTP Request

GET /api/financial-obligation-reports/{id}

📋 Description: Retrieves detailed financial obligation reports for a specified asset within the Nakisa Portfolio Management Suite, enabling users to analyze portfolio performance and make informed real estate investment decisions.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

200

OK

OK

FOReportDto

Update Foreport

HTTP Request

PUT /api/financial-obligation-reports/{id}

📋 Description: Updates the financial obligation report identified by the specified ID, enabling users to refine asset analytics within the Nakisa Portfolio Management Suite for enhanced portfolio management and real estate property insights.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

body

body

FOReportDto

true

Request body containing the updated financial obligation report data, including asset details, portfolio metrics, and analytics relevant to real estate property management.

Responses

Status

Meaning

Description

Schema

200

OK

OK

FOReportDto

Delete Foreport

HTTP Request

DELETE /api/financial-obligation-reports/{id}

📋 Description: Deletes a specified financial obligation report from the Nakisa Portfolio Management Suite, enabling users to manage and streamline their portfolio and asset 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

204

No Content

No Content

None

Get Assumptions

HTTP Request

GET /api/financial-obligation-reports/{id}/assumptions

📋 Description: Fetches the assumptions associated with a specific financial obligation report, providing insights for 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

Responses

Status

Meaning

Description

Schema

200

OK

OK

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[ExpenseCategoryAssumptionDto]

false

none

[Data transfer object representing the assumptions related to expense categories within the Nakisa Portfolio Management Suite, facilitating effective portfolio and asset analytics for 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

» foReportId

integer(int64)

false

none

Unique identifier for the fo report

» expenseCategoryId

integer(int64)

false

none

Unique identifier for the expense category

» percentageChange

number

false

none

Value for percentageChange field

» source

string

false

none

Text value for source in ExpenseCategoryAssumptionDto

» startDate

string(date)

false

none

Start date of the resource

» endDate

string(date)

false

none

End date of the resource

Update Assumptions

HTTP Request

PUT /api/financial-obligation-reports/{id}/assumptions

📋 Description: Updates the assumptions associated with a specific financial obligation report in the Nakisa Portfolio Management Suite, enabling enhanced analytics and insights 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

ExpenseCategoryAssumptionDto

true

Request body containing the updated assumptions data for the specified financial obligation report, including relevant portfolio and asset analytics for real estate property management.

Responses

Status

Meaning

Description

Schema

200

OK

OK

None

Unarchive Foreport

HTTP Request

POST /api/financial-obligation-reports/{id}/unarchive

📋 Description: Unarchives a specified financial obligation report within the Nakisa Portfolio Management Suite, allowing users to reintegrate valuable analytics related to portfolio and asset management 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

FOReportDto

Review Foreport

HTTP Request

POST /api/financial-obligation-reports/{id}/review

📋 Description: Submits a review for the specified financial obligation report, facilitating enhanced analytics and decision-making within the Nakisa Portfolio Management Suite for real estate property and asset management.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

200

OK

OK

FOReportDto

Reopen Foreport

HTTP Request

POST /api/financial-obligation-reports/{id}/reopen

📋 Description: Reopens a previously closed financial obligation report identified by the specified ID, enabling users to make necessary adjustments within the Nakisa Portfolio Management Suite for enhanced portfolio and asset analytics in real estate property management.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

200

OK

OK

FOReportDto

Reject Foreport

HTTP Request

POST /api/financial-obligation-reports/{id}/reject

📋 Description: Rejects a specified financial obligation report within the Nakisa Portfolio Management Suite, enabling users to manage and streamline portfolio analytics related to real estate assets.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

200

OK

OK

FOReportDto

Regenerate Foreport

HTTP Request

POST /api/financial-obligation-reports/{id}/regenerate

📋 Description: Regenerates the financial obligation report associated with the specified ID, enabling users to refresh data for enhanced accuracy in 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

Responses

Status

Meaning

Description

Schema

200

OK

OK

FOReportDto

Get Foreport Notes

HTTP Request

GET /api/financial-obligation-reports/{id}/notes

📋 Description: Fetches notes associated with a specific financial obligation report, enabling users to gain insights into 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 results of the financial obligation report notes 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 notes related to a specific financial obligation report, enhancing portfolio and asset analytics within the Nakisa Portfolio Management Suite.

message

query

string

false

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

Responses

Status

Meaning

Description

Schema

200

OK

OK

PagedModelEntityModelNoteDto

Create Foreport Notes

HTTP Request

POST /api/financial-obligation-reports/{id}/notes

📋 Description: Adds notes to a specified financial obligation report within the Nakisa Portfolio Management Suite, enhancing portfolio and asset 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 financial obligation report notes data, including relevant annotations and metadata to enhance portfolio and asset analytics within the Nakisa Portfolio Management Suite.

Responses

Status

Meaning

Description

Schema

201

Created

Created

Inline

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

Generate Foreport

HTTP Request

POST /api/financial-obligation-reports/{id}/generate

📋 Description: Generates a financial obligation report for a specified asset within the Nakisa Portfolio Management Suite, enabling stakeholders to analyze portfolio performance and financial commitments 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

FOReportDto

Archive Foreport

HTTP Request

POST /api/financial-obligation-reports/{id}/archive

📋 Description: Archives the specified financial obligation report within the Nakisa Portfolio Management Suite, enabling streamlined asset management and enhanced 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

FOReportDto

Approve Foreport

HTTP Request

POST /api/financial-obligation-reports/{id}/approve

📋 Description: Approves a specified financial obligation report 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

FOReportDto

Get Foreports

HTTP Request

GET /api/financial-obligation-report

📋 Description: Fetches the financial obligation report for assets within the Nakisa Portfolio Management Suite, providing critical analytics for real estate properties and portfolio management.

Parameters

Name

In

Type

Required

Description

pageable

query

Pageable

true

Indicates whether the results of the financial obligation report should be returned in a paginated format, facilitating efficient data retrieval for portfolio and asset analysis within the Nakisa Portfolio Management Suite.

search

query

string

false

Search term used to filter financial obligation reports based on portfolio, asset, or real estate property criteria within the Nakisa Portfolio Management Suite.

name

query

string

false

Name of the resource

description

query

string

false

Description of the resource

start-date

query

string

false

Specifies the start date for generating the financial obligation report, allowing users to analyze portfolio and asset performance within a defined time frame.

end-date

query

string

false

Specifies the end date for the financial obligation report, allowing users to filter data relevant to portfolio and asset analytics within the real estate property context.

status-id

query

string

false

Unique identifier for the status of a financial obligation report, facilitating targeted analytics within the Nakisa Portfolio Management Suite for portfolio and asset management in real estate properties.

status-id-is-not

query

string

false

Excludes financial obligations from the report based on the specified status ID, enabling targeted analysis of portfolio assets within the Nakisa Portfolio Management Suite.

Responses

Status

Meaning

Description

Schema

200

OK

OK

PagedModelEntityModelFOReportDto