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

YooKassa API SDK

Class: \YooKassa\Model\Invoice\InvoiceCancellationDetails

Namespace: \YooKassa\Model\Invoice

---

Summary:

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

Description:

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

---

Constants

• No constants found

---

Properties

Visibility	Name	Flag	Summary
public	$party		Участник процесса, который принял решение об отмене счета.
public	$reason		Причина отмены счета.

---

Methods

Visibility	Name	Flag	Summary
public	__construct()		AbstractObject constructor.
public	__get()		Возвращает значение свойства.
public	__isset()		Проверяет наличие свойства.
public	__set()		Устанавливает значение свойства.
public	__unset()		Удаляет свойство.
public	fromArray()		Устанавливает значения свойств текущего объекта из массива.
public	getParty()		Возвращает party.
public	getReason()		Возвращает reason.
public	getValidator()
public	jsonSerialize()		Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации.
public	offsetExists()		Проверяет наличие свойства.
public	offsetGet()		Возвращает значение свойства.
public	offsetSet()		Устанавливает значение свойства.
public	offsetUnset()		Удаляет свойство.
public	setParty()		Устанавливает party.
public	setReason()		Устанавливает reason.
public	toArray()		Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize().
protected	getUnknownProperties()		Возвращает массив свойств которые не существуют, но были заданы у объекта.
protected	validatePropertyValue()

---

Details

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

• Package: YooKassa\Model

• Class Hierarchy:

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

• See Also:

---

Tags

Tag	Version	Description
category		Class
author		cms@yoomoney.ru

---

Properties

public $party : string

---

Description

Участник процесса, который принял решение об отмене счета.

Type: string

Details:

public $reason : string

---

Description

Причина отмены счета.

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 getParty() : string|null

public getParty() : string|null

Summary

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

Details:

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

Returns: string|null -

public getReason() : string|null

public getReason() : string|null

Summary

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

Details:

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

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

public setParty(string|null $party = null) : self

Summary

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

Details:

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

Parameters:

Type	Name	Description
string OR null	party	Участник процесса, который принял решение об отмене счета. Возможные значения: * ~merchant — продавец товаров и услуг (вы); * ~yoo_money — ЮKassa.

Returns: self -

public setReason() : self

public setReason(string|null $reason = null) : self

Summary

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

Details:

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

Parameters:

Type	Name	Description
string OR null	reason	Причина отмены счета. Возможные значения: * ~invoice_canceled — %счет отменен вручную из личного кабинета ЮKassa; * ~invoice_expired — истек срок действия счета, который вы установили в запросе на создание счета в параметре expires_at, и по счету нет ни одного успешного платежа; * ~general_decline — причина не детализирована, поэтому пользователю следует обратиться к инициатору отмены счета за уточнением подробностей; * ~payment_canceled — %платеж отменен по API при оплате в две стадии; * ~payment_expired_on_capture — %истек срок списания оплаты для платежа в две стадии.

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-08-13 using phpDocumentor

© 2026 YooMoney