geckon01/yookassa-sdk-php
1
0
Fork 0
mirror of https://git.yoomoney.ru/scm/sdk/yookassa-sdk-php.git synced 2026-09-13 03:16:24 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
3.7.3
yookassa-sdk-php/docs/classes/YooKassa-Request-Receipts-ReceiptsRequest.md
T
Антон Н. Николаев 1de0e88c4d Расширение исключений ApiException
2024-12-05 17:27:30 +03:00

43 KiB
Raw Permalink Blame History

YooKassa API SDK

Class: \YooKassa\Request\Receipts\ReceiptsRequest

Namespace: \YooKassa\Request\Receipts

Summary:

Класс объекта запроса к API списка возвратов магазина.

Constants

Visibility Name Flag Summary
public MAX_LIMIT_VALUE Максимальное количество объектов чеков в выборке
public LENGTH_PAYMENT_ID Длина идентификатора платежа
public LENGTH_REFUND_ID Длина идентификатора платежа

Properties

Visibility Name Flag Summary
public $created_at_gt Время создания, от (не включая)
public $created_at_gte Время создания, от (включительно)
public $created_at_lt Время создания, до (не включая)
public $created_at_lte Время создания, до (включительно)
public $createdAtGt Время создания, от (не включая)
public $createdAtGte Время создания, от (включительно)
public $createdAtLt Время создания, до (не включая)
public $createdAtLte Время создания, до (включительно)
public $cursor Токен для получения следующей страницы выборки
public $limit Ограничение количества объектов возврата, отображаемых на одной странице выдачи
public $payment_id Идентификатор платежа
public $paymentId Идентификатор платежа
public $refund_id Идентификатор возврата
public $refundId Идентификатор возврата
public $status Статус возврата

Methods

Visibility Name Flag Summary
public __construct() AbstractObject constructor.
public __get() Возвращает значение свойства.
public __isset() Проверяет наличие свойства.
public __set() Устанавливает значение свойства.
public __unset() Удаляет свойство.
public builder() Возвращает инстанс билдера объектов запросов списка возвратов магазина.
public clearValidationError() Очищает статус валидации текущего запроса.
public fromArray() Устанавливает значения свойств текущего объекта из массива.
public getCreatedAtGt() Возвращает дату создания от которой будут возвращены возвраты или null, если дата не была установлена.
public getCreatedAtGte() Возвращает дату создания от которой будут возвращены возвраты или null, если дата не была установлена.
public getCreatedAtLt() Возвращает дату создания до которой будут возвращены возвраты или null, если дата не была установлена.
public getCreatedAtLte() Возвращает дату создания до которой будут возвращены возвраты или null, если дата не была установлена.
public getCursor() Возвращает токен для получения следующей страницы выборки.
public getLastValidationError() Возвращает последнюю ошибку валидации.
public getLimit() Ограничение количества объектов платежа.
public getPaymentId() Возвращает идентификатор платежа если он задан или null.
public getRefundId() Возвращает идентификатор возврата.
public getStatus() Возвращает статус выбираемых возвратов или null, если он до этого не был установлен.
public getValidator()
public hasCreatedAtGt() Проверяет, была ли установлена дата создания от которой выбираются возвраты.
public hasCreatedAtGte() Проверяет, была ли установлена дата создания от которой выбираются возвраты.
public hasCreatedAtLt() Проверяет, была ли установлена дата создания до которой выбираются возвраты.
public hasCreatedAtLte() Проверяет, была ли установлена дата создания до которой выбираются возвраты.
public hasCursor() Проверяет, был ли установлен токен следующей страницы.
public hasLimit() Проверяет, было ли установлено ограничение количества объектов платежа.
public hasPaymentId() Проверяет, был ли задан идентификатор платежа.
public hasRefundId() Проверяет, был ли установлен идентификатор возврата.
public hasStatus() Проверяет, был ли установлен статус выбираемых возвратов.
public jsonSerialize() Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации.
public offsetExists() Проверяет наличие свойства.
public offsetGet() Возвращает значение свойства.
public offsetSet() Устанавливает значение свойства.
public offsetUnset() Удаляет свойство.
public setCreatedAtGt() Устанавливает дату создания от которой выбираются возвраты.
public setCreatedAtGte() Устанавливает дату создания от которой выбираются возвраты.
public setCreatedAtLt() Устанавливает дату создания до которой выбираются возвраты.
public setCreatedAtLte() Устанавливает дату создания до которой выбираются возвраты.
public setCursor() Устанавливает токен следующей страницы выборки.
public setLimit() Устанавливает ограничение количества объектов платежа.
public setPaymentId() Устанавливает идентификатор платежа или null, если требуется его удалить.
public setRefundId() Устанавливает идентификатор возврата.
public setStatus() Устанавливает статус выбираемых чеков
public toArray() Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize().
public validate() Проверяет валидность текущего объекта запроса.
protected getUnknownProperties() Возвращает массив свойств которые не существуют, но были заданы у объекта.
protected setValidationError() Устанавливает ошибку валидации.
protected validatePropertyValue()

Details

Tags

Tag Version Description
category Class
author cms@yoomoney.ru

Constants

MAX_LIMIT_VALUE

Максимальное количество объектов чеков в выборке

MAX_LIMIT_VALUE = 100

LENGTH_PAYMENT_ID

Длина идентификатора платежа

LENGTH_PAYMENT_ID = 36

LENGTH_REFUND_ID

Длина идентификатора платежа

LENGTH_REFUND_ID = 36

Properties

public $created_at_gt : \DateTime

Description

Время создания, от (не включая)

Type: \DateTime

Details:

public $created_at_gte : \DateTime

Description

Время создания, от (включительно)

Type: \DateTime

Details:

public $created_at_lt : \DateTime

Description

Время создания, до (не включая)

Type: \DateTime

Details:

public $created_at_lte : \DateTime

Description

Время создания, до (включительно)

Type: \DateTime

Details:

public $createdAtGt : \DateTime

Description

Время создания, от (не включая)

Type: \DateTime

Details:

public $createdAtGte : \DateTime

Description

Время создания, от (включительно)

Type: \DateTime

Details:

public $createdAtLt : \DateTime

Description

Время создания, до (не включая)

Type: \DateTime

Details:

public $createdAtLte : \DateTime

Description

Время создания, до (включительно)

Type: \DateTime

Details:

public $cursor : string

Description

Токен для получения следующей страницы выборки

Type: string

Details:

public $limit : null|int

Description

Ограничение количества объектов возврата, отображаемых на одной странице выдачи

Type: null|int

Details:

public $payment_id : string

Description

Идентификатор платежа

Type: string

Details:

public $paymentId : string

Description

Идентификатор платежа

Type: string

Details:

public $refund_id : string

Description

Идентификатор возврата

Type: string

Details:

public $refundId : string

Description

Идентификатор возврата

Type: string

Details:

public $status : string

Description

Статус возврата

Type: string

Details:

Methods

public __construct() : mixed

public __construct(array|null $data = []) : mixed

Summary

AbstractObject constructor.

Details:

Parameters:
Type Name Description
array OR null data

Returns: mixed -

public __get() : mixed

public __get(string $propertyName) : mixed

Summary

Возвращает значение свойства.

Details:

Parameters:
Type Name Description
string propertyName Имя свойства

Returns: mixed - Значение свойства

public __isset() : bool

public __isset(string $propertyName) : bool

Summary

Проверяет наличие свойства.

Details:

Parameters:
Type Name Description
string propertyName Имя проверяемого свойства

Returns: bool - True если свойство имеется, false если нет

public __set() : void

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

Summary

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

Details:

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

Returns: void -

public __unset() : void

public __unset(string $propertyName) : void

Summary

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

Details:

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

Returns: void -

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

Static public builder() : \YooKassa\Request\Receipts\ReceiptsRequestBuilder

Summary

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

Details:

Returns: \YooKassa\Request\Receipts\ReceiptsRequestBuilder - Билдер объектов запросов списка возвратов

public clearValidationError() : void

public clearValidationError() : void

Summary

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

Details:

Returns: void -

public fromArray() : void

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

Summary

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

Details:

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

Returns: void -

public getCreatedAtGt() : null|\DateTime

public getCreatedAtGt() : null|\DateTime

Summary

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

Details:

Returns: null|\DateTime - Время создания, от (не включая)

public getCreatedAtGte() : null|\DateTime

public getCreatedAtGte() : null|\DateTime

Summary

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

Details:

Returns: null|\DateTime - Время создания, от (включительно)

public getCreatedAtLt() : null|\DateTime

public getCreatedAtLt() : null|\DateTime

Summary

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

Details:

Returns: null|\DateTime - Время создания, до (не включая)

public getCreatedAtLte() : null|\DateTime

public getCreatedAtLte() : null|\DateTime

Summary

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

Details:

Returns: null|\DateTime - Время создания, до (включительно)

public getCursor() : null|string

public getCursor() : null|string

Summary

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

Details:

Returns: null|string - Токен для получения следующей страницы выборки

public getLastValidationError() : string|null

public getLastValidationError() : string|null

Summary

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

Details:

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

public getLimit() : null|int

public getLimit() : null|int

Summary

Ограничение количества объектов платежа.

Details:

Returns: null|int - Ограничение количества объектов платежа

public getPaymentId() : null|string

public getPaymentId() : null|string

Summary

Возвращает идентификатор платежа если он задан или null.

Details:

Returns: null|string - Идентификатор платежа

public getRefundId() : string|null

public getRefundId() : string|null

Summary

Возвращает идентификатор возврата.

Details:

Returns: string|null - Идентификатор возврата

public getStatus() : null|string

public getStatus() : null|string

Summary

Возвращает статус выбираемых возвратов или null, если он до этого не был установлен.

Details:

Returns: null|string - Статус выбираемых возвратов

public getValidator() : \YooKassa\Validator\Validator

public getValidator() : \YooKassa\Validator\Validator

Details:

Returns: \YooKassa\Validator\Validator -

public hasCreatedAtGt() : bool

public hasCreatedAtGt() : bool

Summary

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

Details:

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

public hasCreatedAtGte() : bool

public hasCreatedAtGte() : bool

Summary

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

Details:

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

public hasCreatedAtLt() : bool

public hasCreatedAtLt() : bool

Summary

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

Details:

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

public hasCreatedAtLte() : bool

public hasCreatedAtLte() : bool

Summary

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

Details:

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

public hasCursor() : bool

public hasCursor() : bool

Summary

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

Details:

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

public hasLimit() : bool

public hasLimit() : bool

Summary

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

Details:

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

public hasPaymentId() : bool

public hasPaymentId() : bool

Summary

Проверяет, был ли задан идентификатор платежа.

Details:

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

public hasRefundId() : bool

public hasRefundId() : bool

Summary

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

Details:

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

public hasStatus() : bool

public hasStatus() : bool

Summary

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

Details:

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

public jsonSerialize() : array

public jsonSerialize() : array

Summary

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

Details:

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

public offsetExists() : bool

public offsetExists(string $offset) : bool

Summary

Проверяет наличие свойства.

Details:

Parameters:
Type Name Description
string offset Имя проверяемого свойства

Returns: bool - True если свойство имеется, false если нет

public offsetGet() : mixed

public offsetGet(string $offset) : mixed

Summary

Возвращает значение свойства.

Details:

Parameters:
Type Name Description
string offset Имя свойства

Returns: mixed - Значение свойства

public offsetSet() : void

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

Summary

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

Details:

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

Returns: void -

public offsetUnset() : void

public offsetUnset(string $offset) : void

Summary

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

Details:

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

Returns: void -

public setCreatedAtGt() : self

public setCreatedAtGt(null|\DateTime|int|string $created_at_gt) : self

Summary

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

Details:

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

Returns: self -

public setCreatedAtGte() : self

public setCreatedAtGte(null|\DateTime|int|string $_created_at_gte) : self

Summary

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

Details:

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

Returns: self -

public setCreatedAtLt() : self

public setCreatedAtLt(null|\DateTime|int|string $created_at_lt) : self

Summary

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

Details:

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

Returns: self -

public setCreatedAtLte() : self

public setCreatedAtLte(null|\DateTime|int|string $created_at_lte) : self

Summary

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

Details:

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

Returns: self -

public setCursor() : self

public setCursor(string|null $cursor) : self

Summary

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

Details:

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

Returns: self -

public setLimit() : self

public setLimit(null|int $limit) : self

Summary

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

Details:

Parameters:
Type Name Description
null OR int limit Ограничение количества объектов платежа или null, чтобы удалить значение

Returns: self -

public setPaymentId() : self

public setPaymentId(null|string $payment_id) : self

Summary

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

Details:

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

Returns: self -

public setRefundId() : self

public setRefundId(string|null $refund_id) : self

Summary

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

Details:

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

Returns: self -

public setStatus() : self

public setStatus(string|null $status) : self

Summary

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

Details:

Parameters:
Type Name Description
string OR null status Статус выбираемых чеков или null, чтобы удалить значение

Returns: self -

public toArray() : array

public toArray() : array

Summary

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

Details:

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

public validate() : bool

public validate() : bool

Summary

Проверяет валидность текущего объекта запроса.

Details:

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

protected getUnknownProperties() : array

protected getUnknownProperties() : array

Summary

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

Details:

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

protected setValidationError() : void

protected setValidationError(string $value) : void

Summary

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

Details:

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

Returns: void -

protected validatePropertyValue() : mixed

protected validatePropertyValue(string $propertyName, mixed $propertyValue) : mixed

Details:

Parameters:
Type Name Description
string propertyName
mixed propertyValue

Returns: mixed -

Top Namespaces

Reports

This document was automatically generated from source code comments on 2024-12-05 using phpDocumentor

© 2024 YooMoney

Reference in New Issue View Git Blame Copy Permalink