Skip to Content
Technical Articles
Author's profile photo Yogananda Muthaiah

APM(ProducerPro) API Sync to SAP Commissions – Part 1

Dear Readers,

The purpose of this article is to demonstrate and explain how Integration between Agent Performance Management(Producer Pro) to SAP Commissions is through Sync process which syncs the Producer related data to Commissions via the Commissions API(Rest API v2) with Auto scheduler.


Note ⚠️ :The process is a one way sync from APM to Commissions and not from Commissions to APM.

Part 1 : Enable Sync and Setup API endpoints for Commission Sync


  • ⚙️ APM Admin user should enable Sync Option and Configuration Settings
  • ⚙️ SAP Commission User must have Admin role to setup Sync (Assign Role)
  • ⚙️ RestAPI role should be assigned to user created from Commission – User Administration
  • ⚙️ APM to Commissions Sync must be enabled in the Global Features section in Producer Manager
  • ⚙️ In Channel Management,  Objects in Contract Type, Status Code should be created       through RestAPI endpoints.

How to enable Sync ?

Before you can get started you need to ensure the Producer Manager to Commissions Sync has been enabled.

Go to Administrator > Configuration > Global Features

Enable checkbox for Sync


Click Save to complete the enabling process and you will see it later with Sync

Setup Sync (API Endpoint Configuration )

Navigate to Administrator → Sync → Sync Target Search. Click + to create a new Sync Target.

New form will be displayed to fill out the following fields:

SyncTargetId: <ANY thing you can enter>
SyncTargetName: <ANY Name to identify the running process >
SyncTargetType:  Commissions
RetryAttempts: Defaults to 0. The value 0 indicates the sync will only try to sync an audit record once with no retries on failure. Indicate a value greater than 0 if you want Producer Manager Sync to retry a failed sync record for a specific number of retries.
SyncTargetAuthEndPoint: The authentication endpoint URL for the Commissions region.
SyncTargetEndPoint: The end point URL for the Commissions region.
SyncTargetUserId: The Commissions API endpoint UserID
SyncTargetPwd: The Commissions API endpoint password.
SyncTargetAuthUserId: The Commissions Auth end point UserID.
SyncTargetAuthPwd: The Commissions Auth endpoint password
ReferenceRetryAttempts: -1 is the default value which means the process will indefinitely try to resync the reference failures until something is syncing newly. If the user wants to restrict the number of retries, they can specify the value here


The Sync Target Detail has two sets of servers that you need to fill out



The fields SyncTargetUserId & SyncTargetAuth UserId may have different values based upon how the server is setup.

The value of SyncTargetEntity.SyncTargetEntity should be the name of the API end point as defined in the Commissions API documentation

Once the required details above have been entered, click Save button. Once the form has been saved, click the Test button. This will validate that the detail entered are correct. If the test connection fails troubleshoot that the end point URLs are correct and that the UserID’s and passwords are correct.

 Coming Next – Part 2 

? Thank you for reading!. I feel much better. It’s good to be liked. (Hit Like Button). you can also share this blog through LinkedIn or twitter.

Assigned Tags

      You must be Logged on to comment or reply to a post.
      Author's profile photo Kimberly Manzano
      Kimberly Manzano

      Hi Yogananda Muthaiah ,


      I would like to ask if this SAP Commissions API is related to SAP ICM Software (CallidusCloud ICM)?

      Author's profile photo Yogananda Muthaiah
      Yogananda Muthaiah
      Blog Post Author


      This is related to ProducerPro of CallidusCloud Product and after SAP was acquired - It was renamed to Agent Performance Management(APM).  SAP Commissions API will be used integration.

      Also, CallidusCloud Product has Insurance Compensation Management (ICM) and SAP has the same product Name ICM.

      Author's profile photo Kimberly Manzano
      Kimberly Manzano

      Hi Yogananda Muthaiah ,


      Thank you for responding on my concern.

      Actually, I've been doing some research related on that SAP APM -  CallidusCloud Insurance Incentive Compensation Management.. and seem to can't find enough documents to refer.

      Thank you very much for the answer!

      Author's profile photo Yogananda Muthaiah
      Yogananda Muthaiah
      Blog Post Author


      Can I know what kind of information are you looking for ?  I can share more links if that matches my list ..

      Author's profile photo Kimberly Manzano
      Kimberly Manzano

      Hi Yogananda Muthaiah ,

      I'm trying to look on how to configure SAP APM with CallidusCloud Insurance ICM.. from end to end process.


      The only reference I got is the videos from this list but what I'm trying to find is a demo process on how to configure the SAP APM just like how we configure SAP Sales Cloud Commissions on getting their incentives and commission amount.

      I apologized on my way of explaining. I'm new to SAP still learning..

      Author's profile photo Kimberly Manzano
      Kimberly Manzano

      I'm new with SAP so I'm having a hard time to explain it properly. I apologize