geckon01/yookassa-sdk-php
1
0
Fork 0
mirror of https://git.yoomoney.ru/scm/sdk/yookassa-sdk-php.git synced 2026-09-20 15:16:51 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
3.11.0
yookassa-sdk-php/docs/classes/YooKassa-Request-Receipts-ReceiptResponseItem.md
T

57 KiB
Raw Permalink Blame History

YooKassa API SDK

Class: \YooKassa\Request\Receipts\ReceiptResponseItem

Namespace: \YooKassa\Request\Receipts

Summary:

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

Constants

Visibility Name Flag Summary
public COUNTRY_CODE_LENGTH
public MAX_DECLARATION_NUMBER_LENGTH
public MAX_PRODUCT_CODE_LENGTH

Properties

Visibility Name Flag Summary
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 $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 $planned_status Планируемый статус товара. Тег в 54 ФЗ — 2003
public $plannedStatus Планируемый статус товара. Тег в 54 ФЗ — 2003
public $price Цена товара (тег в 54 ФЗ — 1079)
public $product_code Код товара — уникальный номер, который присваивается экземпляру товара при маркировке (тег в 54 ФЗ — 1162)
public $productCode Код товара — уникальный номер, который присваивается экземпляру товара при маркировке (тег в 54 ФЗ — 1162)
public $quantity Количество (тег в 54 ФЗ — 1023)
public $supplier Информация о поставщике товара или услуги (тег в 54 ФЗ — 1224)
public $vat_code Ставка НДС, число 1-10 (тег в 54 ФЗ — 1199)
public $vatCode Ставка НДС, число 1-10 (тег в 54 ФЗ — 1199)

Methods

Visibility Name Flag Summary
public __construct() AbstractObject constructor.
public __get() Возвращает значение свойства.
public __isset() Проверяет наличие свойства.
public __set() Устанавливает значение свойства.
public __unset() Удаляет свойство.
public fromArray() Устанавливает значения свойств текущего объекта из массива.
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 getPlannedStatus() Возвращает планируемый статус товара.
public getPrice() Возвращает цену товара.
public getProductCode() Возвращает код товара — уникальный номер, который присваивается экземпляру товара при маркировке.
public getQuantity() Возвращает количество товара.
public getSupplier() Возвращает информацию о поставщике товара или услуги
public getValidator()
public getVatCode() Возвращает ставку НДС
public jsonSerialize() Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации.
public offsetExists() Проверяет наличие свойства.
public offsetGet() Возвращает значение свойства.
public offsetSet() Устанавливает значение свойства.
public offsetUnset() Удаляет свойство.
public setAgentType() Устанавливает тип посредника, реализующего товар или услугу.
public setCountryOfOriginCode() Устанавливает код страны происхождения товара по общероссийскому классификатору стран мира.
public setCustomsDeclarationNumber() Устанавливает номер таможенной декларации (от 1 до 32 символов).
public setDescription() Устанавливает наименование товара.
public setExcise() Устанавливает сумму акциза товара с учетом копеек.
public setMarkCodeInfo() Устанавливает код товара.
public setMarkMode() Устанавливает режим обработки кода маркировки.
public setMarkQuantity() Устанавливает дробное количество маркированного товара.
public setMeasure() Устанавливает меру количества предмета расчета.
public setPaymentMode() Устанавливает признак способа расчета.
public setPaymentSubject() Устанавливает признак предмета расчета.
public setPaymentSubjectIndustryDetails() Устанавливает отраслевой реквизит чека.
public setPlannedStatus() Устанавливает планируемый статус товара.
public setPrice() Устанавливает цену товара.
public setProductCode() Устанавливает код товара — уникальный номер, который присваивается экземпляру товара при маркировке.
public setQuantity() Устанавливает количество покупаемого товара.
public setSupplier() Устанавливает информацию о поставщике товара или услуги.
public setVatCode() Устанавливает ставку НДС
public toArray() Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize().
protected getUnknownProperties() Возвращает массив свойств которые не существуют, но были заданы у объекта.
protected validatePropertyValue()

Details

Tags

Tag Version Description
category Class
author cms@yoomoney.ru

Constants

COUNTRY_CODE_LENGTH
COUNTRY_CODE_LENGTH = 2 : int

MAX_DECLARATION_NUMBER_LENGTH
MAX_DECLARATION_NUMBER_LENGTH = 32 : int

MAX_PRODUCT_CODE_LENGTH
MAX_PRODUCT_CODE_LENGTH = 96 : int

Properties

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 $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\Common\ListObjectInterface|\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\Common\ListObjectInterface|\YooKassa\Model\Receipt\IndustryDetails[]

Description

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

Type: IndustryDetails[]

Details:

public $planned_status : int

Description

Планируемый статус товара. Тег в 54 ФЗ — 2003

Type: int

Details:

public $plannedStatus : int

Description

Планируемый статус товара. Тег в 54 ФЗ — 2003

Type: int

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\Receipt\Supplier

Description

Информация о поставщике товара или услуги (тег в 54 ФЗ — 1224)

Type: Supplier

Details:

public $vat_code : int

Description

Ставка НДС, число 1-10 (тег в 54 ФЗ — 1199)

Type: int

Details:

public $vatCode : int

Description

Ставка НДС, число 1-10 (тег в 54 ФЗ — 1199)

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 fromArray() : void

public fromArray(array $sourceArray) : void

Summary

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

Details:

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

Returns: void -

public getAgentType() : string|null

public getAgentType() : string|null

Summary

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

Details:

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

public getAmount() : int|null

public getAmount() : int|null

Summary

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

Details:

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

public getCountryOfOriginCode() : null|string

public getCountryOfOriginCode() : null|string

Summary

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

Details:

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

public getCustomsDeclarationNumber() : null|string

public getCustomsDeclarationNumber() : null|string

Summary

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

Details:

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

public getDescription() : string|null

public getDescription() : string|null

Summary

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

Details:

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

public getExcise() : null|float

public getExcise() : null|float

Summary

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

Details:

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

public getMarkCodeInfo() : \YooKassa\Model\Receipt\MarkCodeInfo|null

public getMarkCodeInfo() : \YooKassa\Model\Receipt\MarkCodeInfo|null

Summary

Возвращает код товара.

Details:

Returns: \YooKassa\Model\Receipt\MarkCodeInfo|null - Код товара

public getMarkMode() : string|null

public getMarkMode() : string|null

Summary

Возвращает режим обработки кода маркировки.

Details:

Returns: string|null - Режим обработки кода маркировки

public getMarkQuantity() : \YooKassa\Model\Receipt\MarkQuantity|null

public getMarkQuantity() : \YooKassa\Model\Receipt\MarkQuantity|null

Summary

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

Details:

Returns: \YooKassa\Model\Receipt\MarkQuantity|null - Дробное количество маркированного товара

public getMeasure() : string|null

public getMeasure() : string|null

Summary

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

Details:

Returns: string|null - Мера количества предмета расчета

public getPaymentMode() : null|string

public getPaymentMode() : null|string

Summary

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

Details:

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

public getPaymentSubject() : null|string

public getPaymentSubject() : null|string

Summary

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

Details:

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

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

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

Summary

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

Details:

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

public getPlannedStatus() : int|null

public getPlannedStatus() : int|null

Summary

Возвращает планируемый статус товара.

Details:

Returns: int|null - Планируемый статус товара

public getPrice() : \YooKassa\Model\AmountInterface|null

public getPrice() : \YooKassa\Model\AmountInterface|null

Summary

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

Details:

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

public getProductCode() : null|string

public getProductCode() : null|string

Summary

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

Details:

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

public getQuantity() : float

public getQuantity() : float

Summary

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

Details:

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

public getSupplier() : \YooKassa\Model\Receipt\SupplierInterface|null

public getSupplier() : \YooKassa\Model\Receipt\SupplierInterface|null

Summary

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

Details:

Returns: \YooKassa\Model\Receipt\SupplierInterface|null -

public getValidator() : \YooKassa\Validator\Validator

public getValidator() : \YooKassa\Validator\Validator

Details:

Returns: \YooKassa\Validator\Validator -

public getVatCode() : null|int

public getVatCode() : null|int

Summary

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

Details:

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

public jsonSerialize() : array

public jsonSerialize() : array

Summary

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

Details:

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

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

public setAgentType(string|null $agent_type = null) : self

Summary

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

Details:

Parameters:
Type Name Description
string OR null agent_type Тип посредника

Returns: self -

public setCountryOfOriginCode() : self

public setCountryOfOriginCode(string|null $country_of_origin_code = null) : self

Summary

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

Details:

Parameters:
Type Name Description
string OR null country_of_origin_code Код страны происхождения товара

Returns: self -

public setCustomsDeclarationNumber() : self

public setCustomsDeclarationNumber(string|null $customs_declaration_number = null) : self

Summary

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

Details:

Parameters:
Type Name Description
string OR null customs_declaration_number Номер таможенной декларации

Returns: self -

public setDescription() : self

public setDescription(string|null $description) : self

Summary

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

Details:

Parameters:
Type Name Description
string OR null description Наименование товара

Returns: self -

public setExcise() : self

public setExcise(float|null $excise = null) : self

Summary

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

Details:

Parameters:
Type Name Description
float OR null excise Сумма акциза товара с учетом копеек

Returns: self -

public setMarkCodeInfo() : self

public setMarkCodeInfo(array|\YooKassa\Model\Receipt\MarkCodeInfo|null $mark_code_info = null) : self

Summary

Устанавливает код товара.

Details:

Parameters:
Type Name Description
array OR \YooKassa\Model\Receipt\MarkCodeInfo OR null mark_code_info Код товара

Returns: self -

public setMarkMode() : self

public setMarkMode(string|null $mark_mode = null) : self

Summary

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

Details:

Parameters:
Type Name Description
string OR null mark_mode Режим обработки кода маркировки

Returns: self -

public setMarkQuantity() : self

public setMarkQuantity(array|\YooKassa\Model\Receipt\MarkQuantity|null $mark_quantity = null) : self

Summary

Устанавливает дробное количество маркированного товара.

Details:

Parameters:
Type Name Description
array OR \YooKassa\Model\Receipt\MarkQuantity OR null mark_quantity Дробное количество маркированного товара

Returns: self -

public setMeasure() : self

public setMeasure(string|null $measure) : self

Summary

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

Details:

Parameters:
Type Name Description
string OR null measure Мера количества предмета расчета

Returns: self -

public setPaymentMode() : self

public setPaymentMode(string|null $payment_mode = null) : self

Summary

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

Details:

Parameters:
Type Name Description
string OR null payment_mode Признак способа расчета

Returns: self -

public setPaymentSubject() : self

public setPaymentSubject(null|string $payment_subject = null) : self

Summary

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

Details:

Parameters:
Type Name Description
null OR string payment_subject Признак предмета расчета

Returns: self -

public setPaymentSubjectIndustryDetails() : self

public setPaymentSubjectIndustryDetails(array|\YooKassa\Model\Receipt\IndustryDetails[]|null $payment_subject_industry_details = null) : self

Summary

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

Details:

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

Returns: self -

public setPlannedStatus() : self

public setPlannedStatus(int|null $planned_status = null) : self

Summary

Устанавливает планируемый статус товара.

Details:

Parameters:
Type Name Description
int OR null planned_status Планируемый статус товара

Returns: self -

public setPrice() : void

public setPrice(\YooKassa\Model\AmountInterface|array|null $value) : void

Summary

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

Details:

Parameters:
Type Name Description
\YooKassa\Model\AmountInterface OR array OR null value Цена товара

Returns: void -

public setProductCode() : self

public setProductCode(\YooKassa\Helpers\ProductCode|string $product_code) : self

Summary

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

Details:

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

Returns: self -

public setQuantity() : self

public setQuantity(float|null $quantity) : self

Summary

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

Details:

Parameters:
Type Name Description
float OR null quantity Количество

Returns: self -

public setSupplier() : self

public setSupplier(array|\YooKassa\Model\Receipt\SupplierInterface|null $supplier = null) : self

Summary

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

Details:

Parameters:
Type Name Description
array OR \YooKassa\Model\Receipt\SupplierInterface OR null supplier Информация о поставщике товара или услуги

Returns: self -

public setVatCode() : self

public setVatCode(int|null $vat_code = null) : self

Summary

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

Details:

Parameters:
Type Name Description
int OR null vat_code Ставка НДС, число 1-10

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 2025-10-31 using phpDocumentor

© 2025 YooMoney

Reference in New Issue View Git Blame Copy Permalink