Magento 2 Documentation  2.3
Documentation for Magento 2 CMS v2.3 (December 2018)
InvoiceInterface.php
Go to the documentation of this file.
1 <?php
6 namespace Magento\Sales\Api\Data;
7 
16 {
20  /*
21  * Entity ID.
22  */
23  const ENTITY_ID = 'entity_id';
24  /*
25  * Store ID.
26  */
27  const STORE_ID = 'store_id';
28  /*
29  * Base grand total.
30  */
31  const BASE_GRAND_TOTAL = 'base_grand_total';
32  /*
33  * Shipping tax amount.
34  */
35  const SHIPPING_TAX_AMOUNT = 'shipping_tax_amount';
36  /*
37  * Tax amount.
38  */
39  const TAX_AMOUNT = 'tax_amount';
40  /*
41  * Base tax amount.
42  */
43  const BASE_TAX_AMOUNT = 'base_tax_amount';
44  /*
45  * Store-to-order rate.
46  */
47  const STORE_TO_ORDER_RATE = 'store_to_order_rate';
48  /*
49  * Base shipping tax amount.
50  */
51  const BASE_SHIPPING_TAX_AMOUNT = 'base_shipping_tax_amount';
52  /*
53  * Base discount amount.
54  */
55  const BASE_DISCOUNT_AMOUNT = 'base_discount_amount';
56  /*
57  * Base-to-order rate.
58  */
59  const BASE_TO_ORDER_RATE = 'base_to_order_rate';
60  /*
61  * Grand total.
62  */
63  const GRAND_TOTAL = 'grand_total';
64  /*
65  * Shipping amount.
66  */
67  const SHIPPING_AMOUNT = 'shipping_amount';
68  /*
69  * Subtotal including tax.
70  */
71  const SUBTOTAL_INCL_TAX = 'subtotal_incl_tax';
72  /*
73  * Base subtotal including tax.
74  */
75  const BASE_SUBTOTAL_INCL_TAX = 'base_subtotal_incl_tax';
76  /*
77  * Store-to-base rate.
78  */
79  const STORE_TO_BASE_RATE = 'store_to_base_rate';
80  /*
81  * Base shipping amount.
82  */
83  const BASE_SHIPPING_AMOUNT = 'base_shipping_amount';
84  /*
85  * Total quantity.
86  */
87  const TOTAL_QTY = 'total_qty';
88  /*
89  * Base-to-global rate.
90  */
91  const BASE_TO_GLOBAL_RATE = 'base_to_global_rate';
92  /*
93  * Subtotal.
94  */
95  const SUBTOTAL = 'subtotal';
96  /*
97  * Base subtotal.
98  */
99  const BASE_SUBTOTAL = 'base_subtotal';
100  /*
101  * Discount amount.
102  */
103  const DISCOUNT_AMOUNT = 'discount_amount';
104  /*
105  * Billing address ID.
106  */
107  const BILLING_ADDRESS_ID = 'billing_address_id';
108  /*
109  * Is used for refund.
110  */
111  const IS_USED_FOR_REFUND = 'is_used_for_refund';
112  /*
113  * Order ID.
114  */
115  const ORDER_ID = 'order_id';
116  /*
117  * Email sent flag.
118  */
119  const EMAIL_SENT = 'email_sent';
120  /*
121  * Can void flag.
122  */
123  const CAN_VOID_FLAG = 'can_void_flag';
124  /*
125  * State.
126  */
127  const STATE = 'state';
128  /*
129  * Shipping address ID.
130  */
131  const SHIPPING_ADDRESS_ID = 'shipping_address_id';
132  /*
133  * Store currency code.
134  */
135  const STORE_CURRENCY_CODE = 'store_currency_code';
136  /*
137  * Transaction ID.
138  */
139  const TRANSACTION_ID = 'transaction_id';
140  /*
141  * Order currency code.
142  */
143  const ORDER_CURRENCY_CODE = 'order_currency_code';
144  /*
145  * Base currency code.
146  */
147  const BASE_CURRENCY_CODE = 'base_currency_code';
148  /*
149  * Global currency code.
150  */
151  const GLOBAL_CURRENCY_CODE = 'global_currency_code';
152  /*
153  * Increment ID.
154  */
155  const INCREMENT_ID = 'increment_id';
156  /*
157  * Created-at timestamp.
158  */
159  const CREATED_AT = 'created_at';
160  /*
161  * Updated-at timestamp.
162  */
163  const UPDATED_AT = 'updated_at';
164  /*
165  * Discount tax compensation amount.
166  */
167  const DISCOUNT_TAX_COMPENSATION_AMOUNT = 'discount_tax_compensation_amount';
168  /*
169  * Base discount tax compensation amount.
170  */
171  const BASE_DISCOUNT_TAX_COMPENSATION_AMOUNT = 'base_discount_tax_compensation_amount';
172  /*
173  * Shipping discount tax compensation amount.
174  */
175  const SHIPPING_DISCOUNT_TAX_COMPENSATION_AMOUNT = 'shipping_discount_tax_compensation_amount';
176  /*
177  * Base shipping discount tax compensation amount.
178  */
179  const BASE_SHIPPING_DISCOUNT_TAX_COMPENSATION_AMNT = 'base_shipping_discount_tax_compensation_amnt';
180  /*
181  * Shipping including tax.
182  */
183  const SHIPPING_INCL_TAX = 'shipping_incl_tax';
184  /*
185  * Base shipping including tax.
186  */
187  const BASE_SHIPPING_INCL_TAX = 'base_shipping_incl_tax';
188  /*
189  * Base total refunded.
190  */
191  const BASE_TOTAL_REFUNDED = 'base_total_refunded';
192  /*
193  * Discount description.
194  */
195  const DISCOUNT_DESCRIPTION = 'discount_description';
196  /*
197  * Items.
198  */
199  const ITEMS = 'items';
200  /*
201  * Comments.
202  */
203  const COMMENTS = 'comments';
204 
210  public function getBaseCurrencyCode();
211 
217  public function getBaseDiscountAmount();
218 
224  public function getBaseGrandTotal();
225 
231  public function getBaseDiscountTaxCompensationAmount();
232 
238  public function getBaseShippingAmount();
239 
246 
252  public function getBaseShippingInclTax();
253 
259  public function getBaseShippingTaxAmount();
260 
266  public function getBaseSubtotal();
267 
273  public function getBaseSubtotalInclTax();
274 
280  public function getBaseTaxAmount();
281 
287  public function getBaseTotalRefunded();
288 
294  public function getBaseToGlobalRate();
295 
301  public function getBaseToOrderRate();
302 
308  public function getBillingAddressId();
309 
315  public function getCanVoidFlag();
316 
322  public function getCreatedAt();
323 
330  public function setCreatedAt($createdAt);
331 
337  public function getDiscountAmount();
338 
344  public function getDiscountDescription();
345 
351  public function getEmailSent();
352 
358  public function getEntityId();
359 
366  public function setEntityId($entityId);
367 
373  public function getGlobalCurrencyCode();
374 
380  public function getGrandTotal();
381 
387  public function getDiscountTaxCompensationAmount();
388 
394  public function getIncrementId();
395 
401  public function getIsUsedForRefund();
402 
408  public function getOrderCurrencyCode();
409 
415  public function getOrderId();
416 
422  public function getShippingAddressId();
423 
429  public function getShippingAmount();
430 
437 
443  public function getShippingInclTax();
444 
450  public function getShippingTaxAmount();
451 
457  public function getState();
458 
464  public function getStoreCurrencyCode();
465 
471  public function getStoreId();
472 
478  public function getStoreToBaseRate();
479 
485  public function getStoreToOrderRate();
486 
492  public function getSubtotal();
493 
499  public function getSubtotalInclTax();
500 
506  public function getTaxAmount();
507 
513  public function getTotalQty();
514 
520  public function getTransactionId();
521 
528  public function setTransactionId($transactionId);
529 
535  public function getUpdatedAt();
536 
542  public function getItems();
543 
550  public function setItems($items);
551 
557  public function getComments();
558 
565  public function setComments($comments);
566 
573  public function setUpdatedAt($timestamp);
574 
581  public function setStoreId($id);
582 
589  public function setBaseGrandTotal($amount);
590 
597  public function setShippingTaxAmount($amount);
598 
605  public function setTaxAmount($amount);
606 
613  public function setBaseTaxAmount($amount);
614 
621  public function setStoreToOrderRate($rate);
622 
629  public function setBaseShippingTaxAmount($amount);
630 
637  public function setBaseDiscountAmount($amount);
638 
645  public function setBaseToOrderRate($rate);
646 
653  public function setGrandTotal($amount);
654 
661  public function setShippingAmount($amount);
662 
669  public function setSubtotalInclTax($amount);
670 
677  public function setBaseSubtotalInclTax($amount);
678 
685  public function setStoreToBaseRate($rate);
686 
693  public function setBaseShippingAmount($amount);
694 
701  public function setTotalQty($qty);
702 
709  public function setBaseToGlobalRate($rate);
710 
717  public function setSubtotal($amount);
718 
725  public function setBaseSubtotal($amount);
726 
733  public function setDiscountAmount($amount);
734 
741  public function setBillingAddressId($id);
742 
749  public function setIsUsedForRefund($isUsedForRefund);
750 
757  public function setOrderId($id);
758 
765  public function setEmailSent($emailSent);
766 
773  public function setCanVoidFlag($canVoidFlag);
774 
781  public function setState($state);
782 
789  public function setShippingAddressId($id);
790 
797  public function setStoreCurrencyCode($code);
798 
805  public function setOrderCurrencyCode($code);
806 
813  public function setBaseCurrencyCode($code);
814 
821  public function setGlobalCurrencyCode($code);
822 
829  public function setIncrementId($id);
830 
837  public function setDiscountTaxCompensationAmount($amount);
838 
846 
854 
861  public function setBaseShippingDiscountTaxCompensationAmnt($amnt);
862 
869  public function setShippingInclTax($amount);
870 
877  public function setBaseShippingInclTax($amount);
878 
885  public function setBaseTotalRefunded($amount);
886 
893  public function setDiscountDescription($description);
894 
900  public function getExtensionAttributes();
901 
908  public function setExtensionAttributes(\Magento\Sales\Api\Data\InvoiceExtensionInterface $extensionAttributes);
909 }
setExtensionAttributes(\Magento\Sales\Api\Data\InvoiceExtensionInterface $extensionAttributes)
$id
Definition: fieldset.phtml:14
$amount
Definition: order.php:14
$extensionAttributes
Definition: payment.php:22
$code
Definition: info.phtml:12
$items