taxdetails

This topic applies to

Applies to

Commerce Web Stores

 

This object contains tax information for each line item in a web store shopping order. Each taxdetails object contains details for one type of tax, for example PST. The taxdetails object is used only with tax calculations using SuiteTax. Tax calculation using SuiteTax is available only for US and Canada.

Field Name

Field Type

Description

In Get Functions?

In Set Functions?

taxdetailsreference

string

The ID that links the tax details in the taxdetails object with the orderitem to which they apply.

The taxdetails object for shipping has the taxdetailsreference SHIPPING. If handling is set up as separate from shipping, then the taxdetails object for handling has the taxdetailsreference HANDLING.

Applicable only for tax calculations using SuiteTax. Tax calculation using SuiteTax is available only for US and Canada.

yes

no

linetype

string

The type of line item in the sales order to which the tax applies.

For example, ‘Item’, ‘Shipping’, and ‘Handling’.

yes

no

linename

string

The name of the line item in the sales order to which the tax applies.

For items, this returns the name of the item from the item record, for example “Blue Shirt”.

For shipping, this returns the name of the shipping record plus the term “Shipping Cost”, for example “US_CA_Ship_Item_1, Shipping Cost”.

If handling is set up as separate from shipping, this returns the name of the handling record plus the term “Handling Cost”, for example “US_CA_Ship_Item_1, Handling Cost”.

yes

no

netamount

number

The cost of the line item, not including tax.

yes

no

grossamount

number

The cost of the line item, including tax.

yes

no

taxtype

string

The type of tax. For example, if the type of tax applicable is PST, this contains the ID of the corresponding tax type record.

yes

no

taxcode

string

The tax code associated with the tax type.

yes

no

taxbasis

string

The amount based on which tax is calculated.

yes

no

taxrate

number

The rate of tax being charged.

yes

no

taxamount

number

The total tax amount for the line item for the tax type returned in taxtype.

yes

no

calcdetail

string

The information returned by the tax engine used to calculate the tax.

yes

no