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
TaxEngineContext Class
TaxLineItemRequest Class
TaxSellerDetailsRequest Class
TaxTransactionRequest Class
TaxTransactionRequest Constructors
TaxTransactionRequest Properties
TaxTransactionRequest Methods
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
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

TaxTransactionRequest Class

Abstract class for storing customer details used in tax calculation and estimation requests.

Namespace

CommerceTax

Usage

Specify the CommerceTax namespace when creating an instance of this class. The constructor of this class takes no arguments. For example, let's say you create an instance of CalculateTaxRequest class, which extends the TaxTransactionRequest class.

TaxTransactionRequest Constructors

Learn more about the available constructors with the TaxTransactionRequest class.

The TaxTransactionRequest class includes these constructors.

TaxTransactionRequest(addresses, currencyIsoCode, customerDetails, description, documentCode, referenceDocumentCode, transactionDate, effectiveDate, lineItems, referenceEntityId, sellerDetails, customTaxAttributes)

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

Signature

global TaxTransactionRequest(commercetax.HeaderTaxAddressesRequest addresses, String currencyIsoCode, commercetax.TaxCustomerDetailsRequest customerDetails, String description, String documentCode, String referenceDocumentCode, Datetime transactionDate, Datetime effectiveDate, List<commercetax.TaxLineItemRequest> lineItems, String referenceEntityId, commercetax.TaxSellerDetailsRequest sellerDetails,Map<String,Object> customTaxAttributes)

Parameters

addresses
Type: HeaderTaxAddressesRequest
Tax addresses, such as Ship To and Bill From.
currencyIsoCode
Type: String
Three-letter ISO 4217 currency code associated with the TaxTransactionRequest.
customerDetails
Type: TaxCustomerDetailsRequest
Customer information used in tax calculation.
description
Type: String
Optional user-defined description for providing more information about the tax transaction request.
documentCode
Type: String
Code for documents that are used to provide more information in the tax calculation process.
referenceDocumentCode
Type: String
Identifier that combines the original invoice ID, previous tax transaction type, and tax engine ID, used in tax calculations for negative invoice lines. For example, a referenceDocumentCode parameter value 3ttxx00000004Bh_Debit-4wAxx0000000001EAA indicates 3ttxx00000004Bh is the original invoice ID and 4wAxx0000000001EAA is the tax engine ID.
transactionDate
Type: Datetime
The date that the tax transaction occurred.
effectiveDate
Type: Datetime
The date that the tax transaction takes effect. User-defined and used only for reporting purposes.
lineItems
Type: List<TaxLineItemRequest>
A list of line items on which tax is calculated.
referenceEntityId
Type: String
ID of an object related to the line items sent for tax calculation.
sellerDetails
Type: TaxSellerDetailsRequest
Contains tax code information used in a tax calculation request.
customTaxAttributes
Type: Map<String, Object>
Customised tax contract to include additional attributes at the header level.

TaxTransactionRequest Properties

Learn more about the available properties with the TaxTransactionRequest class.

The TaxTransactionRequest class includes these properties.

addresses

A list of addresses (such as Ship To and Sold To) used as part of the tax transaction.

Signature

global commercetax.HeaderTaxAddressesRequest addresses {get; set;}

Property Value

Type: HeaderTaxAddressesRequest

currencyIsoCode

Three-letter ISO 4217 currency code associated with the TaxTransactionRequest.

Signature

global String currencyIsoCode {get; set;}

Property Value

Type: String

customerDetails

Customer information used in tax calculation.

Signature

global CommerceTax.TaxCustomerDetailsRequest customerDetails {get; set;}

Property Value

Type: TaxCustomerDetailsRequest

customTaxAttributes

Customised tax contract to include additional attributes at the header level.

Signature

global commercetax.TaxTransactionRequest customTaxAttributes {get; set;}

Property Value

Type: Map<String, Object>

description

Optional user-defined description for providing more information about the tax transaction request.

Signature

global String description {get; set;}

Property Value

Type: String

documentCode

Code for documents used to provide more information in the tax calculation process.

Signature

global String documentCode {get; set;}

Property Value

Type: String

effectiveDate

The date that the tax transaction takes effect. User-defined and used only for reporting purposes.

Signature

global Datetime effectiveDate {get; set;}

Property Value

Type: Datetime

lineItems

A list of line items on which tax will be calculated.

Signature

global List<CommerceTax.TaxLineItemRequest> lineItems {get; set;}

Property Value

Type: List<TaxLineItemRequest>

referenceDocumentCode

Identifier that combines the original invoice ID, previous tax transaction type, and tax engine ID, used in tax calculations for negative invoice lines.

For example, a referenceDocumentCode parameter value 3ttxx00000004Bh_Debit-4wAxx0000000001EAA indicates 3ttxx00000004Bh is the original invoice ID and 4wAxx0000000001EAA is the tax engine ID.

Signature

global String referenceDocumentCode {get; set;}

Property Value

Type: String

referenceEntityId

ID of an object related to the line items sent for tax calculation.

Signature

global String referenceEntityId {get; set;}

Property Value

Type: String

sellerDetails

Contains tax code information used in a tax calculation request.

Signature

global commercetax.TaxSellerDetailsRequest sellerDetails {get; set;}

Property Value

Type: TaxSellerDetailsRequest

transactionDate

The date that the tax transaction occurred.

Signature

global Datetime transactionDate {get; set;}

Property Value

Type: Datetime

TaxTransactionRequest Methods

The following are methods for TaxTransactionRequest.

equals(obj)

Maintains the integrity of lists of type TaxTransactionRequest by determining the equality of external objects in a list. This method is dynamic and based on the equals() method in Java.

Signature

global Boolean equals(Object obj)

Parameters

obj
Type: Object

Return Value

Type: Boolean

hashCode()

Maintains the integrity of lists of type TaxTransactionRequest by determining the uniqueness of the external object records in a list.

Signature

global Integer hashCode()

Return Value

Type: Integer

toString()

Converts a value to a string.

Signature

global String toString()

Return Value

Type: String