Salesforce Billing Developer Guide

Salesforce Billing Fields on Standard Objects
Salesforce Billing Custom Objects
Salesforce Billing Standard Objects
Salesforce Billing Developer Guides & Lightning Components
Salesforce Billing Payment Gateway Developer Guide
Salesforce Billing Tax Integration Developer Guide
Get Started With Tax Integration API
Tax Integration Core Classes
TaxParameters Class
TaxResults Class
TaxEngines Interface
TaxEngines Methods
Revenue Recognition Service Developer Guide
Hosted Card Payments Lightning Component
REST API for Converting Invoice Lines with Negative Balances
Set Up Standalone Orders with API
Salesforce Billing Apex Reference
PDF

Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

TaxEngines Interface

Your tax engine implements this interface. It contains methods for calculating tax, clearing in-memory entities from the previous call, and clearing legal references from the previous call.

Namespace

blng

TaxEngines Methods

Learn more about the methods available with the TaxEngines interface.

The TaxEngines interface includes these methods.

resetSObjectListofIds()

Sets the in-memory IDs, such as credit note IDs, debit note IDs, to null.

Signature

global static Void resetSObjectListofIds()

Return Value

Type: Void

resetLegalEntityReferences()

Sets the in-memory list of legal entities to null.

Signature

global static Void resetLegalEntityReferences()

Return Value

Type: Void

calculateTax(taxParametersInstance)

Returns the calculated tax for the specified taxParametersInstance parameter.

Signature

global static Map<Id,TaxResults> calculateTax(TaxParameters taxParametersInstance)

Parameters

taxParametersInstance
Type: TaxParameters

The taxParametersInstance parameter is populated based on the process that uses tax calculation. These examples show the sample values for each process.

Order is created
1TaxParameters:[
2 isCommitOnGetTax=false,
3 isStandardFromBatch=false,
4 legalEntityReference=80105000000i1MqAAI,
5 listOfSObjectIds=(),
6 listOfSObjects=(),
7 mapOfSObjectByUniqueId={},
8 mapOfTaxResultsById={},
9 mapOfTaxTreatmentById={},
10 sObjectId=null,
11 sObjectTypeInstance=OrderItem,
12 sobjectInstance=null,
13 taxMethod=null
14]
Bill Now or Invoice is created
1TaxParameters:[
2 isCommitOnGetTax=false,
3 isStandardFromBatch=false,
4 legalEntityReference=a2305000000BKIoAAO,
5 listOfSObjectIds=(),
6 listOfSObjects=(),
7 mapOfSObjectByUniqueId={},
8 mapOfTaxResultsById={},
9 mapOfTaxTreatmentById={},
10 sObjectId=null,
11 sObjectTypeInstance=blng__InvoiceLine__c,
12 sobjectInstance=null,
13 taxMethod=null
14]
Invoice is manually posted
1TaxParameters:[
2isCommitOnGetTax=false,
3 isStandardFromBatch=false,
4 legalEntityReference=null,
5 listOfSObjectIds=(a2305000000BKIoAAO),
6 listOfSObjects=(),
7 mapOfSObjectByUniqueId={},
8 mapOfTaxResultsById={},
9 mapOfTaxTreatmentById={},
10 sObjectId=null,
11 sObjectTypeInstance=blng__Invoice__c,
12 sobjectInstance=null,
13 taxMethod=postTax
14]

Return Value

Type: Map<Id,TaxResults>