High- Level Specification

Functional Overview

Syniti which is the source of Currency Conversion Master Data SAP ECC, the source system for currency conversion master data, will be integrated with Icertis to create and update currency exchange masterdata master data records in Icertis a custom Currency Exchange masterdata table using Master Data table within Icertis.

This integration will be executed via SAP CPI, which will invoke the Icertis Business API to perform bulk upsert operations.

The exchange rates maintained in Icertis will be used to convert

local

currency values into Euros

in

agreements.

Records will be created

or updated

daily in Icertis. The objective of this FS is to create Currency Exchange Masterdata in Icertis so that the currency exchange rates can be maintained.

Scope and Objectives

Functional Scope:

This interface facilitates the monthly integration of currency exchange rates from Syniti into Icertis Contract Intelligence (ICI) to support accurate financial calculations and DOA (Delegation of Authority) logic in contractsdocument outlines the functional configuration required in Icertis to support the creation and maintenance of currency exchange master data sourced from SAP ECC.

Scope Includes:

1. Source System:

   • Syniti as the master source for currency exchange rates.

2. Target System:

   • Icertis, with a custom Currency Exchange Master Data table.

3. Integration Mechanism:

   • Syniti will call Icertis Business API used for bulk creation and update of masterdata records.

4. Data Elements Transferred:

   • Source Currency
   • Target Currency (EUR)
   • Exchange Rate
   • Effective Date (last day of previous month)
   • Rate Source (Syniti)
   • Timestamp of update

5. Frequency:

   • Monthly, preferably on the 1st of each month.

6. Operation Type:

   • Bulk Upsert (create new or update existing records).

7. Usage in Icertis:

   • Used to convert local currency values to Euros.
   • Enables correct DOA approver identification based on Euro thresholds.

1. Creation and update of currency exchange master data in Icertis.
2. Daily update of exchange rates.

Functional Objectives:

1. Ensure Accurate Currency Conversion

   • Maintain up-to-date exchange rates for converting local values to Euros in contracts.

2. Support DOA Logic in Agreements

   • Enable automated identification of approvers based on Euro-converted contract values.

3. Maintain Data Integrity

   • Prevent outdated or duplicate exchange rate records.
   • Ensure historical accuracy by using the rate from the last day of the previous month.

4. Enable Auditability and Traceability

   • Ensure all exchange rate records are timestamped and sourced for compliance and audit purposes. In Icertis when the masterdatas record is created, system automatically generates the Modified Date and time stamp as displayed belowImage Added

5. Minimize Manual Intervention

   • Automate the monthly daily currency exchange masterdata update process to reduce errors and improve efficiency.

Out of Scope:

1. Deletion of any existing currency exchange masterdata record
2. De-activating any existing currency exchange masterdata record

API Information

Get bulk api prepare for masterdata

POST/v{version}/bulk/masterdata/prepare

Sample Request

POST/{{baseUrl}}/{{version}}/bulk/masterdata/prepare

{

"Data": {

"ContractTypeName": "ICMOtherPartyMaster",

"SelectedAttributes": []

}

}

Create or update masterdata records in Bulk

POST/v{version}/bulk/masterdata

Process Flow Diagram

Process Flow Diagram

Image Removed

Assumptions

• Syniti will provide validated and complete exchange rate data for all required currency pairs.
• The exchange rate for the last day of the previous month will be available in Syniti by the 1st of the current month.
• Icertis Business API will support bulk upsert operations without performance degradation.
• The Icertis custom Currency Exchange master table is already configured and accessible via API.
• Exchange rates will be used only for DOA logic and not for financial reporting or invoicing.
• No real-time updates are required; monthly sync is sufficient.
• Error handling and logging will be managed by the middleware or integration layer.
• The integration will be triggered by a scheduled job or batch process on the 1st of each month.

Dependencies

• Syniti Data Availability: Exchange rate data must be finalized and accessible by the 1st of each month.
• Icertis API Availability: Business API must be operational and accessible during the integration window.
• Middleware/ETL Tool: A tool or service must be in place to extract data from Syniti and push it to Icertis.
• Authentication Setup: Secure tokens or credentials must be configured for API access.
• Schedule Dependency: This interface must run after Syniti’s daily currency update job completes.
• Team Coordination: Dependencies on Syniti data team and Icertis integration team for support and monitoring.

Security, Integrity and Controls

• Authentication: API access to Icertis must use secure OAuth tokens or API keys.
• Authorization: Only designated integration service accounts should have write access to the Currency Exchange master table.
• Encryption: Data in transit must be encrypted using HTTPS/TLS.
• Audit Logging: All API calls and data changes must be logged for audit purposes.
• Data Validation: Exchange rates must be validated for completeness and correctness before pushing to Icertis.

Configuration Requirements

Assumptions

• Not Applicable.

Dependencies

• Not Applicable.

Security, Integrity and Controls

• Authentication: Access to Create Masterdata Contract Type (CT)
• A new security group to be created for the Integration Users with manage access to Currency Exchange Master CT. The new security group title will be "Integration User"

Configuration Requirements

• Configure Currency Exchange Masterdata CT in Icertis with below details:

Following Technical Configuration is required to enable integration between CPI & Icertis using ICI Business API

• OAuth Setup

  • Microsoft Identity Platform
    • Register application in Microsoft Identity Platform
    • Capture the following details from IDP     

• • • Redirect URI to be configured - https://syensqo-dev.icertis.com 
    • Implicit Grant: Access Tokens

  • Icertis Side Configuration

    • Configure new masterdata CT in Icertis to store currency exchange rates 
    • Create an Integration User (CPI Integration User) in Icertis with Admin access.
    • Create Security Group "Integration User" with Manage access to Currency Exchange Rate CT.
    • Configure the following OAuth keys in Icertis json file:

Special Requirements

• Localization: Ensure currency formats comply with regional standards (e.g., decimal separators).

Design Rationale

This interface is designed as an API consumer. Icertis will consume data from Syniti via a scheduled integration that uses the Icertis Business API to create or update currency exchange master data records.

The API will be used to:

• Push monthly exchange rates from Syniti to Icertis.
• Ensure that the latest rates are available for contract value conversion and DOA logic.

API Use

• Type: API Consumer
• System Consuming API: Icertis
• System Providing API: Syniti (or middleware extracting from Syniti)

Create a currency exchange rate master data CT in Icertis which will store the currency exchange rates

Data Structure

The following fields will be

configured in Icertis to provide the required data structure of the interface:

Calculation and Validation

API Fields Mapping:

Calculation and Validation

Not Applicable

Processing Logic

• • The integration job runs
on the 1st of each month
• • daily.
• It fetches exchange rates from Syniti for the last day of the previous month.
• The data is transformed into the required format and pushed to Icertis via the Business API.
• The API performs bulk upsert: updates existing records or creates new ones.
• Errors are logged and flagged for manual review.
• • Currency Conversion rates are pushed from a system interface to Icertis via CPI.

Delta or Full Load Requirements

• • Full Load:
    • The interface always pushes the complete set of exchange rates for all supported currencies, for a given date. This does not process historical data. 
    • No delta tracking is required since the data is refreshed
monthly
• • • daily.

Interface Alert & Monitoring

• Alerts should be configured for:
  • API failures
  • Missing or incomplete data
  • Validation errors
• Monitoring tools (middleware logs) should notify:
  • Integration support team
  • Business users (email)
Retry logic should be in place for transient failures.
• • Not Applicable as this FS objective is to create a masterdata CT in Icertis

Language Requirements

• • No multilingual support required for exchange rate data.
  • All fields are numeric or standard ISO codes.

User Interface Requirements

Not Applicable

Volumetrics

• See the appendix for the list of Currencies which needs to be converted to Euros

Performance Consideration

Scheduling and Execution Window

• The integration job should be scheduled during off-peak hours (e.g., early morning on the 1st of each month) daily to avoid contention with other system processes.

Error Handling

Validation Errors

• Cause: Missing mandatory fields, invalid currency codes, negative exchange rates.
• Handling:
  • Reject the record.
  • Log the error with detailed message.
  • Notify integration support team via email or dashboard.
  • Continue processing remaining records.

2. API Failures

• Cause: Icertis Business API is unavailable, authentication failure, timeout.
• Handling:
  • Retry up to 3 times with exponential backoff.
  • If retries fail, log the failure and raise an alert.
  • Notify support team with error code and timestamp.

3. Data Load Failures

• Cause: Payload formatting issues, bulk upsert failure.
• Handling:
  • Validate payload structure before submission.
  • Use staging logs to identify failed records.
  • Allow manual reprocessing of failed records.

4. Partial Success

• Cause: Some records succeed, others fail due to validation or API issues.
• Handling:
  • Log both successful and failed records.
  • Generate a summary report for review.
  • Provide reprocessing option for failed records.

5. Missing Data from Syniti

• Cause: Exchange rate data not available on schedule.
• Handling:
  • Alert business users and integration team.
  • Optionally use previous month’s rates (if approved by business).
  • Flag contracts that rely on missing data for manual review.

6. Monitoring and Alerts

• Tools: Integration monitoring dashboard, email notifications, log files.
• Recipients: Integration support team, business operations team.
• Alert Types:
  • Job success/failure
  • Record-level validation errors
  • API connectivity issues
  • Missing or delayed data

• The priority of the jobs will be decided based on the other jobs mentioned in the list DD-TEC-130 R2 Batch Jobs Register and Schedule

Error Handling

Not Applicable

Testing

Testing

Test Conditions and Expected Results

Test Considerations/Dependencies

Not Applicable

Other Information

Not Applicable

Development Details

Package

Other Development Objects

Appendix

Sample payload:

{

  "Messages": null,

  "Data": {

    "ContractTypeName": "ICMCurrencyExchangeRate",

    "JobItems": [

      {

        "NextState": "",

        "RequestIdentifier": 1,

        "EndpointVersion": null,

        "UseExternalId": true,

        "SysId": "5449222c-3d3a-4044-baae-a17165381ed1",

        "RequestBody": {

          "ICMUniqueName": "AUD:EUR",

          "Name": "Masterdata_1_created",

          "ICMFromCurrency": "AUD",

          "ICMAgreementCode": "ICMCurrencyExchangeRate_19",

          "ICMToCurrency": "EUR",

           "ICMRate": "0.59",

          }

        },

        "TemplateSelection": "none",

        "EndPointVersion": 3

      },

      {

        "NextState": "",

        "RequestIdentifier": 2,

        "EndpointVersion": null,

        "UseExternalId": false,

        "SysId": "96c08d87-3c89-4b7d-b075-e360bb41db07",

        "RequestBody": {

         "ICMUniqueName": "INR:EUR",

          "Name": "Masterdata_2_created",

          "ICMFromCurrency": "INR",

          "ICMAgreementCode": "ICMCurrencyExchangeRate_20",

          "ICMToCurrency": "EUR",

           "ICMRate": "0.0099",

          }

        },

        "TemplateSelection": "none",

        "EndPointVersion": 3

      }

    ]

  },

  "HasMoreData": false,

  "PagingData": null

}

See also

Change log