--- schema_version: "1" id: 8f767560e72b37234eecfeb9d63765e203b94b6d12fa7f27203c7735c07e446d title: TaxLineItemRequest Class collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/apexref/apex_class_commercetax_TaxLineItemRequest.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_commercetax_TaxLineItemRequest.htm source_site: developer.salesforce.com content_type: documentation content_hash: 20bbf7b6581ee3baa9860dd96661779441da4afc48313fd33e71621146e5eea2 description: Contains line item details of a tax request.Learn more about the constructors available with the TaxLineItemRequest class.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.Learn more about the available properties with the TaxLineItemRequest class.Contains the list of addresses of a line item.Total amount (in a given currency) represented by a line item sent for tax calculation.Customised tax contract to include additional attributes at the line item level.User-defined description for a tax line item.The date that a tax transaction takes effect on a line item. This is a user-defined date used for reporting only.Unique number used to identify a tax line item.Catalog code for the product represented by the tax line item.Unique identifier of a product that can be used to identify products that are exempted from tax.Number of units of a given product that the tax line item represents.Identifier that combines the original invoice ID, previous tax transaction type, and tax engine ID, used in tax calculations for negative invoice lines.Code used to identify how tax is calculated for a tax line item.Learn more about the available methods with the TaxLineItemRequest class.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.Maintains the integrity of lists of type TaxLineItemRequest by determining the uniqueness of the external object records in a list.Converts a value to a string. --- # TaxLineItemRequest Class Contains line item details of a tax request. ## Namespace [CommerceTax](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_namespace_commercetax.htm "Manage the communication between Salesforce and an external tax engine.") - **[TaxLineItemRequest Constructors](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_commercetax_TaxLineItemRequest.htm#apex_commercetax_TaxLineItemRequest_constructors)** Learn more about the constructors available with the TaxLineItemRequest class. - **[TaxLineItemRequest Properties](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_commercetax_TaxLineItemRequest.htm#apex_commercetax_TaxLineItemRequest_properties)** Learn more about the available properties with the TaxLineItemRequest class. - **[TaxLineItemRequest Methods](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_commercetax_TaxLineItemRequest.htm#apex_commercetax_TaxLineItemRequest_methods)** Learn more about the available methods with the TaxLineItemRequest class. ## TaxLineItemRequest Constructors Learn more about the constructors available with the TaxLineItemRequest class. The TaxLineItemRequest class includes these constructors. - **[TaxLineItemRequest(addresses, amount, description, productCode, quantity, lineNumber, taxCode, effectiveDate)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_commercetax_TaxLineItemRequest.htm#apex_commercetax_TaxLineItemRequest_ctor)** 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. ### TaxLineItemRequest(addresses, amount, description, productCode, 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, Double quantity, String lineNumber, String taxCode, Datetime effectiveDate) #### Parameters - **addresses**: Type: [LineTaxAddressesRequest](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_commercetax_LineTaxAddressesRequest.htm#apex_class_commercetax_LineTaxAddressesRequest "Stores details of the addresses applied per line item in a tax calculation request.") Information about the addresses applied to each line item in a tax calculation request. - **amount**: Type: [Double](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_double.htm#apex_methods_system_double "Contains methods for the Double primitive data type.") Total amount (in a given currency) represented by a line item sent for tax calculation. - **description**: Type: [String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.") User-defined description for a tax line item. - **productCode**: Type: [String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.") Catalog code for the product represented by the tax line item. - **quantity**: Type: [Double](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_double.htm#apex_methods_system_double "Contains methods for the Double primitive data type.") Number of units of a given product that the tax line item represents. - **lineNumber**: Type: [String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.") Unique number used to identify a tax line item. - **taxCode**: Type: [String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.") Code used to identify how tax is calculated for a tax line item. - **effectiveDate**: Type: [Datetime](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_datetime.htm#apex_methods_system_datetime "Contains methods for the Datetime primitive data type.") This is a user-defined date used for reporting only. For negative invoice lines, this parameter represents the invoice date from the original invoice. In other cases, it represents the date when the tax transaction takes effect on the line item. The previous tax transaction type is always Debit for negative invoice lines. ## TaxLineItemRequest Properties Learn more about the available properties with the TaxLineItemRequest class. The TaxLineItemRequest class includes these properties. - **[addresses](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_commercetax_TaxLineItemRequest.htm#apex_commercetax_TaxLineItemRequest_addresses)** Contains the list of addresses of a line item. - **[amount](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_commercetax_TaxLineItemRequest.htm#apex_commercetax_TaxLineItemRequest_amount)** Total amount (in a given currency) represented by a line item sent for tax calculation. - **[customTaxAttributes](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_commercetax_TaxLineItemRequest.htm#apex_commercetax_TaxLineItemRequest_customTaxAttributes)** Customised tax contract to include additional attributes at the line item level. - **[description](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_commercetax_TaxLineItemRequest.htm#apex_commercetax_TaxLineItemRequest_description)** User-defined description for a tax line item. - **[effectiveDate](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_commercetax_TaxLineItemRequest.htm#apex_commercetax_TaxLineItemRequest_effectiveDate)** The date that a tax transaction takes effect on a line item. This is a user-defined date used for reporting only. - **[lineNumber](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_commercetax_TaxLineItemRequest.htm#apex_commercetax_TaxLineItemRequest_lineNumber)** Unique number used to identify a tax line item. - **[productCode](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_commercetax_TaxLineItemRequest.htm#apex_commercetax_TaxLineItemRequest_productCode)** Catalog code for the product represented by the tax line item. - **[productSKU](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_commercetax_TaxLineItemRequest.htm#apex_commercetax_TaxLineItemRequest_productSKU)** Unique identifier of a product that can be used to identify products that are exempted from tax. - **[quantity](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_commercetax_TaxLineItemRequest.htm#apex_commercetax_TaxLineItemRequest_quantity)** Number of units of a given product that the tax line item represents. - **[referenceDocumentCode](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_commercetax_TaxLineItemRequest.htm#apex_commercetax_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. - **[taxCode](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_commercetax_TaxLineItemRequest.htm#apex_commercetax_TaxLineItemRequest_taxCode)** Code used to identify how tax is calculated for a tax line item. ### addresses Contains the list of addresses of a line item. #### Signature public commercetax.LineTaxAddressesRequest addresses {get; set;} #### Property Value Type: [commercetax.LineTaxAddressesRequest](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_commercetax_LineTaxAddressesRequest.htm#apex_class_commercetax_LineTaxAddressesRequest "Stores details of the addresses applied per line item in a tax calculation request.") ### 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](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_double.htm#apex_methods_system_double "Contains methods for the Double primitive data type.") ### customTaxAttributes Customised tax contract to include additional attributes at the line item level. #### Signature global commercetax.TaxLineItemRequest customTaxAttributes {get; set;} #### Property Value Type: Map<[String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type."), Object> ### description User-defined description for a tax line item. #### Signature global String description {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.") ### 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](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_datetime.htm#apex_methods_system_datetime "Contains methods for the Datetime primitive data type.") ### lineNumber Unique number used to identify a tax line item. #### Signature global String lineNumber {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.") ### productCode Catalog code for the product represented by the tax line item. #### Signature global String productCode {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.") ### 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](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.") ### quantity Number of units of a given product that the tax line item represents. #### Signature global Double quantity {get; set;} #### Property Value Type: [Double](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_double.htm#apex_methods_system_double "Contains methods for the Double primitive data type.") ### 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. The previous tax transaction type is always Debit for negative invoice lines. #### Signature global String referenceDocumentCode {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.") ### taxCode Code used to identify how tax is calculated for a tax line item. #### Signature global String taxCode {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.") ## TaxLineItemRequest Methods Learn more about the available methods with the TaxLineItemRequest class. The TaxLineItemRequest class includes these methods. - **[equals(obj)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_commercetax_TaxLineItemRequest.htm#apex_commercetax_TaxLineItemRequest_equals)** 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. - **[hashCode()](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_commercetax_TaxLineItemRequest.htm#apex_commercetax_TaxLineItemRequest_hashCode)** Maintains the integrity of lists of type TaxLineItemRequest by determining the uniqueness of the external object records in a list. - **[toString()](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_commercetax_TaxLineItemRequest.htm#apex_commercetax_TaxLineItemRequest_toString)** Converts a value to a string. ### 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](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_boolean.htm#apex_methods_system_boolean "Contains methods for the Boolean primitive data type.") ### 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](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_integer.htm#apex_methods_system_integer "Contains methods for the Integer primitive data type.") ### toString() Converts a value to a string. #### Signature global String toString() #### Return Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.")