meraproject/vendor/yoomoney/yookassa-sdk-php/docs/classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md
keboss-m 5c21d25d45 Initial commit: Merakomis portal, Docker stack and user-reader API.
Co-authored-by: Cursor <cursoragent@cursor.com>
2026-06-24 11:04:05 +03:00

52 KiB
Raw Permalink Blame History

YooKassa API SDK

Abstract Class: \YooKassa\Request\Receipts\AbstractReceiptResponse

Namespace: \YooKassa\Request\Receipts


Summary:

Class AbstractReceipt


Constants

Visibility Name Flag Summary
public LENGTH_RECEIPT_ID Длина идентификатора чека

Properties

Visibility Name Flag Summary
public $fiscal_attribute Фискальный признак чека. Формируется фискальным накопителем на основе данных, переданных для регистрации чека.
public $fiscal_document_number Номер фискального документа.
public $fiscal_provider_id Идентификатор чека в онлайн-кассе. Присутствует, если чек удалось зарегистрировать.
public $fiscal_storage_number Номер фискального накопителя в кассовом аппарате.
public $fiscalAttribute Фискальный признак чека. Формируется фискальным накопителем на основе данных, переданных для регистрации чека.
public $fiscalDocumentNumber Номер фискального документа.
public $fiscalProviderId Идентификатор чека в онлайн-кассе. Присутствует, если чек удалось зарегистрировать.
public $fiscalStorageNumber Номер фискального накопителя в кассовом аппарате.
public $id Идентификатор чека в ЮKassa.
public $items Список товаров в заказе.
public $object_id Идентификатор объекта чека.
public $objectId Идентификатор объекта чека.
public $on_behalf_of Идентификатор магазина.
public $onBehalfOf Идентификатор магазина.
public $receipt_industry_details Отраслевой реквизит чека.
public $receipt_operational_details Операционный реквизит чека.
public $receiptIndustryDetails Отраслевой реквизит чека.
public $receiptOperationalDetails Операционный реквизит чека.
public $registered_at Дата и время формирования чека в фискальном накопителе.
public $registeredAt Дата и время формирования чека в фискальном накопителе.
public $settlements Перечень совершенных расчетов.
public $status Статус доставки данных для чека в онлайн-кассу ("pending", "succeeded" или "canceled").
public $tax_system_code Код системы налогообложения. Число 1-6.
public $taxSystemCode Код системы налогообложения. Число 1-6.
public $type Тип чека в онлайн-кассе: приход "payment" или возврат "refund".

Methods

Visibility Name Flag Summary
public __construct() AbstractObject constructor.
public __get() Возвращает значение свойства
public __isset() Проверяет наличие свойства
public __set() Устанавливает значение свойства
public __unset() Удаляет свойство
public addItem() Добавляет товар в чек
public addSettlement() Добавляет оплату в массив
public fromArray() AbstractReceiptResponse constructor.
public getFiscalAttribute() Возвращает фискальный признак чека
public getFiscalDocumentNumber() Возвращает номер фискального документа
public getFiscalProviderId() Возвращает идентификатор чека в онлайн-кассе
public getFiscalStorageNumber() Возвращает номер фискального накопителя в кассовом аппарате
public getId() Возвращает идентификатор чека в ЮKassa
public getItems() Возвращает список товаров в заказ
public getObjectId() Возвращает идентификатор платежа или возврата, для которого был сформирован чек.
public getOnBehalfOf() Возвращает идентификатор магазин
public getReceiptIndustryDetails() Возвращает отраслевой реквизит чека
public getReceiptOperationalDetails() Возвращает операционный реквизит чека
public getRegisteredAt() Возвращает дату и время формирования чека в фискальном накопителе
public getSettlements() Возвращает Массив оплат, обеспечивающих выдачу товара
public getStatus() Возвращает статус доставки данных для чека в онлайн-кассу
public getTaxSystemCode() Возвращает код системы налогообложения
public getType() Возвращает тип чека в онлайн-кассе
public jsonSerialize()
public notEmpty() Проверяет есть ли в чеке хотя бы одна позиция
public offsetExists()
public offsetGet()
public offsetSet()
public offsetUnset()
public setFiscalAttribute() Устанавливает фискальный признак чека
public setFiscalDocumentNumber() Устанавливает номер фискального документа
public setFiscalProviderId() Устанавливает идентификатор чека в онлайн-кассе
public setFiscalStorageNumber() Устанавливает номер фискального накопителя в кассовом аппарате
public setId() Устанавливает идентификатор чека
public setItems() Устанавливает список позиций в чеке
public setObjectId() Устанавливает идентификатор платежа или возврата, для которого был сформирован чек
public setOnBehalfOf() Возвращает идентификатор магазина, от имени которого нужно отправить чек
public setReceiptIndustryDetails() Устанавливает отраслевой реквизит чека
public setReceiptOperationalDetails() Устанавливает операционный реквизит чека
public setRegisteredAt() Устанавливает дату и время формирования чека в фискальном накопителе
public setSettlements() Устанавливает массив оплат, обеспечивающих выдачу товара
public setSpecificProperties() Установка свойств, присущих конкретному объекту
public setStatus() Устанавливает состояние регистрации фискального чека
public setTaxSystemCode() Устанавливает код системы налогообложения
public setType() Устанавливает типа чека
public toArray() Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize()
protected getUnknownProperties() Возвращает массив свойств которые не существуют, но были заданы у объекта

Details


Constants

LENGTH_RECEIPT_ID

Длина идентификатора чека

LENGTH_RECEIPT_ID = 39

Properties

public $fiscal_attribute : string


Description

Фискальный признак чека. Формируется фискальным накопителем на основе данных, переданных для регистрации чека.

Type: string

Details:

public $fiscal_document_number : string


Description

Номер фискального документа.

Type: string

Details:

public $fiscal_provider_id : string


Description

Идентификатор чека в онлайн-кассе. Присутствует, если чек удалось зарегистрировать.

Type: string

Details:

public $fiscal_storage_number : string


Description

Номер фискального накопителя в кассовом аппарате.

Type: string

Details:

public $fiscalAttribute : string


Description

Фискальный признак чека. Формируется фискальным накопителем на основе данных, переданных для регистрации чека.

Type: string

Details:

public $fiscalDocumentNumber : string


Description

Номер фискального документа.

Type: string

Details:

public $fiscalProviderId : string


Description

Идентификатор чека в онлайн-кассе. Присутствует, если чек удалось зарегистрировать.

Type: string

Details:

public $fiscalStorageNumber : string


Description

Номер фискального накопителя в кассовом аппарате.

Type: string

Details:

public $id : string


Description

Идентификатор чека в ЮKassa.

Type: string

Details:

public $items : \YooKassa\Request\Receipts\ReceiptResponseItemInterface[]


Description

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

Type: ReceiptResponseItemInterface[]

Details:

public $object_id : string


Description

Идентификатор объекта чека.

Type: string

Details:

public $objectId : string


Description

Идентификатор объекта чека.

Type: string

Details:

public $on_behalf_of : string


Description

Идентификатор магазина.

Type: string

Details:

public $onBehalfOf : string


Description

Идентификатор магазина.

Type: string

Details:

public $receipt_industry_details : \YooKassa\Model\Receipt\IndustryDetails[]


Description

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

Type: IndustryDetails[]

Details:

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


Description

Операционный реквизит чека.

Type: OperationalDetails

Details:

public $receiptIndustryDetails : \YooKassa\Model\Receipt\IndustryDetails[]


Description

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

Type: IndustryDetails[]

Details:

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


Description

Операционный реквизит чека.

Type: OperationalDetails

Details:

public $registered_at : \DateTime


Description

Дата и время формирования чека в фискальном накопителе.

Type: \DateTime

Details:

public $registeredAt : \DateTime


Description

Дата и время формирования чека в фискальном накопителе.

Type: \DateTime

Details:

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


Description

Перечень совершенных расчетов.

Type: SettlementInterface[]

Details:

public $status : string


Description

Статус доставки данных для чека в онлайн-кассу ("pending", "succeeded" или "canceled").

Type: string

Details:

public $tax_system_code : int


Description

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

Type: int

Details:

public $taxSystemCode : int


Description

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

Type: int

Details:

public $type : string


Description

Тип чека в онлайн-кассе: приход "payment" или возврат "refund".

Type: string

Details:


Methods

public __construct() : mixed

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

Summary

AbstractObject constructor.

Details:

Parameters:
Type Name Description
array 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() : mixed

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

Summary

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

Details:

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

Returns: mixed -

public __unset() : mixed

public __unset(string $propertyName) : mixed

Summary

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

Details:

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

Returns: mixed -

public addItem() : mixed

public addItem(\YooKassa\Request\Receipts\ReceiptResponseItemInterface $value) : mixed

Summary

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

Details:

Parameters:
Type Name Description
\YooKassa\Request\Receipts\ReceiptResponseItemInterface value Объект добавляемой в чек позиции

Returns: mixed -

public addSettlement() : mixed

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

Summary

Добавляет оплату в массив

Details:

Parameters:
Type Name Description
\YooKassa\Model\SettlementInterface value

Returns: mixed -

public fromArray() : mixed

public fromArray(mixed $sourceArray) : mixed

Summary

AbstractReceiptResponse constructor.

Details:

Parameters:
Type Name Description
mixed sourceArray
Throws:
Type Description
\Exception

Returns: mixed -

public getFiscalAttribute() : string

public getFiscalAttribute() : string

Summary

Возвращает фискальный признак чека

Details:

Returns: string - Фискальный признак чека

public getFiscalDocumentNumber() : string

public getFiscalDocumentNumber() : string

Summary

Возвращает номер фискального документа

Details:

Returns: string - Номер фискального документа

public getFiscalProviderId() : string

public getFiscalProviderId() : string

Summary

Возвращает идентификатор чека в онлайн-кассе

Details:

Returns: string - Идентификатор чека в онлайн-кассе

public getFiscalStorageNumber() : string

public getFiscalStorageNumber() : string

Summary

Возвращает номер фискального накопителя в кассовом аппарате

Details:

Returns: string - Номер фискального накопителя в кассовом аппарате

public getId() : string

public getId() : string

Summary

Возвращает идентификатор чека в ЮKassa

Details:

Returns: string -

Tags
Tag Version Description
inheritdoc

public getItems() : \YooKassa\Request\Receipts\ReceiptResponseItem[]|\YooKassa\Request\Receipts\ReceiptResponseItemInterface[]

public getItems() : \YooKassa\Request\Receipts\ReceiptResponseItem[]|\YooKassa\Request\Receipts\ReceiptResponseItemInterface[]

Summary

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

Details:

Returns: \YooKassa\Request\Receipts\ReceiptResponseItem[]|\YooKassa\Request\Receipts\ReceiptResponseItemInterface[] -

Tags
Tag Version Description
inheritdoc

public getObjectId() : string

public getObjectId() : string

Summary

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

Details:

Returns: string -

public getOnBehalfOf() : string|null

public getOnBehalfOf() : string|null

Summary

Возвращает идентификатор магазин

Details:

Returns: string|null -

Tags
Tag Version Description
inheritdoc

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

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

Summary

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

Details:

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

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

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

Summary

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

Details:

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

public getRegisteredAt() : \DateTime

public getRegisteredAt() : \DateTime

Summary

Возвращает дату и время формирования чека в фискальном накопителе

Details:

Returns: \DateTime - Дата и время формирования чека в фискальном накопителе

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

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

Summary

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

Details:

Returns: \YooKassa\Model\SettlementInterface[] -

public getStatus() : string

public getStatus() : string

Summary

Возвращает статус доставки данных для чека в онлайн-кассу

Details:

Returns: string -

Tags
Tag Version Description
inheritdoc

public getTaxSystemCode() : int

public getTaxSystemCode() : int

Summary

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

Details:

Returns: int -

Tags
Tag Version Description
inheritdoc

public getType() : string

public getType() : string

Summary

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

Details:

Returns: string -

Tags
Tag Version Description
inheritdoc

public jsonSerialize() : mixed

public jsonSerialize() : mixed

Details:

Returns: mixed -

public notEmpty() : bool

public notEmpty() : bool

Summary

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

Details:

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

public offsetExists() : mixed

public offsetExists(mixed $offset) : mixed

Details:

Parameters:
Type Name Description
mixed offset

Returns: mixed -

public offsetGet() : mixed

public offsetGet(mixed $offset) : mixed

Details:

Parameters:
Type Name Description
mixed offset

Returns: mixed -

public offsetSet() : mixed

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

Details:

Parameters:
Type Name Description
mixed offset
mixed value

Returns: mixed -

public offsetUnset() : mixed

public offsetUnset(mixed $offset) : mixed

Details:

Parameters:
Type Name Description
mixed offset

Returns: mixed -

public setFiscalAttribute() : mixed

public setFiscalAttribute(string $fiscal_attribute) : mixed

Summary

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

Details:

Parameters:
Type Name Description
string fiscal_attribute Фискальный признак чека

Returns: mixed -

public setFiscalDocumentNumber() : mixed

public setFiscalDocumentNumber(string $value) : mixed

Summary

Устанавливает номер фискального документа

Details:

Parameters:
Type Name Description
string value Номер фискального документа
Throws:
Type Description
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException Выбрасывается если переданный аргумент не строка

Returns: mixed -

public setFiscalProviderId() : mixed

public setFiscalProviderId(string $fiscal_provider_id) : mixed

Summary

Устанавливает идентификатор чека в онлайн-кассе

Details:

Parameters:
Type Name Description
string fiscal_provider_id Идентификатор чека в онлайн-кассе

Returns: mixed -

public setFiscalStorageNumber() : mixed

public setFiscalStorageNumber(string $fiscal_storage_number) : mixed

Summary

Устанавливает номер фискального накопителя в кассовом аппарате

Details:

Parameters:
Type Name Description
string fiscal_storage_number Номер фискального накопителя в кассовом аппарате

Returns: mixed -

public setId() : mixed

public setId(string $value) : mixed

Summary

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

Details:

Parameters:
Type Name Description
string value Идентификатор чека
Throws:
Type Description
\YooKassa\Common\Exceptions\InvalidPropertyValueException Выбрасывается если длина переданной строки не равна 40
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException Выбрасывается если в метод была передана не строка

Returns: mixed -

public setItems() : mixed

public setItems(\YooKassa\Request\Receipts\ReceiptResponseItemInterface[] $value) : mixed

Summary

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

Description

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

Details:

Parameters:
Type Name Description
\YooKassa\Request\Receipts\ReceiptResponseItemInterface[] value Список товаров в заказе
Throws:
Type Description
\YooKassa\Common\Exceptions\EmptyPropertyValueException Выбрасывается если передали пустой массив значений
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException Выбрасывается если в качестве значения был передан не массив и не итератор, либо если одно из переданных значений не реализует интерфейс ReceiptItemInterface

Returns: mixed -

public setObjectId() : mixed

public setObjectId($value) : mixed

Summary

Устанавливает идентификатор платежа или возврата, для которого был сформирован чек

Details:

Parameters:
Type Name Description
value

Returns: mixed -

public setOnBehalfOf() : mixed

public setOnBehalfOf(string $value) : mixed

Summary

Возвращает идентификатор магазина, от имени которого нужно отправить чек

Details:

Parameters:
Type Name Description
string value Идентификатор магазина, от имени которого нужно отправить чек

Returns: mixed -

public setReceiptIndustryDetails() : mixed

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

Summary

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

Details:

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:

Parameters:
Type Name Description
array OR \YooKassa\Model\Receipt\OperationalDetails value Операционный реквизит чека
Throws:
Type Description
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException Выбрасывается если переданный аргумент - не массив

Returns: mixed -

public setRegisteredAt() : mixed

public setRegisteredAt(\DateTime $registered_at) : mixed

Summary

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

Details:

Parameters:
Type Name Description
\DateTime registered_at Дата и время формирования чека в фискальном накопителе

Returns: mixed -

public setSettlements() : mixed

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

Summary

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

Details:

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

Returns: mixed -

public setSpecificProperties() : void

Abstract public setSpecificProperties(array $receiptData) : void

Summary

Установка свойств, присущих конкретному объекту

Details:

Parameters:
Type Name Description
array receiptData

Returns: void -

public setStatus() : \YooKassa\Request\Receipts\AbstractReceiptResponse

public setStatus(string $value) : \YooKassa\Request\Receipts\AbstractReceiptResponse

Summary

Устанавливает состояние регистрации фискального чека

Details:

Parameters:
Type Name Description
string value Состояние регистрации фискального чека
Throws:
Type Description
\YooKassa\Common\Exceptions\InvalidPropertyValueException Выбрасывается если переданное состояние регистрации не существует
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException Выбрасывается если переданный аргумент не строка

Returns: \YooKassa\Request\Receipts\AbstractReceiptResponse -

public setTaxSystemCode() : mixed

public setTaxSystemCode(int $value) : mixed

Summary

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

Details:

Parameters:
Type Name Description
int value Код системы налогообложения. Число 1-6
Throws:
Type Description
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException Выбрасывается если переданный аргумент - не число
\YooKassa\Common\Exceptions\InvalidPropertyValueException Выбрасывается если переданный аргумент меньше одного или больше шести

Returns: mixed -

public setType() : mixed

public setType(string $value) : mixed

Summary

Устанавливает типа чека

Details:

Parameters:
Type Name Description
string value Тип чека
Throws:
Type Description
\YooKassa\Common\Exceptions\InvalidPropertyValueException Выбрасывается если переданная строка не является валидным типом
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException Выбрасывается если в метод была передана не строка

Returns: mixed -

public toArray() : array

public toArray() : array

Summary

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

Details:

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

protected getUnknownProperties() : array

protected getUnknownProperties() : array

Summary

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

Details:

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


Top Namespaces


Reports


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

© 2023 YooMoney