meraproject/vendor/yoomoney/yookassa-sdk-php/docs/classes/YooKassa-Model-Payout-IncomeReceipt.md

YooKassa API SDK

Class: \YooKassa\Model\Payout\IncomeReceipt

Namespace: \YooKassa\Model\Payout

---

Summary:

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

Description:

Данные чека, зарегистрированного в ФНС. Присутствует, если вы делаете выплату самозанятому.

---

Constants

Visibility	Name	Flag	Summary
public	MAX_LENGTH_SERVICE_NAME

---

Properties

Visibility	Name	Flag	Summary
public	$amount		Сумма, указанная в чеке. Присутствует, если в запросе передавалась сумма для печати в чеке.
public	$npd_receipt_id		Идентификатор чека в сервисе.
public	$npdReceiptId		Идентификатор чека в сервисе.
public	$service_name		Описание услуги, оказанной получателем выплаты. Не более 50 символов.
public	$serviceName		Описание услуги, оказанной получателем выплаты. Не более 50 символов.
public	$url		Ссылка на зарегистрированный чек.

---

Methods

Visibility	Name	Flag	Summary
public	__construct()		AbstractObject constructor.
public	__get()		Возвращает значение свойства
public	__isset()		Проверяет наличие свойства
public	__set()		Устанавливает значение свойства
public	__unset()		Удаляет свойство
public	fromArray()		Устанавливает значения свойств текущего объекта из массива
public	getAmount()		Возвращает amount.
public	getNpdReceiptId()		Возвращает npd_receipt_id.
public	getServiceName()		Возвращает service_name.
public	getUrl()		Возвращает Ссылка на зарегистрированный чек.
public	jsonSerialize()
public	offsetExists()
public	offsetGet()
public	offsetSet()
public	offsetUnset()
public	setAmount()		Устанавливает amount.
public	setNpdReceiptId()		Устанавливает npd_receipt_id.
public	setServiceName()		Устанавливает service_name.
public	setUrl()		Устанавливает ссылка на зарегистрированный чек.
public	toArray()		Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize()
protected	getUnknownProperties()		Возвращает массив свойств которые не существуют, но были заданы у объекта

---

Details

• File: lib/Model/Payout/IncomeReceipt.php
• Package: YooKassa\Model
• Class Hierarchy:
  • \YooKassa\Common\AbstractObject
  • \YooKassa\Model\Payout\IncomeReceipt

---

Tags

Tag	Version	Description
author		cms@yoomoney.ru

---

Constants

MAX_LENGTH_SERVICE_NAME

MAX_LENGTH_SERVICE_NAME = 50 : int

---

Properties

public $amount : \YooKassa\Model\AmountInterface|null

---

Description

Сумма, указанная в чеке. Присутствует, если в запросе передавалась сумма для печати в чеке.

Type: AmountInterface|null

Details:

public $npd_receipt_id : string|null

---

Description

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

Type: string|null

Details:

public $npdReceiptId : string|null

---

Description

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

Type: string|null

Details:

public $service_name : string

---

Description

Описание услуги, оказанной получателем выплаты. Не более 50 символов.

Type: string

Details:

public $serviceName : string

---

Description

Описание услуги, оказанной получателем выплаты. Не более 50 символов.

Type: string

Details:

public $url : string|null

---

Description

Ссылка на зарегистрированный чек.

Type: string|null

Details:

---

Methods

public __construct() : mixed

public __construct(array $data = array()) : mixed

Summary

AbstractObject constructor.

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
array	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() : mixed

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

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

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

Returns: mixed -

public __unset() : mixed

public __unset(string $propertyName) : mixed

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

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

Returns: mixed -

public fromArray() : mixed

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

Summary

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

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

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

Returns: mixed -

public getAmount() : \YooKassa\Model\AmountInterface|null

public getAmount() : \YooKassa\Model\AmountInterface|null

Summary

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

Details:

• Inherited From: \YooKassa\Model\Payout\IncomeReceipt

Returns: \YooKassa\Model\AmountInterface|null -

public getNpdReceiptId() : string|null

public getNpdReceiptId() : string|null

Summary

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

Details:

• Inherited From: \YooKassa\Model\Payout\IncomeReceipt

Returns: string|null -

public getServiceName() : string

public getServiceName() : string

Summary

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

Details:

• Inherited From: \YooKassa\Model\Payout\IncomeReceipt

Returns: string -

public getUrl() : string|null

public getUrl() : string|null

Summary

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

Details:

• Inherited From: \YooKassa\Model\Payout\IncomeReceipt

Returns: string|null -

public jsonSerialize() : mixed

public jsonSerialize() : mixed

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Returns: mixed -

public offsetExists() : mixed

public offsetExists(mixed $offset) : mixed

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
mixed	offset

Returns: mixed -

public offsetGet() : mixed

public offsetGet(mixed $offset) : mixed

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
mixed	offset

Returns: mixed -

public offsetSet() : mixed

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

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
mixed	offset
mixed	value

Returns: mixed -

public offsetUnset() : mixed

public offsetUnset(mixed $offset) : mixed

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
mixed	offset

Returns: mixed -

public setAmount() : $this

public setAmount(\YooKassa\Model\AmountInterface|array|null $value = null) : $this

Summary

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

Details:

• Inherited From: \YooKassa\Model\Payout\IncomeReceipt

Parameters:

Type	Name	Description
\YooKassa\Model\AmountInterface OR array OR null	value

Returns: $this -

public setNpdReceiptId() : $this

public setNpdReceiptId(string|null $value = null) : $this

Summary

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

Details:

• Inherited From: \YooKassa\Model\Payout\IncomeReceipt

Parameters:

Type	Name	Description
string OR null	value	Идентификатор чека в сервисе. Пример: ~208jd98zqe

Returns: $this -

public setServiceName() : $this

public setServiceName(string $value) : $this

Summary

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

Details:

• Inherited From: \YooKassa\Model\Payout\IncomeReceipt

Parameters:

Type	Name	Description
string	value	Описание услуги, оказанной получателем выплаты. Не более 50 символов.

Returns: $this -

public setUrl() : $this

public setUrl(string|null $value = null) : $this

Summary

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

Details:

• Inherited From: \YooKassa\Model\Payout\IncomeReceipt

Parameters:

Type	Name	Description
string OR null	value	Ссылка на зарегистрированный чек Пример: ~https://www.nalog.gov.ru/api/v1/receipt/<Идентификатор чека>/print

Returns: $this -

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

---

Top Namespaces

• \YooKassa

---

Reports

• Errors - 0
• Markers - 1
• Deprecated - 25

---

This document was automatically generated from source code comments on 2023-04-06 using phpDocumentor

© 2023 YooMoney