ERP Field Mapping

Get ERP Field Mapping By ID

HTTP Request

GET /api/v1/erp-field-mapping/{id}

Interactive Demo

📋 Description: Retrieves the ERP field mapping details for a specified identifier, facilitating accurate alignment of lease, contract, and financial obligation data within the Nakisa Lease Accounting Suite.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource

Example Values

Parameter	Example	Type
id	5000001	path

Responses

Status	Meaning	Description	Schema
200	OK	Successfully retrieved ERP field mapping	ResponseErpFieldMappingDto
400	Bad Request	Invalid ID supplied	None
404	Not Found	ERP field mapping not found	None
500	Internal Server Error	Internal server error	None

Example Responses

{
  "code": "OK",
  "errors": {
    "all": []
  },
  "object": {
    "id": 5000001,
    "erpSystem": {
      "id": "string",
      "displayId": "Euro"
    },
    "principalPositionType": {
      "name": "LESSEE",
      "captionKey": "enum.principalpositiontype.lessee",
      "caption": "Lessee"
    },
    "sourceTableName": {
      "name": "MASTER_AGREEMENT",
      "captionKey": "enum.SourceTable.field",
      "caption": "MASTER_AGREEMENT"
    },
    "sourceField": {
      "id": 67890,
      "sourceFieldName": "CONTRACT_NUMBER",
      "sourceFieldNameCaption": "Contract Number",
      "sourceFieldNameDataType": {
        "name": "MASTER_AGREEMENT",
        "captionKey": "enum.SourceTable.field",
        "caption": "MASTER_AGREEMENT"
      },
      "mappingId": 5000001
    }
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Update ERP Field Mapping

HTTP Request

PUT /api/v1/erp-field-mapping/{id}

Interactive Demo

📋 Description: Updates the specified ERP field mapping entry in the Nakisa Lease Accounting Suite, allowing for adjustments to lease, contract, financial obligation, and accounting entry configurations to ensure accurate data alignment and reporting.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
body	body	ErpFieldMappingDto	false	Request body containing the updated lease and contract field mapping data, including financial obligation details and accounting entry specifications.

Example Values

Parameter	Example	Type
id	5000001	path

Body Parameters

{
  "id": 5000001,
  "erpSystem": {
    "id": "string",
    "displayId": "Euro"
  },
  "principalPositionType": {
    "name": "LESSEE",
    "captionKey": "enum.principalpositiontype.lessee",
    "caption": "Lessee"
  },
  "sourceTableName": {
    "name": "MASTER_AGREEMENT",
    "captionKey": "enum.SourceTable.field",
    "caption": "MASTER_AGREEMENT"
  },
  "sourceField": {
    "id": 67890,
    "sourceFieldName": "CONTRACT_NUMBER",
    "sourceFieldNameCaption": "Contract Number",
    "sourceFieldNameDataType": {
      "name": "MASTER_AGREEMENT",
      "captionKey": "enum.SourceTable.field",
      "caption": "MASTER_AGREEMENT"
    },
    "mappingId": 5000001
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	ERP field mapping updated successfully	ResponseErpFieldMappingDto
400	Bad Request	Invalid request body or ID supplied	None
404	Not Found	ERP field mapping not found	None
500	Internal Server Error	Internal server error	None

Example Responses

{
  "code": "OK",
  "errors": {
    "all": []
  },
  "object": {
    "id": 5000001,
    "erpSystem": {
      "id": "string",
      "displayId": "Euro"
    },
    "principalPositionType": {
      "name": "LESSEE",
      "captionKey": "enum.principalpositiontype.lessee",
      "caption": "Lessee"
    },
    "sourceTableName": {
      "name": "MASTER_AGREEMENT",
      "captionKey": "enum.SourceTable.field",
      "caption": "MASTER_AGREEMENT"
    },
    "sourceField": {
      "id": 67890,
      "sourceFieldName": "CONTRACT_NUMBER",
      "sourceFieldNameCaption": "Contract Number",
      "sourceFieldNameDataType": {
        "name": "MASTER_AGREEMENT",
        "captionKey": "enum.SourceTable.field",
        "caption": "MASTER_AGREEMENT"
      },
      "mappingId": 5000001
    }
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Create Or Update ERP Field Mapping

HTTP Request

PUT /api/v1/erp-field-mapping/createOrUpdate

Interactive Demo

📋 Description: Updates or creates field mappings within the Nakisa Lease Accounting Suite, ensuring accurate alignment of lease, contract, financial obligation, and accounting entry data. This operation facilitates seamless integration and data consistency across financial reporting processes.

Parameters

Name	In	Type	Required	Description
body	body	ErpFieldMappingDto	false	Request body containing the lease and contract field mapping data necessary for updating financial obligations and accounting entries within the Nakisa Lease Accounting Suite.

Body Parameters

{
  "id": 5000001,
  "erpSystem": {
    "id": "string",
    "displayId": "Euro"
  },
  "principalPositionType": {
    "name": "LESSEE",
    "captionKey": "enum.principalpositiontype.lessee",
    "caption": "Lessee"
  },
  "sourceTableName": {
    "name": "MASTER_AGREEMENT",
    "captionKey": "enum.SourceTable.field",
    "caption": "MASTER_AGREEMENT"
  },
  "sourceField": {
    "id": 67890,
    "sourceFieldName": "CONTRACT_NUMBER",
    "sourceFieldNameCaption": "Contract Number",
    "sourceFieldNameDataType": {
      "name": "MASTER_AGREEMENT",
      "captionKey": "enum.SourceTable.field",
      "caption": "MASTER_AGREEMENT"
    },
    "mappingId": 5000001
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	ERP field mapping created or updated successfully	ResponseErpFieldMappingDto
400	Bad Request	Invalid request body	None
500	Internal Server Error	Internal server error	None

Example Responses

{
  "code": "OK",
  "errors": {
    "all": []
  },
  "object": {
    "id": 5000001,
    "erpSystem": {
      "id": "string",
      "displayId": "Euro"
    },
    "principalPositionType": {
      "name": "LESSEE",
      "captionKey": "enum.principalpositiontype.lessee",
      "caption": "Lessee"
    },
    "sourceTableName": {
      "name": "MASTER_AGREEMENT",
      "captionKey": "enum.SourceTable.field",
      "caption": "MASTER_AGREEMENT"
    },
    "sourceField": {
      "id": 67890,
      "sourceFieldName": "CONTRACT_NUMBER",
      "sourceFieldNameCaption": "Contract Number",
      "sourceFieldNameDataType": {
        "name": "MASTER_AGREEMENT",
        "captionKey": "enum.SourceTable.field",
        "caption": "MASTER_AGREEMENT"
      },
      "mappingId": 5000001
    }
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Bulk Create Or Update ERP Field Mappings

HTTP Request

PUT /api/v1/erp-field-mapping/createOrUpdate/bulk

Interactive Demo

📋 Description: Updates or creates multiple ERP field mappings in bulk within the Nakisa Lease Accounting Suite, facilitating efficient management of lease, contract, financial obligation, and accounting entry data.

Parameters

Name	In	Type	Required	Description
body	body	ErpFieldMappingDto	false	Request body containing bulk lease and contract field mapping data, including financial obligations and accounting entries, for efficient updates within the Nakisa Lease Accounting Suite.

Body Parameters

[
  {
    "id": 5000001,
    "erpSystem": {
      "id": "string",
      "displayId": "Euro"
    },
    "principalPositionType": {
      "name": "LESSEE",
      "captionKey": "enum.principalpositiontype.lessee",
      "caption": "Lessee"
    },
    "sourceTableName": {
      "name": "MASTER_AGREEMENT",
      "captionKey": "enum.SourceTable.field",
      "caption": "MASTER_AGREEMENT"
    },
    "sourceField": {
      "id": 67890,
      "sourceFieldName": "CONTRACT_NUMBER",
      "sourceFieldNameCaption": "Contract Number",
      "sourceFieldNameDataType": {
        "name": "MASTER_AGREEMENT",
        "captionKey": "enum.SourceTable.field",
        "caption": "MASTER_AGREEMENT"
      },
      "mappingId": 5000001
    }
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	ERP field mappings created or updated successfully	ResponseListErpFieldMappingDto
400	Bad Request	Invalid request body	None
500	Internal Server Error	Internal server error	None

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": []
  },
  "object": [
    {
      "id": 5000001,
      "erpSystem": {
        "id": "string",
        "displayId": "Euro"
      },
      "principalPositionType": {
        "name": "LESSEE",
        "captionKey": "enum.principalpositiontype.lessee",
        "caption": "Lessee"
      },
      "sourceTableName": {
        "name": "MASTER_AGREEMENT",
        "captionKey": "enum.SourceTable.field",
        "caption": "MASTER_AGREEMENT"
      },
      "sourceField": {
        "id": 67890,
        "sourceFieldName": "CONTRACT_NUMBER",
        "sourceFieldNameCaption": "Contract Number",
        "sourceFieldNameDataType": {
          "name": "MASTER_AGREEMENT",
          "captionKey": "enum.SourceTable.field",
          "caption": "MASTER_AGREEMENT"
        },
        "mappingId": 5000001
      }
    }
  ]
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Bulk Update ERP Field Mappings

HTTP Request

PUT /api/v1/erp-field-mapping/bulk

Interactive Demo

📋 Description: Updates multiple ERP field mappings in bulk within the Nakisa Lease Accounting Suite, facilitating the alignment of lease, contract, and financial obligation data for accurate accounting entries.

Parameters

Name	In	Type	Required	Description
body	body	ErpFieldMappingDto	false	Request body containing bulk lease and contract field mapping data, including financial obligations and accounting entries for efficient integration within the Nakisa Lease Accounting Suite.

Body Parameters

[
  {
    "id": 5000001,
    "erpSystem": {
      "id": "string",
      "displayId": "Euro"
    },
    "principalPositionType": {
      "name": "LESSEE",
      "captionKey": "enum.principalpositiontype.lessee",
      "caption": "Lessee"
    },
    "sourceTableName": {
      "name": "MASTER_AGREEMENT",
      "captionKey": "enum.SourceTable.field",
      "caption": "MASTER_AGREEMENT"
    },
    "sourceField": {
      "id": 67890,
      "sourceFieldName": "CONTRACT_NUMBER",
      "sourceFieldNameCaption": "Contract Number",
      "sourceFieldNameDataType": {
        "name": "MASTER_AGREEMENT",
        "captionKey": "enum.SourceTable.field",
        "caption": "MASTER_AGREEMENT"
      },
      "mappingId": 5000001
    }
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	ERP field mappings updated successfully	ResponseListErpFieldMappingDto
400	Bad Request	Invalid request body	None
500	Internal Server Error	Internal server error	None

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": []
  },
  "object": [
    {
      "id": 5000001,
      "erpSystem": {
        "id": "string",
        "displayId": "Euro"
      },
      "principalPositionType": {
        "name": "LESSEE",
        "captionKey": "enum.principalpositiontype.lessee",
        "caption": "Lessee"
      },
      "sourceTableName": {
        "name": "MASTER_AGREEMENT",
        "captionKey": "enum.SourceTable.field",
        "caption": "MASTER_AGREEMENT"
      },
      "sourceField": {
        "id": 67890,
        "sourceFieldName": "CONTRACT_NUMBER",
        "sourceFieldNameCaption": "Contract Number",
        "sourceFieldNameDataType": {
          "name": "MASTER_AGREEMENT",
          "captionKey": "enum.SourceTable.field",
          "caption": "MASTER_AGREEMENT"
        },
        "mappingId": 5000001
      }
    }
  ]
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Search ERP Field Mappings With Filter

HTTP Request

POST /api/v1/erp-field-mapping/search

Interactive Demo

📋 Description: Submits a search request for ERP field mappings related to leases, contracts, financial obligations, and accounting entries, enabling efficient data retrieval and management within the Nakisa Lease Accounting Suite.

Parameters

Name	In	Type	Required	Description
filter	query	ErpFieldMappingDtoFilter	true	Filter criteria for searching ERP field mappings.
page	query	integer	false	Page number (0-indexed)
size	query	integer	false	Number of items per page
sort	query	array[string]	false	Sorting criteria in format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

Default Values

Parameter	Default	Type
page	0	query
size	20	query

Parameter Constraints

Parameter	Constraints
page	Min: 0
size	Min: 1, Max: 100

Responses

Status	Meaning	Description	Schema
200	OK	Successfully retrieved filtered list of ERP field mappings.	PageErpFieldMappingDto

Example Responses

{
  "totalElements": 10000001,
  "totalPages": 100,
  "pageable": {
    "pageNumber": 0,
    "unpaged": false,
    "paged": true,
    "pageSize": 100,
    "offset": 0,
    "sort": {
      "unsorted": false,
      "sorted": true,
      "empty": false
    }
  },
  "numberOfElements": 100,
  "size": 100,
  "content": [],
  "number": 0,
  "sort": {
    "unsorted": false,
    "sorted": true,
    "empty": false
  },
  "first": true,
  "last": false,
  "empty": false
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Get Nla Mapping Fields

HTTP Request

POST /api/v1/erp-field-mapping/mapping-nla-fields

Interactive Demo

📋 Description: Creates a mapping of NLA fields for leases and contracts, facilitating accurate financial obligation tracking and accounting entry integration within the Nakisa Lease Accounting Suite.

Parameters

Name	In	Type	Required	Description
body	body	ErpFieldMappingDto	false	Request body containing the mapping configuration for NLA fields related to lease, contract, financial obligation, and accounting entry data.

Body Parameters

{
  "id": 5000001,
  "erpSystem": {
    "id": "string",
    "displayId": "Euro"
  },
  "principalPositionType": {
    "name": "LESSEE",
    "captionKey": "enum.principalpositiontype.lessee",
    "caption": "Lessee"
  },
  "sourceTableName": {
    "name": "MASTER_AGREEMENT",
    "captionKey": "enum.SourceTable.field",
    "caption": "MASTER_AGREEMENT"
  },
  "sourceField": {
    "id": 67890,
    "sourceFieldName": "CONTRACT_NUMBER",
    "sourceFieldNameCaption": "Contract Number",
    "sourceFieldNameDataType": {
      "name": "MASTER_AGREEMENT",
      "captionKey": "enum.SourceTable.field",
      "caption": "MASTER_AGREEMENT"
    },
    "mappingId": 5000001
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Successfully retrieved NLA mapping fields	Inline
400	Bad Request	Invalid request body	None
500	Internal Server Error	Internal server error	None

Example Responses

[
  {
    "id": 67890,
    "sourceFieldName": "CONTRACT_NUMBER",
    "sourceFieldNameCaption": "Contract Number",
    "sourceFieldNameDataType": {
      "name": "MASTER_AGREEMENT",
      "captionKey": "enum.SourceTable.field",
      "caption": "MASTER_AGREEMENT"
    },
    "mappingId": 5000001
  }
]

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[SourceFieldDto]	false	none	[Data transfer object representing a source field within the Nakisa Lease Accounting Suite, encapsulating essential attributes related to leases, contracts, financial obligations, and accounting entries.]
» id	integer(int64)	false	none	Unique identifier for the resource
» sourceFieldName	string	true	none	Name of the source field
» sourceFieldNameCaption	string	true	none	Caption representing the name of the source field associated with lease, contract, financial obligation, or accounting entry within the Nakisa Lease Accounting Suite.
» sourceFieldNameDataType	SourceTableField	true	none	Represents the Source Field Values.
»» name	string	false	none	Enum name representing the source field.
»» captionKey	string	false	none	Source Field values.
»» caption	string	false	none	Source Field Values.
» mappingId	integer(int64)	false	none	Unique identifier for the mapping

Enumerated Values

Attribute	Value
name	ACTIVATION_GROUP_ACCOUNTING, ACTIVATION_GROUP_CLASSIFICATION, ACTIVATION_GROUP_USER_DEFINED, CHARGE, CONTRACT, CONTRACT_ACCOUNTING, CONTRACT_USER_DEFINED, LEASE_COMPONENT, LEASE_COMPONENT_USER_DEFINED, MASTER_AGREEMENT, MASTER_AGREEMENT_USER_DEFINED, UNIT, UNIT_USER_DEFINED

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Find All ERP Field Mappings

HTTP Request

POST /api/v1/erp-field-mapping/find-all-mappings

Interactive Demo

📋 Description: Fetches all ERP field mappings related to leases, contracts, financial obligations, and accounting entries within the Nakisa Lease Accounting Suite, facilitating streamlined data integration and management.

Parameters

Name	In	Type	Required	Description
body	body	ErpFieldMappingDtoFilter	false	Request body containing the criteria for retrieving all lease, contract, financial obligation, and accounting entry mappings within the Nakisa Lease Accounting Suite.

Body Parameters

{
  "idIn": [
    5000001,
    5000002,
    5000003
  ],
  "idEqual": 5000001,
  "idLike": "5000",
  "createdAtGreaterThanOrEqual": "2024-01-01T00:00:00Z",
  "createdAtLessThanOrEqual": "2024-12-31T23:59:59Z",
  "createdByLike": "john",
  "createdByEqual": "john.doe@example.com",
  "modifiedAtGreaterThanOrEqual": "2024-01-01T00:00:00Z",
  "modifiedAtLessThanOrEqual": "2024-12-31T23:59:59Z",
  "modifiedByLike": "jane",
  "modifiedByEqual": "jane.smith@example.com",
  "erpSystemIdEqual": 1001,
  "erpSystemDisplayIdLike": "SAP",
  "principalPositionTypeEqual": {
    "name": "LESSEE",
    "captionKey": "enum.principalpositiontype.lessee",
    "caption": "Lessee"
  },
  "sourceTableNameEqual": {
    "name": "MASTER_AGREEMENT",
    "captionKey": "enum.SourceTable.field",
    "caption": "MASTER_AGREEMENT"
  },
  "sourceFieldNameCaptionLike": "Contract"
}

Responses

Status	Meaning	Description	Schema
200	OK	Successfully retrieved ERP field mappings	Inline
400	Bad Request	Invalid filter criteria	None
500	Internal Server Error	Internal server error	None

Example Responses

[
  {
    "id": 5000001,
    "erpSystem": {
      "id": "string",
      "displayId": "Euro"
    },
    "principalPositionType": {
      "name": "LESSEE",
      "captionKey": "enum.principalpositiontype.lessee",
      "caption": "Lessee"
    },
    "sourceTableName": {
      "name": "MASTER_AGREEMENT",
      "captionKey": "enum.SourceTable.field",
      "caption": "MASTER_AGREEMENT"
    },
    "sourceField": {
      "id": 67890,
      "sourceFieldName": "CONTRACT_NUMBER",
      "sourceFieldNameCaption": "Contract Number",
      "sourceFieldNameDataType": {
        "name": "MASTER_AGREEMENT",
        "captionKey": "enum.SourceTable.field",
        "caption": "MASTER_AGREEMENT"
      },
      "mappingId": 5000001
    }
  }
]

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[ErpFieldMappingDto]	false	none	[Data transfer object representing the mapping of ERP fields within the Nakisa Lease Accounting Suite, facilitating the integration of lease, contract, financial obligation, and accounting entry data for streamlined financial reporting and compliance.]
» id	integer(int64)	false	none	Unique identifier for the resource
» erpSystem	BaseId	true	none	Data transfer object representing a unique identifier for leases, contracts, and financial obligations within the Nakisa Lease Accounting Suite, facilitating accurate tracking and management of accounting entries.
»» id	string(int64)	false	none	Unique identifier for the resource
»» displayId	string	false	none	Unique identifier for the display
» principalPositionType	PrincipalPositionType	true	none	Represents the type of principal position with localized captions.
»» name	string	false	none	Enum name representing the principal position type.
»» captionKey	string	false	none	Localization key for the principal position type caption.
»» caption	string	false	none	Localized caption of the principal position type.
» sourceTableName	SourceTableField	true	none	Represents the Source Field Values.
»» name	string	false	none	Enum name representing the source field.
»» captionKey	string	false	none	Source Field values.
»» caption	string	false	none	Source Field Values.
» sourceField	SourceFieldDto	true	none	Data transfer object representing a source field within the Nakisa Lease Accounting Suite, encapsulating essential attributes related to leases, contracts, financial obligations, and accounting entries.
»» id	integer(int64)	false	none	Unique identifier for the resource
»» sourceFieldName	string	true	none	Name of the source field
»» sourceFieldNameCaption	string	true	none	Caption representing the name of the source field associated with lease, contract, financial obligation, or accounting entry within the Nakisa Lease Accounting Suite.
»» sourceFieldNameDataType	SourceTableField	true	none	Represents the Source Field Values.
»» mappingId	integer(int64)	false	none	Unique identifier for the mapping

Enumerated Values

Attribute	Value
name	ACTIVATION_GROUP_ACCOUNTING, ACTIVATION_GROUP_CLASSIFICATION, ACTIVATION_GROUP_USER_DEFINED, CHARGE, CONTRACT, CONTRACT_ACCOUNTING, CONTRACT_USER_DEFINED, LEASE_COMPONENT, LEASE_COMPONENT_USER_DEFINED, LESSEE, LESSOR, MASTER_AGREEMENT, MASTER_AGREEMENT_USER_DEFINED, UNIT, UNIT_USER_DEFINED

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Get Custom Reference Mapping Options

HTTP Request

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

Interactive Demo

📋 Description: Creates custom reference mapping options for lease, contract, and financial obligation entries within the Nakisa Lease Accounting Suite, facilitating accurate accounting entries and streamlined data integration.

Parameters

Name	In	Type	Required	Description
body	body	CustomReferenceMappingOptionRequest	false	Request body containing the custom reference mapping options for leases, contracts, and financial obligations to facilitate accurate accounting entry integration.

Body Parameters

{
  "principalPositionType": {
    "name": "LESSEE",
    "captionKey": "enum.principalpositiontype.lessee",
    "caption": "Lessee"
  },
  "erpSystem": {
    "id": "string",
    "displayId": "Euro"
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Successfully retrieved custom reference mapping options	Inline
400	Bad Request	Invalid request body	None
500	Internal Server Error	Internal server error	None

Example Responses

[
  {
    "principalPositionType": {
      "name": "LESSEE",
      "captionKey": "enum.principalpositiontype.lessee",
      "caption": "Lessee"
    },
    "erpSystem": {
      "id": "string",
      "displayId": "Euro"
    },
    "mappingTarget": {
      "name": "LEDGER_TRANSACTION",
      "captionKey": "enum.mappingTargetType.ledgerTransaction",
      "caption": "Ledger Transaction"
    },
    "referenceKey": "LEDGER_TRANS_REF_001",
    "captionKey": "mapping.option.ledger.transaction",
    "caption": "Ledger Transaction Mapping"
  }
]

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[CustomReferenceMappingOption]	false	none	[Data transfer object representing a customizable mapping option for lease-related references within the Nakisa Lease Accounting Suite, facilitating the alignment of contracts, financial obligations, and accounting entries.]
» principalPositionType	PrincipalPositionType	false	none	Represents the type of principal position with localized captions.
»» name	string	false	none	Enum name representing the principal position type.
»» captionKey	string	false	none	Localization key for the principal position type caption.
»» caption	string	false	none	Localized caption of the principal position type.
» erpSystem	BaseId	false	none	Data transfer object representing a unique identifier for leases, contracts, and financial obligations within the Nakisa Lease Accounting Suite, facilitating accurate tracking and management of accounting entries.
»» id	string(int64)	false	none	Unique identifier for the resource
»» displayId	string	false	none	Unique identifier for the display
» mappingTarget	MappingTargetType	false	none	Represents the type of mapping target for ERP field mapping operations.
»» name	string	false	none	Enum name representing the mapping target type.
»» captionKey	string	false	none	Localization key for the mapping target type caption.
»» caption	string	false	none	Localized caption of the mapping target type.
» referenceKey	string	false	none	Unique identifier for mapping custom references related to leases, contracts, and financial obligations within the Nakisa Lease Accounting Suite.
» captionKey	string	false	none	Unique identifier for the caption associated with lease contracts and financial obligations within the Nakisa Lease Accounting Suite.
» caption	string	false	none	Descriptive text associated with a lease or contract, providing context for financial obligations and accounting entries within the Nakisa Lease Accounting Suite.

Enumerated Values

Attribute	Value
name	LEDGER_ENTRY, LEDGER_TRANSACTION, LESSEE, LESSOR

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Get ERP Field Mappings

HTTP Request

GET /api/v1/erp-field-mapping

Interactive Demo

📋 Description: Retrieves the ERP field mapping configurations used for aligning lease and contract data with financial obligations and accounting entries within the Nakisa Lease Accounting Suite.

Parameters

Name	In	Type	Required	Description
page	query	integer	false	Page number (0-indexed)
size	query	integer	false	Number of items per page
sort	query	array[string]	false	Sorting criteria in format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

Default Values

Parameter	Default	Type
page	0	query
size	20	query

Parameter Constraints

Parameter	Constraints
page	Min: 0
size	Min: 1, Max: 100

Responses

Status	Meaning	Description	Schema
200	OK	Successfully retrieved list of ERP field mappings.	PageErpFieldMappingDto

Example Responses

{
  "totalElements": 10000001,
  "totalPages": 100,
  "pageable": {
    "pageNumber": 0,
    "unpaged": false,
    "paged": true,
    "pageSize": 100,
    "offset": 0,
    "sort": {
      "unsorted": false,
      "sorted": true,
      "empty": false
    }
  },
  "numberOfElements": 100,
  "size": 100,
  "content": [],
  "number": 0,
  "sort": {
    "unsorted": false,
    "sorted": true,
    "empty": false
  },
  "first": true,
  "last": false,
  "empty": false
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Get Nla Mapping Tables

HTTP Request

GET /api/v1/erp-field-mapping/mapping-nla-tables

Interactive Demo

📋 Description: Retrieves the mapping of NLA tables related to lease, contract, financial obligation, and accounting entry within the Nakisa Lease Accounting Suite, facilitating seamless data integration and management.

Responses

Status	Meaning	Description	Schema
200	OK	Successfully retrieved NLA mapping tables	Inline
500	Internal Server Error	Internal server error	None

Example Responses

[
  {
    "name": "MASTER_AGREEMENT",
    "captionKey": "enum.SourceTable.field",
    "caption": "MASTER_AGREEMENT"
  }
]

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[SourceTableField]	false	none	[Represents the Source Field Values.]
» name	string	false	none	Enum name representing the source field.
» captionKey	string	false	none	Source Field values.
» caption	string	false	none	Source Field Values.

Enumerated Values

Attribute	Value
name	ACTIVATION_GROUP_ACCOUNTING, ACTIVATION_GROUP_CLASSIFICATION, ACTIVATION_GROUP_USER_DEFINED, CHARGE, CONTRACT, CONTRACT_ACCOUNTING, CONTRACT_USER_DEFINED, LEASE_COMPONENT, LEASE_COMPONENT_USER_DEFINED, MASTER_AGREEMENT, MASTER_AGREEMENT_USER_DEFINED, UNIT, UNIT_USER_DEFINED

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Delete ERP Field Mappings

HTTP Request

DELETE /api/v1/erp-field-mapping/delete

Interactive Demo

📋 Description: Deletes specified ERP field mappings within the Nakisa Lease Accounting Suite, ensuring the accurate management of lease, contract, and financial obligation data in accounting entries.

Parameters

Name	In	Type	Required	Description
body	body	ErpFieldMappingDto	false	Request body containing the identifiers for the lease, contract, or financial obligation to be deleted from the accounting entries in the Nakisa Lease Accounting Suite.

Body Parameters

[
  {
    "id": 5000001,
    "erpSystem": {
      "id": "string",
      "displayId": "Euro"
    },
    "principalPositionType": {
      "name": "LESSEE",
      "captionKey": "enum.principalpositiontype.lessee",
      "caption": "Lessee"
    },
    "sourceTableName": {
      "name": "MASTER_AGREEMENT",
      "captionKey": "enum.SourceTable.field",
      "caption": "MASTER_AGREEMENT"
    },
    "sourceField": {
      "id": 67890,
      "sourceFieldName": "CONTRACT_NUMBER",
      "sourceFieldNameCaption": "Contract Number",
      "sourceFieldNameDataType": {
        "name": "MASTER_AGREEMENT",
        "captionKey": "enum.SourceTable.field",
        "caption": "MASTER_AGREEMENT"
      },
      "mappingId": 5000001
    }
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	ERP field mappings deleted successfully	ResponseVoid
400	Bad Request	Invalid request body	None
404	Not Found	One or more ERP field mappings not found	None
500	Internal Server Error	Internal server error	None

Example Responses

{
  "code": "OK",
  "errors": {
    "all": []
  },
  "object": {}
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

---