yookassa-sdk-php/docs/classes/YooKassa-Request-Invoices-CreateInvoiceRequest.md

YooKassa API SDK

Class: \YooKassa\Request\Invoices\CreateInvoiceRequest

Namespace: \YooKassa\Request\Invoices

---

Summary:

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

---

Constants

• No constants found

---

Properties

Visibility	Name	Flag	Summary
public	$cart		Корзина заказа — список товаров или услуг, который отобразится на странице счета перед оплатой.
public	$delivery_method_data		Данные о способе доставки счета пользователю. Доступен только один способ — самостоятельная доставка: ЮKassa возвращает вам ссылку на счет, и вы передаете ее пользователю любым удобным для вас способом.
public	$description		Описание выставленного счета (не более 128 символов), которое вы увидите в личном кабинете ЮKassa, а пользователь на странице счета. Например: «Счет на оплату по договору 37».
public	$expires_at		Срок действия счета — дата и время, до которых можно оплатить выставленный счет. Указывается по UTC и передается в формате ISO 8601. Пример: ~2024-10-18T10:51:18.139Z
public	$locale		Язык интерфейса, писем и смс, которые будет видеть или получать пользователь. Формат соответствует ISO/IEC 15897. Возможные значения: ru_RU, en_US. Регистр важен.
public	$metadata		Любые дополнительные данные, которые нужны вам для работы (например, ваш внутренний идентификатор заказа). Передаются в виде набора пар «ключ-значение» и возвращаются в ответе от ЮKassa. Ограничения: максимум 16 ключей, имя ключа не больше 32 символов, значение ключа не больше 512 символов, тип данных — строка в формате UTF-8.
public	$payment_data		Данные для проведения платежа по выставленному счету.

---

Methods

Visibility	Name	Flag	Summary
public	__construct()		AbstractObject constructor.
public	__get()		Возвращает значение свойства.
public	__isset()		Проверяет наличие свойства.
public	__set()		Устанавливает значение свойства.
public	__unset()		Удаляет свойство.
public	builder()		Возвращает билдер объектов запросов создания платежа.
public	clearValidationError()		Очищает статус валидации текущего запроса.
public	fromArray()		Устанавливает значения свойств текущего объекта из массива.
public	getCart()		Возвращает cart.
public	getDeliveryMethodData()		Возвращает delivery_method_data.
public	getDescription()		Возвращает description.
public	getExpiresAt()		Возвращает expires_at.
public	getLastValidationError()		Возвращает последнюю ошибку валидации.
public	getLocale()		Возвращает locale.
public	getMetadata()		Возвращает metadata.
public	getPaymentData()		Возвращает payment_data.
public	getValidator()
public	hasCart()		Проверяет, были ли установлены товары в корзине.
public	hasDeliveryMethodData()		Проверяет, были ли установлены данные для о способе доставки счета.
public	hasDescription()		Проверяет наличие описания транзакции в создаваемом счете.
public	hasExpiresAt()		Проверяет, был ли установлен срок действия счета.
public	hasLocale()		Проверяет наличие языка интерфейса в создаваемом счете.
public	hasMetadata()		Проверяет, были ли установлены метаданные счета.
public	hasPaymentData()		Проверяет, были ли установлены данные для проведения платежа.
public	jsonSerialize()		Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации.
public	offsetExists()		Проверяет наличие свойства.
public	offsetGet()		Возвращает значение свойства.
public	offsetSet()		Устанавливает значение свойства.
public	offsetUnset()		Удаляет свойство.
public	setCart()		Устанавливает cart.
public	setDeliveryMethodData()		Устанавливает delivery_method_data.
public	setDescription()		Устанавливает description.
public	setExpiresAt()		Устанавливает expires_at.
public	setLocale()		Устанавливает locale.
public	setMetadata()		Устанавливает metadata.
public	setPaymentData()		Устанавливает payment_data.
public	toArray()		Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize().
public	validate()		Проверяет на валидность текущий объект
protected	getUnknownProperties()		Возвращает массив свойств которые не существуют, но были заданы у объекта.
protected	setValidationError()		Устанавливает ошибку валидации.
protected	validatePropertyValue()

---

Details

• File: lib/Request/Invoices/CreateInvoiceRequest.php

• Package: YooKassa\Model

• Class Hierarchy:

  • \YooKassa\Common\AbstractObject
  • \YooKassa\Common\AbstractRequest
  • \YooKassa\Request\Invoices\CreateInvoiceRequest

• Implements:

  • \YooKassa\Request\Invoices\CreateInvoiceRequestInterface

• See Also:

---

Tags

Tag	Version	Description
category		Class
author		cms@yoomoney.ru

---

Properties

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

---

Description

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

Type: ListObjectInterface

Details:

public $delivery_method_data : \YooKassa\Request\Invoices\DeliveryMethodData\AbstractDeliveryMethodData

---

Description

Данные о способе доставки счета пользователю. Доступен только один способ — самостоятельная доставка: ЮKassa возвращает вам ссылку на счет, и вы передаете ее пользователю любым удобным для вас способом.

Type: AbstractDeliveryMethodData

Details:

public $description : string

---

Description

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

Type: string

Details:

public $expires_at : \DateTime

---

Description

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

Type: \DateTime

Details:

public $locale : string

---

Description

Язык интерфейса, писем и смс, которые будет видеть или получать пользователь. Формат соответствует ISO/IEC 15897. Возможные значения: ru_RU, en_US. Регистр важен.

Type: string

Details:

public $metadata : \YooKassa\Model\Metadata

---

Description

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

Type: Metadata

Details:

public $payment_data : \YooKassa\Request\Invoices\PaymentData

---

Description

Данные для проведения платежа по выставленному счету.

Type: PaymentData

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 builder() : \YooKassa\Request\Invoices\CreateInvoiceRequestBuilder

Static public builder() : \YooKassa\Request\Invoices\CreateInvoiceRequestBuilder

Summary

Возвращает билдер объектов запросов создания платежа.

Details:

• Inherited From: \YooKassa\Request\Invoices\CreateInvoiceRequest

Returns: \YooKassa\Request\Invoices\CreateInvoiceRequestBuilder - Инстанс билдера объектов запросов

public clearValidationError() : void

public clearValidationError() : void

Summary

Очищает статус валидации текущего запроса.

Details:

• Inherited From: \YooKassa\Common\AbstractRequest

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 getCart() : \YooKassa\Model\Invoice\LineItem[]|\YooKassa\Common\ListObjectInterface

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

Summary

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

Details:

• Inherited From: \YooKassa\Request\Invoices\CreateInvoiceRequest

Returns: \YooKassa\Model\Invoice\LineItem[]|\YooKassa\Common\ListObjectInterface - Корзина заказа — список товаров или услуг

public getDeliveryMethodData() : \YooKassa\Request\Invoices\DeliveryMethodData\AbstractDeliveryMethodData|null

public getDeliveryMethodData() : \YooKassa\Request\Invoices\DeliveryMethodData\AbstractDeliveryMethodData|null

Summary

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

Details:

• Inherited From: \YooKassa\Request\Invoices\CreateInvoiceRequest

Returns: \YooKassa\Request\Invoices\DeliveryMethodData\AbstractDeliveryMethodData|null - Данные о способе доставки счета пользователю

public getDescription() : string|null

public getDescription() : string|null

Summary

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

Details:

• Inherited From: \YooKassa\Request\Invoices\CreateInvoiceRequest

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

public getExpiresAt() : \DateTime|null

public getExpiresAt() : \DateTime|null

Summary

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

Details:

• Inherited From: \YooKassa\Request\Invoices\CreateInvoiceRequest

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

public getLastValidationError() : string|null

public getLastValidationError() : string|null

Summary

Возвращает последнюю ошибку валидации.

Details:

• Inherited From: \YooKassa\Common\AbstractRequest

Returns: string|null - Последняя произошедшая ошибка валидации

public getLocale() : string|null

public getLocale() : string|null

Summary

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

Details:

• Inherited From: \YooKassa\Request\Invoices\CreateInvoiceRequest

Returns: string|null - Язык интерфейса, писем и смс, которые будет видеть или получать пользователь

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

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

Summary

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

Details:

• Inherited From: \YooKassa\Request\Invoices\CreateInvoiceRequest

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

public getPaymentData() : \YooKassa\Request\Invoices\PaymentData|null

public getPaymentData() : \YooKassa\Request\Invoices\PaymentData|null

Summary

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

Details:

• Inherited From: \YooKassa\Request\Invoices\CreateInvoiceRequest

Returns: \YooKassa\Request\Invoices\PaymentData|null - Данные для проведения платежа по выставленному счету

public getValidator() : \YooKassa\Validator\Validator

public getValidator() : \YooKassa\Validator\Validator

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Returns: \YooKassa\Validator\Validator -

public hasCart() : bool

public hasCart() : bool

Summary

Проверяет, были ли установлены товары в корзине.

Details:

• Inherited From: \YooKassa\Request\Invoices\CreateInvoiceRequest

Returns: bool - True если товары в корзине были установлены, false если нет

public hasDeliveryMethodData() : bool

public hasDeliveryMethodData() : bool

Summary

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

Details:

• Inherited From: \YooKassa\Request\Invoices\CreateInvoiceRequest

Returns: bool - True если данные о способе доставки счета были установлены, false если нет

public hasDescription() : bool

public hasDescription() : bool

Summary

Проверяет наличие описания транзакции в создаваемом счете.

Details:

• Inherited From: \YooKassa\Request\Invoices\CreateInvoiceRequest

Returns: bool - True если описание транзакции есть, false если нет

public hasExpiresAt() : bool

public hasExpiresAt() : bool

Summary

Проверяет, был ли установлен срок действия счета.

Details:

• Inherited From: \YooKassa\Request\Invoices\CreateInvoiceRequest

Returns: bool - True если срок действия счета был установлен, false если нет

public hasLocale() : bool

public hasLocale() : bool

Summary

Проверяет наличие языка интерфейса в создаваемом счете.

Details:

• Inherited From: \YooKassa\Request\Invoices\CreateInvoiceRequest

Returns: bool - True если язык интерфейса есть, false если нет

public hasMetadata() : bool

public hasMetadata() : bool

Summary

Проверяет, были ли установлены метаданные счета.

Details:

• Inherited From: \YooKassa\Request\Invoices\CreateInvoiceRequest

Returns: bool - True если метаданные были установлены, false если нет

public hasPaymentData() : bool

public hasPaymentData() : bool

Summary

Проверяет, были ли установлены данные для проведения платежа.

Details:

• Inherited From: \YooKassa\Request\Invoices\CreateInvoiceRequest

Returns: bool - True если данные для проведения платежа были установлены, false если нет

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

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

Summary

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

Details:

• Inherited From: \YooKassa\Request\Invoices\CreateInvoiceRequest

Parameters:

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

Returns: self -

public setDeliveryMethodData() : self

public setDeliveryMethodData(\YooKassa\Request\Invoices\DeliveryMethodData\AbstractDeliveryMethodData|array|null $delivery_method_data = null) : self

Summary

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

Details:

• Inherited From: \YooKassa\Request\Invoices\CreateInvoiceRequest

Parameters:

Type	Name	Description
\YooKassa\Request\Invoices\DeliveryMethodData\AbstractDeliveryMethodData OR array OR null	delivery_method_data	Данные о способе доставки счета пользователю

Returns: self -

public setDescription() : self

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

Summary

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

Details:

• Inherited From: \YooKassa\Request\Invoices\CreateInvoiceRequest

Parameters:

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

Returns: self -

public setExpiresAt() : self

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

Summary

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

Details:

• Inherited From: \YooKassa\Request\Invoices\CreateInvoiceRequest

Parameters:

Type	Name	Description
\DateTime OR string OR null	expires_at	Срок действия счета — дата и время, до которых можно оплатить выставленный счет. Указывается по UTC и передается в формате ISO 8601. Пример: ~2024-10-18T10:51:18.139Z

Returns: self -

public setLocale() : self

public setLocale(string|null $locale = null) : self

Summary

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

Details:

• Inherited From: \YooKassa\Request\Invoices\CreateInvoiceRequest

Parameters:

Type	Name	Description
string OR null	locale	Язык интерфейса, писем и смс, которые будет видеть или получать пользователь

Returns: self -

public setMetadata() : self

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

Summary

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

Details:

• Inherited From: \YooKassa\Request\Invoices\CreateInvoiceRequest

Parameters:

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

Returns: self -

public setPaymentData() : self

public setPaymentData(\YooKassa\Request\Invoices\PaymentData|array|null $payment_data = null) : self

Summary

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

Details:

• Inherited From: \YooKassa\Request\Invoices\CreateInvoiceRequest

Parameters:

Type	Name	Description
\YooKassa\Request\Invoices\PaymentData OR array OR null	payment_data	Данные для проведения платежа по выставленному счету

Returns: self -

public toArray() : array

public toArray() : array

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractObject

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

public validate() : bool

public validate() : bool

Summary

Проверяет на валидность текущий объект

Details:

• Inherited From: \YooKassa\Request\Invoices\CreateInvoiceRequest

Returns: bool - True если объект запроса валиден, false если нет

protected getUnknownProperties() : array

protected getUnknownProperties() : array

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractObject

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

protected setValidationError() : void

protected setValidationError(string $value) : void

Summary

Устанавливает ошибку валидации.

Details:

• Inherited From: \YooKassa\Common\AbstractRequest

Parameters:

Type	Name	Description
string	value	Ошибка, произошедшая при валидации объекта

Returns: void -

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