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
CommerceOrders Namespace
CommercePayments 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
TaxDetailsResponse Methods
TaxEngineAdapter Interface
TaxEngineContext Class
TaxLineItemRequest Class
TaxSellerDetailsRequest Class
TaxTransactionRequest Class
TaxTransactionStatus Enum
TaxTransactionType Enum
Compression Namespace (Developer Preview)
ConnectApi Namespace
Database Namespace
Datacloud Namespace
DataSource Namespace
DataWeave Namespace
Dom Namespace
EventBus Namespace
ExternalService Namespace
Flow Namespace
FormulaEval Namespace (Developer Preview)
Functions Namespace
Invocable Namespace
IsvPartners Namespace
KbManagement Namespace
LxScheduler Namespace
Messaging Namespace
Metadata Namespace
PlaceQuote Namespace
Pref_center Namespace
Process Namespace
QuickAction Namespace
Reports Namespace
RichMessaging Namespace
Schema Namespace
Search Namespace
Sfc Namespace
Sfdc_Checkout Namespace
sfdc_surveys Namespace
Site Namespace
Slack Namespace
Support Namespace
System Namespace
TerritoryMgmt Namespace
TxnSecurity Namespace
UserProvisioning Namespace
VisualEditor Namespace
Wave Namespace
Appendices
PDF

Newer Version Available

This content describes an older version of this product. View Latest

TaxDetailsResponse Class

Stores details of the tax values that an external tax engine calculates in response to a tax calculation request.

Namespace

CommerceTax

Usage

If your tax calculation request contains multiple line items, we recommend building your adapter using a list of TaxDetailsResponse instances. Each instance represents the tax details calculated for a given line item.

Example

TaxDetailsResponse Methods

Learn more about the available methods with the TaxDetailsResponse class.

The TaxDetailsResponse class includes these methods.

setExemptAmount(exemptAmount)

Sets the ExemptAmount field of the TaxDetailsResponse class.

Signature

global void setExemptAmount(Double exemptAmount)

Parameters

exemptAmount
Type: Double
Amount of tax on a line item that is exempt from tax calculation.

Return Value

Type: void

setExemptReason(reason)

Sets the ExemptReason field of the TaxDetailsResponse class.

Signature

global void setExemptReason(String reason)

Parameters

reason
Type: String
Optional user-defined information on why a tax exemption applies to a line item.

Return Value

Type: void

setImposition(imposition)

Sets the Imposition field of the TaxDetailsResponse class using an instance of the ImpositionResponse class.

Signature

global void setImposition(commercetax.ImpositionResponse imposition)

Parameters

imposition
Type: ImpositionResponse
Contains information about why tax was imposed on a line item.

Return Value

Type: void

setJurisdiction(jurisdiction)

Sets the Jurisdiction field of the TaxDetailsResponse using an instance of the JurisdictionResponse class.

Signature

global void setJurisdiction(commercetax.JurisdictionResponse jurisdiction)

Parameters

jurisdiction
Type: JurisdictionResponse
Contains address information about the tax jurisdiction used in the tax calculation process.

Return Value

Type: void

setRate(rate)

Sets the Rate field of the TaxDetailsResponse class.

Signature

global void setRate(Double rate)

Parameters

rate
Type: Double
Tax used during tax calculation. This value is often a decimal amount, such as 0.1 or 0.06, based on the applied tax percentage.

Return Value

Type: void

setSerCode(serCode)

Sets the Service Code field of the TaxDetailsResponse class.

Signature

global void setSerCode(String serCode)

Parameters

serCode
Type: String
Service code used in tax calculation.

Return Value

Type: void

setTax(tax)

Sets the Tax field of the TaxDetailsResponse class.

Signature

global void setTax(Double tax)

Parameters

tax
Type: Double
Amount of tax for a line item.

Return Value

Type: void

setTaxAuthorityTypeId(taxAuthorityTypeId)

Sets the TaxAuthorityTypeId field of the TaxDetailsResponse class.

Signature

global void setTaxAuthorityTypeId(String taxAuthorityTypeId)

Parameters

taxAuthorityTypeId
Type: String
ID of the organization that oversees tax collection.

Return Value

Type: void

setTaxId(taxId)

Sets the TaxId field of the TaxDetailsResponse class.

Signature

global void setTaxId(String taxId)

Parameters

taxId
Type: String
ID value used to determine the tax for an individual or business.

Return Value

Type: void

setTaxRegionId(taxRegionId)

Sets the TaxRegionId field on the TaxDetailsResponse class.

Signature

global void setTaxRegionId(String taxRegionId)

Parameters

taxRegionId
Type: String
ID of the tax region used in tax calculation. A tax region represents a geographical area where tax is applied.

Return Value

Type: void

setTaxRuleDetails(taxRuleDetails)

Sets the TaxRuleDetails field of the TaxDetailsResponse class.

Signature

global void setTaxRuleDetails(commercetax.RuleDetailsResponse taxRuleDetails)

Parameters

taxRuleDetails
Type: RuleDetailsResponse
Information about the Salesforce tax rules used during tax calculation.

Return Value

Type: void

setTaxableAmount(taxableAmount)

Sets the TaxableAmount field of the TaxDetailsResponse class.

Signature

global void setTaxableAmount(Double taxableAmount)

Parameters

taxableAmount
Type: Double
Amount that can be taxed on a line item.

Return Value

Type: void