События работы с кассами и чеками

• массив с данными по чеку;
  
  

  Нажмите на [+], чтобы раскрыть детальное описание массива

  [ 'ORDER' => {Bitrix\Sale\Order}, // объект заказа, к которому привязан чек 'PAYMENTS' => [ // массив оплат [ 'ENTITY' => {Bitrix\Sale\Payment}, // объект оплаты 'IS_CASH' => "N", // тип документа оплаты: наличные/безналичные (оставлен для совместимости). // Правильнее опираться на поле с ключом TYPE 'TYPE' => "cashless", // тип документа оплаты: принимает одно из значений: cash (наличные), //cashless (безналичные), advance (аванс), credit (кредит) 'SUM' => 1400, // сумма документа оплаты ] ], 'PRODUCTS' => [ // список товарных позиций [ 'ENTITY' => {Bitrix\Sale\BasketItem}, // объект элемента корзин 'PRODUCT_ID' => "176", // ID продукта 'NAME' => "Футболка Женский Соблазн", // название 'BASE_PRICE' => 849, // цена без учета скидок и наценок за единицу 'PRICE' => 1099, // цена с учетом скидок и наценок за единицу 'SUM' => 1099, // общая цена с учетом количества 'QUANTITY' => 1, // количество 'VAT' => 0, // ID налоговой ставки 'DISCOUNT' => [ // информация о скидках 'PRICE' => -250, // величина скидки (отрицательное значение – наценка, // положительная – скидка) 'TYPE' => "C", // тип скидки: С-абсолютная ], 'PAYMENT_OBJECT' => \Bitrix\Sale\Cashbox\Check::PAYMENT_OBJECT_COMMODITY //тип предмета расчета* ] ], 'DELIVERY' => [ // список отгрузок [ 'ENTITY' => {Bitrix\Sale\Shipment}, // объект отгрузки 'NAME' => "Доставка", // название 'BASE_PRICE' => 301, // цена без учета скидок и наценок за единицу 'PRICE' => 301, // цена с учетом скидок и наценок за единицу 'SUM' => 301, // общая цена с учетом количества 'QUANTITY' => 1, // количество (всегда равняется 1) 'VAT' => 1, // ID налоговой ставки 'PAYMENT_OBJECT' => \Bitrix\Sale\Cashbox\Check::PAYMENT_OBJECT_SERVICE //тип предмета расчета* ] ], 'BUYER' => [ // информация о покупателе 'EMAIL' => "admin-aladin@aladin.loc", // email 'PHONE' => "90979648725", // телефон ], 'TOTAL_SUM' => 1400 // общая сумма чека ] * – ключ PAYMENT_OBJECT доступен с версии 18.5.10, его возможные значения: \Bitrix\Sale\Cashbox\Check::PAYMENT_OBJECT_COMMODITY – товар; \Bitrix\Sale\Cashbox\Check::PAYMENT_OBJECT_EXCISE – акциз; \Bitrix\Sale\Cashbox\Check::PAYMENT_OBJECT_JOB – работа; \Bitrix\Sale\Cashbox\Check::PAYMENT_OBJECT_SERVICE – услуга; \Bitrix\Sale\Cashbox\Check::PAYMENT_OBJECT_PAYMENT – платеж.

  
  
• тип чека (например, credit, advancepayment и т.д.).

// удаление доставки с 0 стоимостью
AddEventHandler("sale", "OnSaleCheckPrepareData", "CheckProductPrint");
function CheckProductPrint($a, $type)
{
	if ($a['DELIVERY']['SUM'] == 0)
		unset($a['DELIVERY']);
	return $a;
}

// добавление своего обработчика кассы
AddEventHandler("sale", "OnGetCustomCashboxHandlers", "GetCustomCashboxHandlers");
function GetCustomCashboxHandlers()
{
	$data = array('\Bitrix\Sale\Cashbox\cashboxnew' => '/bitrix/php_interface/include/cashboxnew.php');
	$event = new Bitrix\Main\EventResult(Bitrix\Main\EventResult::SUCCESS, $data);
	
	return $event;
}

// добавление своего типа чека
AddEventHandler("sale", "OnGetCustomCheckList", "GetCustomCheckList");
function GetCustomCheckList()
{
	$data = array('\Bitrix\Sale\Cashbox\SellExCheck' => '/bitrix/php_interface/include/sellexcheck.php');
	$event = new Bitrix\Main\EventResult(Bitrix\Main\EventResult::SUCCESS, $data);
	
	return $event;
}

// переопределение стандартного механизма печати чека
AddEventHandler("sale", "OnPrintableCheckSend", "PrintableCheckSend");
function PrintableCheckSend()
{
	/*
		Отправка чека по СМС
	*/
	
	$event = new Bitrix\Main\EventResult(Bitrix\Main\EventResult::SUCCESS);
	
	return $event;
}

onSaleCashboxRestrictionsClassNamesBuildList
// добавление своего типа чека
AddEventHandler("sale", "onSaleCashboxRestrictionsClassNamesBuildList", 
"GetSaleCashboxRestrictionsClassNamesBuildList");
function GetSaleCashboxRestrictionsClassNamesBuildList()
{
	$data = array(
		'\Bitrix\Sale\Cashbox\Restrictions\Site' => '/bitrix/php_interface/include/site.php'
	);
	$event = new Bitrix\Main\EventResult(Bitrix\Main\EventResult::SUCCESS, $data);
	
	return $event;
}

Пример 1. Формирование чеков для предоплаты и полной оплаты

Если сумма заказа превышает 10 000, покупатель вносит предоплату. После проверки заказа менеджером покупатель оплачивает оставшуюся сумму. Для первой оплаты обработчик формирует чек аванса, для второй — чек полной оплаты с учетом аванса. В упрощенном виде код выглядит так:

AddEventHandler("sale", "OnCheckCollateDocuments", "OnCheckCollateDocuments");
function OnCheckCollateDocuments($entities)
{
	foreach ($entities as $entity)
	{
		if ($entity instanceof \Bitrix\Sale\Payment)
		{
			$order = $entity->getCollection()->getOrder();
			if ($order->isPaid())
			{
				$related = [];
				foreach ($entity->getCollection() as $payment)
				{
					if ($payment->getId() != $entity->getId())
					{
						$related[\Bitrix\Sale\Cashbox\Check::PAYMENT_TYPE_ADVANCE][] = $payment;
					}
				}
			
				foreach ($order->getShipmentCollection() as $shipment)
				{
					if (!$shipment->isSystem())
					{
						$related[\Bitrix\Sale\Cashbox\Check::SHIPMENT_TYPE_NONE][] = $shipment;
					}
				}
				return new \Bitrix\Main\EventResult(
					\Bitrix\Main\EventResult::SUCCESS, 
					[
						[
							'TYPE' => 'sell',
							'ENTITIES' => [$entity],
							'RELATED_ENTITIES' => $related
						]
					]
				);
			}
			else
			{
				if ($entity->isPaid() && !$order->isPaid())
				{
					return new \Bitrix\Main\EventResult(
						\Bitrix\Main\EventResult::SUCCESS, 
						[
							[
								'TYPE' => 'advancepayment',
								'ENTITIES' => [$entity],
								'RELATED_ENTITIES' => []
							]
						]
					);
				}
			}
		}
	}
}

Пример2. Формирование чека с товарными позициями

Чтобы добавить в чек товарные позиции, передайте отгрузки заказа в RELATED_ENTITIES. Класс чека получит товары из коллекций элементов этих отгрузок.

<?php
use Bitrix\Main\Event;
use Bitrix\Main\EventManager;
use Bitrix\Main\EventResult;
use Bitrix\Main\Loader;
use Bitrix\Sale\Cashbox\Check;
use Bitrix\Sale\Payment;

if (!Loader::includeModule('sale'))
{
	throw new RuntimeException('Модуль sale не установлен');
}

EventManager::getInstance()->addEventHandler(
	'sale',
	'OnCheckCollateDocuments',
	'onCheckCollateDocumentsWithProducts'
);

function onCheckCollateDocumentsWithProducts(Event $event): EventResult
{
	$entities = $event->getParameter('ENTITIES');

	foreach ($entities as $entity)
	{
		if (!($entity instanceof Payment) || !$entity->isPaid())
		{
			continue;
		}

		$order = $entity->getCollection()->getOrder();
		$relatedEntities = [];

		foreach ($order->getShipmentCollection() as $shipment)
		{
			if (!$shipment->isSystem())
			{
				$relatedEntities[Check::SHIPMENT_TYPE_NONE][] = $shipment;
			}
		}

		if (!$relatedEntities)
		{
			continue;
		}

		return new EventResult(
			EventResult::SUCCESS,
			[
				[
					'TYPE' => 'sell',
					'ENTITIES' => [$entity],
					'RELATED_ENTITIES' => $relatedEntities,
				],
			]
		);
	}

	return new EventResult(EventResult::UNDEFINED);
}