58 KiB
YooKassa API SDK
Class: \YooKassa\Model\ReceiptItem
Namespace: \YooKassa\Model
Summary:
Информация о товарной позиции в заказе, позиция фискального чека
Constants
| Visibility | Name | Flag | Summary |
|---|---|---|---|
| public | DESCRIPTION_MAX_LENGTH | ||
| public | ADD_PROPS_MAX_LENGTH |
Properties
| Visibility | Name | Flag | Summary |
|---|---|---|---|
| public | $additional_payment_subject_props | Дополнительный реквизит предмета расчета (тег в 54 ФЗ — 1191) | |
| public | $additionalPaymentSubjectProps | Дополнительный реквизит предмета расчета (тег в 54 ФЗ — 1191) | |
| public | $agent_type | Тип посредника, реализующего товар или услугу | |
| public | $agentType | Тип посредника, реализующего товар или услугу | |
| public | $amount | Суммарная стоимость покупаемого товара в копейках/центах | |
| public | $country_of_origin_code | Код страны происхождения товара (тег в 54 ФЗ — 1230) | |
| public | $countryOfOriginCode | Код страны происхождения товара (тег в 54 ФЗ — 1230) | |
| public | $customs_declaration_number | Номер таможенной декларации (от 1 до 32 символов). Тег в 54 ФЗ — 1231 | |
| public | $customsDeclarationNumber | Номер таможенной декларации (от 1 до 32 символов). Тег в 54 ФЗ — 1231 | |
| public | $description | Наименование товара (тег в 54 ФЗ — 1030) | |
| public | $excise | Сумма акциза товара с учетом копеек (тег в 54 ФЗ — 1229) | |
| public | $isShipping | Флаг доставки | |
| public | $mark_code_info | Код товара (тег в 54 ФЗ — 1163) | |
| public | $mark_mode | Режим обработки кода маркировки (тег в 54 ФЗ — 2102) | |
| public | $mark_quantity | Дробное количество маркированного товара (тег в 54 ФЗ — 1291) | |
| public | $markCodeInfo | Код товара (тег в 54 ФЗ — 1163) | |
| public | $markMode | Режим обработки кода маркировки (тег в 54 ФЗ — 2102) | |
| public | $markQuantity | Дробное количество маркированного товара (тег в 54 ФЗ — 1291) | |
| public | $measure | Мера количества предмета расчета (тег в 54 ФЗ — 2108) | |
| public | $payment_mode | Признак способа расчета (тег в 54 ФЗ — 1214) | |
| public | $payment_subject | Признак предмета расчета (тег в 54 ФЗ — 1212) | |
| public | $payment_subject_industry_details | Отраслевой реквизит предмета расчета (тег в 54 ФЗ — 1260) | |
| public | $paymentMode | Признак способа расчета (тег в 54 ФЗ — 1214) | |
| public | $paymentSubject | Признак предмета расчета (тег в 54 ФЗ — 1212) | |
| public | $paymentSubjectIndustryDetails | Отраслевой реквизит предмета расчета (тег в 54 ФЗ — 1260) | |
| public | $price | Цена товара (тег в 54 ФЗ — 1079) | |
| public | $product_code | Код товара (тег в 54 ФЗ — 1162) | |
| public | $productCode | Код товара (тег в 54 ФЗ — 1162) | |
| public | $quantity | Количество (тег в 54 ФЗ — 1023) | |
| public | $supplier | Информация о поставщике товара или услуги (тег в 54 ФЗ — 1224) | |
| public | $vat_code | Ставка НДС (тег в 54 ФЗ — 1199), число 1-6 | |
| public | $vatCode | Ставка НДС (тег в 54 ФЗ — 1199), число 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 | getAdditionalPaymentSubjectProps() | Возвращает дополнительный реквизит предмета расчета | |
| public | getAgentType() | Возвращает тип посредника, реализующего товар или услугу | |
| public | getAmount() | Возвращает общую стоимость покупаемого товара в копейках/центах | |
| public | getCountryOfOriginCode() | Возвращает код страны происхождения товара по общероссийскому классификатору стран мира | |
| public | getCustomsDeclarationNumber() | Возвращает номер таможенной декларации | |
| public | getDescription() | Возвращает наименование товара | |
| public | getExcise() | Возвращает сумму акциза товара с учетом копеек | |
| public | getMarkCodeInfo() | Возвращает код товара | |
| public | getMarkMode() | Возвращает режим обработки кода маркировки | |
| public | getMarkQuantity() | Возвращает дробное количество маркированного товара | |
| public | getMeasure() | Возвращает меру количества предмета расчета | |
| public | getPaymentMode() | Возвращает признак способа расчета | |
| public | getPaymentSubject() | Возвращает признак предмета расчета | |
| public | getPaymentSubjectIndustryDetails() | Возвращает отраслевой реквизит чека | |
| public | getPrice() | Возвращает цену товара | |
| public | getProductCode() | Возвращает код товара — уникальный номер, который присваивается экземпляру товара при маркировке | |
| public | getQuantity() | Возвращает количество товара | |
| public | getSupplier() | Возвращает информацию о поставщике товара или услуги. | |
| public | getVatCode() | Возвращает ставку НДС | |
| public | increasePrice() | Увеличивает цену товара на указанную величину | |
| public | isShipping() | Проверяет, является ли текущий элемент чека доставкой | |
| public | jsonSerialize() | ||
| public | offsetExists() | ||
| public | offsetGet() | ||
| public | offsetSet() | ||
| public | offsetUnset() | ||
| public | setAdditionalPaymentSubjectProps() | Устанавливает дополнительный реквизит предмета расчета | |
| public | setAgentType() | Устанавливает тип посредника, реализующего товар или услугу | |
| public | setCountryOfOriginCode() | Устанавливает код страны происхождения товара по общероссийскому классификатору стран мира | |
| public | setCustomsDeclarationNumber() | Устанавливает номер таможенной декларации (от 1 до 32 символов) | |
| public | setDescription() | Устанавливает наименование товара | |
| public | setExcise() | Устанавливает сумму акциза товара с учетом копеек | |
| public | setIsShipping() | Устанавливает флаг доставки для текущего объекта айтема в чеке | |
| public | setMarkCodeInfo() | Устанавливает код товара | |
| public | setMarkMode() | Устанавливает режим обработки кода маркировки | |
| public | setMarkQuantity() | Устанавливает дробное количество маркированного товара | |
| public | setMeasure() | Устанавливает меру количества предмета расчета | |
| public | setPaymentMode() | Устанавливает признак способа расчета | |
| public | setPaymentSubject() | Устанавливает признак предмета расчета | |
| public | setPaymentSubjectIndustryDetails() | Устанавливает отраслевой реквизит чека | |
| public | setPrice() | Устанавливает цену товара | |
| public | setProductCode() | Устанавливает код товара — уникальный номер, который присваивается экземпляру товара при маркировке | |
| public | setQuantity() | Устанавливает количество покупаемого товара | |
| public | setSupplier() | Устанавливает информацию о поставщике товара или услуги. | |
| public | setVatCode() | Устанавливает ставку НДС | |
| public | toArray() | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | |
| protected | getUnknownProperties() | Возвращает массив свойств которые не существуют, но были заданы у объекта |
Details
- File: lib/Model/ReceiptItem.php
- Package: YooKassa
- Class Hierarchy:
- \YooKassa\Common\AbstractObject
- \YooKassa\Model\ReceiptItem
- Implements:
Constants
DESCRIPTION_MAX_LENGTH
DESCRIPTION_MAX_LENGTH = 128 : int
ADD_PROPS_MAX_LENGTH
ADD_PROPS_MAX_LENGTH = 64 : int
Properties
public $additional_payment_subject_props : string
Description
Дополнительный реквизит предмета расчета (тег в 54 ФЗ — 1191)
Type: string
Details:
public $additionalPaymentSubjectProps : string
Description
Дополнительный реквизит предмета расчета (тег в 54 ФЗ — 1191)
Type: string
Details:
public $agent_type : string
Description
Тип посредника, реализующего товар или услугу
Type: string
Details:
public $agentType : string
Description
Тип посредника, реализующего товар или услугу
Type: string
Details:
public $amount : float
Description
Суммарная стоимость покупаемого товара в копейках/центах
Type: float
Details:
public $country_of_origin_code : string
Description
Код страны происхождения товара (тег в 54 ФЗ — 1230)
Type: string
Details:
public $countryOfOriginCode : string
Description
Код страны происхождения товара (тег в 54 ФЗ — 1230)
Type: string
Details:
public $customs_declaration_number : string
Description
Номер таможенной декларации (от 1 до 32 символов). Тег в 54 ФЗ — 1231
Type: string
Details:
public $customsDeclarationNumber : string
Description
Номер таможенной декларации (от 1 до 32 символов). Тег в 54 ФЗ — 1231
Type: string
Details:
public $description : string
Description
Наименование товара (тег в 54 ФЗ — 1030)
Type: string
Details:
public $excise : float
Description
Сумма акциза товара с учетом копеек (тег в 54 ФЗ — 1229)
Type: float
Details:
public $isShipping : bool
Description
Флаг доставки
Type: bool
Details:
public $mark_code_info : \YooKassa\Model\Receipt\MarkCodeInfo
Description
Код товара (тег в 54 ФЗ — 1163)
Type: MarkCodeInfo
Details:
public $mark_mode : string
Description
Режим обработки кода маркировки (тег в 54 ФЗ — 2102)
Type: string
Details:
public $mark_quantity : \YooKassa\Model\Receipt\MarkQuantity
Description
Дробное количество маркированного товара (тег в 54 ФЗ — 1291)
Type: MarkQuantity
Details:
public $markCodeInfo : \YooKassa\Model\Receipt\MarkCodeInfo
Description
Код товара (тег в 54 ФЗ — 1163)
Type: MarkCodeInfo
Details:
public $markMode : string
Description
Режим обработки кода маркировки (тег в 54 ФЗ — 2102)
Type: string
Details:
public $markQuantity : \YooKassa\Model\Receipt\MarkQuantity
Description
Дробное количество маркированного товара (тег в 54 ФЗ — 1291)
Type: MarkQuantity
Details:
public $measure : string
Description
Мера количества предмета расчета (тег в 54 ФЗ — 2108)
Type: string
Details:
public $payment_mode : string
Description
Признак способа расчета (тег в 54 ФЗ — 1214)
Type: string
Details:
public $payment_subject : string
Description
Признак предмета расчета (тег в 54 ФЗ — 1212)
Type: string
Details:
public $payment_subject_industry_details : \YooKassa\Model\Receipt\IndustryDetails[]
Description
Отраслевой реквизит предмета расчета (тег в 54 ФЗ — 1260)
Type: IndustryDetails[]
Details:
public $paymentMode : string
Description
Признак способа расчета (тег в 54 ФЗ — 1214)
Type: string
Details:
public $paymentSubject : string
Description
Признак предмета расчета (тег в 54 ФЗ — 1212)
Type: string
Details:
public $paymentSubjectIndustryDetails : \YooKassa\Model\Receipt\IndustryDetails[]
Description
Отраслевой реквизит предмета расчета (тег в 54 ФЗ — 1260)
Type: IndustryDetails[]
Details:
public $price : \YooKassa\Model\AmountInterface
Description
Цена товара (тег в 54 ФЗ — 1079)
Type: AmountInterface
Details:
public $product_code : string
Description
Код товара (тег в 54 ФЗ — 1162)
Type: string
Details:
public $productCode : string
Description
Код товара (тег в 54 ФЗ — 1162)
Type: string
Details:
public $quantity : float
Description
Количество (тег в 54 ФЗ — 1023)
Type: float
Details:
public $supplier : \YooKassa\Model\Supplier
Description
Информация о поставщике товара или услуги (тег в 54 ФЗ — 1224)
Type: Supplier
Details:
public $vat_code : int
Description
Ставка НДС (тег в 54 ФЗ — 1199), число 1-6
Type: int
Details:
public $vatCode : int
Description
Ставка НДС (тег в 54 ФЗ — 1199), число 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 getAdditionalPaymentSubjectProps() : string
public getAdditionalPaymentSubjectProps() : string
Summary
Возвращает дополнительный реквизит предмета расчета
Details:
- Inherited From: \YooKassa\Model\ReceiptItem
Returns: string - Дополнительный реквизит предмета расчета
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 getMarkCodeInfo() : \YooKassa\Model\Receipt\MarkCodeInfo
public getMarkCodeInfo() : \YooKassa\Model\Receipt\MarkCodeInfo
Summary
Возвращает код товара
Details:
- Inherited From: \YooKassa\Model\ReceiptItem
Returns: \YooKassa\Model\Receipt\MarkCodeInfo - Код товара
public getMarkMode() : string
public getMarkMode() : string
Summary
Возвращает режим обработки кода маркировки
Details:
- Inherited From: \YooKassa\Model\ReceiptItem
Returns: string - Режим обработки кода маркировки
public getMarkQuantity() : \YooKassa\Model\Receipt\MarkQuantity
public getMarkQuantity() : \YooKassa\Model\Receipt\MarkQuantity
Summary
Возвращает дробное количество маркированного товара
Details:
- Inherited From: \YooKassa\Model\ReceiptItem
Returns: \YooKassa\Model\Receipt\MarkQuantity - Дробное количество маркированного товара
public getMeasure() : string
public getMeasure() : string
Summary
Возвращает меру количества предмета расчета
Details:
- Inherited From: \YooKassa\Model\ReceiptItem
Returns: string - Мера количества предмета расчета
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 getPaymentSubjectIndustryDetails() : \YooKassa\Model\Receipt\IndustryDetails[]
public getPaymentSubjectIndustryDetails() : \YooKassa\Model\Receipt\IndustryDetails[]
Summary
Возвращает отраслевой реквизит чека
Details:
- Inherited From: \YooKassa\Model\ReceiptItem
Returns: \YooKassa\Model\Receipt\IndustryDetails[] - Отраслевой реквизит чека
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
Details:
- Inherited From: \YooKassa\Model\ReceiptItem
Returns: array -
Tags
| Tag | Version | Description |
|---|---|---|
| inheritdoc |
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 setAdditionalPaymentSubjectProps() : mixed
public setAdditionalPaymentSubjectProps(string $value) : mixed
Summary
Устанавливает дополнительный реквизит предмета расчета
Details:
- Inherited From: \YooKassa\Model\ReceiptItem
Parameters:
| Type | Name | Description |
|---|---|---|
string |
value | Дополнительный реквизит предмета расчета |
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 setMarkCodeInfo() : mixed
public setMarkCodeInfo(array|\YooKassa\Model\Receipt\MarkCodeInfo $value) : mixed
Summary
Устанавливает код товара
Details:
- Inherited From: \YooKassa\Model\ReceiptItem
Parameters:
| Type | Name | Description |
|---|---|---|
array OR \YooKassa\Model\Receipt\MarkCodeInfo |
value | Код товара |
Returns: mixed -
public setMarkMode() : mixed
public setMarkMode(string $value) : mixed
Summary
Устанавливает режим обработки кода маркировки
Details:
- Inherited From: \YooKassa\Model\ReceiptItem
Parameters:
| Type | Name | Description |
|---|---|---|
string |
value | Режим обработки кода маркировки |
Returns: mixed -
public setMarkQuantity() : mixed
public setMarkQuantity(array|\YooKassa\Model\Receipt\MarkQuantity $value) : mixed
Summary
Устанавливает дробное количество маркированного товара
Details:
- Inherited From: \YooKassa\Model\ReceiptItem
Parameters:
| Type | Name | Description |
|---|---|---|
array OR \YooKassa\Model\Receipt\MarkQuantity |
value | Дробное количество маркированного товара |
Returns: mixed -
public setMeasure() : mixed
public setMeasure(string $value) : mixed
Summary
Устанавливает меру количества предмета расчета
Details:
- Inherited From: \YooKassa\Model\ReceiptItem
Parameters:
| Type | Name | Description |
|---|---|---|
string |
value | Мера количества предмета расчета |
Returns: mixed -
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 setPaymentSubjectIndustryDetails() : mixed
public setPaymentSubjectIndustryDetails(array|\YooKassa\Model\Receipt\IndustryDetails[] $value) : mixed
Summary
Устанавливает отраслевой реквизит чека
Details:
- Inherited From: \YooKassa\Model\ReceiptItem
Parameters:
| Type | Name | Description |
|---|---|---|
array OR \YooKassa\Model\Receipt\IndustryDetails[] |
value | Отраслевой реквизит чека |
Returns: mixed -
public setPrice() : mixed
public setPrice(\YooKassa\Model\AmountInterface|array $value) : mixed
Summary
Устанавливает цену товара
Details:
- Inherited From: \YooKassa\Model\ReceiptItem
Parameters:
| Type | Name | Description |
|---|---|---|
\YooKassa\Model\AmountInterface OR array |
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() : $this
public setSupplier(\YooKassa\Model\SupplierInterface|array $value) : $this
Summary
Устанавливает информацию о поставщике товара или услуги.
Details:
- Inherited From: \YooKassa\Model\ReceiptItem
Parameters:
| Type | Name | Description |
|---|---|---|
\YooKassa\Model\SupplierInterface OR array |
value | Информация о поставщике товара или услуги |
Returns: $this -
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
Reports
This document was automatically generated from source code comments on 2023-04-06 using phpDocumentor
© 2023 YooMoney