yookassa-sdk-php/docs/classes/YooKassa-Model-ReceiptItem.md

YooKassa API SDK

Class: \YooKassa\Model\ReceiptItem

Namespace: \YooKassa\Model

---

Summary:

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

---

Constants

• No constants found

---

Properties

Visibility	Name	Flag	Summary
public	$amount		Суммарная стоимость покупаемого товара в копейках/центах
public	$country_of_origin_code		Код страны происхождения товара
public	$countryOfOriginCode		Код страны происхождения товара
public	$customs_declaration_number		Номер таможенной декларации (от 1 до 32 символов)
public	$customsDeclarationNumber		Номер таможенной декларации (от 1 до 32 символов)
public	$description		Наименование товара
public	$excise		Сумма акциза товара с учетом копеек
public	$isShipping		Флаг доставки
public	$payment_mode		Признак способа расчета
public	$payment_subject		Признак предмета расчета
public	$paymentMode		Признак способа расчета
public	$paymentSubject		Признак предмета расчета
public	$price		Цена товара
public	$product_code		Код товара
public	$productCode		Код товара
public	$quantity		Количество
public	$supplier		Информация о поставщике товара или услуги
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	applyDiscountCoefficient()		Применяет для товара скидку
public	fetchItem()		Уменьшает количество покупаемого товара на указанное, возвращает объект позиции в чеке с уменьшаемым количеством
public	fromArray()		Устанавливает значения свойств текущего объекта из массива
public	getAgentType()		Возвращает тип посредника, реализующего товар или услугу
public	getAmount()		Возвращает общую стоимость покупаемого товара в копейках/центах
public	getCountryOfOriginCode()		Возвращает код страны происхождения товара по общероссийскому классификатору стран мира
public	getCustomsDeclarationNumber()		Возвращает номер таможенной декларации
public	getDescription()		Возвращает наименование товара
public	getExcise()		Возвращает сумму акциза товара с учетом копеек
public	getPaymentMode()		Возвращает признак способа расчета
public	getPaymentSubject()		Возвращает признак предмета расчета
public	getPrice()		Возвращает цену товара
public	getProductCode()		Возвращает код товара — уникальный номер, который присваивается экземпляру товара при маркировке
public	getQuantity()		Возвращает количество товара
public	getSupplier()		Возвращает информацию о поставщике товара или услуги.
public	getVatCode()		Возвращает ставку НДС
public	increasePrice()		Увеличивает цену товара на указанную величину
public	isShipping()		Проверяет, является ли текущий элемент чека доставкой
public	jsonSerialize()		Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации
public	offsetExists()		Проверяет наличие свойства
public	offsetGet()		Возвращает значение свойства
public	offsetSet()		Устанавливает значение свойства
public	offsetUnset()		Удаляет свойство
public	setAgentType()		Устанавливает тип посредника, реализующего товар или услугу
public	setCountryOfOriginCode()		Устанавливает код страны происхождения товара по общероссийскому классификатору стран мира
public	setCustomsDeclarationNumber()		Устанавливает номер таможенной декларации (от 1 до 32 символов)
public	setDescription()		Устанавливает наименование товара
public	setExcise()		Устанавливает сумму акциза товара с учетом копеек
public	setIsShipping()		Устанавливает флаг доставки для текущего объекта айтема в чеке
public	setPaymentMode()		Устанавливает признак способа расчета
public	setPaymentSubject()		Устанавливает признак предмета расчета
public	setPrice()		Устанавливает цену товара
public	setProductCode()		Устанавливает код товара — уникальный номер, который присваивается экземпляру товара при маркировке
public	setQuantity()		Устанавливает количество покупаемого товара
public	setSupplier()		Устанавливает информацию о поставщике товара или услуги.
public	setVatCode()		Устанавливает ставку НДС
public	toArray()		Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize()
protected	getUnknownProperties()		Возвращает массив свойств которые не существуют, но были заданы у объекта

---

Details

• File: lib/Model/ReceiptItem.php
• Package: Default
• Class Hierarchy:
  • \YooKassa\Common\AbstractObject
  • \YooKassa\Model\ReceiptItem
• Implements:
  • \YooKassa\Model\ReceiptItemInterface

---

Properties

public $amount : float

---

Description

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

Type: float

Details:

public $country_of_origin_code : string

---

Description

Код страны происхождения товара

Type: string

Details:

public $countryOfOriginCode : string

---

Description

Код страны происхождения товара

Type: string

Details:

public $customs_declaration_number : string

---

Description

Номер таможенной декларации (от 1 до 32 символов)

Type: string

Details:

public $customsDeclarationNumber : string

---

Description

Номер таможенной декларации (от 1 до 32 символов)

Type: string

Details:

public $description : string

---

Description

Наименование товара

Type: string

Details:

public $excise : float

---

Description

Сумма акциза товара с учетом копеек

Type: float

Details:

public $isShipping : bool

---

Description

Флаг доставки

Type: bool

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 $product_code : string

---

Description

Код товара

Type: string

Details:

public $productCode : string

---

Description

Код товара

Type: string

Details:

public $quantity : float

---

Description

Количество

Type: float

Details:

public $supplier : \YooKassa\Model\Supplier

---

Description

Информация о поставщике товара или услуги

Type: Supplier

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 applyDiscountCoefficient() : mixed

public applyDiscountCoefficient(float $coefficient) : mixed

Summary

Применяет для товара скидку

Details:

• Inherited From: \YooKassa\Model\ReceiptItem

Parameters:

Type	Name	Description
float	coefficient	Множитель скидки

Returns: mixed -

public fetchItem() : \YooKassa\Model\ReceiptItem

public fetchItem(float $count) : \YooKassa\Model\ReceiptItem

Summary

Уменьшает количество покупаемого товара на указанное, возвращает объект позиции в чеке с уменьшаемым количеством

Details:

• Inherited From: \YooKassa\Model\ReceiptItem

Parameters:

Type	Name	Description
float	count	Количество на которое уменьшаем позицию в чеке

Throws:

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

Returns: \YooKassa\Model\ReceiptItem -

public fromArray() : mixed

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

Summary

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

Details:

• Inherited From: \YooKassa\Model\ReceiptItem

Parameters:

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

Returns: mixed -

public getAgentType() : string

public getAgentType() : string

Summary

Возвращает тип посредника, реализующего товар или услугу

Details:

• Inherited From: \YooKassa\Model\ReceiptItem

Returns: string - Тип посредника

public getAmount() : int

public getAmount() : int

Summary

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

Details:

• Inherited From: \YooKassa\Model\ReceiptItem

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

public getCountryOfOriginCode() : string|null

public getCountryOfOriginCode() : string|null

Summary

Возвращает код страны происхождения товара по общероссийскому классификатору стран мира

Details:

• Inherited From: \YooKassa\Model\ReceiptItem

Returns: string|null - Код страны происхождения товара

public getCustomsDeclarationNumber() : string|null

public getCustomsDeclarationNumber() : string|null

Summary

Возвращает номер таможенной декларации

Details:

• Inherited From: \YooKassa\Model\ReceiptItem

Returns: string|null - Номер таможенной декларации (от 1 до 32 символов)

public getDescription() : string

public getDescription() : string

Summary

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

Details:

• Inherited From: \YooKassa\Model\ReceiptItem

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

public getExcise() : float|null

public getExcise() : float|null

Summary

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

Details:

• Inherited From: \YooKassa\Model\ReceiptItem

Returns: float|null - Сумма акциза товара с учетом копеек

public getPaymentMode() : string|null

public getPaymentMode() : string|null

Summary

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

Details:

• Inherited From: \YooKassa\Model\ReceiptItem

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

public getPaymentSubject() : string|null

public getPaymentSubject() : string|null

Summary

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

Details:

• Inherited From: \YooKassa\Model\ReceiptItem

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

public getPrice() : \YooKassa\Model\AmountInterface

public getPrice() : \YooKassa\Model\AmountInterface

Summary

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

Details:

• Inherited From: \YooKassa\Model\ReceiptItem

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

public getProductCode() : string|null

public getProductCode() : string|null

Summary

Возвращает код товара — уникальный номер, который присваивается экземпляру товара при маркировке

Details:

• Inherited From: \YooKassa\Model\ReceiptItem

Returns: string|null - Код товара

public getQuantity() : float

public getQuantity() : float

Summary

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

Details:

• Inherited From: \YooKassa\Model\ReceiptItem

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

public getSupplier() : \YooKassa\Model\Supplier

public getSupplier() : \YooKassa\Model\Supplier

Summary

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

Details:

• Inherited From: \YooKassa\Model\ReceiptItem

Returns: \YooKassa\Model\Supplier -

public getVatCode() : int|null

public getVatCode() : int|null

Summary

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

Details:

• Inherited From: \YooKassa\Model\ReceiptItem

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

public increasePrice() : mixed

public increasePrice(float $value) : mixed

Summary

Увеличивает цену товара на указанную величину

Details:

• Inherited From: \YooKassa\Model\ReceiptItem

Parameters:

Type	Name	Description
float	value	Сумма на которую цену товара увеличиваем

Returns: mixed -

public isShipping() : bool

public isShipping() : bool

Summary

Проверяет, является ли текущий элемент чека доставкой

Details:

• Inherited From: \YooKassa\Model\ReceiptItem

Returns: bool - True если доставка, false если обычный товар

public jsonSerialize() : array

public jsonSerialize() : array

Summary

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

Details:

• Inherited From: \YooKassa\Model\ReceiptItem

Returns: array -

Tags

Tag	Version	Description
inheritdoc

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 setAgentType() : mixed

public setAgentType(string $value) : mixed

Summary

Устанавливает тип посредника, реализующего товар или услугу

Details:

• Inherited From: \YooKassa\Model\ReceiptItem

Parameters:

Type	Name	Description
string	value	Тип посредника

Returns: mixed -

public setCountryOfOriginCode() : mixed

public setCountryOfOriginCode(string $value) : mixed

Summary

Устанавливает код страны происхождения товара по общероссийскому классификатору стран мира

Details:

• Inherited From: \YooKassa\Model\ReceiptItem

Parameters:

Type	Name	Description
string	value	Код страны происхождения товара

Throws:

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

Returns: mixed -

public setCustomsDeclarationNumber() : mixed

public setCustomsDeclarationNumber(string $value) : mixed

Summary

Устанавливает номер таможенной декларации (от 1 до 32 символов)

Details:

• Inherited From: \YooKassa\Model\ReceiptItem

Parameters:

Type	Name	Description
string	value	Номер таможенной декларации

Throws:

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

Returns: mixed -

public setDescription() : mixed

public setDescription(string $value) : mixed

Summary

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

Details:

• Inherited From: \YooKassa\Model\ReceiptItem

Parameters:

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

Throws:

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

Returns: mixed -

public setExcise() : mixed

public setExcise(float $value) : mixed

Summary

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

Details:

• Inherited From: \YooKassa\Model\ReceiptItem

Parameters:

Type	Name	Description
float	value	Сумма акциза товара с учетом копеек

Throws:

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

Returns: mixed -

public setIsShipping() : \YooKassa\Model\ReceiptItem

public setIsShipping(bool $value) : \YooKassa\Model\ReceiptItem

Summary

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

Details:

• Inherited From: \YooKassa\Model\ReceiptItem

Parameters:

Type	Name	Description
bool	value	True если айтем является доставкой, false если нет

Throws:

Type	Description
\YooKassa\Common\Exceptions\InvalidPropertyValueException	Генерируется если передано значение невалидного типа

Returns: \YooKassa\Model\ReceiptItem -

public setPaymentMode() : mixed

public setPaymentMode(string $value) : mixed

Summary

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

Details:

• Inherited From: \YooKassa\Model\ReceiptItem

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\Model\ReceiptItem

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\Model\ReceiptItem

Parameters:

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

Returns: mixed -

public setProductCode() : mixed

public setProductCode(string|\YooKassa\Helpers\ProductCode $value) : mixed

Summary

Устанавливает код товара — уникальный номер, который присваивается экземпляру товара при маркировке

Details:

• Inherited From: \YooKassa\Model\ReceiptItem

Parameters:

Type	Name	Description
string OR \YooKassa\Helpers\ProductCode	value	Код товара

Throws:

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

Returns: mixed -

public setQuantity() : mixed

public setQuantity(int $value) : mixed

Summary

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

Details:

• Inherited From: \YooKassa\Model\ReceiptItem

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\Model\ReceiptItem

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\Model\ReceiptItem

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

---

This document was automatically generated from source code comments on 2021-07-26 using phpDocumentor

© 2021 YooMoney