Revenue Cloud Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Get Started with Revenue Cloud Developer Resources
Product Catalog Management
Salesforce Pricing
Product Configurator
Transaction Management
Quote and Order Capture
Quote and Order Capture Standard Objects
Quote and Order Capture Fields on Standard Objects
Quote and Order Capture Tooling API Objects
Quote and Order Capture Platform Event
Quote and Order Capture Business APIs
Quote and Order Capture Apex Reference
CommerceOrders Namespace
CommerceTax Namespace
AbstractTransactionResponse Class
AddressesResponse Class
AddressResponse Class
AmountDetailsResponse Class
CalculateTaxRequest Class
CalculateTaxResponse Class
CalculateTaxType Enum
ErrorResponse Class
HeaderTaxAddressesRequest Class
ImpositionResponse Class
JurisdictionResponse Class
LineItemResponse Class
LineTaxAddressesRequest Class
RequestType Enum
ResultCode Enum
RuleDetailsResponse Class
TaxAddressesRequest Class
TaxAddressRequest Class
TaxApiException Class
TaxCustomerDetailsRequest Class
TaxDetailsResponse Class
TaxEngineAdapter Interface
TaxEngineContext Class
TaxEngineContext Constructors
TaxEngineContext Methods
TaxLineItemRequest Class
TaxSellerDetailsRequest Class
TaxTransactionRequest Class
TaxTransactionStatus Enum
TaxTransactionType Enum
PlaceQuote Namespace
RevSalesTrxn Namespace
Quote and Order Capture Standard Invocable Actions
Quote and Order Capture Metadata API Types
Asset Lifecycle
Usage Management
Rate Management
Dynamic Revenue Orchestrator
Billing
Revenue Cloud Associated Objects
PDF

TaxEngineContext Class

Wrapper class that stores details about the type of a tax calculation request.

Namespace

CommerceTax

Example

At the beginning of a tax adapter, use TaxEngineContext class to pass the value of a request type to an instance of RequestType.

global virtual class MockAdapter implements commercetax.TaxEngineAdapter {
 
     global commercetax.TaxEngineResponse processRequest(commercetax.TaxEngineContext taxEngineContext) {
         commercetax.RequestType requestType = taxEngineContext.getRequestType();
         commercetax.CalculateTaxRequest request = (commercetax.CalculateTaxRequest)taxEngineContext.getRequest();

Build the rest of your adapter based on the type of request that you got from TaxEngineContext class.

if(requestType == commercetax.RequestType.CalculateTax){
             commercetax.calculatetaxtype type = request.taxtype;
             String docCode='';
             if(request.DocumentCode == 'simulateEmptyDocumentCode')
                 docCode = '';
             else if(request.DocumentCode != null)
                 docCode =request.DocumentCode;
             else if(request.ReferenceEntityId != null) docCode = request.ReferenceEntityId;
             else docCode =  String.valueOf(getRandomInteger(0,2147483647));
             commercetax.CalculateTaxResponse response = new commercetax.CalculateTaxResponse();
             if(request.isCommit == true) {
                 response.setStatus(commercetax.TaxTransactionStatus.Committed);
             } else {
                 response.setStatus(commercetax.TaxTransactionStatus.Uncommitted);
             }
}

TaxEngineContext Constructors

Learn more about the available constructors with the TaxEngineContext class.

The TaxEngineContext class includes these constructors.

TaxEngineContext(request, requestType, namedUri)

Initializes the TaxEngineContext object. This constructor is intended for test usage and throws an exception if used outside of the Apex test context.

Signature

TaxEngineContext(commercetax.TaxEngineRequest request, commercetax.RequestType requestType, String namedUri)

Parameters

request
Type: TaxEngineRequest
Information about the request.
requestType
Type: RequestType
Whether the tax request is to calculate or estimate tax.
namedUri
Type: String
URI that was called as part of the tax calculation request.

TaxEngineContext Methods

Learn more about the available methods with the TaxEngineContext class.

The TaxEngineContext class includes these methods.

getNamedUri()

Retrieves the value of the NamedUri field of the TaxEngineContext class.

Signature

global String getNamedUri()

Return Value

Type: String

getRequest()

Gets the value of the TaxEngineContext's Request field.

Signature

global commercetax.TaxEngineRequest getRequest()

Return Value

Type: TaxEngineRequest

An implemented instance of an external tax engine's interface for processing requests. We've provided the TaxEngineRequest interface for you to test within mock adapters with classes that implement it, such as CalculateTaxRequest. However, don’t use it outside of a testing context.

getRequestType()

Gets the value of the RequestType field of the TaxEngineContext class.

Signature

global commercetax.RequestType getRequestType()

Return Value

Type: RequestType

Indicates whether the calculation request was for actual or calculated tax.