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 ERP field mapping, enabling tailored integration and data synchronization between systems to enhance operational efficiency.

Parameters

Name

In

Type

Required

Description

body

body

CustomReferenceMappingOptionRequest

true

Request body containing the custom reference mapping options data necessary for aligning ERP fields with business-specific requirements.

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

409

Conflict

Payment amount exceeds remaining invoice balance

InvoicePaymentBalanceConflictDto

502

Bad Gateway

Downstream service call failed

PayableErrorDto

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 structure representing a customizable mapping option for reference data, enabling businesses to align their internal data models with external standards or frameworks for improved data consistency and interoperability.]

» principalPositionType

string

false

none

Type of the principal position

» erpSystem

BaseId

false

none

BaseId is a foundational data object that serves as a unique identifier for various entities within the system, ensuring consistent tracking and management across business processes.

»» 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 reference for mapping custom options within the system.

» referenceKey

string

false

none

Unique string identifier used to map custom references within the system, facilitating efficient data retrieval and integration.

» captionKey

string

false

none

Unique key used to reference and retrieve specific caption data within the CustomReferenceMappingOption schema.

» caption

string

false

none

The caption field provides a descriptive label for the CustomReferenceMappingOption, facilitating easier identification and management within the system.

Enumerated Values

Attribute

Value

mappingTarget

LEDGER_ENTRY, LEDGER_TRANSACTION

principalPositionType

LESSEE, LESSOR