How does the backend invoicing work?

dmitry_fedyuk · March 14, 2016, 9:26pm

magento/magento2/blob/2.1.5/app/code/Magento/Sales/Block/Adminhtml/Order/Invoice/Create/Items.php#L72-L86


if ($this->getOrder()->getForcedShipmentWithInvoice()) {
    $_submitLabel = __('Submit Invoice and Shipment');
} else {
    $_submitLabel = __('Submit Invoice');
}
$this->addChild(
    'submit_button',
    'Magento\Backend\Block\Widget\Button',
    [
        'label' => $_submitLabel,
        'class' => 'save submit-button primary' . $submitButtonClass,
        'onclick' => 'disableElements(\'submit-button\');$(\'edit_form\').submit()',
        'disabled' => $this->_disableSubmitButton
    ]
);

github.com

magento/magento2/blob/2.1.5/app/code/Magento/Sales/view/adminhtml/layout/sales_order_invoice_new.xml#L17-L34


<block class="Magento\Sales\Block\Adminhtml\Order\Invoice\Create" name="sales_invoice_create">
    <block class="Magento\Sales\Block\Adminhtml\Order\Invoice\Create\Form" name="form" template="order/invoice/create/form.phtml">
        <block class="Magento\Sales\Block\Adminhtml\Order\View\Info" name="order_info" template="order/view/info.phtml"/>
        <block class="Magento\Sales\Block\Adminhtml\Order\Payment" name="order_payment"/>
        <block class="Magento\Sales\Block\Adminhtml\Order\Invoice\Create\Items" name="order_items" template="order/invoice/create/items.phtml">
            <block class="Magento\Sales\Block\Adminhtml\Items\Renderer\DefaultRenderer" as="default" template="order/invoice/create/items/renderer/default.phtml"/>
            <block class="Magento\Sales\Block\Adminhtml\Items\Column\Qty" name="column_qty" template="items/column/qty.phtml" group="column"/>
            <block class="Magento\Sales\Block\Adminhtml\Items\Column\Name" name="column_name" template="items/column/name.phtml" group="column"/>
            <block class="Magento\Framework\View\Element\Text\ListText" name="order_item_extra_info"/>
            <block class="Magento\Sales\Block\Adminhtml\Order\Totalbar" name="order_totalbar" template="order/totalbar.phtml"/>
            <block class="Magento\Sales\Block\Adminhtml\Order\Invoice\Totals" name="invoice_totals" template="order/totals.phtml">
                <block class="Magento\Sales\Block\Adminhtml\Order\Totals\Tax" name="tax" template="order/totals/tax.phtml"/>
            </block>
            <container name="submit_before" label="Submit Before"/>
            <container name="submit_after" label="Submit After"/>
        </block>
    </block>
</block>

github.com

magento/magento2/blob/2.1.5/app/code/Magento/Sales/Block/Adminhtml/Order/Invoice/Create/Form.php#L45-L53


/**
 * Get save url
 *
 * @return string
 */
public function getSaveUrl()
{
    return $this->getUrl('sales/*/save', ['order_id' => $this->getInvoice()->getOrderId()]);
}

github.com

magento/magento2/blob/2.1.5/app/code/Magento/Sales/view/adminhtml/templates/order/invoice/create/form.phtml#L10-L10


<form id="edit_form" class="order-invoice-edit" method="post" action="<?php /* @escapeNotVerified */ echo $block->getSaveUrl() ?>">

github.com

magento/magento2/blob/2.1.5/app/code/Magento/Sales/Controller/Adminhtml/Order/Invoice/Save.php#L102-L112


/**
 * Save invoice
 * We can save only new invoice. Existing invoices are not editable
 *
 * @return \Magento\Framework\Controller\ResultInterface
 *
 * @SuppressWarnings(PHPMD.CyclomaticComplexity)
 * @SuppressWarnings(PHPMD.NPathComplexity)
 * @SuppressWarnings(PHPMD.ExcessiveMethodLength)
 */
public function execute()

github.com

magento/magento2/blob/2.1.5/app/code/Magento/Sales/Controller/Adminhtml/Order/Invoice/Save.php#L124-L124


$data = $this->getRequest()->getPost('invoice');

github.com

magento/magento2/blob/2.1.5/app/code/Magento/Sales/Controller/Adminhtml/Order/Invoice/Save.php#L134-L135


/** @var \Magento\Sales\Model\Order $order */
$order = $this->_objectManager->create('Magento\Sales\Model\Order')->load($orderId);

github.com

magento/magento2/blob/2.1.5/app/code/Magento/Sales/Model/Order.php#L574-L594


public function canInvoice()
{
    if ($this->canUnhold() || $this->isPaymentReview()) {
        return false;
    }
    $state = $this->getState();
    if ($this->isCanceled() || $state === self::STATE_COMPLETE || $state === self::STATE_CLOSED) {
        return false;
    }


    if ($this->getActionFlag(self::ACTION_FLAG_INVOICE) === false) {
        return false;
    }


    foreach ($this->getAllItems() as $item) {
        if ($item->getQtyToInvoice() > 0 && !$item->getLockedDoInvoice()) {
            return true;
        }
    }
    return false;
}

github.com

magento/magento2/blob/2.1.5/app/code/Magento/Sales/Model/Order.php#L654-L665


/**
 * Retrieve order unhold availability
 *
 * @return bool
 */
public function canUnhold()
{
    if ($this->getActionFlag(self::ACTION_FLAG_UNHOLD) === false || $this->isPaymentReview()) {
        return false;
    }
    return $this->getState() === self::STATE_HOLDED;
}

github.com

magento/magento2/blob/2.1.5/app/code/Magento/Sales/Model/Order.php#L821-L832


/**
 * Check whether the payment is in payment review state
 * In this state order cannot be normally processed. Possible actions can be:
 * - accept or deny payment
 * - fetch transaction information
 *
 * @return bool
 */
public function isPaymentReview()
{
    return $this->getState() === self::STATE_PAYMENT_REVIEW;
}

github.com

magento/magento2/blob/2.1.5/app/code/Magento/Sales/Controller/Adminhtml/Order/Invoice/Save.php#L146-L146


$invoice = $this->invoiceService->prepareInvoice($order, $invoiceItems);

github.com

magento/magento2/blob/2.1.5/app/code/Magento/Sales/Model/Service/InvoiceService.php#L127-L133


/**
 * @param Order $order
 * @param array $qtys
 * @return \Magento\Sales\Model\Order\Invoice
 * @throws \Magento\Framework\Exception\LocalizedException
 */
public function prepareInvoice(Order $order, array $qtys = [])

github.com

magento/magento2/blob/2.1.5/app/code/Magento/Sales/Model/Service/InvoiceService.php#L135-L155


$invoice = $this->orderConverter->toInvoice($order);
$totalQty = 0;
foreach ($order->getAllItems() as $orderItem) {
    if (!$this->_canInvoiceItem($orderItem)) {
        continue;
    }
    $item = $this->orderConverter->itemToInvoiceItem($orderItem);
    if ($orderItem->isDummy()) {
        $qty = $orderItem->getQtyOrdered() ? $orderItem->getQtyOrdered() : 1;
    } elseif (isset($qtys[$orderItem->getId()])) {
        $qty = (double) $qtys[$orderItem->getId()];
    } elseif (empty($qtys)) {
        $qty = $orderItem->getQtyToInvoice();
    } else {
        $qty = 0;
    }
    $totalQty += $qty;
    $this->setInvoiceItemQuantity($item, $qty);
    $invoice->addItem($item);
}
$invoice->setTotalQty($totalQty);

github.com

magento/magento2/blob/2.1.5/app/code/Magento/Sales/Controller/Adminhtml/Order/Invoice/Save.php#L158-L160


if (!empty($data['capture_case'])) {
    $invoice->setRequestedCaptureCase($data['capture_case']);
}

github.com

magento/magento2/blob/2.1.5/app/code/Magento/Sales/Model/Order/Invoice.php#L576-L585


/**
 * Register invoice
 *
 * Apply to order, order items etc.
 *
 * @return $this
 * @throws \Magento\Framework\Exception\LocalizedException
 * @SuppressWarnings(PHPMD.CyclomaticComplexity)
 */
public function register()

github.com

magento/magento2/blob/2.1.5/app/code/Magento/Sales/Model/Order/Invoice.php#L591-L597


foreach ($this->getAllItems() as $item) {
    if ($item->getQty() > 0) {
        $item->register();
    } else {
        $item->isDeleted(true);
    }
}

github.com

magento/magento2/blob/2.1.5/app/code/Magento/Sales/Model/Order/Invoice/Item.php#L165-L170


/**
 * Applying qty to order item
 *
 * @return $this
 */
public function register()

github.com

magento/magento2/blob/2.1.5/app/code/Magento/Sales/Model/Order/Invoice/Item.php#L172-L189


$orderItem = $this->getOrderItem();
$orderItem->setQtyInvoiced($orderItem->getQtyInvoiced() + $this->getQty());


$orderItem->setTaxInvoiced($orderItem->getTaxInvoiced() + $this->getTaxAmount());
$orderItem->setBaseTaxInvoiced($orderItem->getBaseTaxInvoiced() + $this->getBaseTaxAmount());
$orderItem->setDiscountTaxCompensationInvoiced(
    $orderItem->getDiscountTaxCompensationInvoiced() + $this->getDiscountTaxCompensationAmount()
);
$orderItem->setBaseDiscountTaxCompensationInvoiced(
    $orderItem->getBaseDiscountTaxCompensationInvoiced() + $this->getBaseDiscountTaxCompensationAmount()
);


$orderItem->setDiscountInvoiced($orderItem->getDiscountInvoiced() + $this->getDiscountAmount());
$orderItem->setBaseDiscountInvoiced($orderItem->getBaseDiscountInvoiced() + $this->getBaseDiscountAmount());


$orderItem->setRowInvoiced($orderItem->getRowInvoiced() + $this->getRowTotal());
$orderItem->setBaseRowInvoiced($orderItem->getBaseRowInvoiced() + $this->getBaseRowTotal());
return $this;

github.com

magento/magento2/blob/2.1.5/app/code/Magento/Sales/Model/Order/Invoice.php#L599-L601


$order = $this->getOrder();
$captureCase = $this->getRequestedCaptureCase();
if ($this->canCapture()) {

github.com

magento/magento2/blob/2.1.5/app/code/Magento/Sales/Model/Order/Invoice.php#L282-L292


/**
 * Check invoice capture action availability
 *
 * @return bool
 */
public function canCapture()
{
    return $this->getState() != self::STATE_CANCELED &&
        $this->getState() != self::STATE_PAID &&
        $this->getOrder()->getPayment()->canCapture();
}

github.com

magento/magento2/blob/2.1.5/app/code/Magento/Sales/Model/Order/Invoice.php#L602-L609


if ($captureCase) {
    if ($captureCase == self::CAPTURE_ONLINE) {
        $this->capture();
    } elseif ($captureCase == self::CAPTURE_OFFLINE) {
        $this->setCanVoidFlag(false);
        $this->pay();
    }
}

github.com

magento/magento2/blob/2.1.5/app/code/Magento/Sales/Model/Order/Invoice.php#L335-L347


/**
 * Capture invoice
 *
 * @return $this
 */
public function capture()
{
    $this->getOrder()->getPayment()->capture($this);
    if ($this->getIsPaid()) {
        $this->pay();
    }
    return $this;
}

github.com

magento/magento2/blob/2.1.5/app/code/Magento/Sales/Model/Order/Payment.php#L435-L448


/**
 * Capture the payment online
 * Requires an invoice. If there is no invoice specified, will automatically prepare an invoice for order
 * Updates transactions hierarchy, if required
 * Updates payment totals, updates order status and adds proper comments
 *
 * @param null|Invoice $invoice
 * @throws \Magento\Framework\Exception\LocalizedException
 * @return $this
 */
public function capture($invoice = null)
{
    return $this->orderPaymentProcessor->capture($this, $invoice);
}

github.com

magento/magento2/blob/2.1.5/app/code/Magento/Sales/Model/Order/Payment/Processor.php#L75-L86


/**
 * Process capture operation
 *
 * @param OrderPaymentInterface $payment
 * @param InvoiceInterface $invoice
 * @return OrderPaymentInterface|Payment
 * @throws \Magento\Framework\Exception\LocalizedException
 */
public function capture(OrderPaymentInterface $payment, $invoice)
{
    return $this->captureOperation->capture($payment, $invoice);
}

github.com

magento/magento2/blob/2.1.5/app/code/Magento/Sales/Model/Order/Payment/Operations/CaptureOperation.php#L16-L24


/**
 * Captures payment.
 *
 * @param OrderPaymentInterface $payment
 * @param InvoiceInterface|null $invoice
 * @return OrderPaymentInterface
 * @throws \Magento\Framework\Exception\LocalizedException
 */
public function capture(OrderPaymentInterface $payment, $invoice)

Details: How is \Magento\Sales\Model\Order\Payment\Operations\CaptureOperation::capture() implemented and used?

github.com

magento/magento2/blob/2.1.5/app/code/Magento/Sales/Model/Order/Payment/Operations/CaptureOperation.php#L82-L82


$method->capture($payment, $amountToCapture);

dmitry_fedyuk · March 15, 2016, 10:25am