Magento 2 Documentation
2.3
Documentation for Magento 2 CMS v2.3 (December 2018)
|
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' |
![]() | |
const | EXTENSION_ATTRIBUTES_KEY = 'extension_attributes' |
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
Definition at line 18 of file CreditmemoItemInterface.php.
getAdditionalData | ( | ) |
Gets the additional data for a credit memo item.
Implemented in Item.
getBaseCost | ( | ) |
getBaseDiscountAmount | ( | ) |
getBaseDiscountTaxCompensationAmount | ( | ) |
Gets the base discount tax compensation amount for a credit memo item.
Implemented in Item.
getBasePrice | ( | ) |
getBasePriceInclTax | ( | ) |
Gets the base price including tax for a credit memo item.
Implemented in Item.
getBaseRowTotal | ( | ) |
Gets the base row total for a credit memo item.
Implemented in Item.
getBaseRowTotalInclTax | ( | ) |
Gets the base row total including tax for a credit memo item.
Implemented in Item.
getBaseTaxAmount | ( | ) |
Gets the base tax amount for a credit memo item.
Implemented in Item.
getBaseWeeeTaxAppliedAmount | ( | ) |
Gets the base WEEE tax applied amount for a credit memo item.
Implemented in Item.
getBaseWeeeTaxAppliedRowAmnt | ( | ) |
Gets the base WEEE tax applied row amount for a credit memo item.
Implemented in Item.
getBaseWeeeTaxDisposition | ( | ) |
Gets the base WEEE tax disposition for a credit memo item.
Implemented in Item.
getBaseWeeeTaxRowDisposition | ( | ) |
Gets the base WEEE tax row disposition for a credit memo item.
Implemented in Item.
getDescription | ( | ) |
getDiscountAmount | ( | ) |
Gets the discount amount for a credit memo item.
Implemented in Item.
getDiscountTaxCompensationAmount | ( | ) |
Gets the discount tax compensation amount for a credit memo item.
Implemented in Item.
getEntityId | ( | ) |
Gets the ID for a credit memo item.
getExtensionAttributes | ( | ) |
Retrieve existing extension attributes object or create a new one.
Implemented in Item.
getName | ( | ) |
getOrderItemId | ( | ) |
getParentId | ( | ) |
getPrice | ( | ) |
getPriceInclTax | ( | ) |
Gets the price including tax for a credit memo item.
Implemented in Item.
getProductId | ( | ) |
getQty | ( | ) |
getRowTotal | ( | ) |
getRowTotalInclTax | ( | ) |
Gets the row total including tax for a credit memo item.
Implemented in Item.
getSku | ( | ) |
getTaxAmount | ( | ) |
getWeeeTaxApplied | ( | ) |
Gets the WEEE tax applied for a credit memo item.
Implemented in Item.
getWeeeTaxAppliedAmount | ( | ) |
Gets the WEEE tax applied amount for a credit memo item.
Implemented in Item.
getWeeeTaxAppliedRowAmount | ( | ) |
Gets the WEEE tax applied row amount for a credit memo item.
Implemented in Item.
getWeeeTaxDisposition | ( | ) |
Gets the WEEE tax disposition for a credit memo item.
Implemented in Item.
getWeeeTaxRowDisposition | ( | ) |
Gets the WEEE tax row disposition for a credit memo item.
Implemented in Item.
setAdditionalData | ( | $additionalData | ) |
Sets the additional data for a credit memo item.
string | $additionalData |
Implemented in Item.
setBaseCost | ( | $baseCost | ) |
Sets the base cost for a credit memo item.
float | $baseCost |
Implemented in Item.
setBaseDiscountAmount | ( | $amount | ) |
Sets the base discount amount for a credit memo item.
float | $amount |
Implemented in Item.
setBaseDiscountTaxCompensationAmount | ( | $amount | ) |
Sets the base discount tax compensation amount for a credit memo item.
float | $amount |
Implemented in Item.
setBasePrice | ( | $price | ) |
Sets the base price for a credit memo item.
float | $price |
Implemented in Item.
setBasePriceInclTax | ( | $amount | ) |
Sets the base price including tax for a credit memo item.
float | $amount |
Implemented in Item.
setBaseRowTotal | ( | $amount | ) |
Sets the base row total for a credit memo item.
float | $amount |
Implemented in Item.
setBaseRowTotalInclTax | ( | $amount | ) |
Sets the base row total including tax for a credit memo item.
float | $amount |
Implemented in Item.
setBaseTaxAmount | ( | $amount | ) |
Sets the base tax amount for a credit memo item.
float | $amount |
Implemented in Item.
setBaseWeeeTaxAppliedAmount | ( | $amount | ) |
Sets the base WEEE tax applied amount for a credit memo item.
float | $amount |
Implemented in Item.
setBaseWeeeTaxAppliedRowAmnt | ( | $amnt | ) |
Sets the base WEEE tax applied row amount for a credit memo item.
float | $amnt |
Implemented in Item.
setBaseWeeeTaxDisposition | ( | $baseWeeeTaxDisposition | ) |
Sets the base WEEE tax disposition for a credit memo item.
float | $baseWeeeTaxDisposition |
Implemented in Item.
setBaseWeeeTaxRowDisposition | ( | $baseWeeeTaxRowDisposition | ) |
Sets the base WEEE tax row disposition for a credit memo item.
float | $baseWeeeTaxRowDisposition |
Implemented in Item.
setDescription | ( | $description | ) |
Sets the description for a credit memo item.
string | $description |
Implemented in Item.
setDiscountAmount | ( | $amount | ) |
Sets the discount amount for a credit memo item.
float | $amount |
Implemented in Item.
setDiscountTaxCompensationAmount | ( | $amount | ) |
Sets the discount tax compensation amount for a credit memo item.
float | $amount |
Implemented in Item.
setEntityId | ( | $entityId | ) |
Sets entity ID.
int | $entityId |
setExtensionAttributes | ( | \Magento\Sales\Api\Data\CreditmemoItemExtensionInterface | $extensionAttributes | ) |
Set an extension attributes object.
\Magento\Sales\Api\Data\CreditmemoItemExtensionInterface | $extensionAttributes |
setName | ( | $name | ) |
setOrderItemId | ( | $id | ) |
setParentId | ( | $id | ) |
setPrice | ( | $price | ) |
setPriceInclTax | ( | $amount | ) |
Sets the price including tax for a credit memo item.
float | $amount |
Implemented in Item.
setProductId | ( | $id | ) |
setQty | ( | $qty | ) |
setRowTotal | ( | $amount | ) |
Sets the row total for a credit memo item.
float | $amount |
Implemented in Item.
setRowTotalInclTax | ( | $amount | ) |
Sets the row total including tax for a credit memo item.
float | $amount |
Implemented in Item.
setSku | ( | $sku | ) |
setTaxAmount | ( | $amount | ) |
Sets the tax amount for a credit memo item.
float | $amount |
Implemented in Item.
setWeeeTaxApplied | ( | $weeeTaxApplied | ) |
Sets the WEEE tax applied for a credit memo item.
string | $weeeTaxApplied |
Implemented in Item.
setWeeeTaxAppliedAmount | ( | $amount | ) |
Sets the WEEE tax applied amount for a credit memo item.
float | $amount |
Implemented in Item.
setWeeeTaxAppliedRowAmount | ( | $amount | ) |
Sets the WEEE tax applied row amount for a credit memo item.
float | $amount |
Implemented in Item.
setWeeeTaxDisposition | ( | $weeeTaxDisposition | ) |
Sets the WEEE tax disposition for a credit memo item.
float | $weeeTaxDisposition |
Implemented in Item.
setWeeeTaxRowDisposition | ( | $weeeTaxRowDisposition | ) |
Sets the WEEE tax row disposition for a credit memo item.
float | $weeeTaxRowDisposition |
Implemented in Item.
const ADDITIONAL_DATA = 'additional_data' |
Definition at line 98 of file CreditmemoItemInterface.php.
const BASE_COST = 'base_cost' |
Definition at line 74 of file CreditmemoItemInterface.php.
const BASE_DISCOUNT_AMOUNT = 'base_discount_amount' |
Definition at line 54 of file CreditmemoItemInterface.php.
const BASE_DISCOUNT_TAX_COMPENSATION_AMOUNT = 'base_discount_tax_compensation_amount' |
Definition at line 118 of file CreditmemoItemInterface.php.
const BASE_PRICE = 'base_price' |
Definition at line 34 of file CreditmemoItemInterface.php.
const BASE_PRICE_INCL_TAX = 'base_price_incl_tax' |
Definition at line 66 of file CreditmemoItemInterface.php.
const BASE_ROW_TOTAL = 'base_row_total' |
Definition at line 42 of file CreditmemoItemInterface.php.
const BASE_ROW_TOTAL_INCL_TAX = 'base_row_total_incl_tax' |
Definition at line 82 of file CreditmemoItemInterface.php.
const BASE_TAX_AMOUNT = 'base_tax_amount' |
Definition at line 62 of file CreditmemoItemInterface.php.
const BASE_WEEE_TAX_APPLIED_AMOUNT = 'base_weee_tax_applied_amount' |
Definition at line 142 of file CreditmemoItemInterface.php.
const BASE_WEEE_TAX_APPLIED_ROW_AMNT = 'base_weee_tax_applied_row_amnt' |
Definition at line 146 of file CreditmemoItemInterface.php.
const BASE_WEEE_TAX_DISPOSITION = 'base_weee_tax_disposition' |
Definition at line 130 of file CreditmemoItemInterface.php.
const BASE_WEEE_TAX_ROW_DISPOSITION = 'base_weee_tax_row_disposition' |
Definition at line 134 of file CreditmemoItemInterface.php.
const DESCRIPTION = 'description' |
Definition at line 102 of file CreditmemoItemInterface.php.
const DISCOUNT_AMOUNT = 'discount_amount' |
Definition at line 46 of file CreditmemoItemInterface.php.
const DISCOUNT_TAX_COMPENSATION_AMOUNT = 'discount_tax_compensation_amount' |
Definition at line 114 of file CreditmemoItemInterface.php.
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.
const NAME = 'name' |
Definition at line 110 of file CreditmemoItemInterface.php.
const ORDER_ITEM_ID = 'order_item_id' |
Definition at line 94 of file CreditmemoItemInterface.php.
const PARENT_ID = 'parent_id' |
Definition at line 30 of file CreditmemoItemInterface.php.
const PRICE = 'price' |
Definition at line 78 of file CreditmemoItemInterface.php.
const PRICE_INCL_TAX = 'price_incl_tax' |
Definition at line 58 of file CreditmemoItemInterface.php.
const PRODUCT_ID = 'product_id' |
Definition at line 90 of file CreditmemoItemInterface.php.
const QTY = 'qty' |
Definition at line 70 of file CreditmemoItemInterface.php.
const ROW_TOTAL = 'row_total' |
Definition at line 50 of file CreditmemoItemInterface.php.
const ROW_TOTAL_INCL_TAX = 'row_total_incl_tax' |
Definition at line 86 of file CreditmemoItemInterface.php.
const SKU = 'sku' |
Definition at line 106 of file CreditmemoItemInterface.php.
const TAX_AMOUNT = 'tax_amount' |
Definition at line 38 of file CreditmemoItemInterface.php.
const WEEE_TAX_APPLIED = 'weee_tax_applied' |
Definition at line 138 of file CreditmemoItemInterface.php.
const WEEE_TAX_APPLIED_AMOUNT = 'weee_tax_applied_amount' |
Definition at line 150 of file CreditmemoItemInterface.php.
const WEEE_TAX_APPLIED_ROW_AMOUNT = 'weee_tax_applied_row_amount' |
Definition at line 154 of file CreditmemoItemInterface.php.
const WEEE_TAX_DISPOSITION = 'weee_tax_disposition' |
Definition at line 122 of file CreditmemoItemInterface.php.
const WEEE_TAX_ROW_DISPOSITION = 'weee_tax_row_disposition' |
Definition at line 126 of file CreditmemoItemInterface.php.