Inheritance diagram for CreditmemoInterface:

Public Member Functions
	getAdjustment ()

	getAdjustmentNegative ()

	getAdjustmentPositive ()

	getBaseAdjustment ()

	getBaseAdjustmentNegative ()

	setBaseAdjustmentNegative ($baseAdjustmentNegative)

	getBaseAdjustmentPositive ()

	setBaseAdjustmentPositive ($baseAdjustmentPositive)

	getBaseCurrencyCode ()

	getBaseDiscountAmount ()

	getBaseGrandTotal ()

	getBaseDiscountTaxCompensationAmount ()

	getBaseShippingAmount ()

	getBaseShippingDiscountTaxCompensationAmnt ()

	getBaseShippingInclTax ()

	getBaseShippingTaxAmount ()

	getBaseSubtotal ()

	getBaseSubtotalInclTax ()

	getBaseTaxAmount ()

	getBaseToGlobalRate ()

	getBaseToOrderRate ()

	getBillingAddressId ()

	getCreatedAt ()

	setCreatedAt ($createdAt)

	getCreditmemoStatus ()

	getDiscountAmount ()

	getDiscountDescription ()

	getEmailSent ()

	getEntityId ()

	setEntityId ($entityId)

	getGlobalCurrencyCode ()

	getGrandTotal ()

	getDiscountTaxCompensationAmount ()

	getIncrementId ()

	getInvoiceId ()

	getOrderCurrencyCode ()

	getOrderId ()

	getShippingAddressId ()

	getShippingAmount ()

	getShippingDiscountTaxCompensationAmount ()

	getShippingInclTax ()

	getShippingTaxAmount ()

	getState ()

	getStoreCurrencyCode ()

	getStoreId ()

	getStoreToBaseRate ()

	getStoreToOrderRate ()

	getSubtotal ()

	getSubtotalInclTax ()

	getTaxAmount ()

	getTransactionId ()

	setTransactionId ($transactionId)

	getUpdatedAt ()

	getItems ()

	setItems ($items)

	getComments ()

	setComments ($comments)

	setStoreId ($id)

	setAdjustmentPositive ($adjustmentPositive)

	setBaseShippingTaxAmount ($amount)

	setStoreToOrderRate ($rate)

	setBaseDiscountAmount ($amount)

	setBaseToOrderRate ($rate)

	setGrandTotal ($amount)

	setBaseSubtotalInclTax ($amount)

	setShippingAmount ($amount)

	setSubtotalInclTax ($amount)

	setAdjustmentNegative ($adjustmentNegative)

	setBaseShippingAmount ($amount)

	setStoreToBaseRate ($rate)

	setBaseToGlobalRate ($rate)

	setBaseAdjustment ($baseAdjustment)

	setBaseSubtotal ($amount)

	setDiscountAmount ($amount)

	setSubtotal ($amount)

	setAdjustment ($adjustment)

	setBaseGrandTotal ($amount)

	setBaseTaxAmount ($amount)

	setShippingTaxAmount ($amount)

	setTaxAmount ($amount)

	setOrderId ($id)

	setEmailSent ($emailSent)

	setCreditmemoStatus ($creditmemoStatus)

	setState ($state)

	setShippingAddressId ($id)

	setBillingAddressId ($id)

	setInvoiceId ($id)

	setStoreCurrencyCode ($code)

	setOrderCurrencyCode ($code)

	setBaseCurrencyCode ($code)

	setGlobalCurrencyCode ($code)

	setIncrementId ($id)

	setUpdatedAt ($timestamp)

	setDiscountTaxCompensationAmount ($amount)

	setBaseDiscountTaxCompensationAmount ($amount)

	setShippingDiscountTaxCompensationAmount ($amount)

	setBaseShippingDiscountTaxCompensationAmnt ($amnt)

	setShippingInclTax ($amount)

	setBaseShippingInclTax ($amount)

	setDiscountDescription ($description)

	getExtensionAttributes ()

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

Data Fields
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'

Data Fields inherited from ExtensibleDataInterface
const	EXTENSION_ATTRIBUTES_KEY = 'extension_attributes'

Detailed Description

Credit memo 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. @api

Since: 100.0.2

Definition at line 18 of file CreditmemoInterface.php.

Member Function Documentation

◆ getAdjustment()

getAdjustment ( )

Gets the credit memo adjustment.

Returns: float|null Credit memo adjustment.

Implemented in Creditmemo.

◆ getAdjustmentNegative()

getAdjustmentNegative ( )

Gets the credit memo negative adjustment.

Returns: float|null Credit memo negative adjustment.

Implemented in Creditmemo.

◆ getAdjustmentPositive()

getAdjustmentPositive ( )

Gets the credit memo positive adjustment.

Returns: float|null Credit memo positive adjustment.

Implemented in Creditmemo.

◆ getBaseAdjustment()

getBaseAdjustment ( )

Gets the credit memo base adjustment.

Returns: float|null Credit memo base adjustment.

Implemented in Creditmemo.

◆ getBaseAdjustmentNegative()

getBaseAdjustmentNegative ( )

Gets the credit memo negative base adjustment.

Returns: float|null Credit memo negative base adjustment.

Implemented in Creditmemo.

◆ getBaseAdjustmentPositive()

getBaseAdjustmentPositive ( )

Gets the credit memo positive base adjustment.

Returns: float|null Credit memo positive base adjustment.

Implemented in Creditmemo.

◆ getBaseCurrencyCode()

getBaseCurrencyCode ( )

Gets the credit memo base currency code.

Returns: string|null Credit memo base currency code.

Implemented in Creditmemo.

◆ getBaseDiscountAmount()

getBaseDiscountAmount ( )

Gets the credit memo base discount amount.

Returns: float|null Credit memo base discount amount.

Implemented in Creditmemo.

◆ getBaseDiscountTaxCompensationAmount()

getBaseDiscountTaxCompensationAmount ( )

Gets the credit memo base discount tax compensation amount.

Returns: float|null Credit memo base discount tax compensation amount.

Implemented in Creditmemo.

◆ getBaseGrandTotal()

getBaseGrandTotal ( )

Gets the credit memo base grand total.

Returns: float|null Credit memo base grand total.

Implemented in Creditmemo.

◆ getBaseShippingAmount()

getBaseShippingAmount ( )

Gets the credit memo base shipping amount.

Returns: float|null Credit memo base shipping amount.

Implemented in Creditmemo.

◆ getBaseShippingDiscountTaxCompensationAmnt()

getBaseShippingDiscountTaxCompensationAmnt ( )

Gets the credit memo base shipping discount tax compensation amount.

Returns: float|null Credit memo base shipping discount tax compensation amount.

Implemented in Creditmemo.

◆ getBaseShippingInclTax()

getBaseShippingInclTax ( )

Gets the credit memo base shipping including tax.

Returns: float|null Credit memo base shipping including tax.

Implemented in Creditmemo.

◆ getBaseShippingTaxAmount()

getBaseShippingTaxAmount ( )

Gets the credit memo base shipping tax amount.

Returns: float|null Credit memo base shipping tax amount.

Implemented in Creditmemo.

◆ getBaseSubtotal()

getBaseSubtotal ( )

Gets the credit memo base subtotal.

Returns: float|null Credit memo base subtotal.

Implemented in Creditmemo.

◆ getBaseSubtotalInclTax()

getBaseSubtotalInclTax ( )

Gets the credit memo base subtotal including tax.

Returns: float|null Credit memo base subtotal including tax.

Implemented in Creditmemo.

◆ getBaseTaxAmount()

getBaseTaxAmount ( )

Gets the credit memo base tax amount.

Returns: float|null Credit memo base tax amount.

Implemented in Creditmemo.

◆ getBaseToGlobalRate()

getBaseToGlobalRate ( )

Gets the credit memo base-to-global rate.

Returns: float|null Credit memo base-to-global rate.

Implemented in Creditmemo.

◆ getBaseToOrderRate()

getBaseToOrderRate ( )

Gets the credit memo base-to-order rate.

Returns: float|null Credit memo base-to-order rate.

Implemented in Creditmemo.

◆ getBillingAddressId()

getBillingAddressId ( )

Gets the credit memo billing address ID.

Returns: int|null Credit memo billing address ID.

Implemented in Creditmemo.

◆ getComments()

getComments ( )

Gets credit memo comments.

Returns: \Magento\Sales\Api\Data\CreditmemoCommentInterface[]|null Array of any credit memo comments. Otherwise, null.

Implemented in Creditmemo.

◆ getCreatedAt()

getCreatedAt ( )

Gets the credit memo created-at timestamp.

Returns: string|null Credit memo created-at timestamp.

Implemented in Creditmemo.

◆ getCreditmemoStatus()

getCreditmemoStatus ( )

Gets the credit memo status.

Returns: int|null Credit memo status.

Implemented in Creditmemo.

◆ getDiscountAmount()

getDiscountAmount ( )

Gets the credit memo discount amount.

Returns: float|null Credit memo discount amount.

Implemented in Creditmemo.

◆ getDiscountDescription()

getDiscountDescription ( )

Gets the credit memo discount description.

Returns: string|null Credit memo discount description.

Implemented in Creditmemo.

◆ getDiscountTaxCompensationAmount()

getDiscountTaxCompensationAmount ( )

Gets the credit memo discount tax compensation amount.

Returns: float|null Credit memo discount tax compensation amount.

Implemented in Creditmemo.

◆ getEmailSent()

getEmailSent ( )

Gets the credit memo email sent flag value.

Returns: int|null Credit memo email sent flag value.

Implemented in Creditmemo.

◆ getEntityId()

getEntityId ( )

Gets the credit memo ID.

Returns: int|null Credit memo ID.

◆ getExtensionAttributes()

getExtensionAttributes ( )

Retrieve existing extension attributes object or create a new one.

Returns: \Magento\Sales\Api\Data\CreditmemoExtensionInterface|null

Implemented in Creditmemo.

◆ getGlobalCurrencyCode()

getGlobalCurrencyCode ( )

Gets the credit memo global currency code.

Returns: string|null Credit memo global currency code.

Implemented in Creditmemo.

◆ getGrandTotal()

getGrandTotal ( )

Gets the credit memo grand total.

Returns: float|null Credit memo grand total.

Implemented in Creditmemo.

◆ getIncrementId()

getIncrementId ( )

Gets the credit memo increment ID.

Returns: string|null Credit memo increment ID.

Implemented in Creditmemo.

◆ getInvoiceId()

getInvoiceId ( )

Gets the credit memo invoice ID.

Returns: int|null Credit memo invoice ID.

Implemented in Creditmemo.

◆ getItems()

getItems ( )

Gets credit memo items.

Returns: \Magento\Sales\Api\Data\CreditmemoItemInterface[] Array of credit memo items.

Implemented in Creditmemo.

◆ getOrderCurrencyCode()

getOrderCurrencyCode ( )

Gets the credit memo order currency code.

Returns: string|null Credit memo order currency code.

Implemented in Creditmemo.

◆ getOrderId()

getOrderId ( )

Gets the credit memo order ID.

Returns: int Credit memo order ID.

Implemented in Creditmemo.

◆ getShippingAddressId()

getShippingAddressId ( )

Gets the credit memo shipping address ID.

Returns: int|null Credit memo shipping address ID.

Implemented in Creditmemo.

◆ getShippingAmount()

getShippingAmount ( )

Gets the credit memo shipping amount.

Returns: float|null Credit memo shipping amount.

Implemented in Creditmemo.

◆ getShippingDiscountTaxCompensationAmount()

getShippingDiscountTaxCompensationAmount ( )

Gets the credit memo shipping discount tax compensation amount.

Returns: float|null Credit memo shipping discount tax compensation amount.

Implemented in Creditmemo.

◆ getShippingInclTax()

getShippingInclTax ( )

Gets the credit memo shipping including tax.

Returns: float|null Credit memo shipping including tax.

Implemented in Creditmemo.

◆ getShippingTaxAmount()

getShippingTaxAmount ( )

Gets the credit memo shipping tax amount.

Returns: float|null Credit memo shipping tax amount.

Implemented in Creditmemo.

◆ getState()

getState ( )

Gets the credit memo state.

Returns: int|null Credit memo state.

Implemented in Creditmemo.

◆ getStoreCurrencyCode()

getStoreCurrencyCode ( )

Gets the credit memo store currency code.

Returns: string|null Credit memo store currency code.

Implemented in Creditmemo.

◆ getStoreId()

getStoreId ( )

Gets the credit memo store ID.

Returns: int|null Credit memo store ID.

Implemented in Creditmemo.

◆ getStoreToBaseRate()

getStoreToBaseRate ( )

Gets the credit memo store-to-base rate.

Returns: float|null Credit memo store-to-base rate.

Implemented in Creditmemo.

◆ getStoreToOrderRate()

getStoreToOrderRate ( )

Gets the credit memo store-to-order rate.

Returns: float|null Credit memo store-to-order rate.

Implemented in Creditmemo.

◆ getSubtotal()

getSubtotal ( )

Gets the credit memo subtotal.

Returns: float|null Credit memo subtotal.

Implemented in Creditmemo.

◆ getSubtotalInclTax()

getSubtotalInclTax ( )

Gets the credit memo subtotal including tax.

Returns: float|null Credit memo subtotal including tax.

Implemented in Creditmemo.

◆ getTaxAmount()

getTaxAmount ( )

Gets the credit memo tax amount.

Returns: float|null Credit memo tax amount.

Implemented in Creditmemo.

◆ getTransactionId()

getTransactionId ( )

Gets the credit memo transaction ID.

Returns: string|null Credit memo transaction ID.

Implemented in Creditmemo.

◆ getUpdatedAt()

getUpdatedAt ( )

Gets the credit memo updated-at timestamp.

Returns: string|null Credit memo updated-at timestamp.

Implemented in Creditmemo.

◆ setAdjustment()

setAdjustment ( $adjustment )

Sets the credit memo adjustment.

Parameters

float $adjustment

Returns: $this

Implemented in Creditmemo.

◆ setAdjustmentNegative()

setAdjustmentNegative ( $adjustmentNegative )

Sets the credit memo negative adjustment.

Parameters

float $adjustmentNegative

Returns: $this

Implemented in Creditmemo.

◆ setAdjustmentPositive()

setAdjustmentPositive ( $adjustmentPositive )

Sets the credit memo positive adjustment.

Parameters

float $adjustmentPositive

Returns: $this

Implemented in Creditmemo.

◆ setBaseAdjustment()

setBaseAdjustment ( $baseAdjustment )

Sets the credit memo base adjustment.

Parameters

float $baseAdjustment

Returns: $this

Implemented in Creditmemo.

◆ setBaseAdjustmentNegative()

setBaseAdjustmentNegative ( $baseAdjustmentNegative )

Sets the credit memo negative base adjustment.

Parameters

float $baseAdjustmentNegative

Returns: $this

Implemented in Creditmemo.

◆ setBaseAdjustmentPositive()

setBaseAdjustmentPositive ( $baseAdjustmentPositive )

Sets the credit memo positive base adjustment.

Parameters

float $baseAdjustmentPositive

Returns: $this

Implemented in Creditmemo.

◆ setBaseCurrencyCode()

setBaseCurrencyCode ( $code )

Sets the credit memo base currency code.

Parameters

string $code

Returns: $this

Implemented in Creditmemo.

◆ setBaseDiscountAmount()

setBaseDiscountAmount ( $amount )

Sets the credit memo base discount amount.

Parameters

float $amount

Returns: $this

Implemented in Creditmemo.

◆ setBaseDiscountTaxCompensationAmount()

setBaseDiscountTaxCompensationAmount ( $amount )

Sets the credit memo base discount tax compensation amount.

Parameters

float $amount

Returns: $this

Implemented in Creditmemo.

◆ setBaseGrandTotal()

setBaseGrandTotal ( $amount )

Sets the credit memo base grand total.

Parameters

float $amount

Returns: $this

Implemented in Creditmemo.

◆ setBaseShippingAmount()

setBaseShippingAmount ( $amount )

Sets the credit memo base shipping amount.

Parameters

float $amount

Returns: $this

Implemented in Creditmemo.

◆ setBaseShippingDiscountTaxCompensationAmnt()

setBaseShippingDiscountTaxCompensationAmnt ( $amnt )

Sets the credit memo base shipping discount tax compensation amount.

Parameters

float $amnt

Returns: $this

Implemented in Creditmemo.

◆ setBaseShippingInclTax()

setBaseShippingInclTax ( $amount )

Sets the credit memo base shipping including tax.

Parameters

float $amount

Returns: $this

Implemented in Creditmemo.

◆ setBaseShippingTaxAmount()

setBaseShippingTaxAmount ( $amount )

Sets the credit memo base shipping tax amount.

Parameters

float $amount

Returns: $this

Implemented in Creditmemo.

◆ setBaseSubtotal()

setBaseSubtotal ( $amount )

Sets the credit memo base subtotal.

Parameters

float $amount

Returns: $this

Implemented in Creditmemo.

◆ setBaseSubtotalInclTax()

setBaseSubtotalInclTax ( $amount )

Sets the credit memo base subtotal including tax.

Parameters

float $amount

Returns: $this

Implemented in Creditmemo.

◆ setBaseTaxAmount()

setBaseTaxAmount ( $amount )

Sets the credit memo base tax amount.

Parameters

float $amount

Returns: $this

Implemented in Creditmemo.

◆ setBaseToGlobalRate()

setBaseToGlobalRate ( $rate )

Sets the credit memo base-to-global rate.

Parameters

float $rate

Returns: $this

Implemented in Creditmemo.

◆ setBaseToOrderRate()

setBaseToOrderRate ( $rate )

Sets the credit memo base-to-order rate.

Parameters

float $rate

Returns: $this

Implemented in Creditmemo.

◆ setBillingAddressId()

setBillingAddressId ( $id )

Sets the credit memo billing address ID.

Parameters

int $id

Returns: $this

Implemented in Creditmemo.

◆ setComments()

setComments ( $comments )

Sets credit memo comments.

Parameters

Implemented in Creditmemo.

◆ setCreatedAt()

setCreatedAt ( $createdAt )

Sets the credit memo created-at timestamp.

Parameters

string $createdAt timestamp

Returns: $this

Implemented in Creditmemo.

◆ setCreditmemoStatus()

setCreditmemoStatus ( $creditmemoStatus )

Sets the credit memo status.

Parameters

int $creditmemoStatus

Returns: $this

Implemented in Creditmemo.

◆ setDiscountAmount()

setDiscountAmount ( $amount )

Sets the credit memo discount amount.

Parameters

float $amount

Returns: $this

Implemented in Creditmemo.

◆ setDiscountDescription()

setDiscountDescription ( $description )

Sets the credit memo discount description.

Parameters

string $description

Returns: $this

Implemented in Creditmemo.

◆ setDiscountTaxCompensationAmount()

setDiscountTaxCompensationAmount ( $amount )

Sets the credit memo discount tax compensation amount.

Parameters

float $amount

Returns: $this

Implemented in Creditmemo.

◆ setEmailSent()

setEmailSent ( $emailSent )

Sets the credit memo email sent flag value.

Parameters

int $emailSent

Returns: $this

Implemented in Creditmemo.

◆ setEntityId()

setEntityId ( $entityId )

Sets entity ID.

Parameters

int $entityId

Returns: $this

◆ setExtensionAttributes()

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

Set an extension attributes object.

Parameters

\Magento\Sales\Api\Data\CreditmemoExtensionInterface $extensionAttributes

Returns: $this

◆ setGlobalCurrencyCode()

setGlobalCurrencyCode ( $code )

Sets the credit memo global currency code.

Parameters

string $code

Returns: $this

Implemented in Creditmemo.

◆ setGrandTotal()

setGrandTotal ( $amount )

Sets the credit memo grand total.

Parameters

float $amount

Returns: $this

Implemented in Creditmemo.

◆ setIncrementId()

setIncrementId ( $id )

Sets the credit memo increment ID.

Parameters

string $id

Returns: $this

Implemented in Creditmemo.

◆ setInvoiceId()

setInvoiceId ( $id )

Sets the credit memo invoice ID.

Parameters

int $id

Returns: $this

Implemented in Creditmemo.

◆ setItems()

setItems ( $items )

Sets credit memo items.

Parameters

Implemented in Creditmemo.

◆ setOrderCurrencyCode()

setOrderCurrencyCode ( $code )

Sets the credit memo order currency code.

Parameters

string $code

Returns: $this

Implemented in Creditmemo.

◆ setOrderId()

setOrderId ( $id )

Sets the credit memo order ID.

Parameters

int $id

Returns: $this

Implemented in Creditmemo.

◆ setShippingAddressId()

setShippingAddressId ( $id )

Sets the credit memo shipping address ID.

Parameters

int $id

Returns: $this

Implemented in Creditmemo.

◆ setShippingAmount()

setShippingAmount ( $amount )

Sets the credit memo shipping amount.

Parameters

float $amount

Returns: $this

Implemented in Creditmemo.

◆ setShippingDiscountTaxCompensationAmount()

setShippingDiscountTaxCompensationAmount ( $amount )

Sets the credit memo shipping discount tax compensation amount.

Parameters

float $amount

Returns: $this

Implemented in Creditmemo.

◆ setShippingInclTax()

setShippingInclTax ( $amount )

Sets the credit memo shipping including tax.

Parameters

float $amount

Returns: $this

Implemented in Creditmemo.

◆ setShippingTaxAmount()

setShippingTaxAmount ( $amount )

Sets the credit memo shipping tax amount.

Parameters

float $amount

Returns: $this

Implemented in Creditmemo.

◆ setState()

setState ( $state )

Sets the credit memo state.

Parameters

int $state

Returns: $this

Implemented in Creditmemo.

◆ setStoreCurrencyCode()

setStoreCurrencyCode ( $code )

Sets the credit memo store currency code.

Parameters

string $code

Returns: $this

Implemented in Creditmemo.

◆ setStoreId()

setStoreId ( $id )

Sets the credit memo store ID.

Parameters

int $id

Returns: $this

Implemented in Creditmemo.

◆ setStoreToBaseRate()

setStoreToBaseRate ( $rate )

Sets the credit memo store-to-base rate.

Parameters

float $rate

Returns: $this

Implemented in Creditmemo.

◆ setStoreToOrderRate()

setStoreToOrderRate ( $rate )

Sets the credit memo store-to-order rate.

Parameters

float $rate

Returns: $this

Implemented in Creditmemo.

◆ setSubtotal()

setSubtotal ( $amount )

Sets the credit memo subtotal.

Parameters

float $amount

Returns: $this

Implemented in Creditmemo.

◆ setSubtotalInclTax()

setSubtotalInclTax ( $amount )

Sets the credit memo subtotal including tax.

Parameters

float $amount

Returns: $this

Implemented in Creditmemo.

◆ setTaxAmount()

setTaxAmount ( $amount )

Sets the credit memo tax amount.

Parameters

float $amount

Returns: $this

Implemented in Creditmemo.

◆ setTransactionId()

setTransactionId ( $transactionId )

Sets the credit memo transaction ID.

Parameters

string $transactionId

Returns: $this

Implemented in Creditmemo.

◆ setUpdatedAt()

setUpdatedAt ( $timestamp )

Sets the credit memo updated-at timestamp.

Parameters

string $timestamp

Returns: $this

Implemented in Creditmemo.

Field Documentation

◆ ADJUSTMENT

const ADJUSTMENT = 'adjustment'

Definition at line 106 of file CreditmemoInterface.php.

◆ ADJUSTMENT_NEGATIVE

const ADJUSTMENT_NEGATIVE = 'adjustment_negative'

Definition at line 74 of file CreditmemoInterface.php.

◆ ADJUSTMENT_POSITIVE

const ADJUSTMENT_POSITIVE = 'adjustment_positive'

Definition at line 34 of file CreditmemoInterface.php.

◆ BASE_ADJUSTMENT

const BASE_ADJUSTMENT = 'base_adjustment'

Definition at line 90 of file CreditmemoInterface.php.

◆ BASE_ADJUSTMENT_NEGATIVE

const BASE_ADJUSTMENT_NEGATIVE = 'base_adjustment_negative'

Definition at line 58 of file CreditmemoInterface.php.

◆ BASE_ADJUSTMENT_POSITIVE

const BASE_ADJUSTMENT_POSITIVE = 'base_adjustment_positive'

Definition at line 114 of file CreditmemoInterface.php.

◆ BASE_CURRENCY_CODE

const BASE_CURRENCY_CODE = 'base_currency_code'

Definition at line 166 of file CreditmemoInterface.php.

◆ BASE_DISCOUNT_AMOUNT

const BASE_DISCOUNT_AMOUNT = 'base_discount_amount'

Definition at line 46 of file CreditmemoInterface.php.

◆ BASE_DISCOUNT_TAX_COMPENSATION_AMOUNT

const BASE_DISCOUNT_TAX_COMPENSATION_AMOUNT = 'base_discount_tax_compensation_amount'

Definition at line 194 of file CreditmemoInterface.php.

◆ BASE_GRAND_TOTAL

const BASE_GRAND_TOTAL = 'base_grand_total'

Definition at line 110 of file CreditmemoInterface.php.

◆ BASE_SHIPPING_AMOUNT

const BASE_SHIPPING_AMOUNT = 'base_shipping_amount'

Definition at line 78 of file CreditmemoInterface.php.

◆ BASE_SHIPPING_DISCOUNT_TAX_COMPENSATION_AMNT

const BASE_SHIPPING_DISCOUNT_TAX_COMPENSATION_AMNT = 'base_shipping_discount_tax_compensation_amnt'

Definition at line 202 of file CreditmemoInterface.php.

◆ BASE_SHIPPING_INCL_TAX

const BASE_SHIPPING_INCL_TAX = 'base_shipping_incl_tax'

Definition at line 210 of file CreditmemoInterface.php.

◆ BASE_SHIPPING_TAX_AMOUNT

const BASE_SHIPPING_TAX_AMOUNT = 'base_shipping_tax_amount'

Definition at line 38 of file CreditmemoInterface.php.

◆ BASE_SUBTOTAL

const BASE_SUBTOTAL = 'base_subtotal'

Definition at line 94 of file CreditmemoInterface.php.

◆ BASE_SUBTOTAL_INCL_TAX

const BASE_SUBTOTAL_INCL_TAX = 'base_subtotal_incl_tax'

Definition at line 62 of file CreditmemoInterface.php.

◆ BASE_TAX_AMOUNT

const BASE_TAX_AMOUNT = 'base_tax_amount'

Definition at line 118 of file CreditmemoInterface.php.

◆ BASE_TO_GLOBAL_RATE

const BASE_TO_GLOBAL_RATE = 'base_to_global_rate'

Definition at line 86 of file CreditmemoInterface.php.

◆ BASE_TO_ORDER_RATE

const BASE_TO_ORDER_RATE = 'base_to_order_rate'

Definition at line 50 of file CreditmemoInterface.php.

◆ BILLING_ADDRESS_ID

const BILLING_ADDRESS_ID = 'billing_address_id'

Definition at line 150 of file CreditmemoInterface.php.

◆ COMMENTS

const COMMENTS = 'comments'

Definition at line 222 of file CreditmemoInterface.php.

◆ CREATED_AT

const CREATED_AT = 'created_at'

Definition at line 182 of file CreditmemoInterface.php.

◆ CREDITMEMO_STATUS

const CREDITMEMO_STATUS = 'creditmemo_status'

Definition at line 138 of file CreditmemoInterface.php.

◆ DISCOUNT_AMOUNT

const DISCOUNT_AMOUNT = 'discount_amount'

Definition at line 98 of file CreditmemoInterface.php.

◆ DISCOUNT_DESCRIPTION

const DISCOUNT_DESCRIPTION = 'discount_description'

Definition at line 214 of file CreditmemoInterface.php.

◆ DISCOUNT_TAX_COMPENSATION_AMOUNT

const DISCOUNT_TAX_COMPENSATION_AMOUNT = 'discount_tax_compensation_amount'

Definition at line 190 of file CreditmemoInterface.php.

◆ EMAIL_SENT

const EMAIL_SENT = 'email_sent'

Definition at line 134 of file CreditmemoInterface.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 CreditmemoInterface.php.

◆ GLOBAL_CURRENCY_CODE

const GLOBAL_CURRENCY_CODE = 'global_currency_code'

Definition at line 170 of file CreditmemoInterface.php.

◆ GRAND_TOTAL

const GRAND_TOTAL = 'grand_total'

Definition at line 54 of file CreditmemoInterface.php.

◆ INCREMENT_ID

const INCREMENT_ID = 'increment_id'

Definition at line 178 of file CreditmemoInterface.php.

◆ INVOICE_ID

const INVOICE_ID = 'invoice_id'

Definition at line 154 of file CreditmemoInterface.php.

◆ ITEMS

const ITEMS = 'items'

Definition at line 218 of file CreditmemoInterface.php.

◆ ORDER_CURRENCY_CODE

const ORDER_CURRENCY_CODE = 'order_currency_code'

Definition at line 162 of file CreditmemoInterface.php.

◆ ORDER_ID

const ORDER_ID = 'order_id'

Definition at line 130 of file CreditmemoInterface.php.

◆ SHIPPING_ADDRESS_ID

const SHIPPING_ADDRESS_ID = 'shipping_address_id'

Definition at line 146 of file CreditmemoInterface.php.

◆ SHIPPING_AMOUNT

const SHIPPING_AMOUNT = 'shipping_amount'

Definition at line 66 of file CreditmemoInterface.php.

◆ SHIPPING_DISCOUNT_TAX_COMPENSATION_AMOUNT

const SHIPPING_DISCOUNT_TAX_COMPENSATION_AMOUNT = 'shipping_discount_tax_compensation_amount'

Definition at line 198 of file CreditmemoInterface.php.

◆ SHIPPING_INCL_TAX

const SHIPPING_INCL_TAX = 'shipping_incl_tax'

Definition at line 206 of file CreditmemoInterface.php.

◆ SHIPPING_TAX_AMOUNT

const SHIPPING_TAX_AMOUNT = 'shipping_tax_amount'

Definition at line 122 of file CreditmemoInterface.php.

◆ STATE

const STATE = 'state'

Definition at line 142 of file CreditmemoInterface.php.

◆ STORE_CURRENCY_CODE

const STORE_CURRENCY_CODE = 'store_currency_code'

Definition at line 158 of file CreditmemoInterface.php.

◆ STORE_ID

const STORE_ID = 'store_id'

Definition at line 30 of file CreditmemoInterface.php.

◆ STORE_TO_BASE_RATE

const STORE_TO_BASE_RATE = 'store_to_base_rate'

Definition at line 82 of file CreditmemoInterface.php.

◆ STORE_TO_ORDER_RATE

const STORE_TO_ORDER_RATE = 'store_to_order_rate'

Definition at line 42 of file CreditmemoInterface.php.

◆ SUBTOTAL

const SUBTOTAL = 'subtotal'

Definition at line 102 of file CreditmemoInterface.php.

◆ SUBTOTAL_INCL_TAX

const SUBTOTAL_INCL_TAX = 'subtotal_incl_tax'

Definition at line 70 of file CreditmemoInterface.php.

◆ TAX_AMOUNT

const TAX_AMOUNT = 'tax_amount'

Definition at line 126 of file CreditmemoInterface.php.

◆ TRANSACTION_ID

const TRANSACTION_ID = 'transaction_id'

Definition at line 174 of file CreditmemoInterface.php.

◆ UPDATED_AT

const UPDATED_AT = 'updated_at'

Definition at line 186 of file CreditmemoInterface.php.

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

vendor/magento/module-sales/Api/Data/CreditmemoInterface.php

Public Member Functions

Data Fields

Detailed Description

Member Function Documentation

◆ getAdjustment()

◆ getAdjustmentNegative()

◆ getAdjustmentPositive()

◆ getBaseAdjustment()

◆ getBaseAdjustmentNegative()

◆ getBaseAdjustmentPositive()

◆ getBaseCurrencyCode()

◆ getBaseDiscountAmount()

◆ getBaseDiscountTaxCompensationAmount()

◆ getBaseGrandTotal()

◆ getBaseShippingAmount()

◆ getBaseShippingDiscountTaxCompensationAmnt()

◆ getBaseShippingInclTax()

◆ getBaseShippingTaxAmount()

◆ getBaseSubtotal()

◆ getBaseSubtotalInclTax()

◆ getBaseTaxAmount()

◆ getBaseToGlobalRate()

◆ getBaseToOrderRate()

◆ getBillingAddressId()

◆ getComments()

◆ getCreatedAt()

◆ getCreditmemoStatus()

◆ getDiscountAmount()

◆ getDiscountDescription()

◆ getDiscountTaxCompensationAmount()

◆ getEmailSent()

◆ getEntityId()

◆ getExtensionAttributes()

◆ getGlobalCurrencyCode()

◆ getGrandTotal()

◆ getIncrementId()

◆ getInvoiceId()

◆ getItems()

◆ getOrderCurrencyCode()

◆ getOrderId()

◆ getShippingAddressId()

◆ getShippingAmount()

◆ getShippingDiscountTaxCompensationAmount()

◆ getShippingInclTax()

◆ getShippingTaxAmount()

◆ getState()

◆ getStoreCurrencyCode()

◆ getStoreId()

◆ getStoreToBaseRate()

◆ getStoreToOrderRate()

◆ getSubtotal()

◆ getSubtotalInclTax()

◆ getTaxAmount()

◆ getTransactionId()

◆ getUpdatedAt()

◆ setAdjustment()

◆ setAdjustmentNegative()

◆ setAdjustmentPositive()

◆ setBaseAdjustment()

◆ setBaseAdjustmentNegative()

◆ setBaseAdjustmentPositive()

◆ setBaseCurrencyCode()

◆ setBaseDiscountAmount()

◆ setBaseDiscountTaxCompensationAmount()

◆ setBaseGrandTotal()

◆ setBaseShippingAmount()

◆ setBaseShippingDiscountTaxCompensationAmnt()

◆ setBaseShippingInclTax()

◆ setBaseShippingTaxAmount()

◆ setBaseSubtotal()

◆ setBaseSubtotalInclTax()

◆ setBaseTaxAmount()

◆ setBaseToGlobalRate()

◆ setBaseToOrderRate()

◆ setBillingAddressId()

◆ setComments()

◆ setCreatedAt()

◆ setCreditmemoStatus()

◆ setDiscountAmount()

◆ setDiscountDescription()