Billing Central Apex API Developer Reference
|
|
Billing Central Apex API Developer Reference
|
ffbc.IntegrationSetupServiceglobal with sharing class IntegrationSetupService This class provides service functionality for the configuration of integrations to Salesforce standard objects. Currently this supports an integration of the Salesforce CPQ Order to Billing Central Contract. EnumsContractActionAn enum representing the standard types of order that can be used to create Contracts.
Methods
applyCPQglobal static ffbc.IntegrationSetupService.ApplyAsyncState applyCPQ(ffbc.IntegrationSetupService.ApplyAsyncState applyState, ffbc.IntegrationSetupService.CPQConfiguration configuration) Enable Salesforce CPQ integration by applying the passed configuration. This method should be called repeatedly from separate execution contexts which have not performed any DML operations until it returns null. On the first invocation pass null as applyState and subsequent calls pass the return value from the last call. You may inspect the state for error and progress messages. Once an error has been indicated subsequent calls of applyCPQ will not perform any operations. Input Parameters
Return ValueAsynchronous call state, will return null when complete. initCPQglobal static ffbc.IntegrationSetupService.InitAsyncState initCPQ(ffbc.IntegrationSetupService.InitAsyncState initState) Initialise CPQ integration by performing required configuration actions. This method should be called repeatedly from separate execution contexts which have not performed any DML operations until it returns null. On the first invocation pass null as initState and subsequent calls pass the return value from the last call. You may inspect the state for error and progress messages. Once an error has been indicated subsequent calls of initCPQ will not perform any operations. Input Parameters
Return ValueAsynchronous call state, will return null when complete. loadCPQglobal static ffbc.IntegrationSetupService.CPQConfiguration loadCPQ() Load the current Salesforce CPQ configuration integration information. Integration initialisation must have been completed via initCPQ() before calling this. Return ValueThe integration configuration. getPicklistValuesglobal static List<Schema.PicklistEntry> getPicklistValues(String contextObject, String expression) Get picklist values for a field identified via an expression Input Parameters
Return ValueList of picklist values or empty list if expression does not identify a picklist field. validateSourceExpressionglobal static List<String> validateSourceExpression(String contextObject, String expression) Validate that an expression uniquely identifies a single field. Input Parameters
Return ValueList of errors relating to the expression, an empty list if valid or null if contextObject does not exist. ffbc.IntegrationSetupService.ApplyAsyncStateglobal with sharing class ApplyAsyncState Base class for state passed into a returned from applyCPQ function. Properties
MethodsApplyAsyncStateglobal ApplyAsyncState() ffbc.IntegrationSetupService.ContractActionInfoglobal with sharing class ContractActionInfo A container for additional information on a ContractAction Properties
Methods
ContractActionInfoglobal ContractActionInfo() ContractActionInfoglobal ContractActionInfo(ffbc.IntegrationSetupService.ContractAction action, String label, String factiveLabel, String opportunityTypeValue) ffbc.IntegrationSetupService.CPQConfigurationglobal with sharing class CPQConfiguration This class contains integration configuration information. You can read this information using loadCPQ. To make changes use applyCPQ with updated OrderActions, HeaderMappings and LineItemMappings; other fields are ignored by applyCPQ. Properties
MethodsCPQConfigurationglobal CPQConfiguration() ffbc.IntegrationSetupService.FieldMappingglobal with sharing class FieldMapping Detail of a mapping between Order and Contract fields. The same structure is used to store both 'header' and 'lines' mappings. For lines the mapping is assumed between OrderItem and ContractLineItem sObjects. Properties
MethodsFieldMappingglobal FieldMapping() ffbc.IntegrationSetupService.FieldNameglobal with sharing class FieldName implements Comparable Wrapper for a field APIName with its Label. Properties
MethodsFieldNameglobal FieldName() FieldNameglobal FieldName(Schema.SObjectType objectType, Schema.SObjectField field) ffbc.IntegrationSetupService.InitAsyncStateglobal with sharing class InitAsyncState Class for state passed into and returned from initCPQ function. Properties
MethodsInitAsyncStateglobal InitAsyncState() ffbc.IntegrationSetupService.OrderActionglobal with sharing class OrderAction Holds the contract action to be performed for a given value of the Order trigger field. Properties
Methods
OrderActionglobal OrderAction() OrderActionglobal OrderAction(String orderTriggerValue, ffbc.IntegrationSetupService.ContractAction contractAction) |