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. Methods
getSummariesForPriceBookglobal 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);
loadglobal 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 |