Fix importInvoice

Author: uryvskiy-dima

src/Model/Entity/Payments/ApiImportInvoiceResponse.php

@@ -0,0 +1,29 @@
+<?php
+
+/**
+ * PHP version 7.3
+ *
+ * @category ApiImportInvoiceResponse
+ * @package  RetailCrm\Api\Model\Entity\Payments
+ */
+
+namespace RetailCrm\Api\Model\Entity\Payments;
+
+use RetailCrm\Api\Component\Serializer\Annotation as JMS;
+
+/**
+ * Class ApiImportInvoiceResponse
+ *
+ * @category ApiImportInvoiceResponse
+ * @package  RetailCrm\Api\Model\Entity\Payments
+ */
+class ApiImportInvoiceResponse
+{
+    /**
+     * @var string
+     *
+     * @JMS\Type("string")
+     * @JMS\SerializedName("invoiceUuid")
+     */
+    public $invoiceUuid;
+}

src/Model/Response/Payments/PaymentImportInvoiceResponse.php

@@ -0,0 +1,30 @@
+<?php
+
+/**
+ * PHP version 7.3
+ *
+ * @category PaymentImportInvoiceResponse
+ * @package  RetailCrm\Api\Model\Response\Payments
+ */
+
+namespace RetailCrm\Api\Model\Response\Payments;
+
+use RetailCrm\Api\Component\Serializer\Annotation as JMS;
+use RetailCrm\Api\Model\Response\SuccessResponse;
+
+/**
+ * Class PaymentImportInvoiceResponse
+ *
+ * @category PaymentImportInvoiceResponse
+ * @package  RetailCrm\Api\Model\Response\Payments
+ */
+class PaymentImportInvoiceResponse extends SuccessResponse
+{
+    /**
+     * @var \RetailCrm\Api\Model\Entity\Payments\ApiImportInvoiceResponse
+     *
+     * @JMS\Type("RetailCrm\Api\Model\Entity\Payments\ApiImportInvoiceResponse")
+     * @JMS\SerializedName("invoice")
+     */
+    public $invoice;
+}

src/ResourceGroup/Payments.php

@@ -17,6 +17,7 @@
 use RetailCrm\Api\Model\Response\Payments\PaymentCheckResponse;
 use RetailCrm\Api\Model\Response\Payments\PaymentCreateInvoiceResponse;
 use RetailCrm\Api\Model\Response\Payments\PaymentGetInvoiceResponse;
+use RetailCrm\Api\Model\Response\Payments\PaymentImportInvoiceResponse;
 use RetailCrm\Api\Model\Response\SuccessResponse;
 
 /**
@@ -259,14 +260,67 @@ public function getInvoice(string $invoiceUuid): PaymentGetInvoiceResponse
         return $response;
     }
 
-    public function importInvoice(PaymentImportInvoiceRequest $request)
+    /**
+     * Makes POST "/api/v5/payment/invoice/import" request.
+     *
+     * Example:
+     * ```php
+     * use RetailCrm\Api\Factory\SimpleClientFactory;
+     * use RetailCrm\Api\Interfaces\ApiExceptionInterface;
+     * use RetailCrm\Api\Model\Entity\Payments\ApiImportInvoiceRequest;
+     * use RetailCrm\Api\Model\Request\Payments\PaymentImportInvoiceRequest;
+     *
+     * $client = SimpleClientFactory::createClient('https://test.retailcrm.pro', 'apiKey');
+     *
+     * $request = new PaymentImportInvoiceRequest();
+     * $invoice = new ApiImportInvoiceRequest();
+     *
+     * $invoice->paymentId = 979;
+     * $invoice->externalId = '979';
+     * $invoice->status = 'succeeded';
+     * $invoice->amount = 6697.0;
+     * $invoice->currency = 'RUB';
+     * $invoice->createdAt = '2025-07-08 00:00:00';
+     * $invoice->paidAt = '2025-07-08 00:10:00';
+     *
+     * $request->invoice = $invoice;
+     *
+     * try {
+     *     $response = $client->payments->importInvoice($request);
+     * } catch (ApiExceptionInterface $exception) {
+     *     echo sprintf(
+     *         'Error from RetailCRM API (status code: %d): %s',
+     *         $exception->getStatusCode(),
+     *         $exception->getMessage()
+     *     );
+     *
+     *     if (count($exception->getErrorResponse()->errors) > 0) {
+     *         echo PHP_EOL . 'Errors: ' . implode(', ', $exception->getErrorResponse()->errors);
+     *     }
+     * }
+ * ```
+     *
+     * @param \RetailCrm\Api\Model\Request\Payments\PaymentImportInvoiceRequest $request
+     *
+     * @return \RetailCrm\Api\Model\Response\Payments\PaymentImportInvoiceResponse
+     * @throws \RetailCrm\Api\Interfaces\ApiExceptionInterface
+     * @throws \RetailCrm\Api\Interfaces\ClientExceptionInterface
+     * @throws \RetailCrm\Api\Exception\Api\AccountDoesNotExistException
+     * @throws \RetailCrm\Api\Exception\Api\ApiErrorException
+     * @throws \RetailCrm\Api\Exception\Api\MissingCredentialsException
+     * @throws \RetailCrm\Api\Exception\Api\MissingParameterException
+     * @throws \RetailCrm\Api\Exception\Api\ValidationException
+     * @throws \RetailCrm\Api\Exception\Client\HandlerException
+     * @throws \RetailCrm\Api\Exception\Client\HttpClientException
+     */
+    public function importInvoice(PaymentImportInvoiceRequest $request): PaymentImportInvoiceResponse
     {
-        /** @var SuccessResponse $response */
+        /** @var PaymentImportInvoiceResponse $response */
         $response = $this->sendRequest(
             RequestMethod::POST,
             'payment/invoice/import',
             $request,
-            SuccessResponse::class
+            PaymentImportInvoiceResponse::class
         );
 
         return $response;