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
AbstractTransactionResponse Methods
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
TaxEngineContext Class
TaxLineItemRequest Class
TaxSellerDetailsRequest Class
TaxTransactionRequest Class
TaxTransactionStatus Enum
TaxTransactionType Enum
commonserviceexcellence Namespace
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
disputemanagement Namespace
fsccashflow Namespace
fsccomplaintmanagement Namespace
fschousehold Namespace
fscserviceprocesses Namespace
fscwmgen Namespace
industriespersonalizedfinance 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

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.

AbstractTransactionResponse Class

Abstract class that contains methods for setting tax fields based on the external tax provider's response. Response classes that extend AbstractTransactionResponse inherit these methods.

Namespace

CommerceTax

AbstractTransactionResponse Methods

Learn more about the methods for AbstractTransactionResponse class.

The AbstractTransactionResponse class includes these methods.

setAddresses(addresses)

Uses an instance of AddressesResponse to set the values of tax address fields.

Signature

global void setAddresses(commercetax.AddressesResponse addresses)

Parameters

  • addresses:

    Type: AddressesResponse

    Class that contains methods to set the Ship To, Ship From, and Sold To address information.

Return Value

Type: void

setAmountDetails(amountDetails)

Uses an instance of AmountDetailsResponse to set tax amount fields such as exemption amount and tax amount.

Signature

global void setAmountDetails(commercetax.AmountDetailsResponse amountDetails)

Parameters

  • amountDetails:

    Type: AmountDetailsResponse

    Class that contains methods to set the tax exemption amount, tax amount, total amount, and total amount with tax.

Return Value

Type: void

setCurrencyIsoCode(currencyIsoCode)

Sets the currencyIsoCode field.

Signature

global void setCurrencyIsoCode(String currencyIsoCode)

Parameters

  • currencyIsoCode:

    Type: String

    Three-letter ISO 4217 currency code associated with a tax object.

Return Value

Type: void

setCustomTaxAttributes(customTaxAttributes)

Uses an instance of CustomTaxAttributesResponse class to include additional attributes in the tax response at the header level.

Signature

global void setCustomTaxAttributes(commercetax.CustomTaxAttributesResponse customTaxAttributes)

Parameters

Return Value

Type: void

setDescription(dscptn)

Sets the Description field.

Signature

global void setDescription(String dscptn)

Parameters

  • dscptn:

    Type: String

    Optional field for providing additional information about a record.

Return Value

Type: void

setDocumentCode(documentCode)

Sets the DocumentCode field. Document codes are often used to reference tax documents that the external tax engine uses in the tax calculation process. Document code acts as a unique link to chain-related transactions, such as amendment or refunds.

Signature

global void setDocumentCode(String documentCode)

Parameters

  • documentCode:

    Type: String

    Code

    for a tax document used in the tax calculation process.

Return Value

Type: void

setEffectiveDate(effectiveDate)

Sets the EffectiveDate field. Effective Date fields are optional fields that store the date that a transaction takes effect. We provide these fields only for recordkeeping purposes – for example, if you must report an effective date to an external general ledger system. Salesforce doesn't use them to calculate any tax or payment values.

Signature

global void setEffectiveDate(Datetime effectiveDate)

Parameters

  • effectiveDate:

    Type: Datetime

    Optional field that stores the date that a transaction takes effect.

Return Value

Type: void

setLineItems(lineItems)

Uses an instance of the LineItemResponse class to set a list of line items. Each line item represents an item sent to an external tax engine for tax calculation.

Signature

global void setLineItems(List<commercetax.LineItemResponse> lineItems)

Parameters

  • lineItems:

    Type: List<LineItemResponse>

    A list of line items sent to an external tax engine for tax calculation.

Return Value

Type: void

setReferenceDocumentCode(referenceDocumentCode)

Sets the ReferenceDocumentCode field. Use this field to store the code of an additional document used in the tax calculation process. For example, use this field in case of a refund for a previously taxed purchase.

Signature

global void setReferenceDocumentCode(String referenceDocumentCode)

Parameters

  • referenceDocumentCode:

    Type: String

    The code for a document used in the tax calculation process.

Return Value

Type: void

setReferenceEntityId(referenceEntityId)

Sets the ID of a reference entity. In Commerce Tax, a reference entity represents a record related to the items sent to the external tax engine for tax calculation. For example, if you sent order items for tax calculation, you could define the parent order as the reference entity.

Signature

global void setReferenceEntityId(String referenceEntityId)

Parameters

  • referenceEntityId:

    Type: String

    ID of a record related to the items sent for tax calculation.

Return Value

Type: void

setTaxTransactionId(taxTrxnId)

Sets the TaxTransactionId field using the ID of a tax transaction record. In Commerce Tax, a tax transaction record stores information about a specific tax calculation process.

Signature

global void setTaxTransactionId(String taxTrxnId)

Parameters

  • taxTrxnId:

    Type: String

    The ID of a tax transaction record in Commerce Tax.

Return Value

Type: void

setTransactionDate(transactionDate)

Sets the TransactionDate field.

Signature

global void setTransactionDate(Datetime transactionDate)

Parameters

  • transactionDate:

    Type: Datetime

    Date that a tax transaction occurred.

Return Value

Type: void