yookassa-sdk-php/docs/classes/YooKassa-Request-Receipts-ReceiptResponseItem.md

YooKassa API SDK

Class: \YooKassa\Request\Receipts\ReceiptResponseItem

Namespace: \YooKassa\Request\Receipts

---

Summary:

Класс, описывающий товар в чеке

---

Constants

• No constants found

---

Properties

Visibility	Name	Flag	Summary
public	$amount		Суммарная стоимость товара в копейках/центах
public	$description		Название товара (не более 128 символов).
public	$payment_mode		Признак способа расчета
public	$payment_subject		Признак предмета расчета
public	$paymentMode		Признак способа расчета
public	$paymentSubject		Признак предмета расчета
public	$price		Цена товара
public	$quantity		Количество товара. Максимально возможное значение зависит от модели вашей онлайн-кассы.
public	$vat_code		Ставка НДС, число 1-6
public	$vatCode		Ставка НДС, число 1-6

---

Methods

Visibility	Name	Flag	Summary
public	__construct()		AbstractObject constructor.
public	__get()		Возвращает значение свойства
public	__isset()		Проверяет наличие свойства
public	__set()		Устанавливает значение свойства
public	__unset()		Удаляет свойство
public	fromArray()		Устанавливает значения свойств текущего объекта из массива
public	getAmount()		Возвращает общую стоимость покупаемого товара в копейках/центах
public	getDescription()		Возвращает наименование товара
public	getPaymentMode()		Возвращает признак способа расчета
public	getPaymentSubject()		Возвращает признак предмета расчета
public	getPrice()		Возвращает цену товара
public	getQuantity()		Возвращает количество товара
public	getSupplier()		Возвращает информацию о поставщике товара или услуги
public	getVatCode()		Возвращает ставку НДС
public	jsonSerialize()		Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации
public	offsetExists()		Проверяет наличие свойства
public	offsetGet()		Возвращает значение свойства
public	offsetSet()		Устанавливает значение свойства
public	offsetUnset()		Удаляет свойство
public	setDescription()		Устанавливает наименование товара
public	setPaymentMode()		Устанавливает признак способа расчета
public	setPaymentSubject()		Устанавливает признак предмета расчета
public	setPrice()		Устанавливает цену товара
public	setQuantity()		Устанавливает количество покупаемого товара
public	setSupplier()		Устанавливает информацию о поставщике товара или услуги.
public	setVatCode()		Устанавливает ставку НДС
public	toArray()		Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize()
protected	getUnknownProperties()		Возвращает массив свойств которые не существуют, но были заданы у объекта

---

Details

• File: lib/Request/Receipts/ReceiptResponseItem.php
• Package: YooKassa
• Class Hierarchy:
  • \YooKassa\Common\AbstractObject
  • \YooKassa\Request\Receipts\ReceiptResponseItem
• Implements:
  • \YooKassa\Request\Receipts\ReceiptResponseItemInterface

---

Properties

public $amount : float

---

Description

Суммарная стоимость товара в копейках/центах

Type: float

Details:

public $description : string

---

Description

Название товара (не более 128 символов).

Type: string

Details:

public $payment_mode : string

---

Description

Признак способа расчета

Type: string

Details:

public $payment_subject : string

---

Description

Признак предмета расчета

Type: string

Details:

public $paymentMode : string

---

Description

Признак способа расчета

Type: string

Details:

public $paymentSubject : string

---

Description

Признак предмета расчета

Type: string

Details:

public $price : \YooKassa\Model\AmountInterface

---

Description

Цена товара

Type: AmountInterface

Details:

public $quantity : float

---

Description

Количество товара. Максимально возможное значение зависит от модели вашей онлайн-кассы.

Type: float

Details:

public $vat_code : int

---

Description

Ставка НДС, число 1-6

Type: int

Details:

public $vatCode : 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 fromArray() : mixed

public fromArray(array $itemData) : mixed

Summary

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

Details:

• Inherited From: \YooKassa\Request\Receipts\ReceiptResponseItem

Parameters:

Type	Name	Description
array	itemData	Массив с информацией о товаре, пришедший от API

Returns: mixed -

public getAmount() : int

public getAmount() : int

Summary

Возвращает общую стоимость покупаемого товара в копейках/центах

Details:

• Inherited From: \YooKassa\Request\Receipts\ReceiptResponseItem

Returns: int - Сумма стоимости покупаемого товара

public getDescription() : string

public getDescription() : string

Summary

Возвращает наименование товара

Details:

• Inherited From: \YooKassa\Request\Receipts\ReceiptResponseItem

Returns: string - Наименование товара

public getPaymentMode() : string|null

public getPaymentMode() : string|null

Summary

Возвращает признак способа расчета

Details:

• Inherited From: \YooKassa\Request\Receipts\ReceiptResponseItem

Returns: string|null - Признак способа расчета

public getPaymentSubject() : string|null

public getPaymentSubject() : string|null

Summary

Возвращает признак предмета расчета

Details:

• Inherited From: \YooKassa\Request\Receipts\ReceiptResponseItem

Returns: string|null - Признак предмета расчета

public getPrice() : \YooKassa\Model\AmountInterface

public getPrice() : \YooKassa\Model\AmountInterface

Summary

Возвращает цену товара

Details:

• Inherited From: \YooKassa\Request\Receipts\ReceiptResponseItem

Returns: \YooKassa\Model\AmountInterface - Цена товара

public getQuantity() : float

public getQuantity() : float

Summary

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

Details:

• Inherited From: \YooKassa\Request\Receipts\ReceiptResponseItem

Returns: float - Количество купленного товара

public getSupplier() : \YooKassa\Model\SupplierInterface

public getSupplier() : \YooKassa\Model\SupplierInterface

Summary

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

Details:

• Inherited From: \YooKassa\Request\Receipts\ReceiptResponseItem

Returns: \YooKassa\Model\SupplierInterface -

public getVatCode() : int|null

public getVatCode() : int|null

Summary

Возвращает ставку НДС

Details:

• Inherited From: \YooKassa\Request\Receipts\ReceiptResponseItem

Returns: int|null - Ставка НДС, число 1-6, или null, если ставка не задана

public jsonSerialize() : array

public jsonSerialize() : array

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractObject

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

public offsetExists() : bool

public offsetExists(string $offset) : bool

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

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

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

public offsetGet() : mixed

public offsetGet(string $offset) : mixed

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

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

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

public offsetSet() : mixed

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

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

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

Returns: mixed -

public offsetUnset() : mixed

public offsetUnset(string $offset) : mixed

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

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

Returns: mixed -

public setDescription() : mixed

public setDescription(string $value) : mixed

Summary

Устанавливает наименование товара

Details:

• Inherited From: \YooKassa\Request\Receipts\ReceiptResponseItem

Parameters:

Type	Name	Description
string	value	Наименование товара

Throws:

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

Returns: mixed -

public setPaymentMode() : mixed

public setPaymentMode(string $value) : mixed

Summary

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

Details:

• Inherited From: \YooKassa\Request\Receipts\ReceiptResponseItem

Parameters:

Type	Name	Description
string	value	Признак способа расчета

Throws:

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

Returns: mixed -

public setPaymentSubject() : mixed

public setPaymentSubject(string $value) : mixed

Summary

Устанавливает признак предмета расчета

Details:

• Inherited From: \YooKassa\Request\Receipts\ReceiptResponseItem

Parameters:

Type	Name	Description
string	value	Признак предмета расчета

Throws:

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

Returns: mixed -

public setPrice() : mixed

public setPrice(\YooKassa\Model\AmountInterface $value) : mixed

Summary

Устанавливает цену товара

Details:

• Inherited From: \YooKassa\Request\Receipts\ReceiptResponseItem

Parameters:

Type	Name	Description
\YooKassa\Model\AmountInterface	value	Цена товара

Returns: mixed -

public setQuantity() : mixed

public setQuantity(int $value) : mixed

Summary

Устанавливает количество покупаемого товара

Details:

• Inherited From: \YooKassa\Request\Receipts\ReceiptResponseItem

Parameters:

Type	Name	Description
int	value	Количество

Throws:

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

Returns: mixed -

public setSupplier() : mixed

public setSupplier(\YooKassa\Model\SupplierInterface|array $value) : mixed

Summary

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

Details:

• Inherited From: \YooKassa\Request\Receipts\ReceiptResponseItem

Parameters:

Type	Name	Description
\YooKassa\Model\SupplierInterface OR array	value

Returns: mixed -

public setVatCode() : mixed

public setVatCode(int $value) : mixed

Summary

Устанавливает ставку НДС

Details:

• Inherited From: \YooKassa\Request\Receipts\ReceiptResponseItem

Parameters:

Type	Name	Description
int	value	Ставка НДС, число 1-6

Throws:

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

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 - 0
• Deprecated - 13

---

This document was automatically generated from source code comments on 2021-11-16 using phpDocumentor

© 2021 YooMoney