geckon01/yookassa-sdk-php
1
0
Fork 0
mirror of https://git.yoomoney.ru/scm/sdk/yookassa-sdk-php.git synced 2026-08-18 02:36:28 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
27c2aef05a6d30e508fdb99dab49cd5e205bb5ee
yookassa-sdk-php/docs/classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md
T
Антон Н. Николаев 27c2aef05a Добавлена поддержка кассовых ссылок в СБП
2025-07-01 14:52:30 +03:00

58 KiB
Raw 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".
protected $_fiscal_attribute
protected $_fiscal_document_number
protected $_fiscal_provider_id
protected $_fiscal_storage_number
protected $_id
protected $_items
protected $_object_id
protected $_on_behalf_of
protected $_receipt_industry_details
protected $_receipt_operational_details
protected $_registered_at
protected $_settlements
protected $_status
protected $_tax_system_code
protected $_type

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 getValidator()
public jsonSerialize() Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации.
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() Возвращает массив свойств которые не существуют, но были заданы у объекта.
protected validatePropertyValue()

Details

Tags

Tag Version Description
category Class
author cms@yoomoney.ru

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

Description

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

Type: IndustryDetails[]

Details:

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

Description

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

Type: OperationalDetails

Details:

public $receiptIndustryDetails : \YooKassa\Common\ListObjectInterface|\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\Common\ListObjectInterface|\YooKassa\Model\Receipt\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:

protected $_fiscal_attribute : ?string

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

protected $_fiscal_document_number : ?string

Type: ?string Номер фискального документа. Details:

protected $_fiscal_provider_id : ?string

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

protected $_fiscal_storage_number : ?string

Type: ?string Номер фискального накопителя в кассовом аппарате. Details:

protected $_id : ?string

Type: ?string Идентификатор чека в ЮKassa. Details:

protected $_items : ?\YooKassa\Common\ListObject

Type: ListObject Список товаров в заказе Details:

protected $_object_id : ?string

Type: ?string Идентификатор объекта чека Details:

protected $_on_behalf_of : ?string

Type: ?string Идентификатор магазина Details:

protected $_receipt_industry_details : ?\YooKassa\Common\ListObject

Type: ListObject Отраслевой реквизит предмета расчета Details:

protected $_receipt_operational_details : ?\YooKassa\Model\Receipt\OperationalDetails

Type: OperationalDetails Операционный реквизит чека Details:

protected $_registered_at : ?\DateTime

Type: DateTime Дата и время формирования чека в фискальном накопителе. Указывается в формате ISO 8601. Details:

protected $_settlements : ?\YooKassa\Common\ListObject

Type: ListObject Список оплат Details:

protected $_status : ?string

Type: ?string Статус доставки данных для чека в онлайн-кассу "pending", "succeeded" или "canceled". Details:

protected $_tax_system_code : ?int

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

protected $_type : ?string

Type: ?string Тип чека в онлайн-кассе: приход "payment" или возврат "refund". 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 addItem() : void

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

Summary

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

Details:

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

Returns: void -

public addSettlement() : void

public addSettlement(\YooKassa\Model\Receipt\SettlementInterface $value) : void

Summary

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

Details:

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

Returns: void -

public fromArray() : void

public fromArray(mixed $sourceArray) : void

Summary

AbstractReceiptResponse constructor.

Details:

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

Returns: void -

public getFiscalAttribute() : string|null

public getFiscalAttribute() : string|null

Summary

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

Details:

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

public getFiscalDocumentNumber() : string|null

public getFiscalDocumentNumber() : string|null

Summary

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

Details:

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

public getFiscalProviderId() : string|null

public getFiscalProviderId() : string|null

Summary

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

Details:

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

public getFiscalStorageNumber() : string|null

public getFiscalStorageNumber() : string|null

Summary

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

Details:

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

public getId() : string|null

public getId() : string|null

Summary

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

Details:

Returns: string|null - Идентификатор чека в ЮKassa

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

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

Summary

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

Details:

Returns: \YooKassa\Request\Receipts\ReceiptResponseItemInterface[]|\YooKassa\Common\ListObjectInterface -

public getObjectId() : string|null

public getObjectId() : string|null

Summary

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

Details:

Returns: string|null -

public getOnBehalfOf() : string|null

public getOnBehalfOf() : string|null

Summary

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

Details:

Returns: string|null -

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

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

Summary

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

Details:

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

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

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

Summary

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

Details:

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

public getRegisteredAt() : \DateTime|null

public getRegisteredAt() : \DateTime|null

Summary

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

Details:

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

public getSettlements() : \YooKassa\Model\Receipt\SettlementInterface[]|\YooKassa\Common\ListObjectInterface

public getSettlements() : \YooKassa\Model\Receipt\SettlementInterface[]|\YooKassa\Common\ListObjectInterface

Summary

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

Details:

Returns: \YooKassa\Model\Receipt\SettlementInterface[]|\YooKassa\Common\ListObjectInterface -

public getStatus() : string|null

public getStatus() : string|null

Summary

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

Details:

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

public getTaxSystemCode() : int|null

public getTaxSystemCode() : int|null

Summary

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

Details:

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

public getType() : string|null

public getType() : string|null

Summary

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

Details:

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

public getValidator() : \YooKassa\Validator\Validator

public getValidator() : \YooKassa\Validator\Validator

Details:

Returns: \YooKassa\Validator\Validator -

public jsonSerialize() : array

public jsonSerialize() : array

Summary

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

Details:

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

public notEmpty() : bool

public notEmpty() : bool

Summary

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

Details:

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

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

public setFiscalAttribute(string|null $fiscal_attribute = null) : self

Summary

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

Details:

Parameters:
Type Name Description
string OR null fiscal_attribute Фискальный признак чека. Формируется фискальным накопителем на основе данных, переданных для регистрации чека.

Returns: self -

public setFiscalDocumentNumber() : self

public setFiscalDocumentNumber(string|null $fiscal_document_number = null) : self

Summary

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

Details:

Parameters:
Type Name Description
string OR null fiscal_document_number Номер фискального документа.

Returns: self -

public setFiscalProviderId() : self

public setFiscalProviderId(string|null $fiscal_provider_id = null) : self

Summary

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

Details:

Parameters:
Type Name Description
string OR null fiscal_provider_id Идентификатор чека в онлайн-кассе. Присутствует, если чек удалось зарегистрировать.

Returns: self -

public setFiscalStorageNumber() : self

public setFiscalStorageNumber(string|null $fiscal_storage_number = null) : self

Summary

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

Details:

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

Returns: self -

public setId() : self

public setId(string $id) : self

Summary

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

Details:

Parameters:
Type Name Description
string id Идентификатор чека

Returns: self -

public setItems() : self

public setItems(\YooKassa\Request\Receipts\ReceiptResponseItemInterface[]|null $items) : self

Summary

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

Details:

Parameters:
Type Name Description
\YooKassa\Request\Receipts\ReceiptResponseItemInterface[] OR null items Список товаров в заказе

Returns: self -

public setObjectId() : self

public setObjectId(string|null $object_id) : self

Summary

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

Details:

Parameters:
Type Name Description
string OR null object_id

Returns: self -

public setOnBehalfOf() : self

public setOnBehalfOf(string|null $on_behalf_of = null) : self

Summary

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

Details:

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

Returns: self -

public setReceiptIndustryDetails() : self

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

Summary

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

Details:

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

Returns: self -

public setReceiptOperationalDetails() : self

public setReceiptOperationalDetails(array|\YooKassa\Model\Receipt\OperationalDetails|null $receipt_operational_details = null) : self

Summary

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

Details:

Parameters:
Type Name Description
array OR \YooKassa\Model\Receipt\OperationalDetails OR null receipt_operational_details Операционный реквизит чека

Returns: self -

public setRegisteredAt() : self

public setRegisteredAt(\DateTime|string|null $registered_at = null) : self

Summary

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

Details:

Parameters:
Type Name Description
\DateTime OR string OR null registered_at Дата и время формирования чека в фискальном накопителе. Указывается в формате ISO 8601.

Returns: self -

public setSettlements() : self

public setSettlements(\YooKassa\Model\Receipt\SettlementInterface[]|null $settlements) : self

Summary

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

Details:

Parameters:
Type Name Description
\YooKassa\Model\Receipt\SettlementInterface[] OR null settlements

Returns: self -

public setSpecificProperties() : void

Abstract public setSpecificProperties(array $receiptData) : void

Summary

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

Details:

Parameters:
Type Name Description
array receiptData

Returns: void -

public setStatus() : self

public setStatus(string|null $status) : self

Summary

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

Details:

Parameters:
Type Name Description
string OR null status Состояние регистрации фискального чека

Returns: self -

public setTaxSystemCode() : self

public setTaxSystemCode(int|null $tax_system_code) : self

Summary

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

Details:

Parameters:
Type Name Description
int OR null tax_system_code Код системы налогообложения. Число 1-6

Returns: self -

public setType() : self

public setType(string $type) : self

Summary

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

Details:

Parameters:
Type Name Description
string type Тип чека

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-07-01 using phpDocumentor

© 2025 YooMoney

Reference in New Issue View Git Blame Copy Permalink