src/Service/App/Merchant/Invoice/Listener/RefundPaymentListener.php line 69

Open in your IDE?
  1. <?php
  3. namespace App\Service\App\Merchant\Invoice\Listener;
  5. use App\Entity\Merchant\InvoiceEntity;
  6. use App\Repository\Merchant\Contract\IOrderRepository;
  7. use App\Service\App\Merchant\CustomFeature\Implementation\InvoiceCustomFeature;
  8. use App\Service\App\Merchant\Invoice\Contract\ICreateCreditNoteByInvoiceIdService;
  9. use App\Service\App\Merchant\Invoice\Contract\IPayInvoiceService;
  10. use App\Service\App\Merchant\Payment\Event\RefundPaymentEvent;
  11. use App\Types\InvoiceStatus;
  12. use App\Types\InvoiceType;
  14. class RefundPaymentListener
  15. {
  17.     /**
  18.      * Create credit invoice service
  19.      *
  20.      * @var ICreateCreditNoteByInvoiceIdService
  21.      */
  22.     private ICreateCreditNoteByInvoiceIdService $createCreditNoteByInvoiceIdService;
  24.     /**
  25.      * Pay invoice service
  26.      *
  27.      * @var IPayInvoiceService
  28.      */
  29.     private IPayInvoiceService $payInvoiceService;
  31.     /**
  32.      * Invoice custom feature instance
  33.      *
  34.      * @var InvoiceCustomFeature
  35.      */
  36.     private InvoiceCustomFeature $invoiceCustomFeature;
  38.     /**
  39.      * Order repository
  40.      *
  41.      * @var IOrderRepository
  42.      */
  43.     private IOrderRepository $orderRepository;
  45.     /**
  46.      * Constructor
  47.      *
  48.      * @param ICreateCreditNoteByInvoiceIdService $createCreditNoteByInvoiceIdService
  49.      * @param IPayInvoiceService $payInvoiceService
  50.      * @param InvoiceCustomFeature $invoiceCustomFeature
  51.      * @param IOrderRepository $orderRepository
  52.      */
  53.     public function __construct(
  54.         ICreateCreditNoteByInvoiceIdService $createCreditNoteByInvoiceIdService,
  55.         IPayInvoiceService $payInvoiceService,
  56.         InvoiceCustomFeature $invoiceCustomFeature,
  57.         IOrderRepository $orderRepository
  58.     )
  59.     {
  60.         $this->createCreditNoteByInvoiceIdService = $createCreditNoteByInvoiceIdService;
  61.         $this->payInvoiceService = $payInvoiceService;
  62.         $this->invoiceCustomFeature = $invoiceCustomFeature;
  63.         $this->orderRepository = $orderRepository;
  64.     }
  66.     /**
  67.      * Listen on refund payment event.
  68.      *
  69.      * A refund ALWAYS issues/settles a credit note whenever invoicing is enabled — there is
  70.      * no opt-in flag anymore (a refund without a credit note is not offered). The reversal
  71.      * must be reflected by an avoir (and, under fiscal mode, net into the signed turnover +
  72.      * the FEC). Guarded so it only credits a finalized commercial invoice (no exception on an
  73.      * ineligible document).
  74.      *
  75.      * A credit note issued BEFORE its invoice was paid could not refund anything at issue
  76.      * time, so it was finalized but left unpaid (issued only). When the money is finally
  77.      * collected and this refund runs, that existing avoir is settled now: it is marked paid +
  78.      * seals its §7.2 INVOICE_PAID refund record. A credit note created together with its
  79.      * refund is already paid, so there is nothing left to do.
  80.      *
  81.      * @param RefundPaymentEvent $event
  82.      * @return void
  83.      */
  84.     public function onAction(RefundPaymentEvent $event): void
  85.     {
  86.         if (!$this->invoiceCustomFeature->isEnabled()) {
  87.             return;
  88.         }
  90.         $order = $this->orderRepository->getOrder($event->getRequest()->getId());
  91.         $invoice = $order?->getInvoice();
  92.         if ($invoice === null
  93.             || $invoice->getType() !== InvoiceType::INVOICE_TYPE_INVOICE
  94.             || !in_array($invoice->getStatus(), [InvoiceStatus::STATUS_OPEN, InvoiceStatus::STATUS_PAID], true)
  95.         ) {
  96.             return;
  97.         }
  99.         // One avoir per invoice: reuse the invoice's existing avoir, otherwise create it.
  100.         // findUnpaidCreditNote() returns null when that avoir is already paid — the reversal
  101.         // is settled, so there is nothing to do (and we must NOT create a second avoir:
  102.         // checkMakeCreditAbility rejects that). An OPEN avoir issued before payment is settled
  103.         // by the single pay call below now that the refund has actually happened.
  104.         $creditNote = $invoice->hasCreditNotes()
  105.             ? $this->findUnpaidCreditNote($invoice)
  106.             : $this->createCreditNoteByInvoiceIdService->perform($invoice->getId());
  108.         if ($creditNote === null) {
  109.             return;
  110.         }
  112.         $this->payInvoiceService->perform($creditNote->getId(), $event->getRequest()->getReason());
  113.     }
  115.     /**
  116.      * The invoice's issued-but-unpaid avoir (status OPEN), if any — the credit note that
  117.      * was finalized before its invoice was paid and is now awaiting refund settlement.
  118.      *
  119.      * @param InvoiceEntity $invoice
  120.      * @return InvoiceEntity|null
  121.      */
  122.     private function findUnpaidCreditNote(InvoiceEntity $invoice): ?InvoiceEntity
  123.     {
  124.         /** @var InvoiceEntity $creditNote */
  125.         foreach ($invoice->getCreditNotes() as $creditNote) {
  126.             if ($creditNote->getStatus() === InvoiceStatus::STATUS_OPEN) {
  127.                 return $creditNote;
  128.             }
  129.         }
  131.         return null;
  132.     }
  134. }