CreditmemoInterface.php

Go to the documentation of this file.

<?php
namespace Magento\Sales\Api\Data;

interface CreditmemoInterface extends \Magento\Framework\Api\ExtensibleDataInterface
{
    /*
     * Entity ID.
     */
    const ENTITY_ID = 'entity_id';
    /*
     * Store ID.
     */
    const STORE_ID = 'store_id';
    /*
     * Positive adjustment.
     */
    const ADJUSTMENT_POSITIVE = 'adjustment_positive';
    /*
     * Base shipping tax amount.
     */
    const BASE_SHIPPING_TAX_AMOUNT = 'base_shipping_tax_amount';
    /*
     * Store-to-order rate.
     */
    const STORE_TO_ORDER_RATE = 'store_to_order_rate';
    /*
     * Base discount rate.
     */
    const BASE_DISCOUNT_AMOUNT = 'base_discount_amount';
    /*
     * Base-to-order rate.
     */
    const BASE_TO_ORDER_RATE = 'base_to_order_rate';
    /*
     * Grand total.
     */
    const GRAND_TOTAL = 'grand_total';
    /*
     * Negative base adjustment.
     */
    const BASE_ADJUSTMENT_NEGATIVE = 'base_adjustment_negative';
    /*
     * Base subtotal including tax.
     */
    const BASE_SUBTOTAL_INCL_TAX = 'base_subtotal_incl_tax';
    /*
     * Shipping amount.
     */
    const SHIPPING_AMOUNT = 'shipping_amount';
    /*
     * Subtotal including tax.
     */
    const SUBTOTAL_INCL_TAX = 'subtotal_incl_tax';
    /*
     * Negative adjustment.
     */
    const ADJUSTMENT_NEGATIVE = 'adjustment_negative';
    /*
     * Base shipping amount.
     */
    const BASE_SHIPPING_AMOUNT = 'base_shipping_amount';
    /*
     * Store-to-base rate.
     */
    const STORE_TO_BASE_RATE = 'store_to_base_rate';
    /*
     * Base-to-global rate.
     */
    const BASE_TO_GLOBAL_RATE = 'base_to_global_rate';
    /*
     * Base adjustment.
     */
    const BASE_ADJUSTMENT = 'base_adjustment';
    /*
     * Base subtotal.
     */
    const BASE_SUBTOTAL = 'base_subtotal';
    /*
     * Discount amount.
     */
    const DISCOUNT_AMOUNT = 'discount_amount';
    /*
     * Subtotal.
     */
    const SUBTOTAL = 'subtotal';
    /*
     * Subtotal.
     */
    const ADJUSTMENT = 'adjustment';
    /*
     * Base grand total.
     */
    const BASE_GRAND_TOTAL = 'base_grand_total';
    /*
     * Positive base adjustment.
     */
    const BASE_ADJUSTMENT_POSITIVE = 'base_adjustment_positive';
    /*
     * Base tax amount.
     */
    const BASE_TAX_AMOUNT = 'base_tax_amount';
    /*
     * Shipping tax amount.
     */
    const SHIPPING_TAX_AMOUNT = 'shipping_tax_amount';
    /*
     * Tax amount.
     */
    const TAX_AMOUNT = 'tax_amount';
    /*
     * Order ID.
     */
    const ORDER_ID = 'order_id';
    /*
     * Email sent flag.
     */
    const EMAIL_SENT = 'email_sent';
    /*
     * Credit memo status.
     */
    const CREDITMEMO_STATUS = 'creditmemo_status';
    /*
     * Credit memo state.
     */
    const STATE = 'state';
    /*
     * Shipping address ID.
     */
    const SHIPPING_ADDRESS_ID = 'shipping_address_id';
    /*
     * Billing address ID.
     */
    const BILLING_ADDRESS_ID = 'billing_address_id';
    /*
     * Invoice ID.
     */
    const INVOICE_ID = 'invoice_id';
    /*
     * Store currency code.
     */
    const STORE_CURRENCY_CODE = 'store_currency_code';
    /*
     * Order currency code.
     */
    const ORDER_CURRENCY_CODE = 'order_currency_code';
    /*
     * Base currency code.
     */
    const BASE_CURRENCY_CODE = 'base_currency_code';
    /*
     * Global currency code.
     */
    const GLOBAL_CURRENCY_CODE = 'global_currency_code';
    /*
     * Transaction ID.
     */
    const TRANSACTION_ID = 'transaction_id';
    /*
     * Increment ID.
     */
    const INCREMENT_ID = 'increment_id';
    /*
     * Created-at timestamp.
     */
    const CREATED_AT = 'created_at';
    /*
     * Updated-at timestamp.
     */
    const UPDATED_AT = 'updated_at';
    /*
     * Discount tax compensation amount.
     */
    const DISCOUNT_TAX_COMPENSATION_AMOUNT = 'discount_tax_compensation_amount';
    /*
     * Base discount tax compensation amount.
     */
    const BASE_DISCOUNT_TAX_COMPENSATION_AMOUNT = 'base_discount_tax_compensation_amount';
    /*
     * Shipping discount tax compensation amount.
     */
    const SHIPPING_DISCOUNT_TAX_COMPENSATION_AMOUNT = 'shipping_discount_tax_compensation_amount';
    /*
     * Base shipping discount tax compensation amount.
     */
    const BASE_SHIPPING_DISCOUNT_TAX_COMPENSATION_AMNT = 'base_shipping_discount_tax_compensation_amnt';
    /*
     * Shipping including tax.
     */
    const SHIPPING_INCL_TAX = 'shipping_incl_tax';
    /*
     * Base shipping including tax.
     */
    const BASE_SHIPPING_INCL_TAX = 'base_shipping_incl_tax';
    /*
     * Discount description.
     */
    const DISCOUNT_DESCRIPTION = 'discount_description';
    /*
     * Credit memo items.
     */
    const ITEMS = 'items';
    /*
     * Credit memo comments.
     */
    const COMMENTS = 'comments';

    public function getAdjustment();

    public function getAdjustmentNegative();

    public function getAdjustmentPositive();

    public function getBaseAdjustment();

    public function getBaseAdjustmentNegative();

    public function setBaseAdjustmentNegative($baseAdjustmentNegative);

    public function getBaseAdjustmentPositive();

    public function setBaseAdjustmentPositive($baseAdjustmentPositive);

    public function getBaseCurrencyCode();

    public function getBaseDiscountAmount();

    public function getBaseGrandTotal();

    public function getBaseDiscountTaxCompensationAmount();

    public function getBaseShippingAmount();

    public function getBaseShippingDiscountTaxCompensationAmnt();

    public function getBaseShippingInclTax();

    public function getBaseShippingTaxAmount();

    public function getBaseSubtotal();

    public function getBaseSubtotalInclTax();

    public function getBaseTaxAmount();

    public function getBaseToGlobalRate();

    public function getBaseToOrderRate();

    public function getBillingAddressId();

    public function getCreatedAt();

    public function setCreatedAt($createdAt);

    public function getCreditmemoStatus();

    public function getDiscountAmount();

    public function getDiscountDescription();

    public function getEmailSent();

    public function getEntityId();

    public function setEntityId($entityId);

    public function getGlobalCurrencyCode();

    public function getGrandTotal();

    public function getDiscountTaxCompensationAmount();

    public function getIncrementId();

    public function getInvoiceId();

    public function getOrderCurrencyCode();

    public function getOrderId();

    public function getShippingAddressId();

    public function getShippingAmount();

    public function getShippingDiscountTaxCompensationAmount();

    public function getShippingInclTax();

    public function getShippingTaxAmount();

    public function getState();

    public function getStoreCurrencyCode();

    public function getStoreId();

    public function getStoreToBaseRate();

    public function getStoreToOrderRate();

    public function getSubtotal();

    public function getSubtotalInclTax();

    public function getTaxAmount();

    public function getTransactionId();

    public function setTransactionId($transactionId);

    public function getUpdatedAt();

    public function getItems();

    public function setItems($items);

    public function getComments();

    public function setComments($comments);

    public function setStoreId($id);

    public function setAdjustmentPositive($adjustmentPositive);

    public function setBaseShippingTaxAmount($amount);

    public function setStoreToOrderRate($rate);

    public function setBaseDiscountAmount($amount);

    public function setBaseToOrderRate($rate);

    public function setGrandTotal($amount);

    public function setBaseSubtotalInclTax($amount);

    public function setShippingAmount($amount);

    public function setSubtotalInclTax($amount);

    public function setAdjustmentNegative($adjustmentNegative);

    public function setBaseShippingAmount($amount);

    public function setStoreToBaseRate($rate);

    public function setBaseToGlobalRate($rate);

    public function setBaseAdjustment($baseAdjustment);

    public function setBaseSubtotal($amount);

    public function setDiscountAmount($amount);

    public function setSubtotal($amount);

    public function setAdjustment($adjustment);

    public function setBaseGrandTotal($amount);

    public function setBaseTaxAmount($amount);

    public function setShippingTaxAmount($amount);

    public function setTaxAmount($amount);

    public function setOrderId($id);

    public function setEmailSent($emailSent);

    public function setCreditmemoStatus($creditmemoStatus);

    public function setState($state);

    public function setShippingAddressId($id);

    public function setBillingAddressId($id);

    public function setInvoiceId($id);

    public function setStoreCurrencyCode($code);

    public function setOrderCurrencyCode($code);

    public function setBaseCurrencyCode($code);

    public function setGlobalCurrencyCode($code);

    public function setIncrementId($id);

    public function setUpdatedAt($timestamp);

    public function setDiscountTaxCompensationAmount($amount);

    public function setBaseDiscountTaxCompensationAmount($amount);

    public function setShippingDiscountTaxCompensationAmount($amount);

    public function setBaseShippingDiscountTaxCompensationAmnt($amnt);

    public function setShippingInclTax($amount);

    public function setBaseShippingInclTax($amount);

    public function setDiscountDescription($description);

    public function getExtensionAttributes();

    public function setExtensionAttributes(\Magento\Sales\Api\Data\CreditmemoExtensionInterface $extensionAttributes);
}