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

YooKassa API SDK

Class: \YooKassa\Model\Invoice\Invoice

Namespace: \YooKassa\Model\Invoice

---

Summary:

Класс, представляющий модель Invoice.

Description:

Объект счета (Invoice) — актуальная информация о счете.

---

Constants

• No constants found

---

Properties

Visibility	Name	Flag	Summary
public	$cancellation_details		Комментарий к статусу canceled: кто отменил счет и по какой причине.
public	$cancellationDetails		Комментарий к статусу canceled: кто отменил счет и по какой причине.
public	$cart		Корзина заказа — список товаров или услуг, который отобразится на странице счета перед оплатой.
public	$created_at		Дата и время создания счета на оплату. Указывается по UTC и передается в формате ISO 8601. Пример: 2017-11-03T11:52:31.827Z
public	$createdAt		Дата и время создания счета на оплату. Указывается по UTC и передается в формате ISO 8601. Пример: 2017-11-03T11:52:31.827Z
public	$delivery_method		Данные о выбранном способе доставки счета. Присутствует только для счетов в статусе pending.
public	$deliveryMethod		Данные о выбранном способе доставки счета. Присутствует только для счетов в статусе pending.
public	$description		Описание выставленного счета (не более 128 символов), которое вы увидите в личном кабинете ЮKassa, а пользователь на странице счета. Например: «Счет на оплату по договору 37».
public	$expires_at		Срок действия счета — дата и время, до которых можно оплатить выставленный счет. Указывается по UTC и передается в формате ISO 8601. Пример: 2024-10-18T10:51:18.139Z Присутствует только для счетов в статусе pending.
public	$expiresAt		Срок действия счета — дата и время, до которых можно оплатить выставленный счет. Указывается по UTC и передается в формате ISO 8601. Пример: 2024-10-18T10:51:18.139Z Присутствует только для счетов в статусе pending.
public	$id		Идентификатор счета в ЮKassa.
public	$metadata		Любые дополнительные данные, которые нужны вам для работы (например, ваш внутренний идентификатор заказа). Передаются в виде набора пар «ключ-значение» и возвращаются в ответе от ЮKassa. Ограничения: максимум 16 ключей, имя ключа не больше 32 символов, значение ключа не больше 512 символов, тип данных — строка в формате UTF-8.
public	$payment_details		Данные о платеже по выставленному счету. Присутствуют, только если платеж успешно подтвержден пользователем.
public	$paymentDetails		Данные о платеже по выставленному счету. Присутствуют, только если платеж успешно подтвержден пользователем.
public	$status		Статус счета. Возможные значения: pending, succeeded, canceled.
protected	$_cancellation_details		Комментарий к статусу canceled: кто отменил счет и по какой причине.
protected	$_cart		Корзина заказа — список товаров или услуг, который отобразится на странице счета перед оплатой.
protected	$_created_at		Дата и время создания счета на оплату. Указывается по UTC и передается в формате ISO 8601.
protected	$_delivery_method		Данные о выбранном способе доставки счета. Присутствует только для счетов в статусе pending.
protected	$_description		Описание выставленного счета (не более 128 символов), которое вы увидите в личном кабинете ЮKassa, а пользователь на странице счета.
protected	$_expires_at		Срок действия счета — дата и время, до которых можно оплатить выставленный счет. Указывается по UTC и передается в формате ISO 8601.
protected	$_id		Идентификатор счета в ЮKassa.
protected	$_metadata		Любые дополнительные данные, которые нужны вам для работы (например, ваш внутренний идентификатор заказа).
protected	$_payment_details		Данные о платеже по выставленному счету. Присутствуют, только если платеж успешно подтвержден пользователем.
protected	$_status		Статус счета. Возможные значения: pending, succeeded, canceled.

---

Methods

Visibility	Name	Flag	Summary
public	__construct()		AbstractObject constructor.
public	__get()		Возвращает значение свойства.
public	__isset()		Проверяет наличие свойства.
public	__set()		Устанавливает значение свойства.
public	__unset()		Удаляет свойство.
public	fromArray()		Устанавливает значения свойств текущего объекта из массива.
public	getCancellationDetails()		Возвращает cancellation_details.
public	getCart()		Возвращает cart.
public	getCreatedAt()		Возвращает created_at.
public	getDeliveryMethod()		Возвращает delivery_method.
public	getDescription()		Возвращает description.
public	getExpiresAt()		Возвращает expires_at.
public	getId()		Возвращает id.
public	getMetadata()		Возвращает metadata.
public	getPaymentDetails()		Возвращает payment_details.
public	getStatus()		Возвращает status.
public	getValidator()
public	jsonSerialize()		Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации.
public	offsetExists()		Проверяет наличие свойства.
public	offsetGet()		Возвращает значение свойства.
public	offsetSet()		Устанавливает значение свойства.
public	offsetUnset()		Удаляет свойство.
public	setCancellationDetails()		Устанавливает cancellation_details.
public	setCart()		Устанавливает cart.
public	setCreatedAt()		Устанавливает created_at.
public	setDeliveryMethod()		Устанавливает delivery_method.
public	setDescription()		Устанавливает description.
public	setExpiresAt()		Устанавливает expires_at.
public	setId()		Устанавливает id.
public	setMetadata()		Устанавливает metadata.
public	setPaymentDetails()		Устанавливает payment_details.
public	setStatus()		Устанавливает status.
public	toArray()		Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize().
protected	getUnknownProperties()		Возвращает массив свойств которые не существуют, но были заданы у объекта.
protected	validatePropertyValue()

---

Details

• File: lib/Model/Invoice/Invoice.php

• Package: YooKassa\Model

• Class Hierarchy:

  • \YooKassa\Common\AbstractObject
  • \YooKassa\Model\Invoice\Invoice

• Implements:

  • \YooKassa\Model\Invoice\InvoiceInterface

• See Also:

---

Tags

Tag	Version	Description
category		Class
author		cms@yoomoney.ru

---

Properties

public $cancellation_details : \YooKassa\Model\Invoice\InvoiceCancellationDetails|null

---

Description

Комментарий к статусу canceled: кто отменил счет и по какой причине.

Type: InvoiceCancellationDetails|null

Details:

public $cancellationDetails : \YooKassa\Model\Invoice\InvoiceCancellationDetails|null

---

Description

Комментарий к статусу canceled: кто отменил счет и по какой причине.

Type: InvoiceCancellationDetails|null

Details:

public $cart : \YooKassa\Model\Invoice\LineItem[]|\YooKassa\Common\ListObjectInterface

---

Description

Корзина заказа — список товаров или услуг, который отобразится на странице счета перед оплатой.

Type: ListObjectInterface

Details:

public $created_at : \DateTime

---

Description

Дата и время создания счета на оплату. Указывается по UTC и передается в формате ISO 8601. Пример: 2017-11-03T11:52:31.827Z

Type: \DateTime

Details:

public $createdAt : \DateTime

---

Description

Дата и время создания счета на оплату. Указывается по UTC и передается в формате ISO 8601. Пример: 2017-11-03T11:52:31.827Z

Type: \DateTime

Details:

public $delivery_method : \YooKassa\Model\Invoice\DeliveryMethod\AbstractDeliveryMethod|null

---

Description

Данные о выбранном способе доставки счета. Присутствует только для счетов в статусе pending.

Type: AbstractDeliveryMethod|null

Details:

public $deliveryMethod : \YooKassa\Model\Invoice\DeliveryMethod\AbstractDeliveryMethod|null

---

Description

Данные о выбранном способе доставки счета. Присутствует только для счетов в статусе pending.

Type: AbstractDeliveryMethod|null

Details:

public $description : string|null

---

Description

Описание выставленного счета (не более 128 символов), которое вы увидите в личном кабинете ЮKassa, а пользователь на странице счета. Например: «Счет на оплату по договору 37».

Type: string|null

Details:

public $expires_at : \DateTime|null

---

Description

Срок действия счета — дата и время, до которых можно оплатить выставленный счет. Указывается по UTC и передается в формате ISO 8601. Пример: 2024-10-18T10:51:18.139Z Присутствует только для счетов в статусе pending.

Type: DateTime|null

Details:

public $expiresAt : \DateTime|null

---

Description

Срок действия счета — дата и время, до которых можно оплатить выставленный счет. Указывается по UTC и передается в формате ISO 8601. Пример: 2024-10-18T10:51:18.139Z Присутствует только для счетов в статусе pending.

Type: DateTime|null

Details:

public $id : string

---

Description

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

Type: string

Details:

public $metadata : \YooKassa\Model\Metadata|null

---

Description

Любые дополнительные данные, которые нужны вам для работы (например, ваш внутренний идентификатор заказа). Передаются в виде набора пар «ключ-значение» и возвращаются в ответе от ЮKassa. Ограничения: максимум 16 ключей, имя ключа не больше 32 символов, значение ключа не больше 512 символов, тип данных — строка в формате UTF-8.

Type: Metadata|null

Details:

public $payment_details : \YooKassa\Model\Invoice\PaymentDetails|null

---

Description

Данные о платеже по выставленному счету. Присутствуют, только если платеж успешно подтвержден пользователем.

Type: PaymentDetails|null

Details:

public $paymentDetails : \YooKassa\Model\Invoice\PaymentDetails|null

---

Description

Данные о платеже по выставленному счету. Присутствуют, только если платеж успешно подтвержден пользователем.

Type: PaymentDetails|null

Details:

public $status : string

---

Description

Статус счета. Возможные значения: pending, succeeded, canceled.

Type: string

Details:

protected $_cancellation_details : ?\YooKassa\Model\Invoice\InvoiceCancellationDetails

---

Summary

Комментарий к статусу canceled: кто отменил счет и по какой причине.

Type: InvoiceCancellationDetails

Details:

protected $_cart : ?\YooKassa\Common\ListObjectInterface

---

Summary

Корзина заказа — список товаров или услуг, который отобразится на странице счета перед оплатой.

Type: ListObjectInterface

Details:

protected $_created_at : ?\DateTime

---

Summary

Дата и время создания счета на оплату. Указывается по UTC и передается в формате ISO 8601.

Description

Пример: ~2017-11-03T11:52:31.827Z

Type: DateTime

Details:

protected $_delivery_method : ?\YooKassa\Model\Invoice\DeliveryMethod\AbstractDeliveryMethod

---

Summary

Данные о выбранном способе доставки счета. Присутствует только для счетов в статусе pending.

Type: AbstractDeliveryMethod

Details:

protected $_description : ?string

---

Summary

Описание выставленного счета (не более 128 символов), которое вы увидите в личном кабинете ЮKassa, а пользователь на странице счета.

Description

Например: «Счет на оплату по договору 37».

Type: ?string

Details:

protected $_expires_at : ?\DateTime

---

Summary

Срок действия счета — дата и время, до которых можно оплатить выставленный счет. Указывается по UTC и передается в формате ISO 8601.

Description

Пример: 2024-10-18T10:51:18.139Z

Присутствует только для счетов в статусе pending.

Type: DateTime

Details:

protected $_id : ?string

---

Summary

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

Type: ?string

Details:

protected $_metadata : ?\YooKassa\Model\Metadata

---

Summary

Любые дополнительные данные, которые нужны вам для работы (например, ваш внутренний идентификатор заказа).

Description

Передаются в виде набора пар «ключ-значение» и возвращаются в ответе от ЮKassa. Ограничения: максимум 16 ключей, имя ключа не больше 32 символов, значение ключа не больше 512 символов, тип данных — строка в формате UTF-8.

Type: Metadata

Details:

protected $_payment_details : ?\YooKassa\Model\Invoice\PaymentDetails

---

Summary

Данные о платеже по выставленному счету. Присутствуют, только если платеж успешно подтвержден пользователем.

Type: PaymentDetails

Details:

protected $_status : ?string

---

Summary

Статус счета. Возможные значения: pending, succeeded, canceled.

Type: ?string

Details:

---

Methods

public __construct() : mixed

public __construct(array|null $data = []) : mixed

Summary

AbstractObject constructor.

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
array OR null	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() : void

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

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

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

Returns: void -

public __unset() : void

public __unset(string $propertyName) : void

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

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

Returns: void -

public fromArray() : void

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

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

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

Returns: void -

public getCancellationDetails() : \YooKassa\Model\Invoice\InvoiceCancellationDetails|null

public getCancellationDetails() : \YooKassa\Model\Invoice\InvoiceCancellationDetails|null

Summary

Возвращает cancellation_details.

Details:

• Inherited From: \YooKassa\Model\Invoice\Invoice

Returns: \YooKassa\Model\Invoice\InvoiceCancellationDetails|null - Комментарий к статусу canceled

public getCart() : \YooKassa\Model\Invoice\LineItem[]|\YooKassa\Common\ListObjectInterface|null

public getCart() : \YooKassa\Model\Invoice\LineItem[]|\YooKassa\Common\ListObjectInterface|null

Summary

Возвращает cart.

Details:

• Inherited From: \YooKassa\Model\Invoice\Invoice

Returns: \YooKassa\Model\Invoice\LineItem[]|\YooKassa\Common\ListObjectInterface|null - Корзина заказа — список товаров или услуг, который отобразится на странице счета перед оплатой

public getCreatedAt() : \DateTime|null

public getCreatedAt() : \DateTime|null

Summary

Возвращает created_at.

Details:

• Inherited From: \YooKassa\Model\Invoice\Invoice

Returns: \DateTime|null - Дата и время создания счета на оплату

public getDeliveryMethod() : \YooKassa\Model\Invoice\DeliveryMethod\AbstractDeliveryMethod|\YooKassa\Model\Invoice\DeliveryMethod\DeliveryMethodSelf|null

public getDeliveryMethod() : \YooKassa\Model\Invoice\DeliveryMethod\AbstractDeliveryMethod|\YooKassa\Model\Invoice\DeliveryMethod\DeliveryMethodSelf|null

Summary

Возвращает delivery_method.

Details:

• Inherited From: \YooKassa\Model\Invoice\Invoice

Returns: \YooKassa\Model\Invoice\DeliveryMethod\AbstractDeliveryMethod|\YooKassa\Model\Invoice\DeliveryMethod\DeliveryMethodSelf|null - Данные о выбранном способе доставки счета

public getDescription() : string|null

public getDescription() : string|null

Summary

Возвращает description.

Details:

• Inherited From: \YooKassa\Model\Invoice\Invoice

Returns: string|null - Описание выставленного счета

public getExpiresAt() : \DateTime|null

public getExpiresAt() : \DateTime|null

Summary

Возвращает expires_at.

Details:

• Inherited From: \YooKassa\Model\Invoice\Invoice

Returns: \DateTime|null - Срок действия счета

public getId() : string|null

public getId() : string|null

Summary

Возвращает id.

Details:

• Inherited From: \YooKassa\Model\Invoice\Invoice

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

public getMetadata() : \YooKassa\Model\Metadata|null

public getMetadata() : \YooKassa\Model\Metadata|null

Summary

Возвращает metadata.

Details:

• Inherited From: \YooKassa\Model\Invoice\Invoice

Returns: \YooKassa\Model\Metadata|null - Любые дополнительные данные

public getPaymentDetails() : \YooKassa\Model\Invoice\PaymentDetails|null

public getPaymentDetails() : \YooKassa\Model\Invoice\PaymentDetails|null

Summary

Возвращает payment_details.

Details:

• Inherited From: \YooKassa\Model\Invoice\Invoice

Returns: \YooKassa\Model\Invoice\PaymentDetails|null - Данные о платеже по выставленному счету

public getStatus() : string|null

public getStatus() : string|null

Summary

Возвращает status.

Details:

• Inherited From: \YooKassa\Model\Invoice\Invoice

Returns: string|null - Статус счета

public getValidator() : \YooKassa\Validator\Validator

public getValidator() : \YooKassa\Validator\Validator

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Returns: \YooKassa\Validator\Validator -

public jsonSerialize() : array

public jsonSerialize() : array

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractObject

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

public offsetExists() : bool

public offsetExists(string $offset) : bool

Summary

Проверяет наличие свойства.

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
string	offset	Имя проверяемого свойства

Returns: bool - True если свойство имеется, false если нет

public offsetGet() : mixed

public offsetGet(string $offset) : mixed

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
string	offset	Имя свойства

Returns: mixed - Значение свойства

public offsetSet() : void

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

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

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

Returns: void -

public offsetUnset() : void

public offsetUnset(string $offset) : void

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

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

Returns: void -

public setCancellationDetails() : self

public setCancellationDetails(\YooKassa\Model\Invoice\InvoiceCancellationDetails|array|null $cancellation_details = null) : self

Summary

Устанавливает cancellation_details.

Details:

• Inherited From: \YooKassa\Model\Invoice\Invoice

Parameters:

Type	Name	Description
\YooKassa\Model\Invoice\InvoiceCancellationDetails OR array OR null	cancellation_details	Комментарий к статусу canceled

Returns: self -

public setCart() : self

public setCart(\YooKassa\Common\ListObjectInterface|\YooKassa\Model\Invoice\LineItem[]|array|null $cart = null) : self

Summary

Устанавливает cart.

Details:

• Inherited From: \YooKassa\Model\Invoice\Invoice

Parameters:

Type	Name	Description
\YooKassa\Common\ListObjectInterface OR \YooKassa\Model\Invoice\LineItem[] OR array OR null	cart	Корзина заказа — список товаров или услуг, который отобразится на странице счета перед оплатой

Returns: self -

public setCreatedAt() : self

public setCreatedAt(\DateTime|string|null $created_at = null) : self

Summary

Устанавливает created_at.

Details:

• Inherited From: \YooKassa\Model\Invoice\Invoice

Parameters:

Type	Name	Description
\DateTime OR string OR null	created_at	Дата и время создания счета на оплату

Returns: self -

public setDeliveryMethod() : self

public setDeliveryMethod(\YooKassa\Model\Invoice\DeliveryMethod\AbstractDeliveryMethod|array|null $delivery_method = null) : self

Summary

Устанавливает delivery_method.

Details:

• Inherited From: \YooKassa\Model\Invoice\Invoice

Parameters:

Type	Name	Description
\YooKassa\Model\Invoice\DeliveryMethod\AbstractDeliveryMethod OR array OR null	delivery_method	Данные о выбранном способе доставки счета

Returns: self -

public setDescription() : self

public setDescription(string|null $description = null) : self

Summary

Устанавливает description.

Details:

• Inherited From: \YooKassa\Model\Invoice\Invoice

Parameters:

Type	Name	Description
string OR null	description	Описание выставленного счета (не более 128 символов), которое вы увидите в личном кабинете ЮKassa, а пользователь на странице счета. Например: «Счет на оплату по договору 37».

Returns: self -

public setExpiresAt() : self

public setExpiresAt(\DateTime|array|null $expires_at = null) : self

Summary

Устанавливает expires_at.

Details:

• Inherited From: \YooKassa\Model\Invoice\Invoice

Parameters:

Type	Name	Description
\DateTime OR array OR null	expires_at	Срок действия счета

Returns: self -

public setId() : self

public setId(string|null $id = null) : self

Summary

Устанавливает id.

Details:

• Inherited From: \YooKassa\Model\Invoice\Invoice

Parameters:

Type	Name	Description
string OR null	id	Идентификатор счета в ЮKassa.

Returns: self -

public setMetadata() : self

public setMetadata(\YooKassa\Model\Metadata|array|null $metadata = null) : self

Summary

Устанавливает metadata.

Details:

• Inherited From: \YooKassa\Model\Invoice\Invoice

Parameters:

Type	Name	Description
\YooKassa\Model\Metadata OR array OR null	metadata	Любые дополнительные данные, которые нужны вам для работы (например, ваш внутренний идентификатор заказа).

Returns: self -

public setPaymentDetails() : self

public setPaymentDetails(\YooKassa\Model\Invoice\PaymentDetails|array|null $payment_details = null) : self

Summary

Устанавливает payment_details.

Details:

• Inherited From: \YooKassa\Model\Invoice\Invoice

Parameters:

Type	Name	Description
\YooKassa\Model\Invoice\PaymentDetails OR array OR null	payment_details	Данные о платеже по выставленному счету

Returns: self -

public setStatus() : self

public setStatus(string|null $status = null) : self

Summary

Устанавливает status.

Details:

• Inherited From: \YooKassa\Model\Invoice\Invoice

Parameters:

Type	Name	Description
string OR null	status	Статус счета

Returns: self -

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 - Ассоциативный массив с не существующими у текущего объекта свойствами

protected validatePropertyValue() : mixed

protected validatePropertyValue(string $propertyName, mixed $propertyValue) : mixed

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
string	propertyName
mixed	propertyValue

Returns: mixed -

---

Top Namespaces

• \YooKassa

---

Reports

• Errors - 0
• Markers - 0
• Deprecated - 43

---

This document was automatically generated from source code comments on 2026-06-29 using phpDocumentor

© 2026 YooMoney