ERP Field Mapping

ERP Field Mapping - Get

HTTP Request

GET /api/v1/sap-posting-bot/erp-field-mapping/{id}

📋 Description: Retrieves the ERP field mapping details for a specified ledger entry by its unique identifier, facilitating accurate transaction and account management within financial records.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseErpFieldMappingDto

ERP Field Mapping - Update

HTTP Request

PUT /api/v1/sap-posting-bot/erp-field-mapping/{id}

📋 Description: Updates the ERP field mapping configuration for a specified ledger entry, enabling accurate transaction processing and alignment of financial records within the General Ledger system.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

body

body

ErpFieldMappingDto

true

Request body containing the ERP field mapping data, including ledger entry details, transaction identifiers, and account associations necessary for updating financial records.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseErpFieldMappingDto

ERP Field Mapping - Delete

HTTP Request

DELETE /api/v1/sap-posting-bot/erp-field-mapping/{id}

📋 Description: Deletes the specified ERP field mapping entry by its unique identifier, ensuring the integrity of ledger entries and associated financial records within the General Ledger.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

200

OK

OK

None

ERP Field Mapping - Create Or Update

HTTP Request

PUT /api/v1/sap-posting-bot/erp-field-mapping/createOrUpdate

📋 Description: Updates or creates ERP field mappings for ledger entries, ensuring accurate transaction and account alignment within financial records. This operation facilitates the seamless integration of data between systems, enhancing overall financial reporting accuracy.

Parameters

Name

In

Type

Required

Description

body

body

ErpFieldMappingDto

true

Request body containing the ledger entry mapping data, including transaction details, account identifiers, and associated financial record attributes for creating or updating ERP field mappings.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseErpFieldMappingDto

ERP Field Mapping - Create Or Update Bulk

HTTP Request

PUT /api/v1/sap-posting-bot/erp-field-mapping/createOrUpdate/bulk

📋 Description: Creates or updates multiple ERP field mappings in bulk for ledger entries, ensuring accurate transaction and account alignment within financial records.

Parameters

Name

In

Type

Required

Description

body

body

ErpFieldMappingDto

true

Request body containing bulk ERP field mapping data for ledger entries, including transaction details, account identifiers, and associated financial records.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseListErpFieldMappingDto

ERP Field Mapping - Bulk Update

HTTP Request

PUT /api/v1/sap-posting-bot/erp-field-mapping/bulk

📋 Description: Updates multiple ERP field mappings in bulk for ledger entries, ensuring accurate transaction and account alignment within financial records.

Parameters

Name

In

Type

Required

Description

body

body

ErpFieldMappingDto

true

Request body containing a collection of ERP field mappings for bulk ledger entries, including transaction details and account identifiers to ensure accurate financial record integration.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseListErpFieldMappingDto

ERP Field Mapping - Validate ERP Mapping Script

HTTP Request

POST /api/v1/sap-posting-bot/erp-field-mapping/validate-erp-mapping-script

Parameters

Name

In

Type

Required

Description

body

body

ScriptFieldRequest

true

none

Responses

Status

Meaning

Description

Schema

200

OK

OK

string

ERP Field Mapping - List SAP Fields

HTTP Request

POST /api/v1/sap-posting-bot/erp-field-mapping/sap-fields

📋 Description: Creates a mapping of SAP fields to ERP fields for ledger entries, facilitating accurate transaction processing and ensuring consistency in financial records.

Parameters

Name

In

Type

Required

Description

body

body

string

true

Request body containing the mapping data for SAP fields related to ledger entries, transactions, accounts, and financial records.

Enumerated Values

Attribute

Value

body

ACCOUNT_GL, ACCOUNT_GL_TAX, ACCOUNT_PAYABLE, ACCOUNT_TAX, CURRENCY_AMOUNT, CURRENCY_AMOUNT_ADDITIONAL_CURRENCIES, CURRENCY_AMOUNT_TAX, EXTENSION_2, POST_DOCUMENT_HEADER, REVERSAL

Responses

Status

Meaning

Description

Schema

200

OK

OK

Inline

Response Schema

ERP Field Mapping - List GL Tables And Fields

HTTP Request

POST /api/v1/sap-posting-bot/erp-field-mapping/gl-tables-and-fields

📋 Description: Posts General Ledger field mappings for ledger entries, enabling the accurate alignment of transaction data with corresponding accounts and financial records.

Parameters

Name

In

Type

Required

Description

body

body

MappingGlFieldFilter

true

Request body containing the mapping data for General Ledger tables and fields, essential for accurately recording ledger entries and transactions within the financial record system.

Responses

Status

Meaning

Description

Schema

200

OK

OK

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[MappingGlTableAndFields]

false

none

[Data structure representing the mapping of general ledger tables and fields, facilitating the alignment of ledger entries, transactions, accounts, and financial records for accurate reporting and analysis.]

» table

string

false

none

Specifies the name of the general ledger table associated with the ledger entry, transaction, account, or financial record.

» fields

[MappingGlFieldOption]

false

none

List of fields items

»» field

string

false

none

Represents a specific attribute related to ledger entries, transactions, accounts, or financial records within the General Ledger API.

»» captionKey

string

false

none

The captionKey is a unique string identifier used to reference specific captions associated with ledger entries, transactions, accounts, and financial records within the General Ledger API.

»» caption

string

false

none

Descriptive text associated with a ledger entry, providing context for transactions within financial records and accounts.

»» customReference

boolean

false

none

Boolean flag indicating customReference status

Enumerated Values

Attribute

Value

table

EMPTY_FIELD, LEDGER_ENTRY, LEDGER_ENTRY_ADDITIONAL_CURRENCIES, LEDGER_ENTRY_APPLICATION_REFERENCE_AP, LEDGER_ENTRY_APPLICATION_REFERENCE_NLA, LEDGER_ENTRY_APPLICATION_REFERENCE_NRE, LEDGER_ENTRY_TAX, LEDGER_TRANSACTION, LEDGER_TRANSACTION_APPLICATION_REFERENCE_AP, LEDGER_TRANSACTION_APPLICATION_REFERENCE_NLA, LEDGER_TRANSACTION_APPLICATION_REFERENCE_NRE, USER_INPUT

ERP Field Mapping - Get Mappings

HTTP Request

POST /api/v1/sap-posting-bot/erp-field-mapping/

📋 Description: Creates a mapping between ERP fields and general ledger accounts to facilitate accurate ledger entry and transaction processing, ensuring seamless integration of financial records.

Parameters

Name

In

Type

Required

Description

body

body

ErpFieldMappingDtoFilter

true

Request body containing the mapping data for ledger entries, including transaction details, account identifiers, and associated financial records.

Responses

Status

Meaning

Description

Schema

200

OK

OK

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[ErpFieldMappingDto]

false

none

[Data transfer object representing the mapping of fields between the General Ledger and external systems, facilitating accurate ledger entries, transactions, and financial records management.]

» id

integer(int64)

false

none

Unique identifier for the resource

» erpSystem

BaseId

true

none

Data transfer object representing a unique identifier for ledger entries, transactions, and accounts within the General Ledger, facilitating accurate tracking and management of financial records.

»» id

integer(int64)

false

none

Unique identifier for the resource

»» displayId

string

false

none

Unique identifier for the display

» postingCommand

string

true

none

Specifies the command for posting ledger entries, facilitating accurate transaction processing within financial records.

» mappingMode

string

false

none

Specifies the method of mapping financial records to ensure accurate ledger entries and transactions within the General Ledger.

» principalPositionType

string

true

none

Type of the principal position

» financialAccounting

string

false

none

Represents the financial accounting reference associated with ledger entries, transactions, accounts, and financial records within the General Ledger API.

» mappingSapField

string

false

none

Represents the corresponding SAP field used for mapping in financial records, ensuring accurate ledger entry and transaction processing within the General Ledger domain.

» sapCustomizableField

boolean

false

none

Boolean flag indicating sapCustomizableField status

» mappingSources

[MappingSource]

false

none

List of mappingSources items

»» reference

string

false

none

Unique reference string for identifying ledger entries, transactions, or financial records within the General Ledger.

»» source

string

false

none

Indicates the origin of the ledger entry, providing essential context for transactions and financial records within the General Ledger.

» defaultMappingSources

[MappingSource]

false

none

List of defaultMappingSources items

» customFieldOperation

string

false

none

Specifies the operation type for custom fields in ledger entries, transactions, accounts, and financial records within the General Ledger API.

» customScriptOperation

string

false

none

none

Enumerated Values

Attribute

Value

financialAccounting

ASSET_ACCOUNTING, GENERAL_LEDGER

mappingMode

CUSTOM, DEFAULT

mappingSapField

ACCOUNTING_KEY_ACCOUNT_TAX, ACCOUNTING_PRINCIPAL, ACCOUNTING_PRINCIPAL_REVERSAL, ALLOCATION_NUMBER, ALLOCATION_NUMBER_PAYABLE, ALLOCATION_NUMBER_TAX, AMOUNT_BASE, AMOUNT_BASE_ADDITIONAL_CURRENCY, AMOUNT_BASE_TAX, AMOUNT_DOCCUR, AMOUNT_DOCCUR_ADDITIONAL_CURRENCY, AMOUNT_DOCCUR_TAX, BUSINESS_AREA, BUSINESS_AREA_PAYABLE, BUSINESS_AREA_TAX, BUSINESS_TRANSACTION, COMPANY_CODE, COMPANY_CODE_PAYABLE, COMPANY_CODE_REVERSAL, CONDITION_KEY_ACCOUNT_TAX, COST_CENTER, COST_CENTER_TAX, CS_TRANSACTION_TYPE, CS_TRANSACTION_TYPE_TAX, CURRENCY, CURRENCY_ADDITIONAL_CURRENCY, CURRENCY_TAX, CURRENCY_TYPE, CURRENCY_TYPE_ADDITIONAL_CURRENCY, CURRENCY_TYPE_TAX, DOCUMENT_DATE, DOCUMENT_TYPE, EXCHANGE_RATE, EXCHANGE_RATE_ADDITIONAL_CURRENCY, EXCHANGE_RATE_TAX, FUNCTIONAL_AREA, FUNCTIONAL_AREA_TAX, GL_ACCOUNT, GL_ACCOUNT_ACCOUNT_TAX, GL_ACCOUNT_PAYABLE, GL_ACCOUNT_TAX, HEADER_TEXT, ITEM_ACCOUNT_NUMBER, ITEM_ACCOUNT_NUMBER_ADDITIONAL_CURRENCY, ITEM_ACCOUNT_NUMBER_PAYABLE, ITEM_ACCOUNT_NUMBER_TAX, ITEM_NO_ACCOUNT_TAX, ITEM_NUMBER_ACCOUNT, ITEM_NUMBER_ACCOUNT_ACCOUNT_TAX, ITEM_NUMBER_ACCOUNT_TAX, ITEM_TEXT, ITEM_TEXT_PAYABLE, ITEM_TEXT_TAX, NETWORK, NETWORK_TAX, OBJECT_KEY_R, OBJECT_SYSTEM, OBJECT_TYPE, ORDER_ID, ORDER_ID_TAX, PAYMENT_BLOCK_PAYABLE, PAYMENT_METHOD_PAYABLE, PAYMENT_TERMS_PAYABLE, PLANT, PLANT_TAX, POSTING_DATE, POSTING_DATE_REVERSAL, PO_NUMBER, PO_NUMBER_TAX, PROFIT_CENTER, PROFIT_CENTER_TAX, REFERENCE_DOCUMENT_NUMBER, REFERENCE_KEY_1, REFERENCE_KEY_1_PAYABLE, REFERENCE_KEY_1_TAX, REFERENCE_KEY_2, REFERENCE_KEY_2_PAYABLE, REFERENCE_KEY_2_TAX, REFERENCE_KEY_3, REFERENCE_KEY_3_PAYABLE, REFERENCE_KEY_3_TAX, REVERSAL_REASON, SEGMENT, SEGMENT_TAX, STRUCTURE, TAX_CODE, TAX_CODE_ACCOUNT_TAX, TAX_CODE_PAYABLE, TAX_CODE_TAX, TAX_DATE_ACCOUNT_TAX, TAX_JURISDICTION_CODE, TAX_JURISDICTION_CODE_ACCOUNT_TAX, TAX_JURISDICTION_CODE_PAYABLE, TAX_JURISDICTION_CODE_TAX, TAX_RATE_ACCOUNT_TAX, TRADING_PARTNER, TRADING_PARTNER_TAX, TRANSACTION_DATE, VALUE_PART_1, VALUE_PART_2, VALUE_PART_3, VALUE_PART_4, VENDOR_NUMBER, VENDOR_NUMBER_PAYABLE, VENDOR_NUMBER_TAX, WBS_ELEMENT, WBS_ELEMENT_TAX

postingCommand

ACCRUAL, CAPITALIZATION, CHARGE, CLEARING, DEPRECIATION, IMPAIRMENT, LIABILITY, LIABILITY_ADJUSTMENT, MODIFICATION_RECOGNITION, PAYMENT, TERMINATION

principalPositionType

LESSEE, LESSOR

source

EMPTY_FIELD, LEDGER_ENTRY, LEDGER_ENTRY_ADDITIONAL_CURRENCIES, LEDGER_ENTRY_APPLICATION_REFERENCE_AP, LEDGER_ENTRY_APPLICATION_REFERENCE_NLA, LEDGER_ENTRY_APPLICATION_REFERENCE_NRE, LEDGER_ENTRY_TAX, LEDGER_TRANSACTION, LEDGER_TRANSACTION_APPLICATION_REFERENCE_AP, LEDGER_TRANSACTION_APPLICATION_REFERENCE_NLA, LEDGER_TRANSACTION_APPLICATION_REFERENCE_NRE, USER_INPUT

ERP Field Mapping - Find All

HTTP Request

GET /api/v1/sap-posting-bot/erp-field-mapping

📋 Description: Fetches the ERP field mapping configurations used for ledger entries, enabling accurate transaction processing and account management within the General Ledger.

Parameters

Name

In

Type

Required

Description

pageable

query

Pageable

true

Indicates whether the results of the ledger entry field mapping query should be paginated, facilitating efficient retrieval of financial records and transactions.

Responses

Status

Meaning

Description

Schema

200

OK

OK

PageErpFieldMappingDto

ERP Field Mapping - List Posting Types

HTTP Request

GET /api/v1/sap-posting-bot/erp-field-mapping/posting-type-command

📋 Description: Retrieves the mapping of posting types for ledger entries, facilitating accurate transaction classification and account management within financial records.

Responses

Status

Meaning

Description

Schema

200

OK

OK

Inline

Response Schema

ERP Field Mapping - List Mapping SAP Tables

HTTP Request

GET /api/v1/sap-posting-bot/erp-field-mapping/mapping-sap-tables

📋 Description: Retrieves the mapping of SAP tables for ledger entries, transactions, accounts, and financial records, facilitating accurate data integration within the General Ledger system.

Responses

Status

Meaning

Description

Schema

200

OK

OK

Inline

Response Schema

ERP Field Mapping - List Mapping SAP Fields

HTTP Request

GET /api/v1/sap-posting-bot/erp-field-mapping/mapping-sap-fields

📋 Description: Retrieves the mapping of SAP fields to ERP fields used in ledger entries, transactions, and financial records, facilitating accurate integration and data consistency within the General Ledger domain.

Responses

Status

Meaning

Description

Schema

200

OK

OK

Inline

Response Schema

ERP Field Mapping - List Mapping Modes

HTTP Request

GET /api/v1/sap-posting-bot/erp-field-mapping/mapping-modes

📋 Description: Retrieves the available mapping modes for ERP field mapping within the General Ledger, facilitating the accurate alignment of ledger entries, transactions, and financial records.

Responses

Status

Meaning

Description

Schema

200

OK

OK

Inline

Response Schema

ERP Field Mapping - List Mapping GL Tables

HTTP Request

GET /api/v1/sap-posting-bot/erp-field-mapping/mapping-gl-tables

📋 Description: Retrieves the mapping of General Ledger tables used for ERP field integration, facilitating accurate ledger entry and transaction processing within financial records.

Responses

Status

Meaning

Description

Schema

200

OK

OK

Inline

Response Schema