Class LineItemTax
A tax on a line item: tax identifier, rate, and optional amount. Use with LineItem.setTaxes(Collection)
and LineItem.getTaxes() .
Create instances via new LineItemTax(taxId, taxRate) to have the
server compute the tax value, or via
new LineItemTax(taxId, taxRate, taxValue) to provide a
pre-computed tax value.
Access is currently restricted to select pilot customers and controlled via feature toggle.
See Also:
Property Summary
Property Description taxId : String (read-only)Gets the tax identifier (e.g. taxRate : Number (read-only)Gets the tax rate as a decimal (e.g. taxValue : Money (read-only)Gets the tax value (amount) in purchase currency, or null if computed from rate and tax basis.
Constructor Summary
Method Summary
Method Description getTaxId ()Gets the tax identifier (e.g. getTaxRate ()Gets the tax rate as a decimal (e.g. getTaxValue ()Gets the tax value (amount) in purchase currency, or null if computed from rate and tax basis.
Methods inherited from class Object
assign , create , create , defineProperties , defineProperty , entries , freeze , fromEntries , getOwnPropertyDescriptor , getOwnPropertyNames , getOwnPropertySymbols , getPrototypeOf , hasOwnProperty , is , isExtensible , isFrozen , isPrototypeOf , isSealed , keys , preventExtensions , propertyIsEnumerable , seal , setPrototypeOf , toLocaleString , toString , valueOf , values
Property Details
taxId
taxId: String (read-only)
Gets the tax identifier (e.g. "DE_7").
taxRate
taxRate: Number (read-only)
Gets the tax rate as a decimal (e.g. 0.07 for 7%).
taxValue
taxValue: Money (read-only)
Gets the tax value (amount) in purchase currency, or null if computed from rate and tax basis.
Constructor Details
LineItemTax(String, Number)
LineItemTax(taxId: String , taxRate: Number )
Creates a tax item for use with LineItem.setTaxes(Collection) .
The tax value will be computed server-side from the tax rate and the line item's tax basis.
Access is currently restricted to select pilot customers and controlled via feature toggle.
Parameters:
taxId - tax identifier (e.g. "DE_7"), must not be null or blank
taxRate - tax rate as decimal (e.g. 0.07 for 7%), must not be null
LineItemTax(String, Number, Money)
LineItemTax(taxId: String , taxRate: Number , taxValue: Money )
Creates a tax item for use with LineItem.setTaxes(Collection) .
Access is currently restricted to select pilot customers and controlled via feature toggle.
Parameters:
taxId - tax identifier (e.g. "DE_7"), must not be null or blank
taxRate - tax rate as decimal (e.g. 0.07 for 7%), must not be null
taxValue - tax amount in purchase currency, or null to compute from rate and tax basis
Method Details
getTaxId()
getTaxId(): String
Gets the tax identifier (e.g. "DE_7").
Returns:
getTaxRate()
getTaxRate(): Number
Gets the tax rate as a decimal (e.g. 0.07 for 7%).
Returns:
getTaxValue()
getTaxValue(): Money
Gets the tax value (amount) in purchase currency, or null if computed from rate and tax basis.
Returns:
the tax value as Money, or null
j