Files
HRM-System/vendor/yoomoney/yookassa-sdk-php/docs/classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md
2026-04-13 08:19:53 +08:00

596 lines
25 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# [YooKassa API SDK](../home.md)
# Interface: CreatePostReceiptRequestInterface
### Namespace: [\YooKassa\Request\Receipts](../namespaces/yookassa-request-receipts.md)
---
**Summary:**
Interface CreatePostReceiptRequestInterface.
---
### Constants
* No constants found
---
### Methods
| Visibility | Name | Flag | Summary |
| ----------:| ---- | ---- | ------- |
| public | [getAdditionalUserProps()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md#method_getAdditionalUserProps) | | Возвращает дополнительный реквизит пользователя. |
| public | [getCustomer()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md#method_getCustomer) | | Возвращает информацию о плательщике. |
| public | [getItems()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md#method_getItems) | | Возвращает список товаров в заказе. |
| public | [getObjectId()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md#method_getObjectId) | | Возвращает идентификатор объекта, для которого формируется чек. |
| public | [getObjectType()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md#method_getObjectType) | | Возвращает тип объекта чека. |
| public | [getOnBehalfOf()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md#method_getOnBehalfOf) | | Возвращает идентификатор магазина, от имени которого нужно отправить чек. |
| public | [getReceiptIndustryDetails()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md#method_getReceiptIndustryDetails) | | Возвращает отраслевой реквизит чека. |
| public | [getReceiptOperationalDetails()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md#method_getReceiptOperationalDetails) | | Возвращает операционный реквизит чека. |
| public | [getSend()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md#method_getSend) | | Возвращает признак отложенной отправки чека. |
| public | [getSettlements()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md#method_getSettlements) | | Возвращает Массив оплат, обеспечивающих выдачу товара. |
| public | [getTaxSystemCode()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md#method_getTaxSystemCode) | | Возвращает код системы налогообложения. |
| public | [getType()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md#method_getType) | | Возвращает тип чека в онлайн-кассе. |
| public | [notEmpty()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md#method_notEmpty) | | Проверяет есть ли в чеке хотя бы одна позиция. |
| public | [setAdditionalUserProps()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md#method_setAdditionalUserProps) | | Устанавливает дополнительный реквизит пользователя. |
| public | [setCustomer()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md#method_setCustomer) | | Устанавливает информацию о пользователе. |
| public | [setItems()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md#method_setItems) | | Устанавливает список товаров чека. |
| public | [setObjectId()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md#method_setObjectId) | | Устанавливает идентификатор объекта, для которого формируется чек. |
| public | [setObjectType()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md#method_setObjectType) | | Устанавливает тип объекта чека. |
| public | [setOnBehalfOf()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md#method_setOnBehalfOf) | | Устанавливает идентификатор магазина, от имени которого нужно отправить чек. |
| public | [setReceiptIndustryDetails()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md#method_setReceiptIndustryDetails) | | Устанавливает отраслевой реквизит чека. |
| public | [setReceiptOperationalDetails()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md#method_setReceiptOperationalDetails) | | Устанавливает операционный реквизит чека. |
| public | [setSend()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md#method_setSend) | | Устанавливает признак отложенной отправки чека. |
| public | [setSettlements()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md#method_setSettlements) | | Устанавливает массив оплат, обеспечивающих выдачу товара. |
| public | [setTaxSystemCode()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md#method_setTaxSystemCode) | | Устанавливает код системы налогообложения. |
| public | [setType()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md#method_setType) | | Устанавливает тип чека в онлайн-кассе. |
---
### Details
* File: [lib/Request/Receipts/CreatePostReceiptRequestInterface.php](../../lib/Request/Receipts/CreatePostReceiptRequestInterface.php)
* Package: \YooKassa\Request
* See Also:
* [](https://yookassa.ru/developers/api)
---
### Tags
| Tag | Version | Description |
| --- | ------- | ----------- |
| category | | Interface |
| author | | cms@yoomoney.ru |
| property | | Идентификатор объекта ("payment" или "refund), для которого формируется чек |
| property | | Идентификатор объекта ("payment" или "refund), для которого формируется чек |
| property | | Тип чека в онлайн-кассе: приход "payment" или возврат "refund" |
| property | | Признак отложенной отправки чека |
| property | | Информация о плательщике |
| property | | Код системы налогообложения. Число 1-6 |
| property | | Код системы налогообложения. Число 1-6 |
| property | | Дополнительный реквизит пользователя |
| property | | Дополнительный реквизит пользователя |
| property | | Отраслевой реквизит чека |
| property | | Отраслевой реквизит чека |
| property | | Операционный реквизит чека |
| property | | Операционный реквизит чека |
| property | | Список товаров в заказе |
| property | | Массив оплат, обеспечивающих выдачу товара |
---
## Methods
<a name="method_getObjectId" class="anchor"></a>
#### public getObjectId() : string|null
```php
public getObjectId() : string|null
```
**Summary**
Возвращает идентификатор объекта, для которого формируется чек.
**Details:**
* Inherited From: [\YooKassa\Request\Receipts\CreatePostReceiptRequestInterface](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md)
**Returns:** string|null - Идентификатор объекта
<a name="method_setObjectId" class="anchor"></a>
#### public setObjectId() : \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface
```php
public setObjectId(string|null $value) : \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface
```
**Summary**
Устанавливает идентификатор объекта, для которого формируется чек.
**Details:**
* Inherited From: [\YooKassa\Request\Receipts\CreatePostReceiptRequestInterface](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| <code lang="php">string OR null</code> | value | Идентификатор объекта |
**Returns:** \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface -
<a name="method_getType" class="anchor"></a>
#### public getType() : string|null
```php
public getType() : string|null
```
**Summary**
Возвращает тип чека в онлайн-кассе.
**Details:**
* Inherited From: [\YooKassa\Request\Receipts\CreatePostReceiptRequestInterface](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md)
**Returns:** string|null - Тип чека в онлайн-кассе: приход "payment" или возврат "refund"
<a name="method_setType" class="anchor"></a>
#### public setType() : \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface
```php
public setType(string $type) : \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface
```
**Summary**
Устанавливает тип чека в онлайн-кассе.
**Details:**
* Inherited From: [\YooKassa\Request\Receipts\CreatePostReceiptRequestInterface](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| <code lang="php">string</code> | type | Тип чека в онлайн-кассе: приход "payment" или возврат "refund" |
**Returns:** \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface -
<a name="method_getObjectType" class="anchor"></a>
#### public getObjectType() : string|null
```php
public getObjectType() : string|null
```
**Summary**
Возвращает тип объекта чека.
**Details:**
* Inherited From: [\YooKassa\Request\Receipts\CreatePostReceiptRequestInterface](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md)
**Returns:** string|null - Тип объекта чека
<a name="method_setObjectType" class="anchor"></a>
#### public setObjectType() : \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface
```php
public setObjectType(string|null $value) : \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface
```
**Summary**
Устанавливает тип объекта чека.
**Details:**
* Inherited From: [\YooKassa\Request\Receipts\CreatePostReceiptRequestInterface](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| <code lang="php">string OR null</code> | value | Тип объекта чека |
**Returns:** \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface -
<a name="method_getSend" class="anchor"></a>
#### public getSend() : bool
```php
public getSend() : bool
```
**Summary**
Возвращает признак отложенной отправки чека.
**Description**
@return bool Признак отложенной отправки чека
**Details:**
* Inherited From: [\YooKassa\Request\Receipts\CreatePostReceiptRequestInterface](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md)
**Returns:** bool -
<a name="method_setSend" class="anchor"></a>
#### public setSend() : \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface
```php
public setSend(bool $send) : \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface
```
**Summary**
Устанавливает признак отложенной отправки чека.
**Details:**
* Inherited From: [\YooKassa\Request\Receipts\CreatePostReceiptRequestInterface](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| <code lang="php">bool</code> | send | Признак отложенной отправки чека |
**Returns:** \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface -
<a name="method_getTaxSystemCode" class="anchor"></a>
#### public getTaxSystemCode() : int|null
```php
public getTaxSystemCode() : int|null
```
**Summary**
Возвращает код системы налогообложения.
**Details:**
* Inherited From: [\YooKassa\Request\Receipts\CreatePostReceiptRequestInterface](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md)
**Returns:** int|null - Код системы налогообложения. Число 1-6
<a name="method_setTaxSystemCode" class="anchor"></a>
#### public setTaxSystemCode() : \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface
```php
public setTaxSystemCode(int|null $tax_system_code) : \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface
```
**Summary**
Устанавливает код системы налогообложения.
**Details:**
* Inherited From: [\YooKassa\Request\Receipts\CreatePostReceiptRequestInterface](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| <code lang="php">int OR null</code> | tax_system_code | Код системы налогообложения. Число 1-6 |
**Returns:** \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface -
<a name="method_getAdditionalUserProps" class="anchor"></a>
#### public getAdditionalUserProps() : \YooKassa\Model\Receipt\AdditionalUserProps|null
```php
public getAdditionalUserProps() : \YooKassa\Model\Receipt\AdditionalUserProps|null
```
**Summary**
Возвращает дополнительный реквизит пользователя.
**Details:**
* Inherited From: [\YooKassa\Request\Receipts\CreatePostReceiptRequestInterface](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md)
**Returns:** \YooKassa\Model\Receipt\AdditionalUserProps|null - Дополнительный реквизит пользователя
<a name="method_setAdditionalUserProps" class="anchor"></a>
#### public setAdditionalUserProps() : \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface
```php
public setAdditionalUserProps(\YooKassa\Model\Receipt\AdditionalUserProps|array|null $additional_user_props) : \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface
```
**Summary**
Устанавливает дополнительный реквизит пользователя.
**Details:**
* Inherited From: [\YooKassa\Request\Receipts\CreatePostReceiptRequestInterface](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| <code lang="php">\YooKassa\Model\Receipt\AdditionalUserProps OR array OR null</code> | additional_user_props | Дополнительный реквизит пользователя |
**Returns:** \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface -
<a name="method_getReceiptIndustryDetails" class="anchor"></a>
#### public getReceiptIndustryDetails() : \YooKassa\Model\Receipt\IndustryDetails[]|\YooKassa\Common\ListObjectInterface
```php
public getReceiptIndustryDetails() : \YooKassa\Model\Receipt\IndustryDetails[]|\YooKassa\Common\ListObjectInterface
```
**Summary**
Возвращает отраслевой реквизит чека.
**Details:**
* Inherited From: [\YooKassa\Request\Receipts\CreatePostReceiptRequestInterface](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md)
**Returns:** \YooKassa\Model\Receipt\IndustryDetails[]|\YooKassa\Common\ListObjectInterface - Отраслевой реквизит чека
<a name="method_setReceiptIndustryDetails" class="anchor"></a>
#### public setReceiptIndustryDetails() : mixed
```php
public setReceiptIndustryDetails(array|\YooKassa\Common\ListObjectInterface|null $receipt_industry_details) : mixed
```
**Summary**
Устанавливает отраслевой реквизит чека.
**Details:**
* Inherited From: [\YooKassa\Request\Receipts\CreatePostReceiptRequestInterface](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| <code lang="php">array OR \YooKassa\Common\ListObjectInterface OR null</code> | receipt_industry_details | Отраслевой реквизит чека |
**Returns:** mixed -
<a name="method_getReceiptOperationalDetails" class="anchor"></a>
#### public getReceiptOperationalDetails() : \YooKassa\Model\Receipt\OperationalDetails|null
```php
public getReceiptOperationalDetails() : \YooKassa\Model\Receipt\OperationalDetails|null
```
**Summary**
Возвращает операционный реквизит чека.
**Details:**
* Inherited From: [\YooKassa\Request\Receipts\CreatePostReceiptRequestInterface](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md)
**Returns:** \YooKassa\Model\Receipt\OperationalDetails|null - Операционный реквизит чека
<a name="method_setReceiptOperationalDetails" class="anchor"></a>
#### public setReceiptOperationalDetails() : mixed
```php
public setReceiptOperationalDetails(array|\YooKassa\Model\Receipt\OperationalDetails|null $receipt_operational_details) : mixed
```
**Summary**
Устанавливает операционный реквизит чека.
**Details:**
* Inherited From: [\YooKassa\Request\Receipts\CreatePostReceiptRequestInterface](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| <code lang="php">array OR \YooKassa\Model\Receipt\OperationalDetails OR null</code> | receipt_operational_details | Операционный реквизит чека |
**Returns:** mixed -
<a name="method_getCustomer" class="anchor"></a>
#### public getCustomer() : \YooKassa\Model\Receipt\ReceiptCustomerInterface|null
```php
public getCustomer() : \YooKassa\Model\Receipt\ReceiptCustomerInterface|null
```
**Summary**
Возвращает информацию о плательщике.
**Details:**
* Inherited From: [\YooKassa\Request\Receipts\CreatePostReceiptRequestInterface](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md)
**Returns:** \YooKassa\Model\Receipt\ReceiptCustomerInterface|null - Информация о плательщике
<a name="method_setCustomer" class="anchor"></a>
#### public setCustomer() : \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface
```php
public setCustomer(\YooKassa\Model\Receipt\ReceiptCustomerInterface|array|null $customer) : \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface
```
**Summary**
Устанавливает информацию о пользователе.
**Details:**
* Inherited From: [\YooKassa\Request\Receipts\CreatePostReceiptRequestInterface](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| <code lang="php">\YooKassa\Model\Receipt\ReceiptCustomerInterface OR array OR null</code> | customer | Информация о плательщике |
**Returns:** \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface -
<a name="method_getItems" class="anchor"></a>
#### public getItems() : ?\YooKassa\Common\ListObjectInterface
```php
public getItems() : ?\YooKassa\Common\ListObjectInterface
```
**Summary**
Возвращает список товаров в заказе.
**Description**
@return ReceiptItemInterface[]|ListObjectInterface|null
**Details:**
* Inherited From: [\YooKassa\Request\Receipts\CreatePostReceiptRequestInterface](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md)
**Returns:** ?\YooKassa\Common\ListObjectInterface -
<a name="method_setItems" class="anchor"></a>
#### public setItems() : \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface
```php
public setItems(array|\YooKassa\Common\ListObjectInterface|null $items) : \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface
```
**Summary**
Устанавливает список товаров чека.
**Details:**
* Inherited From: [\YooKassa\Request\Receipts\CreatePostReceiptRequestInterface](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| <code lang="php">array OR \YooKassa\Common\ListObjectInterface OR null</code> | items | Список товаров чека |
**Returns:** \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface -
<a name="method_getSettlements" class="anchor"></a>
#### public getSettlements() : ?\YooKassa\Common\ListObjectInterface
```php
public getSettlements() : ?\YooKassa\Common\ListObjectInterface
```
**Summary**
Возвращает Массив оплат, обеспечивающих выдачу товара.
**Description**
@return SettlementInterface[]|ListObjectInterface|null
**Details:**
* Inherited From: [\YooKassa\Request\Receipts\CreatePostReceiptRequestInterface](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md)
**Returns:** ?\YooKassa\Common\ListObjectInterface -
<a name="method_setSettlements" class="anchor"></a>
#### public setSettlements() : \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface
```php
public setSettlements(array|\YooKassa\Common\ListObjectInterface|null $settlements) : \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface
```
**Summary**
Устанавливает массив оплат, обеспечивающих выдачу товара.
**Details:**
* Inherited From: [\YooKassa\Request\Receipts\CreatePostReceiptRequestInterface](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| <code lang="php">array OR \YooKassa\Common\ListObjectInterface OR null</code> | settlements | Массив оплат, обеспечивающих выдачу товара |
**Returns:** \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface -
<a name="method_getOnBehalfOf" class="anchor"></a>
#### public getOnBehalfOf() : null|string
```php
public getOnBehalfOf() : null|string
```
**Summary**
Возвращает идентификатор магазина, от имени которого нужно отправить чек.
**Details:**
* Inherited From: [\YooKassa\Request\Receipts\CreatePostReceiptRequestInterface](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md)
**Returns:** null|string - Идентификатор магазина, от имени которого нужно отправить чек
<a name="method_setOnBehalfOf" class="anchor"></a>
#### public setOnBehalfOf() : mixed
```php
public setOnBehalfOf(string|null $on_behalf_of) : mixed
```
**Summary**
Устанавливает идентификатор магазина, от имени которого нужно отправить чек.
**Description**
Выдается ЮKassa, отображается в разделе Продавцы личного кабинета (столбец shopId).
Необходимо передавать, если вы используете решение ЮKassa для платформ.
**Details:**
* Inherited From: [\YooKassa\Request\Receipts\CreatePostReceiptRequestInterface](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| <code lang="php">string OR null</code> | on_behalf_of | Идентификатор магазина, от имени которого нужно отправить чек |
**Returns:** mixed -
<a name="method_notEmpty" class="anchor"></a>
#### public notEmpty() : bool
```php
public notEmpty() : bool
```
**Summary**
Проверяет есть ли в чеке хотя бы одна позиция.
**Details:**
* Inherited From: [\YooKassa\Request\Receipts\CreatePostReceiptRequestInterface](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md)
**Returns:** bool - True если чек не пуст, false если в чеке нет ни одной позиции
---
### Top Namespaces
* [\YooKassa](../namespaces/yookassa.md)
---
### Reports
* [Errors - 0](../reports/errors.md)
* [Markers - 0](../reports/markers.md)
* [Deprecated - 33](../reports/deprecated.md)
---
This document was automatically generated from source code comments on 2025-07-01 using [phpDocumentor](http://www.phpdoc.org/)
&copy; 2025 YooMoney