CAM XP API
home
SFDC - CAM Bi-directional Integration API
The key features of this API are:
| Feature | Description |
|---|---|
| Search | This feature can be used for identification of client doublets. Therefore, the complete client address can be used or only some parts, like a view characters from the company name and country. Providing more information (e. g. zip code) can occur in a better / smaller result. Additional you can provide information like VAT ID for a very precise result. During lead processing UTA wants to check if a client is already known, maybe it is already a customer (of UTA or of its partners). Therefore, the repository of CAM is checked. |
| CAM account management | This set of features can be used for:
|
| CAM account credit check management | This set of features can be used for:
A needed limit (in €) has to be send with to CAM (beside CAM id). In case of delayed results a corresponding return code (partially_succeeded) will be returned. In this case CAM will call (asynchronous) the method by UTA (/accounts/{cam_id}/credit-check/{request_ref}) to transfer the decission of UTA finance department. Highlights: Using the attribute increase_securities the finance security has to be steered. Security handling will done in finance department only (not any longer with major support from Sales like before). For this reason the process of credit check needs from the outside (sales) the decision if finance department should start with increasing the security processing or not if the credit check can only be answered positively if the securities would be increased. Using the attribute ceiling-amount customers can limit themself by defining a maximum amount. CAM will not go over this ceiling amount for the credit limit - even if other parameters would allow it. Sales has to take care if the ceiling amount is lower than the already confirmed credit limit - CAM will lower the credit limit to fulfill the customers request. Use case Credit check about 5.000,- € is requested Case A (false): In this case CAM will answer the request without starting any security increasing process. Case B (true): In this case CAM will answer the request with starting (if required) the security increasing process. In case of starting the increasing process, UTA finance department will contact the customer by its own to discuss, negotiate, extend the securities with the (potential) customers directly. In both cases CAM will inform UTA update the progress, only exception is the credit check can be answered directly. |
| CAM partner account management | This set of features can be used for:
|
| CAM account address update | CAM will call the method by UTA (/accounts/{cam_id}/address) to transfer the updated and progressed legal address change for an CAM account. When CAM is calling this method, all prerequisites are fulfilled like rewriting of documents, |
| CAM account credit check management | CAM will call the method by UTA (/accounts/{cam_id}/credit-check/{request_ref}) to transfer the decision of UTA finance department. This method must provide an request_reference which has been provided to PSG before. |
| CAM account credit limit management | CAM will call the method by UTA (/accounts/{cam_id}/credit-limit) to transfer the new calculated credit limit. |
| CAM account payment experiences management | UTA agency TIMEX (SAXO) will call the method (/accounts/{invoice_partner_ref}/transaction/{transaction_ref}) to insert / update payment experiences. |
What are accounts and partner accounts?
Accounts are a synonym for UTA direct sales clients. UTA takes the risks for this clients, for this reason UTA finance department is responsible for the approval of a customer application as well as the management of the credit limit.
To fulfill this a real CAM file is needed, so all by CAM system provided features can be used with this accounts.
Partner accounts are a synonym for clients from UTA partners, for this scenario UTA has different synonyms: third party, agency and more. UTA does not take the risk for this clients, it is covered by the partners. For partner accounts no real CAM fileis created. For partner accounts no CAM file should be created (decission by finance department). Partner accounts should be used at the time of definition for mercedes workshop customers and for agency customers. To fulfill the requirement that these clients are integrated in the result of the double check by CAM, CAM stores these partner accounts in a separate database which does not provide a CAM ID.
What is the CAM ID and Parent CAM ID?
The CAM ID is the unique (technical) identifier for a CAM file. Partner accounts does nothave a CAM ID.
The Parent CAM ID can be used to build a hierarchy in CAM.
Therefore, the CAM ID of the main CAM file of a company is stored in the Parent CAM ID of the sub CAM files.
| CAM ID | Parent CAM ID | Description |
|---|---|---|
| 1 | 1 | Head quarter of sample enterprises |
| 2 | 1 | Subsidiary of sample enterprises in Paris |
| 3 | 1 | Subsidiary of sample enterprises in Hong Kong |
| 4 | 1 | Subsidiary of sample enterprises in New York |
Usage of Parent CAM ID will be defined by UTA finance department.
Business rules
* For each client (lead or customer) an own CAM account or CAM partner account has to be created. If a client has an own complex company structure, e. g. with different subsidiaries, for each lead / customer an own CAM account or CAM partner account has to be created. During the conversion from lead to customer the CAM ID is not changed, only the new status (lead => customer) is transferred to CAM. CAM accounts can be linked using the Parent CAM ID.
Technical rules
* UTA backend systems can handle only charset latin 1 /ISO-8859-1. Therefore, the request from UTA to PSG for creation of an account or partner account will only contain characters out of these charsets.If unsupported characters are provided by search method from CAM, the user has to adjust these to the supported characters.