Apex Reference Guide

Apex Reference Guide
Release Notes
Apex DML Operations
ApexPages Namespace
AppLauncher Namespace
Approval Namespace
Auth Namespace
Cache Namespace
Canvas Namespace
ChatterAnswers Namespace
CommerceBuyGrp Namespace
CommerceExtension Namespace
CommerceOrders Namespace
CommercePayments Namespace
CommerceTax Namespace
AbstractTransactionResponse Class
AddressesResponse Class
AddressResponse Class
AmountDetailsResponse Class
CalculateTaxRequest Class
CalculateTaxResponse Class
CalculateTaxType Enum
CustomTaxAttributesResponse Class
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
TaxEngineAdapter Methods
TaxEngineAdapter Example Implementation
Tax Mappings for Quotes and Orders
TaxEngineContext Class
TaxLineItemRequest Class
TaxSellerDetailsRequest Class
TaxTransactionRequest Class
TaxTransactionStatus Enum
TaxTransactionType Enum
ComplianceMgmt Namespace
Compression Namespace
ConnectApi Namespace
Context Namespace
Database Namespace
Datacloud Namespace
DataRetrieval Namespace
DataSource Namespace
DataWeave Namespace
Dom Namespace
embeddedai Namespace
EventBus Namespace
ExternalService Namespace
Flow Namespace
Flowtesting Namespace
flowuiruntime Namespace
FormulaEval Namespace
fsccashflow Namespace
Functions Namespace
ise_bots_apex Namespace
IssueCreditMemo Namespace
ind_mfg_sample_mgmt_apex Namespace
industriesNlpSvc
IndustriesDigitalLending Namespace
Invocable Namespace
InvoiceWriteOff Namespace
IsvPartners Namespace
KbManagement Namespace
LxScheduler Namespace
Messaging Namespace
Metadata Namespace
PlaceQuote Namespace
Pref_center Namespace
Process Namespace
QuickAction Namespace
renew_assets_summary Namespace
Reports Namespace
RevSignaling Namespace
RevSalesTrxn Namespace
RichMessaging Namespace
RulesAppln Namespace
runtime_industries_cpq Namespace
runtime_industries_insurance Namespace
Schema Namespace
Search Namespace
setup_flow_performance Namespace
Sfc Namespace
Sfdc_Checkout Namespace
Sfdc_Enablement Namespace
sfdc_surveys Namespace
sfdw Namespace
sfsqlquery Namespace
Site Namespace
Slack Namespace
Support Namespace
System Namespace
TerritoryMgmt Namespace
TxnSecurity Namespace
UserProvisioning Namespace
VisualEditor Namespace
Wave Namespace
Appendices
PDF

TaxEngineAdapter Interface

Retrieves information from the tax engine and evaluates the information to define tax details.

Namespace

CommerceTax

TaxEngineAdapter Methods

Learn more about the available methods with the TaxEngineAdapter class.

The TaxEngineAdapter class includes these methods.

processRequest(requestType)

The processRequest method takes an instance of TaxEngineContext class and returns a response with the calculated tax details through the TaxDetailsResponse class or an error response through the ErrorResponse class.

Signature

global commercetax.TaxEngineResponse processRequest(commercetax.TaxEngineContext var1)

Parameters

var1
Type: TaxEngineContext
Wrapper class that stores information about the type of a tax calculation request.

Return Value

Type: TaxEngineResponse

Generic interface representing a response from a tax engine.

TaxEngineAdapter Example Implementation

Refer to the example implementation of the TaxEngineAdapter interface to accept information from a tax engine and evaluate the information to define tax details.

Namespace

commercetax

Usage

The TaxEngineAdapter interface accepts information from the tax engine through the TaxEngineContext class. The interface evaluates the information to define tax in the response with details, such as tax amount and addresses. The response is used to update and create entities in the Salesforce org.

Use these steps to build a sample tax adapter implementation. Each tax adapter implementation varies based on your implementation requirements. Customize this example to suit your business requirements.

Example

  • The custom adapter class implements the TaxEngineAdapter interface. The processRequest method takes an instance of TaxEngineContext class and returns a response with the calculated tax details through the TaxDetailsResponse class or an error response through the ErrorResponse class.

  • This example shows the CalculateTaxService class.

  • In the HttpService class, replace the test value in the endpoint variable with the name of the TaxTypedNamedCredential record. This class contains the credentials that are required to access your Avalara account through Salesforce.

  • Parse the JsonSuccessParser response object by using the AvalaraJSONBuilder class to build the response for your adapter.

    This example shows the JsonSuccessParser class.

    Prepare your JSON request to call the Avalara endpoint by using the AvalaraJSONBuilder class.

  • Use the JsonErrorParser class to extract the error details, if any.

Tax Mappings for Quotes and Orders

You can extend and customize the tax interface for quotes and orders by using custom metadata types and tax mappings. These customizations help you with unique business requirements such as the inclusion of specific data for accurate calculations and audits.

Tax callout extensions are supported for the Quote, QuoteLineItem, Order, and OrderItem objects to include additional fields to tax requests. See custom metadata types to specify all your tax mapping definitions.

Request Mappings for Header Attributes

This table defines the request mappings between the header attributes of a tax callout and fields of applicable quote and order objects.

Header Attributes Quote Mapping Order Mapping
currencyIsoCode If multi-currency is enabled, then this value is Quote.CurrencyISOCode. Otherwise, this value is NULL. If multi-currency is enabled, then this value is Order.CurrencyISOCode. Otherwise, this value is NULL.
isCommit False False
referenceEntityId Quote.ID Order.ID
taxEngineId TaxTreatment.TaxEngine.ID TaxTreatment.TaxEngine.ID
transactionDate Current System Date System Date
sellerDetails NULL
code TaxEngine.SellerCode
customerDetails
accountId Quote.AccountId Order.AccountId
code NULL NULL
exemptionNo NULL NULL
exemptionReason NULL NULL
taxType Estimated Estimated
taxTransactionType NULL NULL
effectiveDate NULL NULL
addresses
billTo NULL NULL
shipTo NULL NULL
shipFrom NULL NULL
soldTo NULL NULL
taxEngineAddress TaxEngine.Address TaxEngine.Address
referenceDocumentCode NULL NULL
description NULL NULL
documentCode Quote.ID-TaxEngineId Order.ID-TaxEngineId
shouldVoid FALSE FALSE
lineItems Refer to the next line attributes section. Refer to the next line attributes section.

Request Mappings for Line Attributes

This table defines the request mappings between the line attributes of a tax callout and fields of applicable quote line items and order products.

Line Attributes Quote Line Item Mapping Order Product Mapping
taxCode TaxTreatment.TaxCode TaxTreatment.TaxCode
productCode TaxTreatment.ProductCode TaxTreatment.ProductCode
productId QuoteLineItem.Product2.Id OrderItem.Product2.Id
amount QuoteLineItem.TotalPrice OrderItem.TotalPrice
effectiveDate Current System Date Current System Date
lineNumber QuoteLineItem.Id OrderItem.Id
description NULL NULL
quantity QuoteLineItem.Quantity OrderItem.Quantity
addresses
billTo Quote.BillingAddress. If Quote.BillingAddress is null, then this value is Quote.Account.BillingAddress. Order.BillingAddress
shipTo Quote.ShippingAddress. If Quote.ShippingAddress is null, then this value is Quote.Account.ShippingAddress. Order.ShippingAddress
shipFrom NULL NULL
soldTo NULL NULL
productsku QuoteLineItem.Product2.ProductCode OrderItem.Product2.ProductCode
referenceDocumentCode NULL NULL

Response Mappings for Header Attributes

This table defines the response mappings between the header attributes of a tax callout and fields of applicable objects. Most response data is used for tax calculation and isn’t persisted on quote or order records.

Header Attributes Quote Mapping Order Mapping
currencyIsoCode Quote.CurrencyISOCode Order.CurrencyISOCode
isCommit Not returned. Not returned.
referenceEntityId Quote.ID Order.ID
taxEngineId TaxTreatment.TaxEngine.ID TaxTreatment.TaxEngine.ID
transactionDate System Date System Date
sellerDetails Not returned. Not returned.
code Not returned. Not returned.
customerDetails Not returned. Not returned.
accountId Not returned. Not returned.
code Not returned. Not returned.
exemptionNo Not returned. Not returned.
exemptionReason Not returned. Not returned.
taxType Estimated Estimated
taxTransactionType Not returned. Not returned.
effectiveDate System Date System Date
addresses
billTo Not returned. Not returned.
shipTo locationCode -> locationCode locationCode -> locationCode
shipFrom Not returned. Not returned.
soldTo Not returned. Not returned.
taxEngineAddress Not returned. Not returned.
referenceDocumentCode Not returned. Not returned.
description Not returned. Not returned.
documentCode Quote.ID-TaxEngineId Order.ID-TaxEngineId
status Uncommitted Uncommitted
taxEngineLogs Not returned. Not returned.
resultCode Not returned. Not returned.
transactionDate System Date System Date
amountDetails
exemptAmount Actual exemptAmount from response. Actual exemptAmount from response.
taxAmount Actual taxAmount from response. Actual taxAmount from response.
totalAmount Quote.Subtotal Order.Subtotal
totalAmountWithTax TaxAmount + TotalAmount TaxAmount + TotalAmount
lineItems Refer to the next line attributes section. Refer to the next line attributes section.

Response Mappings for Line Attributes

This table defines the response mappings between the line attributes of a tax callout and fields of applicable objects.

Line Attributes Quote Line Item Mapping Order Product Mapping
taxCode TaxTreatment.TaxCode TaxTreatment.TaxCode
productCode TaxTreatment.ProductCode TaxTreatment.ProductCode
productId Not returned. Not returned.
amountDetails
exemptAmount Actual exemptAmount from response Actual exemptAmount from response
taxAmount Actual taxAmount from response Actual taxAmount from response
totalAmount QuoteLineItem.Subtotal OrderItem.Subtotal
totalAmountWithTax TaxAmount + TotalAmount TaxAmount + TotalAmount
effectiveDate System Date System Date
lineNumber QuoteLineItem.Id OrderItem.Id
description Not returned. Not returned.
quantity Not returned. Not returned.
addresses
billTo Not persisted. Not persisted.
shipTo locationCode -> locationCode locationCode -> locationCode
shipFrom Not returned. Not returned.
soldTo Not returned. Not returned.
productsku Not returned. Not returned.
referenceDocumentCode Not returned. Not returned.
taxes Refer to the next tax attributes section. Refer to the next tax attributes section.

Response Mappings for Tax Attributes

This table defines the response mappings between the tax attributes of a tax callout and fields of applicable objects.

Tax Attributes Quote Mapping Order Mapping
exemptAmount Not returned. Not returned.
exemptReason Not returned. Not returned.
imposition
type Not returned. Not returned.
Name Not returned. Not returned.
jurisdiction
country Not returned. Not returned.
id Not returned. Not returned.
level Not returned. Not returned.
name Not returned. Not returned.
region Not returned. Not returned.
stateAssignedNo Not returned. Not returned.
rate QuoteItemTaxItem.Rate OrderItemTaxItem.Rate
tax QuoteItemTaxItem.amount OrderItemTaxItem.amount
taxId Not returned. Not returned.
taxableAmount Not returned. Not returned.