meraproject/vendor/yoomoney/yookassa-sdk-php/docs/classes/YooKassa-Model-Receipt.md

YooKassa API SDK

Class: \YooKassa\Model\Receipt

Namespace: \YooKassa\Model

---

Summary:

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

---

Constants

• No constants found

---

Properties

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

---

Methods

Visibility	Name	Flag	Summary
public	__construct()		AbstractObject constructor.
public	__get()		Возвращает значение свойства
public	__isset()		Проверяет наличие свойства
public	__set()		Устанавливает значение свойства
public	__unset()		Удаляет свойство
public	addItem()		Добавляет товар в чек
public	addSettlement()		Добавляет оплату в чек
public	fromArray()		Устанавливает значения свойств текущего объекта из массива
public	getAdditionalUserProps()		Возвращает дополнительный реквизит пользователя
public	getAmountValue()		Возвращает стоимость заказа исходя из состава чека
public	getCustomer()		Возвращает информацию о плательщике
public	getEmail()	deprecated	Возвращает адрес электронной почты на который будет выслан чек
public	getItems()		Возвращает список позиций в текущем чеке
public	getObjectId()		Возвращает Id объекта чека
public	getPhone()	deprecated	Возвращает номер телефона плательщика в формате ITU-T E.164 на который будет выслан чек
public	getReceiptIndustryDetails()		Возвращает отраслевой реквизит чека
public	getReceiptOperationalDetails()		Возвращает операционный реквизит чека
public	getSettlements()		Возвращает массив оплат, обеспечивающих выдачу товара
public	getShippingAmountValue()		Возвращает стоимость доставки исходя из состава чека
public	getTaxSystemCode()		Возвращает код системы налогообложения
public	jsonSerialize()
public	normalize()		Подгоняет стоимость товаров в чеке к общей цене заказа
public	notEmpty()		Проверяет есть ли в чеке хотя бы одна позиция
public	offsetExists()
public	offsetGet()
public	offsetSet()
public	offsetUnset()
public	setAdditionalUserProps()		Устанавливает дополнительный реквизит пользователя
public	setCustomer()		Устанавливает информацию о плательщике
public	setEmail()	deprecated	Устанавливает адрес электронной почты на который будет выслан чек
public	setItems()		Устанавливает список позиций в чеке
public	setPhone()	deprecated	Устанавливает номер телефона плательщика в формате ITU-T E.164 на который будет выслан чек
public	setReceiptIndustryDetails()		Устанавливает отраслевой реквизит чека
public	setReceiptOperationalDetails()		Устанавливает операционный реквизит чека
public	setSettlements()		Возвращает массив оплат, обеспечивающих выдачу товара
public	setTaxSystemCode()		Устанавливает код системы налогообложения
public	toArray()		Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize()
protected	getUnknownProperties()		Возвращает массив свойств которые не существуют, но были заданы у объекта

---

Details

• File: lib/Model/Receipt.php
• Package: YooKassa
• Class Hierarchy:
  • \YooKassa\Common\AbstractObject
  • \YooKassa\Model\Receipt
• Implements:
  • \YooKassa\Model\ReceiptInterface

---

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\ReceiptCustomer

---

Description

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

Type: ReceiptCustomer

Details:

public $items : \YooKassa\Model\ReceiptItemInterface[]

---

Description

Список товаров в заказе

Type: ReceiptItemInterface[]

Details:

public $receipt_industry_details : \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\Model\Receipt\IndustryDetails[]

---

Description

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

Type: IndustryDetails[]

Details:

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

---

Description

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

Type: OperationalDetails

Details:

public $settlements : \YooKassa\Model\SettlementInterface[]

---

Description

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

Type: SettlementInterface[]

Details:

public $tax_system_code : int

---

Description

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

Type: int

Details:

public $taxSystemCode : int

---

Description

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

Type: int

Details:

---

Methods

public __construct() : mixed

public __construct(array $data = array()) : mixed

Summary

AbstractObject constructor.

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
array	data

Returns: mixed -

public __get() : mixed

public __get(string $propertyName) : mixed

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

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

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

public __isset() : bool

public __isset(string $propertyName) : bool

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

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

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

public __set() : mixed

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

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

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

Returns: mixed -

public __unset() : mixed

public __unset(string $propertyName) : mixed

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

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

Returns: mixed -

public addItem() : mixed

public addItem(\YooKassa\Model\ReceiptItemInterface $value) : mixed

Summary

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

Details:

• Inherited From: \YooKassa\Model\Receipt

Parameters:

Type	Name	Description
\YooKassa\Model\ReceiptItemInterface	value	Объект добавляемой в чек позиции

Returns: mixed -

public addSettlement() : mixed

public addSettlement(\YooKassa\Model\SettlementInterface $value) : mixed

Summary

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

Details:

• Inherited From: \YooKassa\Model\Receipt

Parameters:

Type	Name	Description
\YooKassa\Model\SettlementInterface	value	Объект добавляемой в чек позиции

Returns: mixed -

public fromArray() : mixed

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

Summary

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

Details:

• Inherited From: \YooKassa\Model\Receipt

Parameters:

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

Returns: mixed -

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

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

Summary

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

Details:

• Inherited From: \YooKassa\Model\Receipt

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

public getAmountValue() : int

public getAmountValue(bool $withShipping = true) : int

Summary

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

Details:

• Inherited From: \YooKassa\Model\Receipt

Parameters:

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

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

public getCustomer() : \YooKassa\Model\ReceiptCustomer

public getCustomer() : \YooKassa\Model\ReceiptCustomer

Summary

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

Details:

• Inherited From: \YooKassa\Model\Receipt

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

(deprecated) - public getEmail() : string

public getEmail() : string

Summary

Возвращает адрес электронной почты на который будет выслан чек

Deprecated Deprecated since 1.3.0Устарел — данные рекомендуется брать в параметре receipt.customer.email. Details:

• Inherited From: \YooKassa\Model\Receipt

Returns: string - E-mail адрес плательщика

public getItems() : \YooKassa\Model\ReceiptItemInterface[]

public getItems() : \YooKassa\Model\ReceiptItemInterface[]

Summary

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

Details:

• Inherited From: \YooKassa\Model\Receipt

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

public getObjectId() : string

public getObjectId() : string

Summary

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

Details:

• Inherited From: \YooKassa\Model\Receipt

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

(deprecated) - public getPhone() : string

public getPhone() : string

Summary

Возвращает номер телефона плательщика в формате ITU-T E.164 на который будет выслан чек

Deprecated Deprecated since 1.3.0Устарел — данные рекомендуется брать в параметре receipt.customer.phone. Details:

• Inherited From: \YooKassa\Model\Receipt

Returns: string - Номер телефона плательщика

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

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

Summary

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

Details:

• Inherited From: \YooKassa\Model\Receipt

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

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

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

Summary

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

Details:

• Inherited From: \YooKassa\Model\Receipt

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

public getSettlements() : \YooKassa\Model\SettlementInterface[]

public getSettlements() : \YooKassa\Model\SettlementInterface[]

Summary

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

Details:

• Inherited From: \YooKassa\Model\Receipt

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

public getShippingAmountValue() : int

public getShippingAmountValue() : int

Summary

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

Details:

• Inherited From: \YooKassa\Model\Receipt

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

public getTaxSystemCode() : int

public getTaxSystemCode() : int

Summary

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

Details:

• Inherited From: \YooKassa\Model\Receipt

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

public jsonSerialize() : mixed

public jsonSerialize() : mixed

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Returns: mixed -

public normalize() : mixed

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

Summary

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

Details:

• Inherited From: \YooKassa\Model\Receipt

Parameters:

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

Returns: mixed -

public notEmpty() : bool

public notEmpty() : bool

Summary

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

Details:

• Inherited From: \YooKassa\Model\Receipt

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

public offsetExists() : mixed

public offsetExists(mixed $offset) : mixed

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
mixed	offset

Returns: mixed -

public offsetGet() : mixed

public offsetGet(mixed $offset) : mixed

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
mixed	offset

Returns: mixed -

public offsetSet() : mixed

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

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
mixed	offset
mixed	value

Returns: mixed -

public offsetUnset() : mixed

public offsetUnset(mixed $offset) : mixed

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
mixed	offset

Returns: mixed -

public setAdditionalUserProps() : mixed

public setAdditionalUserProps(\YooKassa\Model\Receipt\AdditionalUserProps|array $value) : mixed

Summary

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

Details:

• Inherited From: \YooKassa\Model\Receipt

Parameters:

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

Returns: mixed -

public setCustomer() : mixed

public setCustomer(\YooKassa\Model\ReceiptCustomer $customer) : mixed

Summary

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

Details:

• Inherited From: \YooKassa\Model\Receipt

Parameters:

Type	Name	Description
\YooKassa\Model\ReceiptCustomer	customer

Returns: mixed -

(deprecated) - public setEmail() : mixed

public setEmail(string $value) : mixed

Summary

Устанавливает адрес электронной почты на который будет выслан чек

Deprecated Deprecated since 1.3.0Устарел — данные рекомендуется передавать в параметре receipt.customer.email. Details:

• Inherited From: \YooKassa\Model\Receipt

Parameters:

Type	Name	Description
string	value	E-mail адрес плательщика

Throws:

Type	Description
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException	Выбрасывается если в качестве значения была передана не строка

Returns: mixed -

public setItems() : mixed

public setItems(\YooKassa\Model\ReceiptItemInterface[] $value) : mixed

Summary

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

Description

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

Details:

• Inherited From: \YooKassa\Model\Receipt

Parameters:

Type	Name	Description
\YooKassa\Model\ReceiptItemInterface[]	value	Список товаров в заказе

Throws:

Type	Description
\YooKassa\Common\Exceptions\EmptyPropertyValueException	Выбрасывается если передали пустой массив значений
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException	Выбрасывается если в качестве значения был передан не массив и не итератор, либо если одно из переданных значений не реализует интерфейс ReceiptItemInterface

Returns: mixed -

(deprecated) - public setPhone() : mixed

public setPhone(string $value) : mixed

Summary

Устанавливает номер телефона плательщика в формате ITU-T E.164 на который будет выслан чек

Deprecated Deprecated since 1.3.0Устарел — данные рекомендуется передавать в параметре receipt.customer.phone. Details:

• Inherited From: \YooKassa\Model\Receipt

Parameters:

Type	Name	Description
string	value	Номер телефона плательщика в формате ITU-T E.164

Throws:

Type	Description
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException	Выбрасывается если в качестве значения была передана не строка

Returns: mixed -

public setReceiptIndustryDetails() : mixed

public setReceiptIndustryDetails(array|\YooKassa\Model\Receipt\IndustryDetails[] $value) : mixed

Summary

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

Details:

• Inherited From: \YooKassa\Model\Receipt

Parameters:

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

Throws:

Type	Description
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException	Выбрасывается если переданный аргумент - не массив

Returns: mixed -

public setReceiptOperationalDetails() : mixed

public setReceiptOperationalDetails(array|\YooKassa\Model\Receipt\OperationalDetails $value) : mixed

Summary

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

Details:

• Inherited From: \YooKassa\Model\Receipt

Parameters:

Type	Name	Description
array OR \YooKassa\Model\Receipt\OperationalDetails	value	Операционный реквизит чека

Throws:

Type	Description
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException	Выбрасывается если переданный аргумент - не массив

Returns: mixed -

public setSettlements() : mixed

public setSettlements(\YooKassa\Model\SettlementInterface[] $value) : mixed

Summary

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

Details:

• Inherited From: \YooKassa\Model\Receipt

Parameters:

Type	Name	Description
\YooKassa\Model\SettlementInterface[]	value

Returns: mixed -

public setTaxSystemCode() : mixed

public setTaxSystemCode(int $value) : mixed

Summary

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

Details:

• Inherited From: \YooKassa\Model\Receipt

Parameters:

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

Throws:

Type	Description
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException	Выбрасывается если переданный аргумент - не число
\YooKassa\Common\Exceptions\InvalidPropertyValueException	Выбрасывается если переданный аргумент меньше одного или больше шести

Returns: mixed -

public toArray() : array

public toArray() : array

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractObject

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

protected getUnknownProperties() : array

protected getUnknownProperties() : array

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractObject

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

---

Top Namespaces

• \YooKassa

---

Reports

• Errors - 0
• Markers - 1
• Deprecated - 25

---

This document was automatically generated from source code comments on 2023-04-06 using phpDocumentor

© 2023 YooMoney