meraproject/vendor/yoomoney/yookassa-sdk-php/docs/classes/YooKassa-Request-Receipts-ReceiptsRequestBuilder.md

YooKassa API SDK

Class: \YooKassa\Request\Receipts\ReceiptsRequestBuilder

Namespace: \YooKassa\Request\Receipts

---

Summary:

Класс билдера объектов запросов к API списка чеков

---

Constants

• No constants found

---

Properties

Visibility	Name	Flag	Summary
protected	$currentObject		Инстанс собираемого запроса

---

Methods

Visibility	Name	Flag	Summary
public	__construct()		Конструктор, инициализирует пустой запрос, который в будущем начнём собирать
public	build()		Собирает и возвращает объект запроса списка чеков магазина
public	setCreatedAtGt()		Устанавливает дату создания от которой выбираются чеки
public	setCreatedAtGte()		Устанавливает дату создания от которой выбираются чеки
public	setCreatedAtLt()		Устанавливает дату создания до которой выбираются чеки
public	setCreatedAtLte()		Устанавливает дату создания до которой выбираются чеки
public	setCursor()		Устанавливает токен следующей страницы выборки
public	setLimit()		Устанавливает ограничение количества объектов чеков
public	setOptions()		Устанавливает свойства запроса из массива
public	setPaymentId()		Устанавливает идентификатор платежа или null, если требуется его удалить
public	setRefundId()		Устанавливает идентификатор возврата
public	setStatus()		Устанавливает статус выбираемых чеков
protected	initCurrentObject()		Инициализирует новый инстанс собираемого объекта

---

Details

• File: lib/Request/Receipts/ReceiptsRequestBuilder.php
• Package: YooKassa
• Class Hierarchy:
  • \YooKassa\Common\AbstractRequestBuilder
  • \YooKassa\Request\Receipts\ReceiptsRequestBuilder

---

Properties

protected $currentObject : \YooKassa\Request\Receipts\ReceiptsRequest

---

Summary

Инстанс собираемого запроса

Type: ReceiptsRequest Инстанс собираемого объекта запроса Details:

---

Methods

public __construct() : mixed

public __construct() : mixed

Summary

Конструктор, инициализирует пустой запрос, который в будущем начнём собирать

Details:

• Inherited From: \YooKassa\Common\AbstractRequestBuilder

Returns: mixed -

public build() : \YooKassa\Request\Receipts\ReceiptsRequestInterface|\YooKassa\Common\AbstractRequest

public build(array|null $options = null) : \YooKassa\Request\Receipts\ReceiptsRequestInterface|\YooKassa\Common\AbstractRequest

Summary

Собирает и возвращает объект запроса списка чеков магазина

Details:

• Inherited From: \YooKassa\Request\Receipts\ReceiptsRequestBuilder

Parameters:

Type	Name	Description
array OR null	options	Массив с настройками запроса

Returns: \YooKassa\Request\Receipts\ReceiptsRequestInterface|\YooKassa\Common\AbstractRequest - Инстанс объекта запроса к API для получения списка чеков магазина

public setCreatedAtGt() : \YooKassa\Request\Receipts\ReceiptsRequestBuilder

public setCreatedAtGt(\DateTime|string|int|null $value) : \YooKassa\Request\Receipts\ReceiptsRequestBuilder

Summary

Устанавливает дату создания от которой выбираются чеки

Details:

• Inherited From: \YooKassa\Request\Receipts\ReceiptsRequestBuilder

Parameters:

Type	Name	Description
\DateTime OR string OR int OR null	value	Время создания, от (не включая) или null, чтобы удалить значение

Throws:

Type	Description
\YooKassa\Common\Exceptions\InvalidPropertyValueException	Генерируется если была передана дата в невалидном формате (была передана строка или число, которые не удалось преобразовать в валидную дату)
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException	\Exception

Returns: \YooKassa\Request\Receipts\ReceiptsRequestBuilder - Инстанс текущего объекта билдера

public setCreatedAtGte() : \YooKassa\Request\Receipts\ReceiptsRequestBuilder

public setCreatedAtGte(\DateTime|string|int|null $value) : \YooKassa\Request\Receipts\ReceiptsRequestBuilder

Summary

Устанавливает дату создания от которой выбираются чеки

Details:

• Inherited From: \YooKassa\Request\Receipts\ReceiptsRequestBuilder

Parameters:

Type	Name	Description
\DateTime OR string OR int OR null	value	Время создания, от (включительно) или null, чтобы удалить значение

Throws:

Type	Description
\YooKassa\Common\Exceptions\InvalidPropertyValueException	Генерируется если была передана дата в невалидном формате (была передана строка или число, которые не удалось преобразовать в валидную дату)
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException	\Exception

Returns: \YooKassa\Request\Receipts\ReceiptsRequestBuilder - Инстанс текущего объекта билдера

public setCreatedAtLt() : \YooKassa\Request\Receipts\ReceiptsRequestBuilder

public setCreatedAtLt(\DateTime|string|int|null $value) : \YooKassa\Request\Receipts\ReceiptsRequestBuilder

Summary

Устанавливает дату создания до которой выбираются чеки

Details:

• Inherited From: \YooKassa\Request\Receipts\ReceiptsRequestBuilder

Parameters:

Type	Name	Description
\DateTime OR string OR int OR null	value	Время создания, до (не включая) или null, чтобы удалить значение

Throws:

Type	Description
\YooKassa\Common\Exceptions\InvalidPropertyValueException	Генерируется если была передана дата в невалидном формате (была передана строка или число, которые не удалось преобразовать в валидную дату)
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException	\Exception

Returns: \YooKassa\Request\Receipts\ReceiptsRequestBuilder - Инстанс текущего объекта билдера

public setCreatedAtLte() : \YooKassa\Request\Receipts\ReceiptsRequestBuilder

public setCreatedAtLte(\DateTime|string|int|null $value) : \YooKassa\Request\Receipts\ReceiptsRequestBuilder

Summary

Устанавливает дату создания до которой выбираются чеки

Details:

• Inherited From: \YooKassa\Request\Receipts\ReceiptsRequestBuilder

Parameters:

Type	Name	Description
\DateTime OR string OR int OR null	value	Время создания, до (включительно) или null, чтобы удалить значение

Throws:

Type	Description
\YooKassa\Common\Exceptions\InvalidPropertyValueException	Генерируется если была передана дата в невалидном формате (была передана строка или число, которые не удалось преобразовать в валидную дату)
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException	\Exception

Returns: \YooKassa\Request\Receipts\ReceiptsRequestBuilder - Инстанс текущего объекта билдера

public setCursor() : \YooKassa\Request\Receipts\ReceiptsRequestBuilder

public setCursor(string $value) : \YooKassa\Request\Receipts\ReceiptsRequestBuilder

Summary

Устанавливает токен следующей страницы выборки

Details:

• Inherited From: \YooKassa\Request\Receipts\ReceiptsRequestBuilder

Parameters:

Type	Name	Description
string	value	Токен следующей страницы выборки или null, чтобы удалить значение

Throws:

Type	Description
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException	Выбрасывается если в метод была передана не строка

Returns: \YooKassa\Request\Receipts\ReceiptsRequestBuilder - Инстанс текущего объекта билдера

public setLimit() : \YooKassa\Request\Receipts\ReceiptsRequestBuilder

public setLimit(string $value) : \YooKassa\Request\Receipts\ReceiptsRequestBuilder

Summary

Устанавливает ограничение количества объектов чеков

Details:

• Inherited From: \YooKassa\Request\Receipts\ReceiptsRequestBuilder

Parameters:

Type	Name	Description
string	value	Ограничение количества объектов чеков или null, чтобы удалить значение

Throws:

Type	Description
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException	Выбрасывается если в метод было передана не целое число

Returns: \YooKassa\Request\Receipts\ReceiptsRequestBuilder - Инстанс текущего билдера

public setOptions() : \YooKassa\Common\AbstractRequestBuilder

public setOptions(array|\Traversable $options) : \YooKassa\Common\AbstractRequestBuilder

Summary

Устанавливает свойства запроса из массива

Details:

• Inherited From: \YooKassa\Common\AbstractRequestBuilder

Parameters:

Type	Name	Description
array OR \Traversable	options	Массив свойств запроса

Throws:

Type	Description
\InvalidArgumentException	Выбрасывается если аргумент не массив и не итерируемый объект
\YooKassa\Common\Exceptions\InvalidPropertyException	Выбрасывается если не удалось установить один из параметров, переданныч в массиве настроек

Returns: \YooKassa\Common\AbstractRequestBuilder - Инстанс текущего билдера запросов

public setPaymentId() : \YooKassa\Request\Receipts\ReceiptsRequestBuilder

public setPaymentId(string|null $value) : \YooKassa\Request\Receipts\ReceiptsRequestBuilder

Summary

Устанавливает идентификатор платежа или null, если требуется его удалить

Details:

• Inherited From: \YooKassa\Request\Receipts\ReceiptsRequestBuilder

Parameters:

Type	Name	Description
string OR null	value	Идентификатор платежа

Throws:

Type	Description
\YooKassa\Common\Exceptions\InvalidPropertyValueException	Выбрасывается если длина переданной строки не равна 36 символам
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException	Выбрасывается если в метод была передана не строка

Returns: \YooKassa\Request\Receipts\ReceiptsRequestBuilder - Инстанс текущего объекта билдера

public setRefundId() : \YooKassa\Request\Receipts\ReceiptsRequestBuilder

public setRefundId(string $value) : \YooKassa\Request\Receipts\ReceiptsRequestBuilder

Summary

Устанавливает идентификатор возврата

Details:

• Inherited From: \YooKassa\Request\Receipts\ReceiptsRequestBuilder

Parameters:

Type	Name	Description
string	value	Идентификатор возврата, который ищется в API

Throws:

Type	Description
\YooKassa\Common\Exceptions\InvalidPropertyValueException	Выбрасывается если длина переданного значения не равна 36
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException	Выбрасывается если в метод была передана не строка

Returns: \YooKassa\Request\Receipts\ReceiptsRequestBuilder - Инстанс текущего объекта билдера

public setStatus() : \YooKassa\Request\Receipts\ReceiptsRequestBuilder

public setStatus(string $value) : \YooKassa\Request\Receipts\ReceiptsRequestBuilder

Summary

Устанавливает статус выбираемых чеков

Details:

• Inherited From: \YooKassa\Request\Receipts\ReceiptsRequestBuilder

Parameters:

Type	Name	Description
string	value	Статус выбираемых платежей или null, чтобы удалить значение

Throws:

Type	Description
\YooKassa\Common\Exceptions\InvalidPropertyValueException	Выбрасывается если переданное значение не является валидным статусом
\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException	Выбрасывается если в метод была передана не строка

Returns: \YooKassa\Request\Receipts\ReceiptsRequestBuilder - Инстанс текущего объекта билдера

protected initCurrentObject() : \YooKassa\Request\Receipts\ReceiptsRequest

protected initCurrentObject() : \YooKassa\Request\Receipts\ReceiptsRequest

Summary

Инициализирует новый инстанс собираемого объекта

Details:

• Inherited From: \YooKassa\Request\Receipts\ReceiptsRequestBuilder

Returns: \YooKassa\Request\Receipts\ReceiptsRequest - Инстанс собираемого запроса

---

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