TaxLineItemRequest Class

Contains line item details of a tax request.

Namespace

CommerceTax

TaxLineItemRequest Constructors

Learn more about the constructors available with the TaxLineItemRequest class.

The TaxLineItemRequest class includes these constructors.

TaxLineItemRequest(addresses, amount, description, productCode, productSKU, quantity, lineNumber, taxCode, effectiveDate)

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

Signature

global TaxLineItemRequest(commercetax.LineTaxAddressesRequest addresses, Double amount, String description, String productCode, String productSKU, Double quantity, String lineNumber, String taxCode, Datetime effectiveDate)

commercetax.TaxLineItemRequest, newinstance, [commercetax.LineTaxAddressesRequest, Double, String, String, String, Double, String, String, Datetime], commercetax.TaxLineItemRequest

Parameters

addresses
Type: LineTaxAddressesRequest
Information about the addresses applied to each line item in a tax calculation request.
amount
Type: Double
Total amount (in a given currency) represented by a line item sent for tax calculation.
description
Type: String
User-defined description for a tax line item.
productCode
Type: String
Catalog code for the product represented by the tax line item.
productSKU
Type: String
Unique identifier of a product that can be used to identify products that are exempted from tax.
quantity
Type: Double
Number of units of a given product that the tax line item represents.
lineNumber
Type: String
Unique number used to identify a tax line item.
taxCode
Type: String
Code used to identify how tax is calculated for a tax line item.
effectiveDate
Type: Datetime
This is a user-defined date used for reporting only.

TaxLineItemRequest Properties

Learn more about the available properties with the TaxLineItemRequest class.

The TaxLineItemRequest class includes these properties.

addresses

Contains the list of addresses of a line item.

Signature

public commercetax.LineTaxAddressesRequest addresses {get; set;}

amount

Total amount (in a given currency) represented by a line item sent for tax calculation.

Signature

global Double amount {get; set;}

Property Value

Type: Double

description

User-defined description for a tax line item.

Signature

global String description {get; set;}

Property Value

Type: String

effectiveDate

The date that a tax transaction takes effect on a line item. This is a user-defined date used for reporting only.

Signature

global Datetime effectiveDate {get; set;}

Property Value

Type: Datetime

lineNumber

Unique number used to identify a tax line item.

Signature

global String lineNumber {get; set;}

Property Value

Type: String

productCode

Catalog code for the product represented by the tax line item.

Signature

global String productCode {get; set;}

Property Value

Type: String

productSKU

Unique identifier of a product that can be used to identify products that are exempted from tax.

Signature

global String productSKU {get; set;}

Property Value

Type: String

quantity

Number of units of a given product that the tax line item represents.

Signature

global Double quantity {get; set;}

Property Value

Type: Double

taxCode

Code used to identify how tax is calculated for a tax line item.

Signature

global String taxCode {get; set;}

Property Value

Type: String

TaxLineItemRequest Methods

Learn more about the available methods with the TaxLineItemRequest class.

The TaxLineItemRequest class includes these methods.

equals(obj)

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

Signature

global Boolean equals(Object obj)

Parameters

obj
Type: Object
External object whose key is to be validated.

Return Value

Type: Boolean

hashCode()

Maintains the integrity of lists of type TaxLineItemRequest 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