PHPackages                             brandshopru/online-receipt-api-client - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. brandshopru/online-receipt-api-client

ActiveLibrary

brandshopru/online-receipt-api-client
=====================================

PHP client for Online receipt API Fiscal Service

3.0.10(2mo ago)15.3k↓100%MITPHPPHP ^7.1 || ^8.0

Since Apr 10Pushed 2mo ago1 watchersCompare

[ Source](https://github.com/brandshopru/online-receipt-api-client)[ Packagist](https://packagist.org/packages/brandshopru/online-receipt-api-client)[ RSS](/packages/brandshopru-online-receipt-api-client/feed)WikiDiscussions master Synced today

READMEChangelogDependencies (2)Versions (14)Used By (0)

PHP клиент для API автоматической фискализации чеков интернет-магазина
======================================================================

[](#php-клиент-для-api-автоматической-фискализации-чеков-интернет-магазина)

[![](https://camo.githubusercontent.com/1732e64e39bdc70196fb699bf118535141da82661030e23e54cc614c77ceaa71/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f6c2f4272616e6473686f7072752f6f6e6c696e652d726563656970742d7068702d6170692d636c69656e742e7376673f7374796c653d666c61742d737175617265)](https://github.com/Brandshopru/online-receipt-php-api-client/blob/master/LICENSE)[![](https://camo.githubusercontent.com/3a5c57435e92e1f121f5e7d1d9e3351003f87fb6146a5cad825d232fe71ba7a0/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f4272616e6473686f7072752f6f6e6c696e652d726563656970742d7068702d6170692d636c69656e742e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/Brandshopru/online-receipt-php-api-client)[![](https://camo.githubusercontent.com/1f7a2b01d997cdbb3ca1b9382a596cfde506e2b58a3bd8d5193fc4b44ffe001b/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f4272616e6473686f7072752f6f6e6c696e652d726563656970742d7068702d6170692d636c69656e742e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/Brandshopru/online-receipt-php-api-client)[![](https://camo.githubusercontent.com/996be323b966c309c3e6730cd191cc734a454b5a448d368aa54141c9293ae775/68747470733a2f2f696d672e736869656c64732e696f2f7472617669732f4272616e6473686f7072752f6f6e6c696e652d726563656970742d7068702d6170692d636c69656e742e7376673f7374796c653d666c61742d737175617265)](https://travis-ci.org/Brandshopru/online-receipt-php-api-client)[![](https://camo.githubusercontent.com/aff9f1c2689f9a1c9c4a1f44b996b50106f2b1e4033e7b598ec464e410d22328/68747470733a2f2f696d672e736869656c64732e696f2f636f6465636f762f632f6769746875622f4272616e6473686f7072752f6f6e6c696e652d726563656970742d7068702d6170692d636c69656e742e7376673f7374796c653d666c61742d737175617265)](https://codecov.io/gh/Brandshopru/online-receipt-php-api-client)

Пакет предоставляет удобный интерфейс для общения с API Онлайн.Чека для отправки данных чеков в сервис фискализации. Пакет упрощает разработку модулей интеграции интернет-магазина с сервисом фискализации Онлайн.Чека.

Требования
----------

[](#требования)

- php 7.1, 8.0 и выше
- guzzlehttp/guzzle (или любой клиент следующий интерфейсу `\GuzzleHttp\ClientInterface`)
- ext-json
- curl

Использование
-------------

[](#использование)

### Отправка данных чека на сервер фискализации (создание документа)

[](#отправка-данных-чека-на-сервер-фискализации-создание-документа)

Для начала необходимо сформировать данные самого чека. Для этого достаточно для ваших моделей инплементировать интерфейсы OnlineReceiptOrderInterface для заказа, OnlineReceiptOrderItemInterface для товара в заказе, OnlineReceiptPaymentItemInterface для способа оплаты. Также вы можете использовать entity из пакета, или отнаследовать от них собственные классы переопределив методы на собственные.

```
use Brandshopru\OnlineReceiptApiClient\Entity\Order;
use Brandshopru\OnlineReceiptApiClient\Entity\Cashier;
use Brandshopru\OnlineReceiptApiClient\Entity\OrderItem;
use Brandshopru\OnlineReceiptApiClient\Entity\PaymentItem;

$dateTime =  new \DateTime('NOW');
// Создаем заказ
$order = Order::create([
    'documentUuid'     => uniqid(),
    'checkoutDateTime' => $dateTime->format(DATE_RFC3339),
    'orderId'          => rand(100000, 999999),
    'typeOperation'    => 'SALE',
    'customerContact'  => 'test@example.com',
]);

// Созадем товары
$orderItem1 = OrderItem::create([
    'price' => 100,
    'quantity' => 1,
    'vatTag' => OrderItem::VAT_NO,
    'name' => 'Test Product1'
]);

$orderItem2 = OrderItem::create([
    'price' => 200,
    'quantity' => 1,
    'vatTag' => OrderItem::VAT_NO,
    'name' => 'Test Product2'
]);

//Создаем способ оплаты
$paymentItem = PaymentItem::create([
    'type' => 'CARD',
    'sum' => 300
]);

// Добавляем товары и способ оплаты к заказу
$order->addItem($orderItem1);
$order->addItem($orderItem2);
$order->addPaymentItem($paymentItem);

//Создаем кассира
$cashier = Cashier::create([
    'name' => 'Test Cashier',
    'inn' => '123456789012',
    'position' => 'salesman',
]);
```

Далее объект заказа необходимо передать клиенту, также вы можете передать `responseURL` и печатать ли чек на кассе:

```
$login = 'test@test.ru'; // Логин полученный на первом шаге
$password = 'password'; // Пароль полученный на первом шаге
$testMode = true; // Тестовый режим
$client = new \Brandshopru\OnlineReceiptApiClient\Client($login, $password, $testMode);
$responseUrl =  'https://internet.shop.ru/order/982340931/checkout?completed=1';
$printReceipt = true; // Печатать ли чек на кассе
$result = $client->sendCheck($order, $responseUrl, $printReceipt, $cashier);
```

Все параметры кроме $order - опциональные. Если не передан объект `OnlineReceiptCashierInterface`то будут использованы данные из настроек торговой точки.

В ответ придет массив со статусом обработки документа и фискального накопителя.

### Проверка статуса документа

[](#проверка-статуса-документа)

Если при передаче данных чека был передан `responseURL`, то на него придет результат фискализации, если параметр задан не был, то вы можете самостоятельно проверить статус документа:

```
$login = 'test@test.ru'; // Логин полученный на первом шаге
$password = 'password'; // Пароль полученный на первом шаге
$testMode = true; // Тестовый режим
$documentId = 'efbafcdd-113a-45db-8fb9-718b1fdc3524'; // id документа
$client = new \Brandshopru\OnlineReceiptApiClient\Client($login, $password, $testMode);
$result = $client->getStatusDocumentById($documentId);
```

В ответ придет массив со статусом `status`, который может принимать значения:

- QUEUED - документ принят в очередь на обработку;
- PENDING - документ получен кассой для печати;
- PRINTED - фискализирован успешно;
- COMPLETED - результат фискализации отправлен (если было заполнено поле responseURL) в сервис источник;
- FAILED - ошибка при фискализации.

Также в массив придет `fnState` - статус фискального накопителя, может принимать значения:

- ready - соединение с фискальным накопителем установлено, состояние позволяет фискализировать чеки
- associated - клиент успешно связан с розничной точкой, но касса еще ни разу не вышла на связь и не сообщила свое состояние
- failed - Проблемы получения статуса фискального накопителя. Этот статус не препятствует добавлению документов для фискализации. Все документы будут добавлены в очередь на сервере и дождутся момента когда касса будет в состоянии их фискализировать

Кроме того вы можете вызвать отдельно метод проверки статуса фискального накопителя (сервиса фискализации):

```
$client = new \Brandshopru\OnlineReceiptApiClient\Client($login, $password, $testMode);
$result = $client->getStatusFiscalService();
```

Лицензия
--------

[](#лицензия)

[MIT](https://raw.githubusercontent.com/Brandshopru/online-receipt-php-api-client/master/LICENSE)

###  Health Score

48

—

FairBetter than 95% of packages

Maintenance84

Actively maintained with recent releases

Popularity22

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity64

Established project with proven stability

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~144 days

Recently: every ~67 days

Total

13

Last Release

81d ago

Major Versions

1.93-beta → 2.02021-04-10

2.5.3 → 3.0.12024-10-17

PHP version history (2 changes)1.92-betaPHP ^7.1

2.5.3PHP ^7.1 || ^8.0

### Community

Maintainers

![](https://www.gravatar.com/avatar/8a600048d349f877fae7f3d1f67444d063b9d16a431d70b3ff3c0f7db4891925?d=identicon)[brandshopru](/maintainers/brandshopru)

---

Top Contributors

[![volodyahome](https://avatars.githubusercontent.com/u/14793121?v=4)](https://github.com/volodyahome "volodyahome (15 commits)")

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/brandshopru-online-receipt-api-client/health.svg)

```
[![Health](https://phpackages.com/badges/brandshopru-online-receipt-api-client/health.svg)](https://phpackages.com/packages/brandshopru-online-receipt-api-client)
```

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
