Magento 2 Documentation  2.3
Documentation for Magento 2 CMS v2.3 (December 2018)
Public Member Functions | Data Fields
CreditmemoItemInterface Interface Reference
Inheritance diagram for CreditmemoItemInterface:
ExtensibleDataInterface Item

Public Member Functions

 getAdditionalData ()
 
 getBaseCost ()
 
 getBaseDiscountAmount ()
 
 getBaseDiscountTaxCompensationAmount ()
 
 getBasePrice ()
 
 getBasePriceInclTax ()
 
 getBaseRowTotal ()
 
 getBaseRowTotalInclTax ()
 
 getBaseTaxAmount ()
 
 getBaseWeeeTaxAppliedAmount ()
 
 getBaseWeeeTaxAppliedRowAmnt ()
 
 getBaseWeeeTaxDisposition ()
 
 getBaseWeeeTaxRowDisposition ()
 
 getDescription ()
 
 getDiscountAmount ()
 
 getEntityId ()
 
 setEntityId ($entityId)
 
 getDiscountTaxCompensationAmount ()
 
 getName ()
 
 getOrderItemId ()
 
 getParentId ()
 
 getPrice ()
 
 getPriceInclTax ()
 
 getProductId ()
 
 getQty ()
 
 getRowTotal ()
 
 getRowTotalInclTax ()
 
 getSku ()
 
 getTaxAmount ()
 
 getWeeeTaxApplied ()
 
 getWeeeTaxAppliedAmount ()
 
 getWeeeTaxAppliedRowAmount ()
 
 getWeeeTaxDisposition ()
 
 getWeeeTaxRowDisposition ()
 
 setParentId ($id)
 
 setBasePrice ($price)
 
 setTaxAmount ($amount)
 
 setBaseRowTotal ($amount)
 
 setDiscountAmount ($amount)
 
 setRowTotal ($amount)
 
 setBaseDiscountAmount ($amount)
 
 setPriceInclTax ($amount)
 
 setBaseTaxAmount ($amount)
 
 setBasePriceInclTax ($amount)
 
 setQty ($qty)
 
 setBaseCost ($baseCost)
 
 setPrice ($price)
 
 setBaseRowTotalInclTax ($amount)
 
 setRowTotalInclTax ($amount)
 
 setProductId ($id)
 
 setOrderItemId ($id)
 
 setAdditionalData ($additionalData)
 
 setDescription ($description)
 
 setSku ($sku)
 
 setName ($name)
 
 setDiscountTaxCompensationAmount ($amount)
 
 setBaseDiscountTaxCompensationAmount ($amount)
 
 setWeeeTaxDisposition ($weeeTaxDisposition)
 
 setWeeeTaxRowDisposition ($weeeTaxRowDisposition)
 
 setBaseWeeeTaxDisposition ($baseWeeeTaxDisposition)
 
 setBaseWeeeTaxRowDisposition ($baseWeeeTaxRowDisposition)
 
 setWeeeTaxApplied ($weeeTaxApplied)
 
 setBaseWeeeTaxAppliedAmount ($amount)
 
 setBaseWeeeTaxAppliedRowAmnt ($amnt)
 
 setWeeeTaxAppliedAmount ($amount)
 
 setWeeeTaxAppliedRowAmount ($amount)
 
 getExtensionAttributes ()
 
 setExtensionAttributes (\Magento\Sales\Api\Data\CreditmemoItemExtensionInterface $extensionAttributes)
 

Data Fields

const ENTITY_ID = 'entity_id'
 
const PARENT_ID = 'parent_id'
 
const BASE_PRICE = 'base_price'
 
const TAX_AMOUNT = 'tax_amount'
 
const BASE_ROW_TOTAL = 'base_row_total'
 
const DISCOUNT_AMOUNT = 'discount_amount'
 
const ROW_TOTAL = 'row_total'
 
const BASE_DISCOUNT_AMOUNT = 'base_discount_amount'
 
const PRICE_INCL_TAX = 'price_incl_tax'
 
const BASE_TAX_AMOUNT = 'base_tax_amount'
 
const BASE_PRICE_INCL_TAX = 'base_price_incl_tax'
 
const QTY = 'qty'
 
const BASE_COST = 'base_cost'
 
const PRICE = 'price'
 
const BASE_ROW_TOTAL_INCL_TAX = 'base_row_total_incl_tax'
 
const ROW_TOTAL_INCL_TAX = 'row_total_incl_tax'
 
const PRODUCT_ID = 'product_id'
 
const ORDER_ITEM_ID = 'order_item_id'
 
const ADDITIONAL_DATA = 'additional_data'
 
const DESCRIPTION = 'description'
 
const SKU = 'sku'
 
const NAME = 'name'
 
const DISCOUNT_TAX_COMPENSATION_AMOUNT = 'discount_tax_compensation_amount'
 
const BASE_DISCOUNT_TAX_COMPENSATION_AMOUNT = 'base_discount_tax_compensation_amount'
 
const WEEE_TAX_DISPOSITION = 'weee_tax_disposition'
 
const WEEE_TAX_ROW_DISPOSITION = 'weee_tax_row_disposition'
 
const BASE_WEEE_TAX_DISPOSITION = 'base_weee_tax_disposition'
 
const BASE_WEEE_TAX_ROW_DISPOSITION = 'base_weee_tax_row_disposition'
 
const WEEE_TAX_APPLIED = 'weee_tax_applied'
 
const BASE_WEEE_TAX_APPLIED_AMOUNT = 'base_weee_tax_applied_amount'
 
const BASE_WEEE_TAX_APPLIED_ROW_AMNT = 'base_weee_tax_applied_row_amnt'
 
const WEEE_TAX_APPLIED_AMOUNT = 'weee_tax_applied_amount'
 
const WEEE_TAX_APPLIED_ROW_AMOUNT = 'weee_tax_applied_row_amount'
 
- Data Fields inherited from ExtensibleDataInterface
const EXTENSION_ATTRIBUTES_KEY = 'extension_attributes'
 

Detailed Description

Credit memo item interface.

After a customer places and pays for an order and an invoice has been issued, the merchant can create a credit memo to refund all or part of the amount paid for any returned or undelivered items. The memo restores funds to the customer account so that the customer can make future purchases. A credit memo item is an invoiced item for which a merchant creates a credit memo. @api

Since
100.0.2

Definition at line 18 of file CreditmemoItemInterface.php.

Member Function Documentation

◆ getAdditionalData()

getAdditionalData ( )

Gets the additional data for a credit memo item.

Returns
string|null Additional data.

Implemented in Item.

◆ getBaseCost()

getBaseCost ( )

Gets the base cost for a credit memo item.

Returns
float

Implemented in Item.

◆ getBaseDiscountAmount()

getBaseDiscountAmount ( )

Gets the base discount amount for a credit memo item.

Returns
float|null

Implemented in Item.

◆ getBaseDiscountTaxCompensationAmount()

getBaseDiscountTaxCompensationAmount ( )

Gets the base discount tax compensation amount for a credit memo item.

Returns
float|null

Implemented in Item.

◆ getBasePrice()

getBasePrice ( )

Gets the base price for a credit memo item.

Returns
float

Implemented in Item.

◆ getBasePriceInclTax()

getBasePriceInclTax ( )

Gets the base price including tax for a credit memo item.

Returns
float|null Base price including tax.

Implemented in Item.

◆ getBaseRowTotal()

getBaseRowTotal ( )

Gets the base row total for a credit memo item.

Returns
float|null Base row total.

Implemented in Item.

◆ getBaseRowTotalInclTax()

getBaseRowTotalInclTax ( )

Gets the base row total including tax for a credit memo item.

Returns
float|null Base row total including tax.

Implemented in Item.

◆ getBaseTaxAmount()

getBaseTaxAmount ( )

Gets the base tax amount for a credit memo item.

Returns
float|null Base tax amount.

Implemented in Item.

◆ getBaseWeeeTaxAppliedAmount()

getBaseWeeeTaxAppliedAmount ( )

Gets the base WEEE tax applied amount for a credit memo item.

Returns
float|null Base WEEE tax applied amount.

Implemented in Item.

◆ getBaseWeeeTaxAppliedRowAmnt()

getBaseWeeeTaxAppliedRowAmnt ( )

Gets the base WEEE tax applied row amount for a credit memo item.

Returns
float|null Base WEEE tax applied row amount.

Implemented in Item.

◆ getBaseWeeeTaxDisposition()

getBaseWeeeTaxDisposition ( )

Gets the base WEEE tax disposition for a credit memo item.

Returns
float|null Base WEEE tax disposition.

Implemented in Item.

◆ getBaseWeeeTaxRowDisposition()

getBaseWeeeTaxRowDisposition ( )

Gets the base WEEE tax row disposition for a credit memo item.

Returns
float|null Base WEEE tax row disposition.

Implemented in Item.

◆ getDescription()

getDescription ( )

Gets the description for a credit memo item.

Returns
string|null Description.

Implemented in Item.

◆ getDiscountAmount()

getDiscountAmount ( )

Gets the discount amount for a credit memo item.

Returns
float|null Discount amount.

Implemented in Item.

◆ getDiscountTaxCompensationAmount()

getDiscountTaxCompensationAmount ( )

Gets the discount tax compensation amount for a credit memo item.

Returns
float|null Discount tax compensation amount.

Implemented in Item.

◆ getEntityId()

getEntityId ( )

Gets the ID for a credit memo item.

Returns
int Credit memo item ID.

◆ getExtensionAttributes()

getExtensionAttributes ( )

Retrieve existing extension attributes object or create a new one.

Returns
\Magento\Sales\Api\Data\CreditmemoItemExtensionInterface|null

Implemented in Item.

◆ getName()

getName ( )

Gets the name for a credit memo item.

Returns
string|null Name.

Implemented in Item.

◆ getOrderItemId()

getOrderItemId ( )

Gets the order item ID for a credit memo item.

Returns
int Order item ID.

Implemented in Item.

◆ getParentId()

getParentId ( )

Gets the parent ID for a credit memo item.

Returns
int|null Parent ID.

Implemented in Item.

◆ getPrice()

getPrice ( )

Gets the price for a credit memo item.

Returns
float|null Price.

Implemented in Item.

◆ getPriceInclTax()

getPriceInclTax ( )

Gets the price including tax for a credit memo item.

Returns
float|null Price including tax.

Implemented in Item.

◆ getProductId()

getProductId ( )

Gets the product ID for a credit memo item.

Returns
int|null Product ID.

Implemented in Item.

◆ getQty()

getQty ( )

Gets the quantity for a credit memo item.

Returns
float Quantity.

Implemented in Item.

◆ getRowTotal()

getRowTotal ( )

Gets the row total for a credit memo item.

Returns
float|null Row total.

Implemented in Item.

◆ getRowTotalInclTax()

getRowTotalInclTax ( )

Gets the row total including tax for a credit memo item.

Returns
float|null Row total including tax.

Implemented in Item.

◆ getSku()

getSku ( )

Gets the SKU for a credit memo item.

Returns
string|null SKU.

Implemented in Item.

◆ getTaxAmount()

getTaxAmount ( )

Gets the tax amount for a credit memo item.

Returns
float|null Tax amount.

Implemented in Item.

◆ getWeeeTaxApplied()

getWeeeTaxApplied ( )

Gets the WEEE tax applied for a credit memo item.

Returns
string|null WEEE tax applied.

Implemented in Item.

◆ getWeeeTaxAppliedAmount()

getWeeeTaxAppliedAmount ( )

Gets the WEEE tax applied amount for a credit memo item.

Returns
float|null WEEE tax applied amount.

Implemented in Item.

◆ getWeeeTaxAppliedRowAmount()

getWeeeTaxAppliedRowAmount ( )

Gets the WEEE tax applied row amount for a credit memo item.

Returns
float|null WEEE tax applied row amount.

Implemented in Item.

◆ getWeeeTaxDisposition()

getWeeeTaxDisposition ( )

Gets the WEEE tax disposition for a credit memo item.

Returns
float|null WEEE tax disposition.

Implemented in Item.

◆ getWeeeTaxRowDisposition()

getWeeeTaxRowDisposition ( )

Gets the WEEE tax row disposition for a credit memo item.

Returns
float|null WEEE tax row disposition.

Implemented in Item.

◆ setAdditionalData()

setAdditionalData (   $additionalData)

Sets the additional data for a credit memo item.

Parameters
string$additionalData
Returns
$this

Implemented in Item.

◆ setBaseCost()

setBaseCost (   $baseCost)

Sets the base cost for a credit memo item.

Parameters
float$baseCost
Returns
$this

Implemented in Item.

◆ setBaseDiscountAmount()

setBaseDiscountAmount (   $amount)

Sets the base discount amount for a credit memo item.

Parameters
float$amount
Returns
$this

Implemented in Item.

◆ setBaseDiscountTaxCompensationAmount()

setBaseDiscountTaxCompensationAmount (   $amount)

Sets the base discount tax compensation amount for a credit memo item.

Parameters
float$amount
Returns
$this

Implemented in Item.

◆ setBasePrice()

setBasePrice (   $price)

Sets the base price for a credit memo item.

Parameters
float$price
Returns
$this

Implemented in Item.

◆ setBasePriceInclTax()

setBasePriceInclTax (   $amount)

Sets the base price including tax for a credit memo item.

Parameters
float$amount
Returns
$this

Implemented in Item.

◆ setBaseRowTotal()

setBaseRowTotal (   $amount)

Sets the base row total for a credit memo item.

Parameters
float$amount
Returns
$this

Implemented in Item.

◆ setBaseRowTotalInclTax()

setBaseRowTotalInclTax (   $amount)

Sets the base row total including tax for a credit memo item.

Parameters
float$amount
Returns
$this

Implemented in Item.

◆ setBaseTaxAmount()

setBaseTaxAmount (   $amount)

Sets the base tax amount for a credit memo item.

Parameters
float$amount
Returns
$this

Implemented in Item.

◆ setBaseWeeeTaxAppliedAmount()

setBaseWeeeTaxAppliedAmount (   $amount)

Sets the base WEEE tax applied amount for a credit memo item.

Parameters
float$amount
Returns
$this

Implemented in Item.

◆ setBaseWeeeTaxAppliedRowAmnt()

setBaseWeeeTaxAppliedRowAmnt (   $amnt)

Sets the base WEEE tax applied row amount for a credit memo item.

Parameters
float$amnt
Returns
$this

Implemented in Item.

◆ setBaseWeeeTaxDisposition()

setBaseWeeeTaxDisposition (   $baseWeeeTaxDisposition)

Sets the base WEEE tax disposition for a credit memo item.

Parameters
float$baseWeeeTaxDisposition
Returns
$this

Implemented in Item.

◆ setBaseWeeeTaxRowDisposition()

setBaseWeeeTaxRowDisposition (   $baseWeeeTaxRowDisposition)

Sets the base WEEE tax row disposition for a credit memo item.

Parameters
float$baseWeeeTaxRowDisposition
Returns
$this

Implemented in Item.

◆ setDescription()

setDescription (   $description)

Sets the description for a credit memo item.

Parameters
string$description
Returns
$this

Implemented in Item.

◆ setDiscountAmount()

setDiscountAmount (   $amount)

Sets the discount amount for a credit memo item.

Parameters
float$amount
Returns
$this

Implemented in Item.

◆ setDiscountTaxCompensationAmount()

setDiscountTaxCompensationAmount (   $amount)

Sets the discount tax compensation amount for a credit memo item.

Parameters
float$amount
Returns
$this

Implemented in Item.

◆ setEntityId()

setEntityId (   $entityId)

Sets entity ID.

Parameters
int$entityId
Returns
$this

◆ setExtensionAttributes()

setExtensionAttributes ( \Magento\Sales\Api\Data\CreditmemoItemExtensionInterface  $extensionAttributes)

Set an extension attributes object.

Parameters
\Magento\Sales\Api\Data\CreditmemoItemExtensionInterface$extensionAttributes
Returns
$this

◆ setName()

setName (   $name)

Sets the name for a credit memo item.

Parameters
string$name
Returns
$this

Implemented in Item.

◆ setOrderItemId()

setOrderItemId (   $id)

Sets the order item ID for a credit memo item.

Parameters
int$id
Returns
$this

Implemented in Item.

◆ setParentId()

setParentId (   $id)

Sets the parent ID for a credit memo item.

Parameters
int$id
Returns
$this

Implemented in Item.

◆ setPrice()

setPrice (   $price)

Sets the price for a credit memo item.

Parameters
float$price
Returns
$this

Implemented in Item.

◆ setPriceInclTax()

setPriceInclTax (   $amount)

Sets the price including tax for a credit memo item.

Parameters
float$amount
Returns
$this

Implemented in Item.

◆ setProductId()

setProductId (   $id)

Sets the product ID for a credit memo item.

Parameters
int$id
Returns
$this

Implemented in Item.

◆ setQty()

setQty (   $qty)

Sets the quantity for a credit memo item.

Parameters
float$qty
Returns
$this

Implemented in Item.

◆ setRowTotal()

setRowTotal (   $amount)

Sets the row total for a credit memo item.

Parameters
float$amount
Returns
$this

Implemented in Item.

◆ setRowTotalInclTax()

setRowTotalInclTax (   $amount)

Sets the row total including tax for a credit memo item.

Parameters
float$amount
Returns
$this

Implemented in Item.

◆ setSku()

setSku (   $sku)

Sets the SKU for a credit memo item.

Parameters
string$sku
Returns
$this

Implemented in Item.

◆ setTaxAmount()

setTaxAmount (   $amount)

Sets the tax amount for a credit memo item.

Parameters
float$amount
Returns
$this

Implemented in Item.

◆ setWeeeTaxApplied()

setWeeeTaxApplied (   $weeeTaxApplied)

Sets the WEEE tax applied for a credit memo item.

Parameters
string$weeeTaxApplied
Returns
$this

Implemented in Item.

◆ setWeeeTaxAppliedAmount()

setWeeeTaxAppliedAmount (   $amount)

Sets the WEEE tax applied amount for a credit memo item.

Parameters
float$amount
Returns
$this

Implemented in Item.

◆ setWeeeTaxAppliedRowAmount()

setWeeeTaxAppliedRowAmount (   $amount)

Sets the WEEE tax applied row amount for a credit memo item.

Parameters
float$amount
Returns
$this

Implemented in Item.

◆ setWeeeTaxDisposition()

setWeeeTaxDisposition (   $weeeTaxDisposition)

Sets the WEEE tax disposition for a credit memo item.

Parameters
float$weeeTaxDisposition
Returns
$this

Implemented in Item.

◆ setWeeeTaxRowDisposition()

setWeeeTaxRowDisposition (   $weeeTaxRowDisposition)

Sets the WEEE tax row disposition for a credit memo item.

Parameters
float$weeeTaxRowDisposition
Returns
$this

Implemented in Item.

Field Documentation

◆ ADDITIONAL_DATA

const ADDITIONAL_DATA = 'additional_data'

Definition at line 98 of file CreditmemoItemInterface.php.

◆ BASE_COST

const BASE_COST = 'base_cost'

Definition at line 74 of file CreditmemoItemInterface.php.

◆ BASE_DISCOUNT_AMOUNT

const BASE_DISCOUNT_AMOUNT = 'base_discount_amount'

Definition at line 54 of file CreditmemoItemInterface.php.

◆ BASE_DISCOUNT_TAX_COMPENSATION_AMOUNT

const BASE_DISCOUNT_TAX_COMPENSATION_AMOUNT = 'base_discount_tax_compensation_amount'

Definition at line 118 of file CreditmemoItemInterface.php.

◆ BASE_PRICE

const BASE_PRICE = 'base_price'

Definition at line 34 of file CreditmemoItemInterface.php.

◆ BASE_PRICE_INCL_TAX

const BASE_PRICE_INCL_TAX = 'base_price_incl_tax'

Definition at line 66 of file CreditmemoItemInterface.php.

◆ BASE_ROW_TOTAL

const BASE_ROW_TOTAL = 'base_row_total'

Definition at line 42 of file CreditmemoItemInterface.php.

◆ BASE_ROW_TOTAL_INCL_TAX

const BASE_ROW_TOTAL_INCL_TAX = 'base_row_total_incl_tax'

Definition at line 82 of file CreditmemoItemInterface.php.

◆ BASE_TAX_AMOUNT

const BASE_TAX_AMOUNT = 'base_tax_amount'

Definition at line 62 of file CreditmemoItemInterface.php.

◆ BASE_WEEE_TAX_APPLIED_AMOUNT

const BASE_WEEE_TAX_APPLIED_AMOUNT = 'base_weee_tax_applied_amount'

Definition at line 142 of file CreditmemoItemInterface.php.

◆ BASE_WEEE_TAX_APPLIED_ROW_AMNT

const BASE_WEEE_TAX_APPLIED_ROW_AMNT = 'base_weee_tax_applied_row_amnt'

Definition at line 146 of file CreditmemoItemInterface.php.

◆ BASE_WEEE_TAX_DISPOSITION

const BASE_WEEE_TAX_DISPOSITION = 'base_weee_tax_disposition'

Definition at line 130 of file CreditmemoItemInterface.php.

◆ BASE_WEEE_TAX_ROW_DISPOSITION

const BASE_WEEE_TAX_ROW_DISPOSITION = 'base_weee_tax_row_disposition'

Definition at line 134 of file CreditmemoItemInterface.php.

◆ DESCRIPTION

const DESCRIPTION = 'description'

Definition at line 102 of file CreditmemoItemInterface.php.

◆ DISCOUNT_AMOUNT

const DISCOUNT_AMOUNT = 'discount_amount'

Definition at line 46 of file CreditmemoItemInterface.php.

◆ DISCOUNT_TAX_COMPENSATION_AMOUNT

const DISCOUNT_TAX_COMPENSATION_AMOUNT = 'discount_tax_compensation_amount'

Definition at line 114 of file CreditmemoItemInterface.php.

◆ ENTITY_ID

const ENTITY_ID = 'entity_id'

#+ Constants for keys of data array. Identical to the name of the getter in snake case.

Definition at line 26 of file CreditmemoItemInterface.php.

◆ NAME

const NAME = 'name'

Definition at line 110 of file CreditmemoItemInterface.php.

◆ ORDER_ITEM_ID

const ORDER_ITEM_ID = 'order_item_id'

Definition at line 94 of file CreditmemoItemInterface.php.

◆ PARENT_ID

const PARENT_ID = 'parent_id'

Definition at line 30 of file CreditmemoItemInterface.php.

◆ PRICE

const PRICE = 'price'

Definition at line 78 of file CreditmemoItemInterface.php.

◆ PRICE_INCL_TAX

const PRICE_INCL_TAX = 'price_incl_tax'

Definition at line 58 of file CreditmemoItemInterface.php.

◆ PRODUCT_ID

const PRODUCT_ID = 'product_id'

Definition at line 90 of file CreditmemoItemInterface.php.

◆ QTY

const QTY = 'qty'

Definition at line 70 of file CreditmemoItemInterface.php.

◆ ROW_TOTAL

const ROW_TOTAL = 'row_total'

Definition at line 50 of file CreditmemoItemInterface.php.

◆ ROW_TOTAL_INCL_TAX

const ROW_TOTAL_INCL_TAX = 'row_total_incl_tax'

Definition at line 86 of file CreditmemoItemInterface.php.

◆ SKU

const SKU = 'sku'

Definition at line 106 of file CreditmemoItemInterface.php.

◆ TAX_AMOUNT

const TAX_AMOUNT = 'tax_amount'

Definition at line 38 of file CreditmemoItemInterface.php.

◆ WEEE_TAX_APPLIED

const WEEE_TAX_APPLIED = 'weee_tax_applied'

Definition at line 138 of file CreditmemoItemInterface.php.

◆ WEEE_TAX_APPLIED_AMOUNT

const WEEE_TAX_APPLIED_AMOUNT = 'weee_tax_applied_amount'

Definition at line 150 of file CreditmemoItemInterface.php.

◆ WEEE_TAX_APPLIED_ROW_AMOUNT

const WEEE_TAX_APPLIED_ROW_AMOUNT = 'weee_tax_applied_row_amount'

Definition at line 154 of file CreditmemoItemInterface.php.

◆ WEEE_TAX_DISPOSITION

const WEEE_TAX_DISPOSITION = 'weee_tax_disposition'

Definition at line 122 of file CreditmemoItemInterface.php.

◆ WEEE_TAX_ROW_DISPOSITION

const WEEE_TAX_ROW_DISPOSITION = 'weee_tax_row_disposition'

Definition at line 126 of file CreditmemoItemInterface.php.


The documentation for this interface was generated from the following file: