alekciy/komtet-kassa-php-sdk

Модуль подключения Онлайн Кассы на PHP

komtet-kassa-php-sdk

Библиотека для интеграции вашего сайта с облачным сервисом распределенной печати чеков КОМТЕТ Касса

Требования

• PHP >= 5.4
• CURL

Установка

С помощью Composer:

composer require komtet/kassa-sdk

Вручную:

git clone https://github.com/Komtet/komtet-kassa-php-sdk

<?php

require __DIR__.'/komtet-kassa-php-sdk/autoload.php';

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

Первым делом необходимо создать менеджер очередей:

<?php

use Komtet\KassaSdk\Client;
use Komtet\KassaSdk\QueueManager;

$key = 'идентификатор магазина';
$secret = 'секретный ключ';
// PSR-совместимый логгер (опциональный параметр)
$logger = null;
$client = new Client($key, $secret, $logger);
$manager = new QueueManager($client);

После чего зарегистрировать очереди:

$manager->registerQueue('queue-name-1', 'queue-id-1');
$manager->registerQueue('queue-name-2', 'queue-id-2');
// 'queue-name-1' и 'queue-name-2' - произвольные псевдомимы для обращения к очередям.
// 'queue-id-1' и 'queue-id-2' - идентификаторы очередей, созданных в личном кабинете.

Отправка чека на печать:

<?php
use Komtet\KassaSdk\Agent;
use Komtet\KassaSdk\Buyer;
use Komtet\KassaSdk\Check;
use Komtet\KassaSdk\Cashier;
use Komtet\KassaSdk\Payment;
use Komtet\KassaSdk\Position;
use Komtet\KassaSdk\TaxSystem;
use Komtet\KassaSdk\Vat;
use Komtet\KassaSdk\Exception\SdkException;

// уникальный ID, предоставляемый магазином
$checkID = 'id';
// E-Mail клиента, на который будет отправлен E-Mail с чеком.
$clientEmail = 'user@host';

$check = Check::createSell($checkID, $clientEmail, TaxSystem::COMMON); // или Check::createSellReturn для оформления возврата
// Говорим, что чек нужно распечатать
$check->setShouldPrint(true);

$vat = new Vat(Vat::RATE_20);

// Позиция в чеке: имя, цена, кол-во, общая стоимость, налог
$position = new Position('name', 100, 1, 100, $vat);

// Опционально можно установить:
// Идентификатор позиции
// $position->setId('123');

// Единицу измерения
// $position->setMeasureName('Кг.');

// Cпособ рассчета
// $position->setCalculationMethod(CalculationMethod::FULL_PAYMENT);

// Признак рассчета
// $position->setCalculationSubject(CalculationSubject::PRODUCT);

// Агента по предмету расчета
// $agent = new Agent(Agent::COMMISSIONAIRE, "+77777777777", "ООО 'Лютик'", "12345678901");
// $position->setAgent($agent);

$check->addPosition($position);

// Итоговая сумма расчёта
$payment = new Payment(Payment::TYPE_CARD, 100);
$check->addPayment($payment);

// Добавление данных покупателя (опционально)
$buyer = new Buyer('Пупкин П.П.', '123412341234');
$check->addBuyer($buyer);

// Добавление кассира (опционально)
$cashier = new Cashier('Иваров И.П.', '1234567890123');
$check->addCashier($cashier);

// Добавляем чек в очередь.
try {
    $manager->putCheck($check, 'queue-name-1');
} catch (SdkException $e) {
    echo $e->getMessage();
}

Отправка чека коррекции:

<?php
use Komtet\KassaSdk\Correction;
use Komtet\KassaSdk\CorrectionCheck;
use Komtet\KassaSdk\AuthorisedPerson;

// Данные коррекции
// createSelf для самостоятельной коррекции
// createForced для коррекции по предписанию
$correction = Correction::createSelf(
    '2012-12-21', // Дата документа коррекции в формате yyyy-mm-dd
    '4815162342', // Номер документа коррекции
    'description' // Описание коррекции
);

// createSell для коррекции прихода
// createSellReturn для коррекции расхода
$check = CorrectionCheck::createSell(
    '4815162342', // Номер операции в вашей системе
    '4815162342', // Серийный номер принтера
    TaxSystem::COMMON, // Система налогообложения
    $correction // Данные коррекции
);

$check->setPayment(
    new Payment(Payment::TYPE_CARD, 4815), // Общая сумма по чеку
    new Vat('120') // Ставка налога
);

$authorised_person = new AuthorisedPerson(
  'Иваров И.И.', // ФИО
  '123456789012' // ИНН
);
$check->setAuthorisedPerson($authorised_person);

// Добавляем чек в очередь.
try {
    $manager->putCheck($check, 'queue-name-1');
} catch (SdkException $e) {
    echo $e->getMessage();
}

Чтобы не указывать каждый раз имя очереди, установите очередь по умолчанию:

<?php

$manager->setDefaultQueue('queue-name-1');
$manager->putCheck($check);

Получить состояние очереди:

<?php
$manager->isQueueActive('queue-name-1');

Получить информацию о поставленной на фискализацию задаче:

<?php
$taskManager = new TaskManager($client);
try {
    $taskManager->getTaskInfo('task-id');
} catch (SdkException $e) {
    echo $e->getMessage();
}

Создание заказа на доставку:

<?php
$orderManager = new OrderManager(client);

$order = new Order('123', 'new', 0);
$order->setClient('г.Пенза, ул.Суворова д.10 кв.25',
                  '+87654443322',
                  'client@email.com',
                  'Сергеев Виктор Сергеевич');
$order->setDeliveryTime('2018-02-28 14:00',
                        '2018-02-28 15:20');
$orderPosition = new OrderPosition(['oid' => '1',
                                    'name' => 'position name1',
                                    'price' => 555.0,
                                    'type' => 'product'
                                    ]);
$order->addPosition($orderPosition);

try {
    $orderManager->createOrder($order);
} catch (SdkException $e) {
    echo $e->getMessage();
}

Обновление заказа на доставку:

<?php
$orderManager = new OrderManager(client);
$order_id = 1;

$order = new Order('123', 'new', 0);
$order->setClient('г.Пенза, ул.Суворова д.10 кв.25',
                  '+87654443322',
                  'client@email.com',
                  'Сергеев Виктор Сергеевич');
$order->setDeliveryTime('2018-02-28 14:00',
                        '2018-02-28 15:20');
$orderPosition = new OrderPosition(['oid' => '1',
                                    'name' => 'position name1',
                                    'price' => 555.0,
                                    'type' => 'product'
                                    ]);
$order->addPosition($orderPosition);

try {
    $orderManager->updateOrder($order_id, $order);
} catch (SdkException $e) {
    echo $e->getMessage();
}

Информация о заказе:

<?php
$orderManager = new OrderManager(client);
$order_id = 1;

try {
  $info = $orderManager->getOrderInfo($order_id);
} catch (SdkException $e) {
    echo $e->getMessage();
}

Применить общую скидку на заказ:

<?php
$discount = 250;
$order->applyDiscount($discount);

Удалить заказ:

<?php
$orderManager = new OrderManager(client);
$order_id = 1;

try {
  $orderManager->deleteOrder($order_id);
} catch (SdkException $e) {
    echo $e->getMessage();
}

Получить список заказов:

<?php
$orderManager = new OrderManager(client);
$order_id = 1;

try {
    $orderList = $orderManager->getOrders();
} catch (SdkException $e) {
    echo $e->getMessage();
}

Получить список курьеров:

<?php
$courierManager = new CourierManager(client);

try {
    $courierList = $courierManager->getCouriers();
} catch (SdkException $e) {
    echo $e->getMessage();
}

Changelog

4.0.0 (26.03.2020)

• В классе Position убрана поддержка discount
• В класс Check добавлен метод addAdditionalCheckProps для поддержки дополнительного реквизита чека

3.1.0 (02.03.2020)

• Для заказов добавлена поддержка exices, country_code, declaration_number

3.0.0 (20.01.2020)

• Заменены параметры gtin и serial класса Nomenclature на code

2.6.0 (16.12.2019)

• В метод Order.add_position добавлен необязательный параметр agent.

2.5.0 (18.11.2019)

• Параметр inn в классе Cashier и AuthorisedPerson необязателен для ввода

2.4.2 (06.09.2019)

• Точности округления перед использованием функции json_encode выставлена для всех версий php

2.4.1 (03.09.2019)

• Изменена настройка точности округления перед использованием функции json_encode

2.4.0 (12.08.2019)

• Добавлен метод setName в класс Buyer

2.3.5 (07.08.2019)

• В ClientException добавлен код EXTERNAL_ID_EXISTS — чек с таким внешним идентификатором уже был напечатан

2.3.4 (06.08.2019)

• Исправлены ошибки при серилиазации полей класса Position

2.3.3 (18.07.2019)

• Добавлены празнаки рассчета PROPERTY_RIGHT, NON_OPERATING, INSURANCE, SALES_TAX, RESORT_FEE у класса CalculationSubject
• Добавлен класс Nomenclature для создания маркировок
• Добавлены новые методы Position::setNomenclature, Position::setExcise, Position::setCountryCode и Position::setDeclarationNumber

2.3.2 (10.07.2019)

• Исправлена обработка НДС 0%

2.3.1 (08.07.2019)

• Параметры конструктора Buyer сделаны необязательны для ввода
• Добавлен метод setINN в класс Buyer

2.3.0 (26.06.2019)

• Добавлена настройка точности округления перед использованием функции json_encode
• Добавлена функция applyDiscount для заказа доставки для применения общей скидки

2.2.0 (19.04.2019)

• Добавлены классы Order, OrderManager, OrderPosition для работы с заказами.
• Добавлен класс CourierManager для работы с курьерами.
• Добавлено конвертирование типов НДС Vat::RATE_18 и Vat::RATE_118 в Vat::RATE_20 и Vat::RATE_120

2.1.0 (05.06.2019)

• Добавлен класс покупателя Buyer
• Добавлена функция Check::addBuyer для передачи данных покупателя в чек на фискализацию

2.0.2 (16.04.2019)

• Исправлена структура передачи данных поставщика в позиции заказа
• Расширенны возможности статических функций Check::createSell, Check::createSellReturn, Check::createBuy и Check::createBuyReturn приемом адреса места расчета $paymentAddress

2.0.1 (23.01.2019)

• Перед использованием констант добавлена проверка на существование класса Psr\Log\LogLevel

2.0.0 (18.01.2019)

• Убраны типы НДС Vat::RATE_18 и Vat::RATE_118

1.3.0 (24.12.2018)

• Добавлены новые методы Agent::setSupplierInfo, Agent::setPayingAgentInfo, Agent::setReceivePaymentsOperatorInfo и Agent::setMoneyTransferOperatorInfo.
• Класс Check принимает необязательный параметр места расчета $paymentAddress

1.2.0 (10.12.2018)

• Добалвены новые виды НДС Vat::RATE_20 и Vat::RATE_120

1.1.0 (27.11.2018)

• Добавлен метод применения скидки к чеку Check::applyDiscount;

1.0.0 (01.09.2018)

• Убрыны методы Payment::createCard и Payment::createCash из-за расширения списка возможных видов оплаты. Теперь объект платежа необходимо создавать явно new Payment(Payment::TYPE_CARD, 100);

0.9.1 (01.09.2018)

• Вернул методы createCard и createCash для подержания совместимости версии 0.X.X

0.9.0 (15.08.2018)

• Добавлены константы направлений платежа INTENT_BUY и INTENT_BUY_RETURN в класс Check

0.8.0 (09.04.2018)

• Добавлен класс AuthorisedPerson

0.7.0 (02.04.2018)

• Добавлены классы Agent, CalculationMethod, CalculationSubject и Cashier.
• Добавлены методы Check::addCashier, Position::setCalculationMethod, Position::setCalculationSubject, Position::setAgent.
• Добавлены константы Payment::TYPE_PREPAYMENT, Payment::TYPE_CREDIT и Payment::TYPE_COUNTER_PROVISIONING.
• Удалены методы Payment::createCard и Payment::createCash

0.6.0 (28.11.2017)

• Добавлен метод Client::setPartner.

0.5.2 (01.11.2017)

• Маскирование значений заголовков Authorization и X-HMAC-Signature в логах.

0.5.1 (31.10.2017)

• Логирование с помощью PSR-совместимого логера.

0.5.0 (27.10.2017)

• Добавлен класс TaskManager.
• Добавлен метод Position::setId.

0.4.0 (29.09.2017)

• Добавлен метод Payment::getSum.
• Check::TS_* константы перенесены в класс TaxSystem.
• Добавлен метод Position::setMeasureName.
• Добавлен чек коррекции.

0.3.0 (11.08.2017)

• Удалён метод Vat::calculate.
• Конструктор класса Vat теперь принимает только ставку налога.
• Метод Vat::as_array() заменён на Vat::getRate, который возвращает строку, содержащую ставку налога.

0.2.1 (18.07.2017)

• QueueManager::putCheck() теперь возвращает ответ от сервера.

0.2.0 (12.07.2017)

• Добавлена возможность указать систему налогообложения.
• Удалены все упоминания о Motmom.

0.1.0 (30.06.2017)

• Первый релиз.