Class InvoiceItem
Represents a specific item in an Invoice . 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
Constructor Summary
This class does not have a constructor, so you cannot create it directly.
Method Summary
Methods inherited from class AbstractItem
getGrossPrice , getItemID , getLineItem , getNetPrice , getOrderItem , getOrderItemID , getTax , getTaxBasis , getTaxItems
Methods inherited from class Extensible
describe , getCustom
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
basePrice
basePrice: Money (read-only)
Price of a single unit before discount application.
capturedAmount
capturedAmount: Money
Returns the captured amount for this item.
invoiceNumber
invoiceNumber: String (read-only)
Returns the number of the invoice to which this item belongs.
parentItem
parentItem: InvoiceItem
Returns null or the parent item.
quantity
quantity: Quantity (read-only)
Returns the quantity of this item.
refundedAmount
refundedAmount: Money
Returns the refunded amount for this item.
Method Details
getBasePrice()
getBasePrice(): Money
Price of a single unit before discount application.
Returns:
Price of a single unit before discount application.
getCapturedAmount()
getCapturedAmount(): Money
Returns the captured amount for this item.
Returns:
the captured amount for this item
getInvoiceNumber()
getInvoiceNumber(): String
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
Returns null or the parent item.
Returns:
getQuantity()
getQuantity(): Quantity
Returns the quantity of this item.
Returns:
getRefundedAmount()
getRefundedAmount(): Money
Returns the refunded amount for this item.
Returns:
the refunded amount for this item
setCapturedAmount(Money)
setCapturedAmount(capturedAmount: Money ): void
Updates the captured amount for this item.
Parameters:
capturedAmount - the captured amount for this item
setParentItem(InvoiceItem)
setParentItem(parentItem: InvoiceItem ): void
Set a parent item. The parent item must belong to the same
Invoice . 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() .
Parameters:
parentItem - The parent item, null is allowed
setRefundedAmount(Money)
setRefundedAmount(refundedAmount: Money ): void
Updates the refunded amount for this item.
Parameters:
refundedAmount - the refunded amount for this item
j