PHPackages                             brandshopru/modulpos-php-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/modulpos-php-api-client

ActiveLibrary

brandshopru/modulpos-php-api-client
===================================

PHP client for modulpos API Fiscal Service

2.0.5(6y ago)03.3kMITPHPPHP ^7.1

Since Jul 25Pushed 6y agoCompare

[ Source](https://github.com/brandshopru/modulpos-php-api-client)[ Packagist](https://packagist.org/packages/brandshopru/modulpos-php-api-client)[ RSS](/packages/brandshopru-modulpos-php-api-client/feed)WikiDiscussions master Synced 2mo ago

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

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

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

[![](https://camo.githubusercontent.com/a73b398294b84ebd67b058accb1a959d6d7e0ac51bebc698a9a2c7ee05087deb/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f6c2f4272616e6473686f7072752f6d6f64756c706f732d7068702d6170692d636c69656e742e7376673f7374796c653d666c61742d737175617265)](https://github.com/Brandshopru/modulpos-php-api-client/blob/master/LICENSE)[![](https://camo.githubusercontent.com/f7a51ffff42c31b504cd05b28d45c1ad0856a03dd17413d729a1fd044f0b9dad/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f4272616e6473686f7072752f6d6f64756c706f732d7068702d6170692d636c69656e742e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/Brandshopru/modulpos-php-api-client)[![](https://camo.githubusercontent.com/2ba0d646e59ce3052c8ff6f63251908ddbae8d0b545035e7153f5af278aab838/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f4272616e6473686f7072752f6d6f64756c706f732d7068702d6170692d636c69656e742e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/Brandshopru/modulpos-php-api-client)[![](https://camo.githubusercontent.com/7b1d661cb59bca4a9a2e3e981c9a64c2ab31c24c2cb6221d8a7148159c51968e/68747470733a2f2f696d672e736869656c64732e696f2f7472617669732f4272616e6473686f7072752f6d6f64756c706f732d7068702d6170692d636c69656e742e7376673f7374796c653d666c61742d737175617265)](https://travis-ci.org/Brandshopru/modulpos-php-api-client)[![](https://camo.githubusercontent.com/949fe9295c906dfd3a857b8dce711ab0ef43fea4342a14e629690f061a9e8163/68747470733a2f2f696d672e736869656c64732e696f2f636f6465636f762f632f6769746875622f4272616e6473686f7072752f6d6f64756c706f732d7068702d6170692d636c69656e742e7376673f7374796c653d666c61742d737175617265)](https://codecov.io/gh/Brandshopru/modulpos-php-api-client)[![StyleCI](https://camo.githubusercontent.com/da8202f0cfa2a4b25934f8f43de39232002b6d49dffe03334696615a774633fa/68747470733a2f2f7374796c6563692e696f2f7265706f732f39383330363835312f736869656c643f6272616e63683d6d6173746572)](https://styleci.io/repos/98306851)

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

Часть описания дублирует оригинал [документации по API Модуль.Кассы](http://modulkassa.ru/upload/medialibrary/abb/api-avtomaticheskoy-fiskalizatsii-chekov-internet_magazinov-_ver.1.2_.pdf)

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

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

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

Установка
---------

[](#установка)

Вы можете установить данный пакет с помощью сomposer:

```
composer require brandshopru/modulpos-php-api-client

```

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

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

Схема процесса фискализации подробна описана в [документации к API](https://support.modulkassa.ru/upload/medialibrary/abb/API%20%D0%B0%D0%B2%D1%82%D0%BE%D0%BC%D0%B0%D1%82%D0%B8%D1%87%D0%B5%D1%81%D0%BA%D0%BE%D0%B9%20%D1%84%D0%B8%D1%81%D0%BA%D0%B0%D0%BB%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D0%B8%20%D1%87%D0%B5%D0%BA%D0%BE%D0%B2%20%D0%B8%D0%BD%D1%82%D0%B5%D1%80%D0%BD%D0%B5%D1%82-%D0%BC%D0%B0%D0%B3%D0%B0%D0%B7%D0%B8%D0%BD%D0%BE%D0%B2%20(ver.1.4).pdf). В кратце необходимо связать точку продаж с интернет магазином, настроить отправку данных чеков и проверить статус отправленного чека.

### Создания связки аккаунта и розничной точки

[](#создания-связки-аккаунта-и-розничной-точки)

Для начала необходимо в личном кабинете Модуль.Кассы создать розничную точку продаж, активировать у неё функцию `Использовать для печати документов интернет-магазина` и получить идентификатор `uuid`. Далее вызываем связку

```
$login = 'test@test.ru'; // Логин от аккаунта Модуль.Кассы
$password = 'password'; // Пароль от аккаунта Модуль.Кассы
$retailPointUuid = 'uuid'; // Идентификатор розничной точки
$testMode = true; // Тестовый режим
$associate = new \Brandshopru\ModulposApiClient\Associate($login, $password, $retailPointUuid, $testMode);
$result = $associate->init();
```

В `$result` получим массив с данным `userName` и `password` которые будут использоватся для дальнейших обращений к API. Их нужно где-нибудь сохранить, например в базе данных.

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

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

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

```
use Brandshopru\ModulposApiClient\Entity\Order;
use Brandshopru\ModulposApiClient\Entity\Cashier;
use Brandshopru\ModulposApiClient\Entity\OrderItem;
use Brandshopru\ModulposApiClient\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\ModulposApiClient\Client($login, $password, $testMode);
$responseUrl =  'https://internet.shop.ru/order/982340931/checkout?completed=1';
$printReceipt = true; // Печатать ли чек на кассе
$result = $client->sendCheck($order, $responseUrl, $printReceipt, $cashier);
```

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

###  Health Score

30

—

LowBetter than 65% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity16

Limited adoption so far

Community9

Small or concentrated contributor base

Maturity64

Established project with proven stability

 Bus Factor1

Top contributor holds 58.6% 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 ~118 days

Recently: every ~45 days

Total

9

Last Release

2262d ago

Major Versions

0.0.2 → 1.0.12019-01-21

1.0.1 → 2.0.02019-06-17

PHP version history (2 changes)0.0.1PHP ^5.4

2.0.0PHP ^7.1

### Community

Maintainers

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

---

Top Contributors

[![bigperson](https://avatars.githubusercontent.com/u/4757391?v=4)](https://github.com/bigperson "bigperson (17 commits)")[![brandshopru](https://avatars.githubusercontent.com/u/54398127?v=4)](https://github.com/brandshopru "brandshopru (11 commits)")[![re8us](https://avatars.githubusercontent.com/u/4831984?v=4)](https://github.com/re8us "re8us (1 commits)")

###  Code Quality

TestsPHPUnit

### Embed Badge

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

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

###  Alternatives

[neuron-core/neuron-ai

The PHP Agentic Framework.

1.8k245.3k20](/packages/neuron-core-neuron-ai)[tencentcloud/tencentcloud-sdk-php

TencentCloudApi php sdk

3731.2M42](/packages/tencentcloud-tencentcloud-sdk-php)

PHPackages © 2026

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