Currency

Currency - Get Currency

HTTP Request

GET /api/currencies/{id}

📋 Description: Retrieves detailed information about a specific currency by its unique identifier, facilitating accurate asset valuation and 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

CurrencyDto

Example Responses

 1{
 2  "id": 0,
 3  "status": "CREATED",
 4  "displayId": "string",
 5  "erpSystemId": 0,
 6  "erpSystemDisplayId": "string",
 7  "name": "string",
 8  "decimalPoints": 0,
 9  "depreciationAreaId": 0
10}

Currency - Update Currency

HTTP Request

PUT /api/currencies/{id}

📋 Description: Updates the details of a specified currency within the Nakisa Portfolio Management Suite, enabling accurate financial analytics and reporting 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

CurrencyDto

true

Request body containing the updated currency information, including attributes such as currency code, exchange rate, and related metadata, essential for accurate portfolio and asset analytics in real estate property management.

Body Parameters

 1{
 2  "id": 0,
 3  "status": "CREATED",
 4  "displayId": "string",
 5  "erpSystemId": 0,
 6  "erpSystemDisplayId": "string",
 7  "name": "string",
 8  "decimalPoints": 0,
 9  "depreciationAreaId": 0
10}

Responses

Status

Meaning

Description

Schema

200

OK

OK

CurrencyDto

Example Responses

 1{
 2  "id": 0,
 3  "status": "CREATED",
 4  "displayId": "string",
 5  "erpSystemId": 0,
 6  "erpSystemDisplayId": "string",
 7  "name": "string",
 8  "decimalPoints": 0,
 9  "depreciationAreaId": 0
10}

Currency - Delete Currency

HTTP Request

DELETE /api/currencies/{id}

📋 Description: Deletes a specified currency from the Nakisa Portfolio Management Suite, ensuring accurate asset valuation and analytics within the portfolio management 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

Currency - Get Currencies

HTTP Request

GET /api/currencies

📋 Description: Retrieves a list of available currencies used within the Nakisa Portfolio Management Suite, facilitating accurate asset valuation and analytics for real estate property portfolios.

Responses

Status

Meaning

Description

Schema

200

OK

OK

PageCurrencyDto

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      "status": "CREATED",
22      "displayId": "string",
23      "erpSystemId": 0,
24      "erpSystemDisplayId": "string",
25      "name": "string",
26      "decimalPoints": 0,
27      "depreciationAreaId": 0
28    }
29  ],
30  "number": 0,
31  "sort": {
32    "sorted": true,
33    "unsorted": true,
34    "empty": true
35  },
36  "first": true,
37  "last": true,
38  "empty": true
39}

Currency - Create Currencies

HTTP Request

POST /api/currencies

📋 Description: Creates a new currency entry within the Nakisa Portfolio Management Suite, enabling accurate asset valuation and analytics for real estate properties in your portfolio.

Parameters

Name

In

Type

Required

Description

body

body

CurrencyDto

true

Request body containing the currency details necessary for portfolio and asset analytics within the Nakisa Portfolio Management Suite.

Body Parameters

 1[
 2  {
 3    "id": 0,
 4    "status": "CREATED",
 5    "displayId": "string",
 6    "erpSystemId": 0,
 7    "erpSystemDisplayId": "string",
 8    "name": "string",
 9    "decimalPoints": 0,
10    "depreciationAreaId": 0
11  }
12]

Responses

Status

Meaning

Description

Schema

201

Created

Created

Inline

Example Responses

 1[
 2  {
 3    "id": 0,
 4    "status": "CREATED",
 5    "displayId": "string",
 6    "erpSystemId": 0,
 7    "erpSystemDisplayId": "string",
 8    "name": "string",
 9    "decimalPoints": 0,
10    "depreciationAreaId": 0
11  }
12]

Response Schema

Status Code 201

Name

Type

Required

Restrictions

Description

anonymous

[CurrencyDto]

false

none

[Data transfer object representing currency details utilized within the Nakisa Portfolio Management Suite, facilitating accurate financial analysis and reporting for portfolio, asset, and real estate property management.]

» id

integer(int64)

false

none

Unique identifier for the resource

» status

string

false

none

Status of the resource

» displayId

string

true

none

Unique identifier for the display

» erpSystemId

integer(int64)

false

none

Unique identifier for the erp system

» erpSystemDisplayId

string

false

none

Unique identifier for the erp system display

» name

string

false

none

Name of the resource

» decimalPoints

integer(int32)

true

none

Numeric value representing decimalPoints

» depreciationAreaId

integer(int64)

false

none

Unique identifier for the depreciation area

Enumerated Values

Attribute

Value

status

ACTIVE, CREATED, DECOMMISSIONED, DISABLED

Currency - Search Currencies

HTTP Request

POST /api/currencies/search

📋 Description: Submits a request to search for currencies relevant to portfolio management, asset tracking, and real estate property analytics within the Nakisa Portfolio Management Suite.

Parameters

Name

In

Type

Required

Description

body

body

CurrencyDtoFilter

true

Request body containing search criteria for currency data relevant to portfolio and asset analytics within the Nakisa Portfolio Management Suite.

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  "statusEqual": "CREATED",
16  "statusIn": [
17    "CREATED"
18  ],
19  "displayIdIn": [
20    "string"
21  ],
22  "displayIdLike": "string",
23  "erpSystemIdEqual": 0,
24  "erpSystemIdIn": [
25    0
26  ],
27  "erpSystemDisplayIdLike": "string",
28  "uiSelector": "string",
29  "nameLike": "string",
30  "decimalPointsEqual": 0,
31  "depreciationAreaIdEqual": 0
32}

Responses

Status

Meaning

Description

Schema

200

OK

OK

PageCurrencyDto

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      "status": "CREATED",
22      "displayId": "string",
23      "erpSystemId": 0,
24      "erpSystemDisplayId": "string",
25      "name": "string",
26      "decimalPoints": 0,
27      "depreciationAreaId": 0
28    }
29  ],
30  "number": 0,
31  "sort": {
32    "sorted": true,
33    "unsorted": true,
34    "empty": true
35  },
36  "first": true,
37  "last": true,
38  "empty": true
39}