@salesforce/b2c-tooling-sdk 0.0.1 → 0.0.2

package/data/script-api/dw.order.InvoiceItem.md

@@ -0,0 +1,199 @@
+<!-- prettier-ignore-start -->
+# Class InvoiceItem
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.object.Extensible](dw.object.Extensible.md)
+    - [dw.order.AbstractItem](dw.order.AbstractItem.md)
+      - [dw.order.InvoiceItem](dw.order.InvoiceItem.md)
+
+Represents a specific item in an [Invoice](dw.order.Invoice.md). Invoice items are added to the invoice
+on its creation, each item references exactly one order-item.
+
+
+Order post-processing APIs (gillian) are now inactive by default and will throw
+an exception if accessed. Activation needs preliminary approval by Product Management.
+Please contact support in this case. Existing customers using these APIs are not
+affected by this change and can use the APIs until further notice.
+
+
+
+## Property Summary
+
+| Property | Description |
+| --- | --- |
+| [basePrice](#baseprice): [Money](dw.value.Money.md) `(read-only)` | Price of a single unit before discount application. |
+| [capturedAmount](#capturedamount): [Money](dw.value.Money.md) | Returns the captured amount for this item. |
+| [invoiceNumber](#invoicenumber): [String](TopLevel.String.md) `(read-only)` | Returns the number of the invoice to which this item belongs. |
+| [parentItem](#parentitem): [InvoiceItem](dw.order.InvoiceItem.md) | Returns null or the parent item. |
+| [quantity](#quantity): [Quantity](dw.value.Quantity.md) `(read-only)` | Returns the quantity of this item. |
+| [refundedAmount](#refundedamount): [Money](dw.value.Money.md) | Returns the refunded amount for this item. |
+
+## Constructor Summary
+
+This class does not have a constructor, so you cannot create it directly.
+## Method Summary
+
+| Method | Description |
+| --- | --- |
+| [getBasePrice](dw.order.InvoiceItem.md#getbaseprice)() | Price of a single unit before discount application. |
+| [getCapturedAmount](dw.order.InvoiceItem.md#getcapturedamount)() | Returns the captured amount for this item. |
+| [getInvoiceNumber](dw.order.InvoiceItem.md#getinvoicenumber)() | Returns the number of the invoice to which this item belongs. |
+| [getParentItem](dw.order.InvoiceItem.md#getparentitem)() | Returns null or the parent item. |
+| [getQuantity](dw.order.InvoiceItem.md#getquantity)() | Returns the quantity of this item. |
+| [getRefundedAmount](dw.order.InvoiceItem.md#getrefundedamount)() | Returns the refunded amount for this item. |
+| [setCapturedAmount](dw.order.InvoiceItem.md#setcapturedamountmoney)([Money](dw.value.Money.md)) | Updates the captured amount for this item. |
+| [setParentItem](dw.order.InvoiceItem.md#setparentiteminvoiceitem)([InvoiceItem](dw.order.InvoiceItem.md)) | Set a parent item. |
+| [setRefundedAmount](dw.order.InvoiceItem.md#setrefundedamountmoney)([Money](dw.value.Money.md)) | Updates the refunded amount for this item. |
+
+### Methods inherited from class AbstractItem
+
+[getGrossPrice](dw.order.AbstractItem.md#getgrossprice), [getItemID](dw.order.AbstractItem.md#getitemid), [getLineItem](dw.order.AbstractItem.md#getlineitem), [getNetPrice](dw.order.AbstractItem.md#getnetprice), [getOrderItem](dw.order.AbstractItem.md#getorderitem), [getOrderItemID](dw.order.AbstractItem.md#getorderitemid), [getTax](dw.order.AbstractItem.md#gettax), [getTaxBasis](dw.order.AbstractItem.md#gettaxbasis), [getTaxItems](dw.order.AbstractItem.md#gettaxitems)
+### Methods inherited from class Extensible
+
+[describe](dw.object.Extensible.md#describe), [getCustom](dw.object.Extensible.md#getcustom)
+### Methods inherited from class Object
+
+[assign](TopLevel.Object.md#assignobject-object), [create](TopLevel.Object.md#createobject), [create](TopLevel.Object.md#createobject-object), [defineProperties](TopLevel.Object.md#definepropertiesobject-object), [defineProperty](TopLevel.Object.md#definepropertyobject-object-object), [entries](TopLevel.Object.md#entriesobject), [freeze](TopLevel.Object.md#freezeobject), [fromEntries](TopLevel.Object.md#fromentriesiterable), [getOwnPropertyDescriptor](TopLevel.Object.md#getownpropertydescriptorobject-object), [getOwnPropertyNames](TopLevel.Object.md#getownpropertynamesobject), [getOwnPropertySymbols](TopLevel.Object.md#getownpropertysymbolsobject), [getPrototypeOf](TopLevel.Object.md#getprototypeofobject), [hasOwnProperty](TopLevel.Object.md#hasownpropertystring), [is](TopLevel.Object.md#isobject-object), [isExtensible](TopLevel.Object.md#isextensibleobject), [isFrozen](TopLevel.Object.md#isfrozenobject), [isPrototypeOf](TopLevel.Object.md#isprototypeofobject), [isSealed](TopLevel.Object.md#issealedobject), [keys](TopLevel.Object.md#keysobject), [preventExtensions](TopLevel.Object.md#preventextensionsobject), [propertyIsEnumerable](TopLevel.Object.md#propertyisenumerablestring), [seal](TopLevel.Object.md#sealobject), [setPrototypeOf](TopLevel.Object.md#setprototypeofobject-object), [toLocaleString](TopLevel.Object.md#tolocalestring), [toString](TopLevel.Object.md#tostring), [valueOf](TopLevel.Object.md#valueof), [values](TopLevel.Object.md#valuesobject)
+## Property Details
+
+### basePrice
+- basePrice: [Money](dw.value.Money.md) `(read-only)`
+  - : Price of a single unit before discount application.
+
+
+---
+
+### capturedAmount
+- capturedAmount: [Money](dw.value.Money.md)
+  - : Returns the captured amount for this item.
+
+
+---
+
+### invoiceNumber
+- invoiceNumber: [String](TopLevel.String.md) `(read-only)`
+  - : Returns the number of the invoice to which this item belongs.
+
+
+---
+
+### parentItem
+- parentItem: [InvoiceItem](dw.order.InvoiceItem.md)
+  - : Returns null or the parent item.
+
+
+---
+
+### quantity
+- quantity: [Quantity](dw.value.Quantity.md) `(read-only)`
+  - : Returns the quantity of this item.
+
+
+---
+
+### refundedAmount
+- refundedAmount: [Money](dw.value.Money.md)
+  - : Returns the refunded amount for this item.
+
+
+---
+
+## Method Details
+
+### getBasePrice()
+- getBasePrice(): [Money](dw.value.Money.md)
+  - : Price of a single unit before discount application.
+
+    **Returns:**
+    - Price of a single unit before discount application.
+
+
+---
+
+### getCapturedAmount()
+- getCapturedAmount(): [Money](dw.value.Money.md)
+  - : Returns the captured amount for this item.
+
+    **Returns:**
+    - the captured amount for this item
+
+
+---
+
+### getInvoiceNumber()
+- getInvoiceNumber(): [String](TopLevel.String.md)
+  - : Returns the number of the invoice to which this item belongs.
+
+    **Returns:**
+    - the number of the invoice to which this item belongs
+
+
+---
+
+### getParentItem()
+- getParentItem(): [InvoiceItem](dw.order.InvoiceItem.md)
+  - : Returns null or the parent item.
+
+    **Returns:**
+    - null or the parent item.
+
+
+---
+
+### getQuantity()
+- getQuantity(): [Quantity](dw.value.Quantity.md)
+  - : Returns the quantity of this item.
+
+    **Returns:**
+    - quantity of this item
+
+
+---
+
+### getRefundedAmount()
+- getRefundedAmount(): [Money](dw.value.Money.md)
+  - : Returns the refunded amount for this item.
+
+    **Returns:**
+    - the refunded amount for this item
+
+
+---
+
+### setCapturedAmount(Money)
+- setCapturedAmount(capturedAmount: [Money](dw.value.Money.md)): void
+  - : Updates the captured amount for this item.
+
+    **Parameters:**
+    - capturedAmount - the captured amount for this item
+
+
+---
+
+### setParentItem(InvoiceItem)
+- setParentItem(parentItem: [InvoiceItem](dw.order.InvoiceItem.md)): void
+  - : Set a parent item. The parent item must belong to the same
+      [Invoice](dw.order.Invoice.md). An infinite parent-child loop is disallowed
+      as is a parent-child depth greater than 10. Setting a parent item
+      indicates a dependency of the child item on the parent item, and can be
+      used to form a parallel structure to that accessed using
+      [ProductLineItem.getParent()](dw.order.ProductLineItem.md#getparent).
+
+
+    **Parameters:**
+    - parentItem - The parent item, null is allowed
+
+
+---
+
+### setRefundedAmount(Money)
+- setRefundedAmount(refundedAmount: [Money](dw.value.Money.md)): void
+  - : Updates the refunded amount for this item.
+
+    **Parameters:**
+    - refundedAmount - the refunded amount for this item
+
+
+---
+
+<!-- prettier-ignore-end -->

package/data/script-api/dw.order.LineItem.md

@@ -0,0 +1,489 @@
+<!-- prettier-ignore-start -->
+# Class LineItem
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.object.PersistentObject](dw.object.PersistentObject.md)
+    - [dw.object.ExtensibleObject](dw.object.ExtensibleObject.md)
+      - [dw.order.LineItem](dw.order.LineItem.md)
+
+Common line item base class.
+
+
+## All Known Subclasses
+[GiftCertificateLineItem](dw.order.GiftCertificateLineItem.md), [PriceAdjustment](dw.order.PriceAdjustment.md), [ProductLineItem](dw.order.ProductLineItem.md), [ProductShippingLineItem](dw.order.ProductShippingLineItem.md), [ShippingLineItem](dw.order.ShippingLineItem.md)
+## Property Summary
+
+| Property | Description |
+| --- | --- |
+| [basePrice](#baseprice): [Money](dw.value.Money.md) | Returns the base price for the line item, which is the price of the unit before applying adjustments, in the  purchase currency. |
+| [grossPrice](#grossprice): [Money](dw.value.Money.md) | Returns the gross price for the line item, which is the price of the unit before applying adjustments, in the  purchase currency, including tax. |
+| [lineItemCtnr](#lineitemctnr): [LineItemCtnr](dw.order.LineItemCtnr.md) `(read-only)` | Returns the line item ctnr of the line item. |
+| [lineItemText](#lineitemtext): [String](TopLevel.String.md) | Returns the display text for the line item. |
+| [netPrice](#netprice): [Money](dw.value.Money.md) | Returns the net price for the line item, which is the price of the unit before applying adjustments, in the  purchase currency, excluding tax. |
+| [price](#price): [Money](dw.value.Money.md) `(read-only)` | Get the price of the line item. |
+| [priceValue](#pricevalue): [Number](TopLevel.Number.md) | Return the price amount for the line item. |
+| [tax](#tax): [Money](dw.value.Money.md) | Returns the tax for the line item, which is the tax of the unit before applying adjustments, in the purchase  currency. |
+| [taxBasis](#taxbasis): [Money](dw.value.Money.md) `(read-only)` | Get the price used to calculate the tax for this line item. |
+| [taxClassID](#taxclassid): [String](TopLevel.String.md) | Returns the tax class ID for the line item or null if no tax class ID is associated with the line item. |
+| [taxRate](#taxrate): [Number](TopLevel.Number.md) | Returns the tax rate, which is the decimal tax rate to be applied to the product represented by this line item. |
+
+## Constructor Summary
+
+This class does not have a constructor, so you cannot create it directly.
+## Method Summary
+
+| Method | Description |
+| --- | --- |
+| [getBasePrice](dw.order.LineItem.md#getbaseprice)() | Returns the base price for the line item, which is the price of the unit before applying adjustments, in the  purchase currency. |
+| [getGrossPrice](dw.order.LineItem.md#getgrossprice)() | Returns the gross price for the line item, which is the price of the unit before applying adjustments, in the  purchase currency, including tax. |
+| [getLineItemCtnr](dw.order.LineItem.md#getlineitemctnr)() | Returns the line item ctnr of the line item. |
+| [getLineItemText](dw.order.LineItem.md#getlineitemtext)() | Returns the display text for the line item. |
+| [getNetPrice](dw.order.LineItem.md#getnetprice)() | Returns the net price for the line item, which is the price of the unit before applying adjustments, in the  purchase currency, excluding tax. |
+| [getPrice](dw.order.LineItem.md#getprice)() | Get the price of the line item. |
+| [getPriceValue](dw.order.LineItem.md#getpricevalue)() | Return the price amount for the line item. |
+| [getTax](dw.order.LineItem.md#gettax)() | Returns the tax for the line item, which is the tax of the unit before applying adjustments, in the purchase  currency. |
+| [getTaxBasis](dw.order.LineItem.md#gettaxbasis)() | Get the price used to calculate the tax for this line item. |
+| [getTaxClassID](dw.order.LineItem.md#gettaxclassid)() | Returns the tax class ID for the line item or null if no tax class ID is associated with the line item. |
+| [getTaxRate](dw.order.LineItem.md#gettaxrate)() | Returns the tax rate, which is the decimal tax rate to be applied to the product represented by this line item. |
+| ~~[setBasePrice](dw.order.LineItem.md#setbasepricemoney)([Money](dw.value.Money.md))~~ | Sets the base price for the line item, which is the price of the unit before applying adjustments, in the  purchase currency. |
+| ~~[setGrossPrice](dw.order.LineItem.md#setgrosspricemoney)([Money](dw.value.Money.md))~~ | Sets the gross price for the line item, which is the Price of the unit before applying adjustments, in the  purchase currency, including tax. |
+| [setLineItemText](dw.order.LineItem.md#setlineitemtextstring)([String](TopLevel.String.md)) | Sets the display text for the line item. |
+| ~~[setNetPrice](dw.order.LineItem.md#setnetpricemoney)([Money](dw.value.Money.md))~~ | Sets the value for the net price, which is the price of the unit before applying adjustments, in the purchase  currency, excluding tax. |
+| [setPriceValue](dw.order.LineItem.md#setpricevaluenumber)([Number](TopLevel.Number.md)) | Sets price attributes of the line item based on the current purchase currency and taxation policy. |
+| [setTax](dw.order.LineItem.md#settaxmoney)([Money](dw.value.Money.md)) | Sets the value for the tax of the line item, which is the the tax of the unit before applying adjustments, in the  purchase currency. |
+| [setTaxClassID](dw.order.LineItem.md#settaxclassidstring)([String](TopLevel.String.md)) | Sets the tax class ID for the line item. |
+| [setTaxRate](dw.order.LineItem.md#settaxratenumber)([Number](TopLevel.Number.md)) | Sets the tax rate, which is the decimal tax rate to be applied to the product represented by this line item. |
+| ~~[updatePrice](dw.order.LineItem.md#updatepricemoney)([Money](dw.value.Money.md))~~ | Updates the price attributes of the line item based on the specified price. |
+| [updateTax](dw.order.LineItem.md#updatetaxnumber)([Number](TopLevel.Number.md)) | Updates the tax-related attributes of the line item based on the specified tax rate, a tax basis determined by  the system and the "Tax Rounding Mode" order preference. |
+| [updateTax](dw.order.LineItem.md#updatetaxnumber-money)([Number](TopLevel.Number.md), [Money](dw.value.Money.md)) | Updates the tax-related attributes of the line item based on the specified tax rate, the passed tax basis and the  "Tax Rounding Mode" order preference. |
+| [updateTaxAmount](dw.order.LineItem.md#updatetaxamountmoney)([Money](dw.value.Money.md)) | Updates tax amount of the line item setting the provided value. |
+
+### Methods inherited from class ExtensibleObject
+
+[describe](dw.object.ExtensibleObject.md#describe), [getCustom](dw.object.ExtensibleObject.md#getcustom)
+### Methods inherited from class PersistentObject
+
+[getCreationDate](dw.object.PersistentObject.md#getcreationdate), [getLastModified](dw.object.PersistentObject.md#getlastmodified), [getUUID](dw.object.PersistentObject.md#getuuid)
+### Methods inherited from class Object
+
+[assign](TopLevel.Object.md#assignobject-object), [create](TopLevel.Object.md#createobject), [create](TopLevel.Object.md#createobject-object), [defineProperties](TopLevel.Object.md#definepropertiesobject-object), [defineProperty](TopLevel.Object.md#definepropertyobject-object-object), [entries](TopLevel.Object.md#entriesobject), [freeze](TopLevel.Object.md#freezeobject), [fromEntries](TopLevel.Object.md#fromentriesiterable), [getOwnPropertyDescriptor](TopLevel.Object.md#getownpropertydescriptorobject-object), [getOwnPropertyNames](TopLevel.Object.md#getownpropertynamesobject), [getOwnPropertySymbols](TopLevel.Object.md#getownpropertysymbolsobject), [getPrototypeOf](TopLevel.Object.md#getprototypeofobject), [hasOwnProperty](TopLevel.Object.md#hasownpropertystring), [is](TopLevel.Object.md#isobject-object), [isExtensible](TopLevel.Object.md#isextensibleobject), [isFrozen](TopLevel.Object.md#isfrozenobject), [isPrototypeOf](TopLevel.Object.md#isprototypeofobject), [isSealed](TopLevel.Object.md#issealedobject), [keys](TopLevel.Object.md#keysobject), [preventExtensions](TopLevel.Object.md#preventextensionsobject), [propertyIsEnumerable](TopLevel.Object.md#propertyisenumerablestring), [seal](TopLevel.Object.md#sealobject), [setPrototypeOf](TopLevel.Object.md#setprototypeofobject-object), [toLocaleString](TopLevel.Object.md#tolocalestring), [toString](TopLevel.Object.md#tostring), [valueOf](TopLevel.Object.md#valueof), [values](TopLevel.Object.md#valuesobject)
+## Property Details
+
+### basePrice
+- basePrice: [Money](dw.value.Money.md)
+  - : Returns the base price for the line item, which is the price of the unit before applying adjustments, in the
+      purchase currency. The base price may be net or gross of tax depending on the configured taxation policy.
+
+
+
+---
+
+### grossPrice
+- grossPrice: [Money](dw.value.Money.md)
+  - : Returns the gross price for the line item, which is the price of the unit before applying adjustments, in the
+      purchase currency, including tax.
+
+
+
+---
+
+### lineItemCtnr
+- lineItemCtnr: [LineItemCtnr](dw.order.LineItemCtnr.md) `(read-only)`
+  - : Returns the line item ctnr of the line item.
+
+
+---
+
+### lineItemText
+- lineItemText: [String](TopLevel.String.md)
+  - : Returns the display text for the line item.
+
+
+---
+
+### netPrice
+- netPrice: [Money](dw.value.Money.md)
+  - : Returns the net price for the line item, which is the price of the unit before applying adjustments, in the
+      purchase currency, excluding tax.
+
+
+
+---
+
+### price
+- price: [Money](dw.value.Money.md) `(read-only)`
+  - : Get the price of the line item. If the line item is based on net pricing then the net price is returned. If the
+      line item is based on gross pricing then the gross price is returned.
+
+
+
+---
+
+### priceValue
+- priceValue: [Number](TopLevel.Number.md)
+  - : Return the price amount for the line item. Same as getPrice().getValue().
+
+
+---
+
+### tax
+- tax: [Money](dw.value.Money.md)
+  - : Returns the tax for the line item, which is the tax of the unit before applying adjustments, in the purchase
+      currency.
+
+
+
+---
+
+### taxBasis
+- taxBasis: [Money](dw.value.Money.md) `(read-only)`
+  - : Get the price used to calculate the tax for this line item.
+
+
+---
+
+### taxClassID
+- taxClassID: [String](TopLevel.String.md)
+  - : Returns the tax class ID for the line item or null if no tax class ID is associated with the line item. In the
+      case where the tax class ID is null, you should use the default tax class ID.
+
+
+    **See Also:**
+    - [TaxMgr.getDefaultTaxClassID()](dw.order.TaxMgr.md#getdefaulttaxclassid)
+
+
+---
+
+### taxRate
+- taxRate: [Number](TopLevel.Number.md)
+  - : Returns the tax rate, which is the decimal tax rate to be applied to the product represented by this line item. A
+      value of 0.175 represents a percentage of 17.5%.
+
+
+
+---
+
+## Method Details
+
+### getBasePrice()
+- getBasePrice(): [Money](dw.value.Money.md)
+  - : Returns the base price for the line item, which is the price of the unit before applying adjustments, in the
+      purchase currency. The base price may be net or gross of tax depending on the configured taxation policy.
+
+
+    **Returns:**
+    - the base price for the line item.
+
+
+---
+
+### getGrossPrice()
+- getGrossPrice(): [Money](dw.value.Money.md)
+  - : Returns the gross price for the line item, which is the price of the unit before applying adjustments, in the
+      purchase currency, including tax.
+
+
+    **Returns:**
+    - the value of the gross price.
+
+
+---
+
+### getLineItemCtnr()
+- getLineItemCtnr(): [LineItemCtnr](dw.order.LineItemCtnr.md)
+  - : Returns the line item ctnr of the line item.
+
+    **Returns:**
+    - Line item ctnr of the line item
+
+
+---
+
+### getLineItemText()
+- getLineItemText(): [String](TopLevel.String.md)
+  - : Returns the display text for the line item.
+
+    **Returns:**
+    - the display text.
+
+
+---
+
+### getNetPrice()
+- getNetPrice(): [Money](dw.value.Money.md)
+  - : Returns the net price for the line item, which is the price of the unit before applying adjustments, in the
+      purchase currency, excluding tax.
+
+
+    **Returns:**
+    - the value for the net price.
+
+
+---
+
+### getPrice()
+- getPrice(): [Money](dw.value.Money.md)
+  - : Get the price of the line item. If the line item is based on net pricing then the net price is returned. If the
+      line item is based on gross pricing then the gross price is returned.
+
+
+    **Returns:**
+    - either the net or the gross price
+
+
+---
+
+### getPriceValue()
+- getPriceValue(): [Number](TopLevel.Number.md)
+  - : Return the price amount for the line item. Same as getPrice().getValue().
+
+    **Returns:**
+    - the price for the line item
+
+
+---
+
+### getTax()
+- getTax(): [Money](dw.value.Money.md)
+  - : Returns the tax for the line item, which is the tax of the unit before applying adjustments, in the purchase
+      currency.
+
+
+    **Returns:**
+    - the tax for the line item.
+
+
+---
+
+### getTaxBasis()
+- getTaxBasis(): [Money](dw.value.Money.md)
+  - : Get the price used to calculate the tax for this line item.
+
+    **Returns:**
+    - The tax basis used to calculate tax for this line item, or Money.NOT\_AVAILABLE if tax has not been set
+              for this line item yet.
+
+
+
+---
+
+### getTaxClassID()
+- getTaxClassID(): [String](TopLevel.String.md)
+  - : Returns the tax class ID for the line item or null if no tax class ID is associated with the line item. In the
+      case where the tax class ID is null, you should use the default tax class ID.
+
+
+    **Returns:**
+    - the tax class ID for the line item or null if no tax class ID is associated with the line item.
+
+    **See Also:**
+    - [TaxMgr.getDefaultTaxClassID()](dw.order.TaxMgr.md#getdefaulttaxclassid)
+
+
+---
+
+### getTaxRate()
+- getTaxRate(): [Number](TopLevel.Number.md)
+  - : Returns the tax rate, which is the decimal tax rate to be applied to the product represented by this line item. A
+      value of 0.175 represents a percentage of 17.5%.
+
+
+    **Returns:**
+    - the value of the tax rate.
+
+
+---
+
+### setBasePrice(Money)
+- ~~setBasePrice(aValue: [Money](dw.value.Money.md)): void~~
+  - : Sets the base price for the line item, which is the price of the unit before applying adjustments, in the
+      purchase currency. The base price may be net or gross of tax depending on the configured taxation policy.
+
+
+    **Parameters:**
+    - aValue - the new value of the base price.
+
+    **Deprecated:**
+:::warning
+Use [updatePrice(Money)](dw.order.LineItem.md#updatepricemoney) instead.
+:::
+
+---
+
+### setGrossPrice(Money)
+- ~~setGrossPrice(aValue: [Money](dw.value.Money.md)): void~~
+  - : Sets the gross price for the line item, which is the Price of the unit before applying adjustments, in the
+      purchase currency, including tax.
+
+
+    **Parameters:**
+    - aValue - the new value of the attribute
+
+    **Deprecated:**
+:::warning
+Use [updatePrice(Money)](dw.order.LineItem.md#updatepricemoney) which sets the base price and also the gross price if the line item
+            is based on gross pricing.
+
+:::
+
+---
+
+### setLineItemText(String)
+- setLineItemText(aText: [String](TopLevel.String.md)): void
+  - : Sets the display text for the line item.
+
+    **Parameters:**
+    - aText - line item text.
+
+
+---
+
+### setNetPrice(Money)
+- ~~setNetPrice(aValue: [Money](dw.value.Money.md)): void~~
+  - : Sets the value for the net price, which is the price of the unit before applying adjustments, in the purchase
+      currency, excluding tax.
+
+
+    **Parameters:**
+    - aValue - the new value for the net price
+
+    **Deprecated:**
+:::warning
+Use [updatePrice(Money)](dw.order.LineItem.md#updatepricemoney) which sets the base price and also the net price if the line item is
+            based on net pricing.
+
+:::
+
+---
+
+### setPriceValue(Number)
+- setPriceValue(value: [Number](TopLevel.Number.md)): void
+  - : Sets price attributes of the line item based on the current purchase currency and taxation policy. 
+      
+      The methods sets the 'basePrice' attribute of the line item. Additionally, it sets the 'netPrice' attribute of
+      the line item if the current taxation policy is 'net', and the 'grossPrice' attribute, if the current taxation
+      policy is 'gross'. 
+      
+      If null is specified as value, the price attributes are reset to Money.NOT\_AVAILABLE.
+
+
+    **Parameters:**
+    - value - Price value or null
+
+
+---
+
+### setTax(Money)
+- setTax(aValue: [Money](dw.value.Money.md)): void
+  - : Sets the value for the tax of the line item, which is the the tax of the unit before applying adjustments, in the
+      purchase currency.
+
+
+    **Parameters:**
+    - aValue - the new value for the tax.
+
+
+---
+
+### setTaxClassID(String)
+- setTaxClassID(aValue: [String](TopLevel.String.md)): void
+  - : Sets the tax class ID for the line item.
+
+    **Parameters:**
+    - aValue - the tax class ID for the line item.
+
+
+---
+
+### setTaxRate(Number)
+- setTaxRate(taxRate: [Number](TopLevel.Number.md)): void
+  - : Sets the tax rate, which is the decimal tax rate to be applied to the product represented by this line item. A
+      value of 0.175 represents a percentage of 17.5%.
+
+
+    **Parameters:**
+    - taxRate - the new value for the tax rate.
+
+
+---
+
+### updatePrice(Money)
+- ~~updatePrice(price: [Money](dw.value.Money.md)): void~~
+  - : Updates the price attributes of the line item based on the specified price. The base price is set to the
+      specified value. If the line item is based on net pricing then the net price attribute is set. If the line item
+      is based on gross pricing then the gross price attribute is set. Whether or not a line item is based on net or
+      gross pricing is a site-wide configuration parameter.
+
+
+    **Parameters:**
+    - price - The price to use when performing the update. This price must not be null and must either be equal to             NOT\_AVAIALBLE or must have a currency code equal to that of the parent container.
+
+    **Deprecated:**
+:::warning
+Use [setPriceValue(Number)](dw.order.LineItem.md#setpricevaluenumber) instead.
+:::
+
+---
+
+### updateTax(Number)
+- updateTax(taxRate: [Number](TopLevel.Number.md)): void
+  - : Updates the tax-related attributes of the line item based on the specified tax rate, a tax basis determined by
+      the system and the "Tax Rounding Mode" order preference. This method sets the tax basis as an attribute, and is
+      not affected by the previous value of this attribute.
+      
+      
+      The value used as a basis depends on the type of line item this is and on the promotion preferences for the
+      current site. If you tax products, shipping, and discounts based on price (default), then the tax basis will
+      simply be equal to [getPrice()](dw.order.LineItem.md#getprice). If you tax products and shipping only based on adjusted price, then the
+      tax basis depends upon line item type as follows:
+      
+      - **ProductLineItem:**basis equals [ProductLineItem.getProratedPrice()](dw.order.ProductLineItem.md#getproratedprice).
+      - **ShippingLineItem:**basis equals [ShippingLineItem.getAdjustedPrice()](dw.order.ShippingLineItem.md#getadjustedprice).
+      - **ProductShippingLineItem:**basis equals  [ProductShippingLineItem.getAdjustedPrice()](dw.order.ProductShippingLineItem.md#getadjustedprice).
+      - **PriceAdjustment:**basis equals 0.00.
+      - All other line item types: basis equals [getPrice()](dw.order.LineItem.md#getprice).
+      
+      If null is passed as tax rate, tax-related attribute fields are set to N/A.
+
+
+    **Parameters:**
+    - taxRate - taxRate the tax rate to use or null.
+
+
+---
+
+### updateTax(Number, Money)
+- updateTax(taxRate: [Number](TopLevel.Number.md), taxBasis: [Money](dw.value.Money.md)): void
+  - : Updates the tax-related attributes of the line item based on the specified tax rate, the passed tax basis and the
+      "Tax Rounding Mode" order preference. If null is passed as tax rate or tax basis, tax-related attribute fields
+      are set to N/A.
+
+
+    **Parameters:**
+    - taxRate - the tax rate to use or null.
+    - taxBasis - the tax basis to use or null.
+
+
+---
+
+### updateTaxAmount(Money)
+- updateTaxAmount(tax: [Money](dw.value.Money.md)): void
+  - : Updates tax amount of the line item setting the provided value. Depending on the way how the tax is calculated
+      (based on net or gross price), the corresponding gross or net price is updated accordingly. For tax calculation
+      based on net price, the gross price is calculated by adding the tax to the net price. For tax calculation based
+      on gross price, the net price is calculated by subtracting the tax from the gross price.
+      
+      
+      If null is passed as tax amount, the item tax and resulting net or gross price are set to N/A.
+      
+      
+      Note that tax rate is not calculated and it is not updated.
+
+
+    **Parameters:**
+    - tax - the tax amount of the line item to set
+
+
+---
+
+<!-- prettier-ignore-end -->