Files
yookassa-sdk-php/docs/classes/YooKassa-Model-Receipt-Receipt.md
Евгений Ю. Лозный 260d13f890 Добавлен прием платежей через Alfa Pay. Добавлен новый тип ошибки RuleViolationError
Добавлены нулевые привязки по СБП
Добавлена причина отмены возвратов `payment_expired`
2026-06-29 17:46:40 +03:00

46 KiB

YooKassa API SDK

Class: \YooKassa\Model\Receipt\Receipt

Namespace: \YooKassa\Model\Receipt


Summary:

Класс данных для формирования чека в онлайн-кассе (для соблюдения 54-ФЗ).


Constants

  • No constants found

Properties

Visibility Name Flag Summary
public $additional_user_props Дополнительный реквизит пользователя (тег в 54 ФЗ — 1084)
public $additionalUserProps Дополнительный реквизит пользователя (тег в 54 ФЗ — 1084)
public $customer Информация о плательщике
public $internet Признак проведения платежа в интернете (тег в 54 ФЗ — 1125) — указывает на оплату через интернет.
public $items Список товаров в заказе. Для чеков по 54-ФЗ: если используете Чеки от ЮKassa, можно передать максимум 80 товаров, если используете стороннюю онлайн-кассу, максимум 100 товаров.
public $receipt_industry_details Отраслевой реквизит чека (тег в 54 ФЗ — 1261)
public $receipt_operational_details Операционный реквизит чека (тег в 54 ФЗ — 1270)
public $receiptIndustryDetails Отраслевой реквизит чека (тег в 54 ФЗ — 1261)
public $receiptOperationalDetails Операционный реквизит чека (тег в 54 ФЗ — 1270)
public $settlements Массив оплат, обеспечивающих выдачу товара
public $shipping_items Список товаров в заказе, являющихся доставкой
public $shippingItems Список товаров в заказе, являющихся доставкой
public $tax_system_code Код системы налогообложения. Число 1-6.
public $taxSystemCode Код системы налогообложения. Число 1-6.
public $timezone Номер часовой зоны для адреса, по которому вы принимаете платежи (тег в 54 ФЗ — 1011).

Methods

Visibility Name Flag Summary
public __construct() AbstractObject constructor.
public __get() Возвращает значение свойства.
public __isset() Проверяет наличие свойства.
public __set() Устанавливает значение свойства.
public __unset() Удаляет свойство.
public addItem() Добавляет товар в чек.
public addReceiptIndustryDetails() Добавляет отраслевой реквизит чека.
public addSettlement() Добавляет оплату в чек.
public fromArray() Устанавливает значения свойств текущего объекта из массива.
public getAdditionalUserProps() Возвращает дополнительный реквизит пользователя.
public getAmountValue() Возвращает стоимость заказа исходя из состава чека.
public getCustomer() Возвращает информацию о плательщике.
public getInternet() Возвращает признак проведения платежа в интернете.
public getItems() Возвращает список позиций в текущем чеке.
public getObjectId() Возвращает Id объекта чека.
public getReceiptIndustryDetails() Возвращает отраслевой реквизит чека.
public getReceiptOperationalDetails() Возвращает операционный реквизит чека.
public getSend() Возвращает признак отложенной отправки чека.
public getSettlements() Возвращает массив оплат, обеспечивающих выдачу товара.
public getShippingAmountValue() Возвращает стоимость доставки исходя из состава чека.
public getShippingItems() Возвращает список товаров в заказе, являющихся доставкой
public getTaxSystemCode() Возвращает код системы налогообложения.
public getTimezone() Возвращает номер часовой зоны.
public getValidator()
public jsonSerialize() Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации.
public normalize() Подгоняет стоимость товаров в чеке к общей цене заказа.
public notEmpty() Проверяет есть ли в чеке хотя бы одна позиция.
public offsetExists() Проверяет наличие свойства.
public offsetGet() Возвращает значение свойства.
public offsetSet() Устанавливает значение свойства.
public offsetUnset() Удаляет свойство.
public removeItems() Обнуляет список позиций в чеке.
public setAdditionalUserProps() Устанавливает дополнительный реквизит пользователя.
public setCustomer() Устанавливает информацию о плательщике.
public setInternet() Устанавливает признак проведения платежа в интернете.
public setItems() Устанавливает список позиций в чеке.
public setReceiptIndustryDetails() Устанавливает отраслевой реквизит чека.
public setReceiptOperationalDetails() Устанавливает операционный реквизит чека.
public setSend() Устанавливает признак отложенной отправки чека.
public setSettlements() Возвращает массив оплат, обеспечивающих выдачу товара.
public setTaxSystemCode() Устанавливает код системы налогообложения.
public setTimezone() Устанавливает номер часовой зоны.
public toArray() Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize().
protected getUnknownProperties() Возвращает массив свойств которые не существуют, но были заданы у объекта.
protected validatePropertyValue()

Details


Tags

Tag Version Description
category Class
author cms@yoomoney.ru

Properties

public $additional_user_props : \YooKassa\Model\Receipt\AdditionalUserProps


Description

Дополнительный реквизит пользователя (тег в 54 ФЗ — 1084)

Type: AdditionalUserProps

Details:

public $additionalUserProps : \YooKassa\Model\Receipt\AdditionalUserProps


Description

Дополнительный реквизит пользователя (тег в 54 ФЗ — 1084)

Type: AdditionalUserProps

Details:

public $customer : \YooKassa\Model\Receipt\ReceiptCustomer


Description

Информация о плательщике

Type: ReceiptCustomer

Details:

public $internet : bool


Description

Признак проведения платежа в интернете (тег в 54 ФЗ — 1125) — указывает на оплату через интернет.

Type: bool

Details:

public $items : \YooKassa\Common\ListObjectInterface|\YooKassa\Model\Receipt\ReceiptItemInterface[]


Description

Список товаров в заказе. Для чеков по 54-ФЗ: если используете Чеки от ЮKassa, можно передать максимум 80 товаров, если используете стороннюю онлайн-кассу, максимум 100 товаров.

Type: ReceiptItemInterface[]

Details:

public $receipt_industry_details : \YooKassa\Common\ListObjectInterface|\YooKassa\Model\Receipt\IndustryDetails[]


Description

Отраслевой реквизит чека (тег в 54 ФЗ — 1261)

Type: IndustryDetails[]

Details:

public $receipt_operational_details : \YooKassa\Model\Receipt\OperationalDetails


Description

Операционный реквизит чека (тег в 54 ФЗ — 1270)

Type: OperationalDetails

Details:

public $receiptIndustryDetails : \YooKassa\Common\ListObjectInterface|\YooKassa\Model\Receipt\IndustryDetails[]


Description

Отраслевой реквизит чека (тег в 54 ФЗ — 1261)

Type: IndustryDetails[]

Details:

public $receiptOperationalDetails : \YooKassa\Model\Receipt\OperationalDetails


Description

Операционный реквизит чека (тег в 54 ФЗ — 1270)

Type: OperationalDetails

Details:

public $settlements : \YooKassa\Common\ListObjectInterface|\YooKassa\Model\Receipt\SettlementInterface[]


Description

Массив оплат, обеспечивающих выдачу товара

Type: SettlementInterface[]

Details:

public $shipping_items : \YooKassa\Common\ListObjectInterface|\YooKassa\Model\Receipt\ReceiptItemInterface[]


Description

Список товаров в заказе, являющихся доставкой

Type: ReceiptItemInterface[]

Details:

public $shippingItems : \YooKassa\Common\ListObjectInterface|\YooKassa\Model\Receipt\ReceiptItemInterface[]


Description

Список товаров в заказе, являющихся доставкой

Type: ReceiptItemInterface[]

Details:

public $tax_system_code : int


Description

Код системы налогообложения. Число 1-6.

Type: int

Details:

public $taxSystemCode : int


Description

Код системы налогообложения. Число 1-6.

Type: int

Details:

public $timezone : int


Description

Номер часовой зоны для адреса, по которому вы принимаете платежи (тег в 54 ФЗ — 1011).

Type: int

Details:


Methods

public __construct() : mixed

public __construct(array|null $data = []) : mixed

Summary

AbstractObject constructor.

Details:

Parameters:
Type Name Description
array OR null data

Returns: mixed -

public __get() : mixed

public __get(string $propertyName) : mixed

Summary

Возвращает значение свойства.

Details:

Parameters:
Type Name Description
string propertyName Имя свойства

Returns: mixed - Значение свойства

public __isset() : bool

public __isset(string $propertyName) : bool

Summary

Проверяет наличие свойства.

Details:

Parameters:
Type Name Description
string propertyName Имя проверяемого свойства

Returns: bool - True если свойство имеется, false если нет

public __set() : void

public __set(string $propertyName, mixed $value) : void

Summary

Устанавливает значение свойства.

Details:

Parameters:
Type Name Description
string propertyName Имя свойства
mixed value Значение свойства

Returns: void -

public __unset() : void

public __unset(string $propertyName) : void

Summary

Удаляет свойство.

Details:

Parameters:
Type Name Description
string propertyName Имя удаляемого свойства

Returns: void -

public addItem() : void

public addItem(\YooKassa\Model\Receipt\ReceiptItemInterface[]|\YooKassa\Common\ListObjectInterface $value) : void

Summary

Добавляет товар в чек.

Details:

Parameters:
Type Name Description
\YooKassa\Model\Receipt\ReceiptItemInterface[] OR \YooKassa\Common\ListObjectInterface value Объект добавляемой в чек позиции

Returns: void -

public addReceiptIndustryDetails() : self

public addReceiptIndustryDetails(\YooKassa\Model\Receipt\IndustryDetails|array $value) : self

Summary

Добавляет отраслевой реквизит чека.

Details:

Parameters:
Type Name Description
\YooKassa\Model\Receipt\IndustryDetails OR array value Отраслевой реквизит чека.

Returns: self -

public addSettlement() : self

public addSettlement(\YooKassa\Model\Receipt\SettlementInterface $value) : self

Summary

Добавляет оплату в чек.

Details:

Parameters:
Type Name Description
\YooKassa\Model\Receipt\SettlementInterface value Оплата

Returns: self -

public fromArray() : void

public fromArray(array|\Traversable $sourceArray) : void

Summary

Устанавливает значения свойств текущего объекта из массива.

Details:

Parameters:
Type Name Description
array OR \Traversable sourceArray Ассоциативный массив с настройками

Returns: void -

public getAdditionalUserProps() : \YooKassa\Model\Receipt\AdditionalUserProps|null

public getAdditionalUserProps() : \YooKassa\Model\Receipt\AdditionalUserProps|null

Summary

Возвращает дополнительный реквизит пользователя.

Details:

Returns: \YooKassa\Model\Receipt\AdditionalUserProps|null - Дополнительный реквизит пользователя

public getAmountValue() : int

public getAmountValue(bool $withShipping = true) : int

Summary

Возвращает стоимость заказа исходя из состава чека.

Details:

Parameters:
Type Name Description
bool withShipping Добавить ли к стоимости заказа стоимость доставки

Returns: int - Общая стоимость заказа в центах/копейках

public getCustomer() : \YooKassa\Model\Receipt\ReceiptCustomer

public getCustomer() : \YooKassa\Model\Receipt\ReceiptCustomer

Summary

Возвращает информацию о плательщике.

Details:

Returns: \YooKassa\Model\Receipt\ReceiptCustomer - Информация о плательщике

public getInternet() : bool|null

public getInternet() : bool|null

Summary

Возвращает признак проведения платежа в интернете.

Details:

Returns: bool|null - Признак проведения платежа в интернете

public getItems() : \YooKassa\Model\Receipt\ReceiptItemInterface[]|\YooKassa\Common\ListObjectInterface

public getItems() : \YooKassa\Model\Receipt\ReceiptItemInterface[]|\YooKassa\Common\ListObjectInterface

Summary

Возвращает список позиций в текущем чеке.

Details:

Returns: \YooKassa\Model\Receipt\ReceiptItemInterface[]|\YooKassa\Common\ListObjectInterface - Список товаров в заказе

public getObjectId() : null|string

public getObjectId() : null|string

Summary

Возвращает Id объекта чека.

Details:

Returns: null|string - Id объекта чека

public getReceiptIndustryDetails() : \YooKassa\Model\Receipt\IndustryDetails[]|\YooKassa\Common\ListObjectInterface

public getReceiptIndustryDetails() : \YooKassa\Model\Receipt\IndustryDetails[]|\YooKassa\Common\ListObjectInterface

Summary

Возвращает отраслевой реквизит чека.

Details:

Returns: \YooKassa\Model\Receipt\IndustryDetails[]|\YooKassa\Common\ListObjectInterface - Отраслевой реквизит чека

public getReceiptOperationalDetails() : \YooKassa\Model\Receipt\OperationalDetails|null

public getReceiptOperationalDetails() : \YooKassa\Model\Receipt\OperationalDetails|null

Summary

Возвращает операционный реквизит чека.

Details:

Returns: \YooKassa\Model\Receipt\OperationalDetails|null - Операционный реквизит чека

public getSend() : bool

public getSend() : bool

Summary

Возвращает признак отложенной отправки чека.

Details:

Returns: bool - Признак отложенной отправки чека

public getSettlements() : \YooKassa\Model\Receipt\SettlementInterface[]|\YooKassa\Common\ListObjectInterface

public getSettlements() : \YooKassa\Model\Receipt\SettlementInterface[]|\YooKassa\Common\ListObjectInterface

Summary

Возвращает массив оплат, обеспечивающих выдачу товара.

Details:

Returns: \YooKassa\Model\Receipt\SettlementInterface[]|\YooKassa\Common\ListObjectInterface - Массив оплат, обеспечивающих выдачу товара

public getShippingAmountValue() : int

public getShippingAmountValue() : int

Summary

Возвращает стоимость доставки исходя из состава чека.

Details:

Returns: int - Стоимость доставки из состава чека в центах/копейках

public getShippingItems() : \YooKassa\Model\Receipt\ReceiptItemInterface[]|\YooKassa\Common\ListObjectInterface

public getShippingItems() : \YooKassa\Model\Receipt\ReceiptItemInterface[]|\YooKassa\Common\ListObjectInterface

Summary

Возвращает список товаров в заказе, являющихся доставкой

Details:

Returns: \YooKassa\Model\Receipt\ReceiptItemInterface[]|\YooKassa\Common\ListObjectInterface - Список товаров в заказе, являющихся доставкой

public getTaxSystemCode() : int|null

public getTaxSystemCode() : int|null

Summary

Возвращает код системы налогообложения.

Details:

Returns: int|null - Код системы налогообложения. Число 1-6.

public getTimezone() : int|null

public getTimezone() : int|null

Summary

Возвращает номер часовой зоны.

Details:

Returns: int|null - Номер часовой зоны

public getValidator() : \YooKassa\Validator\Validator

public getValidator() : \YooKassa\Validator\Validator

Details:

Returns: \YooKassa\Validator\Validator -

public jsonSerialize() : array

public jsonSerialize() : array

Summary

Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации.

Details:

Returns: array - Ассоциативный массив со свойствами текущего объекта

public normalize() : void

public normalize(\YooKassa\Model\AmountInterface $orderAmount, bool $withShipping = false) : void

Summary

Подгоняет стоимость товаров в чеке к общей цене заказа.

Details:

Parameters:
Type Name Description
\YooKassa\Model\AmountInterface orderAmount Общая стоимость заказа
bool withShipping Поменять ли заодно и цену доставки

Returns: void -

public notEmpty() : bool

public notEmpty() : bool

Summary

Проверяет есть ли в чеке хотя бы одна позиция.

Details:

Returns: bool - True если чек не пуст, false если в чеке нет ни одной позиции

public offsetExists() : bool

public offsetExists(string $offset) : bool

Summary

Проверяет наличие свойства.

Details:

Parameters:
Type Name Description
string offset Имя проверяемого свойства

Returns: bool - True если свойство имеется, false если нет

public offsetGet() : mixed

public offsetGet(string $offset) : mixed

Summary

Возвращает значение свойства.

Details:

Parameters:
Type Name Description
string offset Имя свойства

Returns: mixed - Значение свойства

public offsetSet() : void

public offsetSet(string $offset, mixed $value) : void

Summary

Устанавливает значение свойства.

Details:

Parameters:
Type Name Description
string offset Имя свойства
mixed value Значение свойства

Returns: void -

public offsetUnset() : void

public offsetUnset(string $offset) : void

Summary

Удаляет свойство.

Details:

Parameters:
Type Name Description
string offset Имя удаляемого свойства

Returns: void -

public removeItems() : self

public removeItems() : self

Summary

Обнуляет список позиций в чеке.

Description

Если до этого в чеке уже были установлены значения, они удаляются.

Details:

Returns: self -

public setAdditionalUserProps() : self

public setAdditionalUserProps(\YooKassa\Model\Receipt\AdditionalUserProps|array $additional_user_props = null) : self

Summary

Устанавливает дополнительный реквизит пользователя.

Details:

Parameters:
Type Name Description
\YooKassa\Model\Receipt\AdditionalUserProps OR array additional_user_props Дополнительный реквизит пользователя

Returns: self -

public setCustomer() : self

public setCustomer(\YooKassa\Model\Receipt\ReceiptCustomer|array|null $customer = null) : self

Summary

Устанавливает информацию о плательщике.

Details:

Parameters:
Type Name Description
\YooKassa\Model\Receipt\ReceiptCustomer OR array OR null customer

Returns: self -

public setInternet() : self

public setInternet(bool|null $internet = null) : self

Summary

Устанавливает признак проведения платежа в интернете.

Details:

Parameters:
Type Name Description
bool OR null internet Признак проведения платежа в интернете (тег в 54 ФЗ — 1125) — указывает на оплату через интернет.

Returns: self -

public setItems() : self

public setItems(array|\YooKassa\Common\ListObjectInterface $items) : self

Summary

Устанавливает список позиций в чеке.

Description

Если до этого в чеке уже были установлены значения, они удаляются и полностью заменяются переданным списком позиций. Все передаваемые значения в массиве позиций должны быть объектами класса, реализующего интерфейс ReceiptItemInterface, в противном случае будет выброшено исключение InvalidPropertyValueTypeException.

Details:

Parameters:
Type Name Description
array OR \YooKassa\Common\ListObjectInterface items Список товаров в заказе: для Чеков от ЮKassa — не более 80 товаров, для сторонних онлайн-касс — не более 100 товаров
Throws:
Type Description
\YooKassa\Validator\Exceptions\EmptyPropertyValueException Выбрасывается если передали пустой массив значений
\YooKassa\Validator\Exceptions\InvalidPropertyValueTypeException Выбрасывается если в качестве значения был передан не массив и не итератор, либо если одно из переданных значений не реализует интерфейс ReceiptItemInterface

Returns: self -

public setReceiptIndustryDetails() : self

public setReceiptIndustryDetails(array|\YooKassa\Common\ListObjectInterface|null $receipt_industry_details = null) : self

Summary

Устанавливает отраслевой реквизит чека.

Details:

Parameters:
Type Name Description
array OR \YooKassa\Common\ListObjectInterface OR null receipt_industry_details Отраслевой реквизит чека
Throws:
Type Description
\YooKassa\Validator\Exceptions\InvalidPropertyValueTypeException Выбрасывается если переданный аргумент - не массив

Returns: self -

public setReceiptOperationalDetails() : self

public setReceiptOperationalDetails(array|\YooKassa\Model\Receipt\OperationalDetails|null $receipt_operational_details = null) : self

Summary

Устанавливает операционный реквизит чека.

Details:

Parameters:
Type Name Description
array OR \YooKassa\Model\Receipt\OperationalDetails OR null receipt_operational_details Операционный реквизит чека
Throws:
Type Description
\YooKassa\Validator\Exceptions\InvalidPropertyValueTypeException Выбрасывается если переданный аргумент - не массив

Returns: self -

public setSend() : self

public setSend(bool $send = null) : self

Summary

Устанавливает признак отложенной отправки чека.

Details:

Parameters:
Type Name Description
bool send Признак отложенной отправки чека

Returns: self -

public setSettlements() : self

public setSettlements(\YooKassa\Common\ListObjectInterface|array|null $settlements = null) : self

Summary

Возвращает массив оплат, обеспечивающих выдачу товара.

Details:

Parameters:
Type Name Description
\YooKassa\Common\ListObjectInterface OR array OR null settlements

Returns: self -

public setTaxSystemCode() : self

public setTaxSystemCode(int|null $tax_system_code) : self

Summary

Устанавливает код системы налогообложения.

Details:

Parameters:
Type Name Description
int OR null tax_system_code Код системы налогообложения. Число 1-6

Returns: self -

public setTimezone() : self

public setTimezone(int|null $timezone = null) : self

Summary

Устанавливает номер часовой зоны.

Details:

Parameters:
Type Name Description
int OR null timezone Номер часовой зоны для адреса, по которому вы принимаете платежи (тег в 54 ФЗ — 1011).

Returns: self -

public toArray() : array

public toArray() : array

Summary

Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize().

Details:

Returns: array - Ассоциативный массив со свойствами текущего объекта

protected getUnknownProperties() : array

protected getUnknownProperties() : array

Summary

Возвращает массив свойств которые не существуют, но были заданы у объекта.

Details:

Returns: array - Ассоциативный массив с не существующими у текущего объекта свойствами

protected validatePropertyValue() : mixed

protected validatePropertyValue(string $propertyName, mixed $propertyValue) : mixed

Details:

Parameters:
Type Name Description
string propertyName
mixed propertyValue

Returns: mixed -


Top Namespaces


Reports


This document was automatically generated from source code comments on 2026-06-29 using phpDocumentor

© 2026 YooMoney