ERP Field Mapping

ERP Field Mapping - Get Custom Mapping Options

HTTP Request

POST /api/v1/erp-field-mapping/custom-reference-mapping-options

📋 Description: Creates custom reference mapping options for portfolio and asset management within the Nakisa Portfolio Management Suite, facilitating enhanced analytics and reporting for real estate properties.

Parameters

Name

In

Type

Required

Description

body

body

CustomReferenceMappingOptionRequest

true

Request body containing custom reference mapping options for portfolio, asset, and real estate property analytics within the Nakisa Portfolio Management Suite.

Body Parameters

1{
2  "principalPositionType": "LESSEE",
3  "erpSystem": {
4    "id": 0,
5    "displayId": "string"
6  }
7}

Responses

Status

Meaning

Description

Schema

200

OK

OK

Inline

Example Responses

 1[
 2  {
 3    "principalPositionType": "LESSEE",
 4    "erpSystem": {
 5      "id": 0,
 6      "displayId": "string"
 7    },
 8    "mappingTarget": "LEDGER_TRANSACTION",
 9    "referenceKey": "string",
10    "captionKey": "string",
11    "caption": "string"
12  }
13]

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[CustomReferenceMappingOption]

false

none

[Data transfer object representing a customizable mapping option for portfolio assets within the Nakisa Portfolio Management Suite, facilitating enhanced analytics and reporting for real estate properties.]

» principalPositionType

string

false

none

Type of the principal position

» erpSystem

BaseId

false

none

Data transfer object representing a unique identifier for assets within the Nakisa Portfolio Management Suite, facilitating effective portfolio analytics and management of real estate properties.

»» id

integer(int64)

false

none

Unique identifier for the resource

»» displayId

string

false

none

Unique identifier for the display

» mappingTarget

string

false

none

Specifies the target mapping reference for assets within the Nakisa Portfolio Management Suite, facilitating accurate portfolio and asset analytics in the context of real estate property management.

» referenceKey

string

false

none

Unique identifier for mapping custom references within the Nakisa Portfolio Management Suite, facilitating efficient asset tracking and analytics in portfolio and real estate property management.

» captionKey

string

false

none

Unique key representing the caption associated with a specific portfolio, asset, or real estate property within the Nakisa Portfolio Management Suite for enhanced analytics.

» caption

string

false

none

Descriptive text associated with a portfolio or asset, providing context for analytics and real estate property management within the Nakisa Portfolio Management Suite.

Enumerated Values

Attribute

Value

mappingTarget

LEDGER_ENTRY, LEDGER_TRANSACTION

principalPositionType

LESSEE, LESSOR