Magento 2 Documentation
2.3
Documentation for Magento 2 CMS v2.3 (December 2018)
|
Static Public Member Functions | |
static | getStates () |
Data Fields | |
const | STATE_OPEN = 1 |
const | STATE_REFUNDED = 2 |
const | STATE_CANCELED = 3 |
const | REPORT_DATE_TYPE_ORDER_CREATED = 'order_created' |
const | REPORT_DATE_TYPE_REFUND_CREATED = 'refund_created' |
![]() | |
const | CUSTOM_ATTRIBUTES = 'custom_attributes' |
![]() | |
const | EXTENSION_ATTRIBUTES_KEY = 'extension_attributes' |
![]() | |
const | ENTITY_ID = 'entity_id' |
const | STORE_ID = 'store_id' |
const | ADJUSTMENT_POSITIVE = 'adjustment_positive' |
const | BASE_SHIPPING_TAX_AMOUNT = 'base_shipping_tax_amount' |
const | STORE_TO_ORDER_RATE = 'store_to_order_rate' |
const | BASE_DISCOUNT_AMOUNT = 'base_discount_amount' |
const | BASE_TO_ORDER_RATE = 'base_to_order_rate' |
const | GRAND_TOTAL = 'grand_total' |
const | BASE_ADJUSTMENT_NEGATIVE = 'base_adjustment_negative' |
const | BASE_SUBTOTAL_INCL_TAX = 'base_subtotal_incl_tax' |
const | SHIPPING_AMOUNT = 'shipping_amount' |
const | SUBTOTAL_INCL_TAX = 'subtotal_incl_tax' |
const | ADJUSTMENT_NEGATIVE = 'adjustment_negative' |
const | BASE_SHIPPING_AMOUNT = 'base_shipping_amount' |
const | STORE_TO_BASE_RATE = 'store_to_base_rate' |
const | BASE_TO_GLOBAL_RATE = 'base_to_global_rate' |
const | BASE_ADJUSTMENT = 'base_adjustment' |
const | BASE_SUBTOTAL = 'base_subtotal' |
const | DISCOUNT_AMOUNT = 'discount_amount' |
const | SUBTOTAL = 'subtotal' |
const | ADJUSTMENT = 'adjustment' |
const | BASE_GRAND_TOTAL = 'base_grand_total' |
const | BASE_ADJUSTMENT_POSITIVE = 'base_adjustment_positive' |
const | BASE_TAX_AMOUNT = 'base_tax_amount' |
const | SHIPPING_TAX_AMOUNT = 'shipping_tax_amount' |
const | TAX_AMOUNT = 'tax_amount' |
const | ORDER_ID = 'order_id' |
const | EMAIL_SENT = 'email_sent' |
const | CREDITMEMO_STATUS = 'creditmemo_status' |
const | STATE = 'state' |
const | SHIPPING_ADDRESS_ID = 'shipping_address_id' |
const | BILLING_ADDRESS_ID = 'billing_address_id' |
const | INVOICE_ID = 'invoice_id' |
const | STORE_CURRENCY_CODE = 'store_currency_code' |
const | ORDER_CURRENCY_CODE = 'order_currency_code' |
const | BASE_CURRENCY_CODE = 'base_currency_code' |
const | GLOBAL_CURRENCY_CODE = 'global_currency_code' |
const | TRANSACTION_ID = 'transaction_id' |
const | INCREMENT_ID = 'increment_id' |
const | CREATED_AT = 'created_at' |
const | UPDATED_AT = 'updated_at' |
const | DISCOUNT_TAX_COMPENSATION_AMOUNT = 'discount_tax_compensation_amount' |
const | BASE_DISCOUNT_TAX_COMPENSATION_AMOUNT = 'base_discount_tax_compensation_amount' |
const | SHIPPING_DISCOUNT_TAX_COMPENSATION_AMOUNT = 'shipping_discount_tax_compensation_amount' |
const | BASE_SHIPPING_DISCOUNT_TAX_COMPENSATION_AMNT = 'base_shipping_discount_tax_compensation_amnt' |
const | SHIPPING_INCL_TAX = 'shipping_incl_tax' |
const | BASE_SHIPPING_INCL_TAX = 'base_shipping_incl_tax' |
const | DISCOUNT_DESCRIPTION = 'discount_description' |
const | ITEMS = 'items' |
const | COMMENTS = 'comments' |
Protected Member Functions | |
_construct () | |
![]() | |
filterCustomAttributes ($data) | |
initializeCustomAttributes () | |
convertCustomAttributeValues (array &$customAttributes) | |
getCustomAttributesCodes () | |
_setExtensionAttributes (\Magento\Framework\Api\ExtensionAttributesInterface $extensionAttributes) | |
_getExtensionAttributes () | |
![]() | |
_construct () | |
_init ($resourceModel) | |
_setResourceModel ($resourceName, $collectionName=null) | |
_getResource () | |
_getEventData () | |
_beforeLoad ($modelId, $field=null) | |
_afterLoad () | |
_hasModelChanged () | |
_getValidatorBeforeSave () | |
_createValidatorBeforeSave () | |
_getValidationRulesBeforeSave () | |
_clearReferences () | |
_clearData () | |
![]() | |
_getData ($key) | |
_underscore ($name) | |
Protected Attributes | |
$entityType = 'creditmemo' | |
$_order | |
$_calculators = [] | |
$_eventPrefix = 'sales_order_creditmemo' | |
$_eventObject = 'creditmemo' | |
$_creditmemoConfig | |
$_orderFactory | |
$_cmItemCollectionFactory | |
$_calculatorFactory | |
$_storeManager | |
$_commentFactory | |
$_commentCollectionFactory | |
$priceCurrency | |
![]() | |
$extensionAttributesFactory | |
$extensionAttributes | |
$customAttributeFactory | |
$customAttributesCodes = null | |
$customAttributesChanged = false | |
![]() | |
$_eventPrefix = 'core_abstract' | |
$_eventObject = 'object' | |
$_idFieldName = 'id' | |
$_hasDataChanges = false | |
$_origData | |
$_isDeleted = false | |
$_resource | |
$_resourceCollection | |
$_resourceName | |
$_collectionName | |
$_cacheTag = false | |
$_dataSaveAllowed = true | |
$_isObjectNew = null | |
$_validatorBeforeSave = null | |
$_eventManager | |
$_cacheManager | |
$_registry | |
$_logger | |
$_appState | |
$_actionValidator | |
$storedData = [] | |
![]() | |
$_data = [] | |
Static Protected Attributes | |
static | $_states |
![]() | |
static | $_underscoreCache = [] |
Order creditmemo model
@api @method \Magento\Sales\Model\Order\Invoice setSendEmail(bool $value) @method \Magento\Sales\Model\Order\Invoice setCustomerNote(string $value) @method string getCustomerNote() @method \Magento\Sales\Model\Order\Invoice setCustomerNoteNotify(bool $value) @method bool getCustomerNoteNotify() @SuppressWarnings(PHPMD.ExcessivePublicCount) @SuppressWarnings(PHPMD.ExcessiveClassComplexity) @SuppressWarnings(PHPMD.CouplingBetweenObjects)
Definition at line 31 of file Creditmemo.php.
__construct | ( | \Magento\Framework\Model\Context | $context, |
\Magento\Framework\Registry | $registry, | ||
\Magento\Framework\Api\ExtensionAttributesFactory | $extensionFactory, | ||
AttributeValueFactory | $customAttributeFactory, | ||
\Magento\Sales\Model\Order\Creditmemo\Config | $creditmemoConfig, | ||
\Magento\Sales\Model\OrderFactory | $orderFactory, | ||
\Magento\Sales\Model\ResourceModel\Order\Creditmemo\Item\CollectionFactory | $cmItemCollectionFactory, | ||
\Magento\Framework\Math\CalculatorFactory | $calculatorFactory, | ||
\Magento\Store\Model\StoreManagerInterface | $storeManager, | ||
\Magento\Sales\Model\Order\Creditmemo\CommentFactory | $commentFactory, | ||
\Magento\Sales\Model\ResourceModel\Order\Creditmemo\Comment\CollectionFactory | $commentCollectionFactory, | ||
PriceCurrencyInterface | $priceCurrency, | ||
\Magento\Framework\Model\ResourceModel\AbstractResource | $resource = null , |
||
\Magento\Framework\Data\Collection\AbstractDb | $resourceCollection = null , |
||
array | $data = [] , |
||
InvoiceFactory | $invoiceFactory = null |
||
) |
\Magento\Framework\Model\Context | $context | |
\Magento\Framework\Registry | $registry | |
\Magento\Framework\Api\ExtensionAttributesFactory | $extensionFactory | |
AttributeValueFactory | $customAttributeFactory | |
Creditmemo\Config | $creditmemoConfig | |
\Magento\Sales\Model\OrderFactory | $orderFactory | |
\Magento\Sales\Model\ResourceModel\Order\Creditmemo\Item\CollectionFactory | $cmItemCollectionFactory | |
\Magento\Framework\Math\CalculatorFactory | $calculatorFactory | |
\Magento\Store\Model\StoreManagerInterface | $storeManager | |
Creditmemo\CommentFactory | $commentFactory | |
\Magento\Sales\Model\ResourceModel\Order\Creditmemo\Comment\CollectionFactory | $commentCollectionFactory | |
PriceCurrencyInterface | $priceCurrency | |
\Magento\Framework\Model\ResourceModel\AbstractResource | $resource | |
\Magento\Framework\Data\Collection\AbstractDb | $resourceCollection | |
array | $data | |
InvoiceFactory | $invoiceFactory | @SuppressWarnings(PHPMD.ExcessiveParameterList) |
Definition at line 141 of file Creditmemo.php.
|
protected |
Adds comment to credit memo with additional possibility to send it to customer via email and show it in customer account
\Magento\Sales\Model\Order\Creditmemo\Comment | string | $comment | |
bool | $notify | |
bool | $visibleOnFront |
Definition at line 553 of file Creditmemo.php.
addItem | ( | \Magento\Sales\Model\Order\Creditmemo\Item | $item | ) |
\Magento\Sales\Model\Order\Creditmemo\Item | $item |
Definition at line 328 of file Creditmemo.php.
canCancel | ( | ) |
Check creditmemo cancel action availability
Definition at line 413 of file Creditmemo.php.
canRefund | ( | ) |
canVoid | ( | ) |
collectTotals | ( | ) |
getAdjustment | ( | ) |
Returns adjustment
Implements CreditmemoInterface.
Definition at line 673 of file Creditmemo.php.
getAdjustmentNegative | ( | ) |
Returns adjustment_negative
Implements CreditmemoInterface.
Definition at line 683 of file Creditmemo.php.
getAdjustmentPositive | ( | ) |
Returns adjustment_positive
Implements CreditmemoInterface.
Definition at line 693 of file Creditmemo.php.
getAllItems | ( | ) |
getBaseAdjustment | ( | ) |
Returns base_adjustment
Implements CreditmemoInterface.
Definition at line 703 of file Creditmemo.php.
getBaseAdjustmentNegative | ( | ) |
Returns base_adjustment_negative
Implements CreditmemoInterface.
Definition at line 713 of file Creditmemo.php.
getBaseAdjustmentPositive | ( | ) |
Returns base_adjustment_positive
Implements CreditmemoInterface.
Definition at line 734 of file Creditmemo.php.
getBaseCurrencyCode | ( | ) |
Returns base_currency_code
Implements CreditmemoInterface.
Definition at line 755 of file Creditmemo.php.
getBaseDiscountAmount | ( | ) |
Returns base_discount_amount
Implements CreditmemoInterface.
Definition at line 765 of file Creditmemo.php.
getBaseDiscountTaxCompensationAmount | ( | ) |
Returns base_discount_tax_compensation_amount
Implements CreditmemoInterface.
Definition at line 785 of file Creditmemo.php.
getBaseGrandTotal | ( | ) |
Returns base_grand_total
Implements CreditmemoInterface.
Definition at line 775 of file Creditmemo.php.
getBaseShippingAmount | ( | ) |
Returns base_shipping_amount
Implements CreditmemoInterface.
Definition at line 795 of file Creditmemo.php.
getBaseShippingDiscountTaxCompensationAmnt | ( | ) |
Returns base_shipping_discount_tax_compensation_amnt
Implements CreditmemoInterface.
Definition at line 805 of file Creditmemo.php.
getBaseShippingInclTax | ( | ) |
Returns base_shipping_incl_tax
Implements CreditmemoInterface.
Definition at line 815 of file Creditmemo.php.
getBaseShippingTaxAmount | ( | ) |
Returns base_shipping_tax_amount
Implements CreditmemoInterface.
Definition at line 825 of file Creditmemo.php.
getBaseSubtotal | ( | ) |
Returns base_subtotal
Implements CreditmemoInterface.
Definition at line 835 of file Creditmemo.php.
getBaseSubtotalInclTax | ( | ) |
Returns base_subtotal_incl_tax
Implements CreditmemoInterface.
Definition at line 845 of file Creditmemo.php.
getBaseTaxAmount | ( | ) |
Returns base_tax_amount
Implements CreditmemoInterface.
Definition at line 855 of file Creditmemo.php.
getBaseToGlobalRate | ( | ) |
Returns base_to_global_rate
Implements CreditmemoInterface.
Definition at line 865 of file Creditmemo.php.
getBaseToOrderRate | ( | ) |
Returns base_to_order_rate
Implements CreditmemoInterface.
Definition at line 875 of file Creditmemo.php.
getBillingAddress | ( | ) |
getBillingAddressId | ( | ) |
Returns billing_address_id
Implements CreditmemoInterface.
Definition at line 885 of file Creditmemo.php.
getComments | ( | ) |
Return creditmemo comments
Implements CreditmemoInterface.
Definition at line 637 of file Creditmemo.php.
getCommentsCollection | ( | $reload = false | ) |
bool | $reload |
Definition at line 574 of file Creditmemo.php.
getConfig | ( | ) |
Retrieve Creditmemo configuration model
Definition at line 194 of file Creditmemo.php.
getCreatedAt | ( | ) |
Returns created_at
Implements CreditmemoInterface.
Definition at line 895 of file Creditmemo.php.
getCreditmemoStatus | ( | ) |
Returns creditmemo_status
Implements CreditmemoInterface.
Definition at line 913 of file Creditmemo.php.
getDiscountAmount | ( | ) |
Returns discount_amount
Implements CreditmemoInterface.
Definition at line 923 of file Creditmemo.php.
getDiscountDescription | ( | ) |
Returns discount_description
Implements CreditmemoInterface.
Definition at line 655 of file Creditmemo.php.
getDiscountTaxCompensationAmount | ( | ) |
Returns discount_tax_compensation_amount
Implements CreditmemoInterface.
Definition at line 963 of file Creditmemo.php.
getEmailSent | ( | ) |
Returns email_sent
Implements CreditmemoInterface.
Definition at line 933 of file Creditmemo.php.
getEntityType | ( | ) |
getExtensionAttributes | ( | ) |
{Retrieve existing extension attributes object or create a new one.
Implements CreditmemoInterface.
Definition at line 1492 of file Creditmemo.php.
getFilteredCollectionItems | ( | $filter = null | ) |
Get creditmemos collection filtered by $filter
array | null | $filter |
Definition at line 593 of file Creditmemo.php.
getGlobalCurrencyCode | ( | ) |
Returns global_currency_code
Implements CreditmemoInterface.
Definition at line 943 of file Creditmemo.php.
getGrandTotal | ( | ) |
Returns grand_total
Implements CreditmemoInterface.
Definition at line 953 of file Creditmemo.php.
getIncrementId | ( | ) |
Returns increment id
Implements CreditmemoInterface.
Definition at line 603 of file Creditmemo.php.
getInvoice | ( | ) |
Returns assigned invoice
Definition at line 388 of file Creditmemo.php.
getInvoiceId | ( | ) |
Returns invoice_id
Implements CreditmemoInterface.
Definition at line 973 of file Creditmemo.php.
getItemById | ( | $itemId | ) |
mixed | $itemId |
Definition at line 298 of file Creditmemo.php.
getItemByOrderId | ( | $orderId | ) |
Returns credit memo item by its order id
mixed | $orderId |
Definition at line 314 of file Creditmemo.php.
getItems | ( | ) |
Return creditmemo items
Implements CreditmemoInterface.
Definition at line 621 of file Creditmemo.php.
getItemsCollection | ( | ) |
getOrder | ( | ) |
Retrieve the order the creditmemo for created for
Definition at line 227 of file Creditmemo.php.
getOrderCurrencyCode | ( | ) |
Returns order_currency_code
Implements CreditmemoInterface.
Definition at line 983 of file Creditmemo.php.
getOrderId | ( | ) |
Returns order_id
Implements CreditmemoInterface.
Definition at line 993 of file Creditmemo.php.
getShippingAddress | ( | ) |
getShippingAddressId | ( | ) |
Returns shipping_address_id
Implements CreditmemoInterface.
Definition at line 1003 of file Creditmemo.php.
getShippingAmount | ( | ) |
Returns shipping_amount
Implements CreditmemoInterface.
Definition at line 1013 of file Creditmemo.php.
getShippingDiscountTaxCompensationAmount | ( | ) |
Returns shipping_discount_tax_compensation_amount
Implements CreditmemoInterface.
Definition at line 1023 of file Creditmemo.php.
getShippingInclTax | ( | ) |
Returns shipping_incl_tax
Implements CreditmemoInterface.
Definition at line 1033 of file Creditmemo.php.
getShippingTaxAmount | ( | ) |
Returns shipping_tax_amount
Implements CreditmemoInterface.
Definition at line 1043 of file Creditmemo.php.
getState | ( | ) |
Returns state
Implements CreditmemoInterface.
Definition at line 1053 of file Creditmemo.php.
getStateName | ( | $stateId = null | ) |
Retrieve Creditmemo state name by state identifier
int | $stateId |
Definition at line 451 of file Creditmemo.php.
|
static |
getStore | ( | ) |
Retrieve creditmemo store instance
Definition at line 204 of file Creditmemo.php.
getStoreCurrencyCode | ( | ) |
Returns store_currency_code
Implements CreditmemoInterface.
Definition at line 1063 of file Creditmemo.php.
getStoreId | ( | ) |
Returns store_id
Implements CreditmemoInterface.
Definition at line 1073 of file Creditmemo.php.
getStoreToBaseRate | ( | ) |
Returns store_to_base_rate
Implements CreditmemoInterface.
Definition at line 1083 of file Creditmemo.php.
getStoreToOrderRate | ( | ) |
Returns store_to_order_rate
Implements CreditmemoInterface.
Definition at line 1093 of file Creditmemo.php.
getSubtotal | ( | ) |
Returns subtotal
Implements CreditmemoInterface.
Definition at line 1103 of file Creditmemo.php.
getSubtotalInclTax | ( | ) |
Returns subtotal_incl_tax
Implements CreditmemoInterface.
Definition at line 1113 of file Creditmemo.php.
getTaxAmount | ( | ) |
Returns tax_amount
Implements CreditmemoInterface.
Definition at line 1123 of file Creditmemo.php.
getTransactionId | ( | ) |
Returns transaction_id
Implements CreditmemoInterface.
Definition at line 1133 of file Creditmemo.php.
getUpdatedAt | ( | ) |
Returns updated_at
Implements CreditmemoInterface.
Definition at line 1154 of file Creditmemo.php.
isLast | ( | ) |
isValidGrandTotal | ( | ) |
roundPrice | ( | $price, | |
$type = 'regular' , |
|||
$negative = false |
|||
) |
Round price considering delta
float | $price | |
string | $type | |
bool | $negative | Indicates if we perform addition (true) or subtraction (false) of rounded value |
Definition at line 358 of file Creditmemo.php.
setAdjustment | ( | $adjustment | ) |
{Sets the credit memo adjustment.
float | $adjustment |
Implements CreditmemoInterface.
Definition at line 1290 of file Creditmemo.php.
setAdjustmentNegative | ( | $amount | ) |
string | $amount |
Implements CreditmemoInterface.
Definition at line 499 of file Creditmemo.php.
setAdjustmentPositive | ( | $amount | ) |
string | $amount |
Implements CreditmemoInterface.
Definition at line 479 of file Creditmemo.php.
setBaseAdjustment | ( | $baseAdjustment | ) |
{Sets the credit memo base adjustment.
float | $baseAdjustment |
Implements CreditmemoInterface.
Definition at line 1258 of file Creditmemo.php.
setBaseAdjustmentNegative | ( | $baseAdjustmentNegative | ) |
Set base_adjustment_negative
float | $baseAdjustmentNegative |
Implements CreditmemoInterface.
Definition at line 724 of file Creditmemo.php.
setBaseAdjustmentPositive | ( | $baseAdjustmentPositive | ) |
Set base_adjustment_positive
float | $baseAdjustmentPositive |
Implements CreditmemoInterface.
Definition at line 745 of file Creditmemo.php.
setBaseCurrencyCode | ( | $code | ) |
{Sets the credit memo base currency code.
string | $code |
Implements CreditmemoInterface.
Definition at line 1402 of file Creditmemo.php.
setBaseDiscountAmount | ( | $amount | ) |
{Sets the credit memo base discount amount.
float | $amount |
Implements CreditmemoInterface.
Definition at line 1194 of file Creditmemo.php.
setBaseDiscountTaxCompensationAmount | ( | $amount | ) |
{Sets the credit memo base discount tax compensation amount.
float | $amount |
Implements CreditmemoInterface.
Definition at line 1442 of file Creditmemo.php.
setBaseGrandTotal | ( | $amount | ) |
{Sets the credit memo base grand total.
float | $amount |
Implements CreditmemoInterface.
Definition at line 1298 of file Creditmemo.php.
setBaseShippingAmount | ( | $amount | ) |
{Sets the credit memo base shipping amount.
float | $amount |
Implements CreditmemoInterface.
Definition at line 1234 of file Creditmemo.php.
setBaseShippingDiscountTaxCompensationAmnt | ( | $amnt | ) |
{Sets the credit memo base shipping discount tax compensation amount.
float | $amnt |
Implements CreditmemoInterface.
Definition at line 1458 of file Creditmemo.php.
setBaseShippingInclTax | ( | $amount | ) |
{Sets the credit memo base shipping including tax.
float | $amount |
Implements CreditmemoInterface.
Definition at line 1474 of file Creditmemo.php.
setBaseShippingTaxAmount | ( | $amount | ) |
{Sets the credit memo base shipping tax amount.
float | $amount |
Implements CreditmemoInterface.
Definition at line 1178 of file Creditmemo.php.
setBaseSubtotal | ( | $amount | ) |
{Sets the credit memo base subtotal.
float | $amount |
Implements CreditmemoInterface.
Definition at line 1266 of file Creditmemo.php.
setBaseSubtotalInclTax | ( | $amount | ) |
{Sets the credit memo base subtotal including tax.
float | $amount |
Implements CreditmemoInterface.
Definition at line 1218 of file Creditmemo.php.
setBaseTaxAmount | ( | $amount | ) |
{Sets the credit memo base tax amount.
float | $amount |
Implements CreditmemoInterface.
Definition at line 1306 of file Creditmemo.php.
setBaseToGlobalRate | ( | $rate | ) |
{Sets the credit memo base-to-global rate.
float | $rate |
Implements CreditmemoInterface.
Definition at line 1250 of file Creditmemo.php.
setBaseToOrderRate | ( | $rate | ) |
{Sets the credit memo base-to-order rate.
float | $rate |
Implements CreditmemoInterface.
Definition at line 1202 of file Creditmemo.php.
setBillingAddressId | ( | $id | ) |
{Sets the credit memo billing address ID.
int | $id |
Implements CreditmemoInterface.
Definition at line 1370 of file Creditmemo.php.
setComments | ( | $comments | ) |
{Sets credit memo comments.
Implements CreditmemoInterface.
Definition at line 1162 of file Creditmemo.php.
setCreatedAt | ( | $createdAt | ) |
{Sets the credit memo created-at timestamp.
string | $createdAt | timestamp |
Implements CreditmemoInterface.
Definition at line 903 of file Creditmemo.php.
setCreditmemoStatus | ( | $creditmemoStatus | ) |
{Sets the credit memo status.
int | $creditmemoStatus |
Implements CreditmemoInterface.
Definition at line 1346 of file Creditmemo.php.
setDiscountAmount | ( | $amount | ) |
{Sets the credit memo discount amount.
float | $amount |
Implements CreditmemoInterface.
Definition at line 1274 of file Creditmemo.php.
setDiscountDescription | ( | $description | ) |
{Sets the credit memo discount description.
string | $description |
Implements CreditmemoInterface.
Definition at line 1482 of file Creditmemo.php.
setDiscountTaxCompensationAmount | ( | $amount | ) |
{Sets the credit memo discount tax compensation amount.
float | $amount |
Implements CreditmemoInterface.
Definition at line 1434 of file Creditmemo.php.
setEmailSent | ( | $emailSent | ) |
{Sets the credit memo email sent flag value.
int | $emailSent |
Implements CreditmemoInterface.
Definition at line 1338 of file Creditmemo.php.
setExtensionAttributes | ( | \Magento\Sales\Api\Data\CreditmemoExtensionInterface | $extensionAttributes | ) |
{}
\Magento\Sales\Api\Data\CreditmemoExtensionInterface | $extensionAttributes |
Definition at line 1503 of file Creditmemo.php.
setGlobalCurrencyCode | ( | $code | ) |
{Sets the credit memo global currency code.
string | $code |
Implements CreditmemoInterface.
Definition at line 1410 of file Creditmemo.php.
setGrandTotal | ( | $amount | ) |
{Sets the credit memo grand total.
float | $amount |
Implements CreditmemoInterface.
Definition at line 1210 of file Creditmemo.php.
setIncrementId | ( | $id | ) |
{Sets the credit memo increment ID.
string | $id |
Implements CreditmemoInterface.
Definition at line 1418 of file Creditmemo.php.
setInvoice | ( | Invoice | $invoice | ) |
Sets invoice
Invoice | $invoice |
Definition at line 402 of file Creditmemo.php.
setInvoiceId | ( | $id | ) |
{Sets the credit memo invoice ID.
int | $id |
Implements CreditmemoInterface.
Definition at line 1378 of file Creditmemo.php.
setItems | ( | $items | ) |
{Sets credit memo items.
Implements CreditmemoInterface.
Definition at line 663 of file Creditmemo.php.
setOrder | ( | \Magento\Sales\Model\Order | $order | ) |
Declare order for creditmemo
\Magento\Sales\Model\Order | $order |
Definition at line 215 of file Creditmemo.php.
setOrderCurrencyCode | ( | $code | ) |
{Sets the credit memo order currency code.
string | $code |
Implements CreditmemoInterface.
Definition at line 1394 of file Creditmemo.php.
setOrderId | ( | $id | ) |
{Sets the credit memo order ID.
int | $id |
Implements CreditmemoInterface.
Definition at line 1330 of file Creditmemo.php.
setShippingAddressId | ( | $id | ) |
{Sets the credit memo shipping address ID.
int | $id |
Implements CreditmemoInterface.
Definition at line 1362 of file Creditmemo.php.
setShippingAmount | ( | $amount | ) |
float | $amount |
Implements CreditmemoInterface.
Definition at line 470 of file Creditmemo.php.
setShippingDiscountTaxCompensationAmount | ( | $amount | ) |
{Sets the credit memo shipping discount tax compensation amount.
float | $amount |
Implements CreditmemoInterface.
Definition at line 1450 of file Creditmemo.php.
setShippingInclTax | ( | $amount | ) |
{Sets the credit memo shipping including tax.
float | $amount |
Implements CreditmemoInterface.
Definition at line 1466 of file Creditmemo.php.
setShippingTaxAmount | ( | $amount | ) |
{Sets the credit memo shipping tax amount.
float | $amount |
Implements CreditmemoInterface.
Definition at line 1314 of file Creditmemo.php.
setState | ( | $state | ) |
{Sets the credit memo state.
int | $state |
Implements CreditmemoInterface.
Definition at line 1354 of file Creditmemo.php.
setStoreCurrencyCode | ( | $code | ) |
{Sets the credit memo store currency code.
string | $code |
Implements CreditmemoInterface.
Definition at line 1386 of file Creditmemo.php.
setStoreId | ( | $id | ) |
{Sets the credit memo store ID.
int | $id |
Implements CreditmemoInterface.
Definition at line 1170 of file Creditmemo.php.
setStoreToBaseRate | ( | $rate | ) |
{Sets the credit memo store-to-base rate.
float | $rate |
Implements CreditmemoInterface.
Definition at line 1242 of file Creditmemo.php.
setStoreToOrderRate | ( | $rate | ) |
{Sets the credit memo store-to-order rate.
float | $rate |
Implements CreditmemoInterface.
Definition at line 1186 of file Creditmemo.php.
setSubtotal | ( | $amount | ) |
{Sets the credit memo subtotal.
float | $amount |
Implements CreditmemoInterface.
Definition at line 1282 of file Creditmemo.php.
setSubtotalInclTax | ( | $amount | ) |
{Sets the credit memo subtotal including tax.
float | $amount |
Implements CreditmemoInterface.
Definition at line 1226 of file Creditmemo.php.
setTaxAmount | ( | $amount | ) |
{Sets the credit memo tax amount.
float | $amount |
Implements CreditmemoInterface.
Definition at line 1322 of file Creditmemo.php.
setTransactionId | ( | $transactionId | ) |
Sets the credit memo transaction ID.
string | $transactionId |
Implements CreditmemoInterface.
Definition at line 1144 of file Creditmemo.php.
setUpdatedAt | ( | $timestamp | ) |
{Sets the credit memo updated-at timestamp.
string | $timestamp |
Implements CreditmemoInterface.
Definition at line 1426 of file Creditmemo.php.
|
protected |
Definition at line 95 of file Creditmemo.php.
|
protected |
Definition at line 65 of file Creditmemo.php.
|
protected |
Definition at line 90 of file Creditmemo.php.
|
protected |
Definition at line 110 of file Creditmemo.php.
|
protected |
Definition at line 105 of file Creditmemo.php.
|
protected |
Definition at line 80 of file Creditmemo.php.
|
protected |
Definition at line 75 of file Creditmemo.php.
|
protected |
Definition at line 70 of file Creditmemo.php.
|
protected |
Definition at line 58 of file Creditmemo.php.
|
protected |
Definition at line 85 of file Creditmemo.php.
|
staticprotected |
Definition at line 53 of file Creditmemo.php.
|
protected |
Definition at line 100 of file Creditmemo.php.
|
protected |
Definition at line 48 of file Creditmemo.php.
|
protected |
Definition at line 115 of file Creditmemo.php.
const REPORT_DATE_TYPE_ORDER_CREATED = 'order_created' |
Definition at line 39 of file Creditmemo.php.
const REPORT_DATE_TYPE_REFUND_CREATED = 'refund_created' |
Definition at line 41 of file Creditmemo.php.
const STATE_CANCELED = 3 |
Definition at line 37 of file Creditmemo.php.
const STATE_OPEN = 1 |
Definition at line 33 of file Creditmemo.php.
const STATE_REFUNDED = 2 |
Definition at line 35 of file Creditmemo.php.