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

YooKassa API SDK

Interface: InvoiceInterface

Namespace: \YooKassa\Model\Invoice

---

Summary:

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

Description:

Данные о счете.

---

Constants

Visibility	Name	Flag	Summary

• public MIN_LENGTH_ID
• public MAX_LENGTH_ID
• public MAX_LENGTH_DESCRIPTION

---

Methods

Visibility	Name	Flag	Summary
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	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.

---

Details

• File: lib/Model/Invoice/InvoiceInterface.php
• Package: \YooKassa\Model
• See Also:

---

Tags

Tag	Version	Description
category		Class
author		cms@yoomoney.ru
property		Идентификатор счета в ЮKassa.
property		Статус счета. Возможные значения: pending, succeeded, canceled.
property		Корзина заказа — список товаров или услуг, который отобразится на странице счета перед оплатой.
property		Данные о выбранном способе доставки счета. Присутствует только для счетов в статусе pending.
property		Данные о выбранном способе доставки счета. Присутствует только для счетов в статусе pending.
property		Данные о платеже по выставленному счету. Присутствуют, только если платеж успешно подтвержден пользователем.
property		Данные о платеже по выставленному счету. Присутствуют, только если платеж успешно подтвержден пользователем.
property		Дата и время создания счета на оплату. Указывается по UTC и передается в формате ISO 8601. Пример: 2017-11-03T11:52:31.827Z
property		Дата и время создания счета на оплату. Указывается по UTC и передается в формате ISO 8601. Пример: 2017-11-03T11:52:31.827Z
property		Срок действия счета — дата и время, до которых можно оплатить выставленный счет. Указывается по UTC и передается в формате ISO 8601. Пример: 2024-10-18T10:51:18.139Z Присутствует только для счетов в статусе pending.
property		Срок действия счета — дата и время, до которых можно оплатить выставленный счет. Указывается по UTC и передается в формате ISO 8601. Пример: 2024-10-18T10:51:18.139Z Присутствует только для счетов в статусе pending.
property		Описание выставленного счета (не более 128 символов), которое вы увидите в личном кабинете ЮKassa, а пользователь на странице счета. Например: «Счет на оплату по договору 37».
property		Комментарий к статусу canceled: кто отменил счет и по какой причине.
property		Комментарий к статусу canceled: кто отменил счет и по какой причине.
property		Любые дополнительные данные, которые нужны вам для работы (например, ваш внутренний идентификатор заказа). Передаются в виде набора пар «ключ-значение» и возвращаются в ответе от ЮKassa. Ограничения: максимум 16 ключей, имя ключа не больше 32 символов, значение ключа не больше 512 символов, тип данных — строка в формате UTF-8./

---

Constants

MIN_LENGTH_ID

MIN_LENGTH_ID = 39 : int

MAX_LENGTH_ID

MAX_LENGTH_ID = 39 : int

MAX_LENGTH_DESCRIPTION

MAX_LENGTH_DESCRIPTION = 128 : int

---

Methods

public getId() : string|null

public getId() : string|null

Summary

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

Details:

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

Returns: string|null -

public setId() : self

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

Summary

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

Details:

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

Parameters:

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

Returns: self -

public getStatus() : string|null

public getStatus() : string|null

Summary

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

Details:

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

Returns: string|null -

public setStatus() : self

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

Summary

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

Details:

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

Parameters:

Type	Name	Description
string OR null	status

Returns: self -

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\InvoiceInterface

Returns: \YooKassa\Model\Invoice\LineItem[]|\YooKassa\Common\ListObjectInterface|null -

public setCart() : self

public setCart(\YooKassa\Common\ListObjectInterface|array|null $cart = null) : self

Summary

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

Details:

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

Parameters:

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

Returns: self -

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\InvoiceInterface

Returns: \YooKassa\Model\Invoice\DeliveryMethod\AbstractDeliveryMethod|\YooKassa\Model\Invoice\DeliveryMethod\DeliveryMethodSelf|null -

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\InvoiceInterface

Parameters:

Type	Name	Description
\YooKassa\Model\Invoice\DeliveryMethod\AbstractDeliveryMethod OR array OR null	delivery_method

Returns: self -

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

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

Summary

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

Details:

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

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

public setPaymentDetails() : self

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

Summary

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

Details:

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

Parameters:

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

Returns: self -

public getCreatedAt() : \DateTime|null

public getCreatedAt() : \DateTime|null

Summary

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

Details:

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

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

public setCreatedAt() : self

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

Summary

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

Details:

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

Parameters:

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

Returns: self -

public getExpiresAt() : \DateTime|null

public getExpiresAt() : \DateTime|null

Summary

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

Details:

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

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

public setExpiresAt() : self

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

Summary

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

Details:

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

Parameters:

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

Returns: self -

public getDescription() : string|null

public getDescription() : string|null

Summary

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

Details:

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

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

public setDescription() : self

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

Summary

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

Details:

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

Parameters:

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

Returns: self -

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

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

Summary

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

Details:

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

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

public setCancellationDetails() : self

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

Summary

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

Details:

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

Parameters:

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

Returns: self -

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

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

Summary

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

Details:

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

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

public setMetadata() : self

public setMetadata(string|array|null $metadata = null) : self

Summary

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

Details:

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

Parameters:

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

Returns: self -

---

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