Billing Central Apex API Developer Reference
|
|
Billing Central Apex API Developer Reference
|
ffbc.ProductsServiceglobal with sharing class ProductsService This class provides service functionality for the Product standard object. This class contains deprecated items. DeprecatedThe following items are deprecated and not supported for use. We recommend that you stop using these items to avoid exceptions. Methods
getSummariesForPriceBookDeprecated: This method has been deprecated. Use a standard Salesforce query instead. global static List<ffbc.ProductsService.ProductSummary> getSummariesForPriceBook(ffbc.ProductsService.ProductSummaryRequest request) Queries all active products for their ID, name and pricing information for the price book and currency provided. This may optionally be further filtered using a collection of ffbc__Filter__mdt records - see the documentation on the request for more details. Input Parameters
Return ValueThe list of product summaries. Sample Code
//Note: This sample code is for demonstration purposes only. It is not intended for
//use in a production environment, is not guaranteed against defects or errors, and
//is in no way optimized or streamlined.
/**
* This sample shows an example of using the ffbc.ProductsService.getSummariesForPriceBook method to retrieve
* product summaries as would be shown on the Billing Central Enhanced UIs.
*/
Id pricebookId;
ffbc.ProductsService.ProductSummaryRequest request = new ffbc.ProductsService.ProductSummaryRequest('USD', pricebookId);
request.WithPricingStructures = true;
request.FilterPurpose = 'Enhanced UI Add Product Drop-Down';
return ffbc.ProductsService.getSummariesForPriceBook(request);
loadDeprecated: This method has been deprecated. Use a standard Salesforce query instead. global static List<ffbc.ProductsService.Product> load(Set<Id> productIds) Queries products with the IDs provided, including fields that are related to Billing Central. Input Parameters
Return ValueThe list of products. ffbc.ProductsService.Productglobal with sharing class Product This class models a product, including fields that are related to creating and editing Billing Central object types. Properties
ffbc.ProductsService.ProductSummaryglobal with sharing class ProductSummary This class models a product, including the ID, name, unit price, and pricing structure for a specific price book and currency. Properties
ffbc.ProductsService.PricingStructureSummaryglobal with sharing class PricingStructureSummary This class is a wrapper for summarised pricing structure information. Properties
ffbc.ProductsService.ProductSummaryRequestglobal with sharing class ProductSummaryRequest This class provides the parameters that determine the product summary information to be retrieved. Properties
Methods |