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

186 lines
5.9 KiB
Markdown
Raw Normal View History

# [YooKassa API SDK](../home.md)
# Interface: ReceiptInterface
### Namespace: [\YooKassa\Model](../namespaces/yookassa-model.md)
---
**Summary:**
Interface ReceiptInterface
---
### Constants
* No constants found
---
### Methods
| Visibility | Name | Flag | Summary |
| ----------:| ---- | ---- | ------- |
| public | [getCustomer()](../classes/YooKassa-Model-ReceiptInterface.md#method_getCustomer) | | Возвращает информацию о плательщике |
| public | [getItems()](../classes/YooKassa-Model-ReceiptInterface.md#method_getItems) | | Возвращает список позиций в текущем чеке |
| public | [getObjectId()](../classes/YooKassa-Model-ReceiptInterface.md#method_getObjectId) | | Возвращает Id объекта чека |
| public | [getSettlements()](../classes/YooKassa-Model-ReceiptInterface.md#method_getSettlements) | | Возвращает массив оплат, обеспечивающих выдачу товара. |
| public | [getTaxSystemCode()](../classes/YooKassa-Model-ReceiptInterface.md#method_getTaxSystemCode) | | Возвращает код системы налогообложения |
| public | [normalize()](../classes/YooKassa-Model-ReceiptInterface.md#method_normalize) | | Подгоняет стоимость товаров в чеке к общей цене заказа |
| public | [notEmpty()](../classes/YooKassa-Model-ReceiptInterface.md#method_notEmpty) | | Проверяет есть ли в чеке хотя бы одна позиция |
---
### Details
* File: [lib/Model/ReceiptInterface.php](../../lib/Model/ReceiptInterface.php)
* Package: \YooKassa
---
### Tags
| Tag | Version | Description |
| --- | ------- | ----------- |
| property-read | | Информация о плательщике |
| property-read | | Список товаров в заказе |
| property-read | | Код системы налогообложения. Число 1-6. |
| property-read | | Код системы налогообложения. Число 1-6. |
---
## Methods
<a name="method_getObjectId" class="anchor"></a>
#### public getObjectId() : string
```php
public getObjectId() : string
```
**Summary**
Возвращает Id объекта чека
**Details:**
* Inherited From: [\YooKassa\Model\ReceiptInterface](../classes/YooKassa-Model-ReceiptInterface.md)
**Returns:** string - Id объекта чека
<a name="method_getCustomer" class="anchor"></a>
#### public getCustomer() : \YooKassa\Model\ReceiptCustomerInterface
```php
public getCustomer() : \YooKassa\Model\ReceiptCustomerInterface
```
**Summary**
Возвращает информацию о плательщике
**Details:**
* Inherited From: [\YooKassa\Model\ReceiptInterface](../classes/YooKassa-Model-ReceiptInterface.md)
**Returns:** \YooKassa\Model\ReceiptCustomerInterface - Информация о плательщике
<a name="method_getItems" class="anchor"></a>
#### public getItems() : \YooKassa\Model\ReceiptItemInterface[]
```php
public getItems() : \YooKassa\Model\ReceiptItemInterface[]
```
**Summary**
Возвращает список позиций в текущем чеке
**Details:**
* Inherited From: [\YooKassa\Model\ReceiptInterface](../classes/YooKassa-Model-ReceiptInterface.md)
**Returns:** \YooKassa\Model\ReceiptItemInterface[] - Список товаров в заказе
<a name="method_getSettlements" class="anchor"></a>
#### public getSettlements() : \YooKassa\Model\SettlementInterface[]
```php
public getSettlements() : \YooKassa\Model\SettlementInterface[]
```
**Summary**
Возвращает массив оплат, обеспечивающих выдачу товара.
**Details:**
* Inherited From: [\YooKassa\Model\ReceiptInterface](../classes/YooKassa-Model-ReceiptInterface.md)
**Returns:** \YooKassa\Model\SettlementInterface[] - Массив оплат, обеспечивающих выдачу товара.
<a name="method_getTaxSystemCode" class="anchor"></a>
#### public getTaxSystemCode() : int
```php
public getTaxSystemCode() : int
```
**Summary**
Возвращает код системы налогообложения
**Details:**
* Inherited From: [\YooKassa\Model\ReceiptInterface](../classes/YooKassa-Model-ReceiptInterface.md)
**Returns:** int - Код системы налогообложения. Число 1-6.
<a name="method_notEmpty" class="anchor"></a>
#### public notEmpty() : bool
```php
public notEmpty() : bool
```
**Summary**
Проверяет есть ли в чеке хотя бы одна позиция
**Details:**
* Inherited From: [\YooKassa\Model\ReceiptInterface](../classes/YooKassa-Model-ReceiptInterface.md)
**Returns:** bool - True если чек не пуст, false если в чеке нет ни одной позиции
<a name="method_normalize" class="anchor"></a>
#### public normalize() : mixed
```php
public normalize(\YooKassa\Model\AmountInterface $orderAmount, bool $withShipping = false) : mixed
```
**Summary**
Подгоняет стоимость товаров в чеке к общей цене заказа
**Details:**
* Inherited From: [\YooKassa\Model\ReceiptInterface](../classes/YooKassa-Model-ReceiptInterface.md)
##### Parameters:
| Type | Name | Description |
| ---- | ---- | ----------- |
| <code lang="php">\YooKassa\Model\AmountInterface</code> | orderAmount | Общая стоимость заказа |
| <code lang="php">bool</code> | withShipping | Поменять ли заодно и цену доставки |
**Returns:** mixed -
---
### Top Namespaces
* [\YooKassa](../namespaces/yookassa.md)
---
### Reports
* [Errors - 0](../reports/errors.md)
* [Markers - 1](../reports/markers.md)
* [Deprecated - 25](../reports/deprecated.md)
---
This document was automatically generated from source code comments on 2023-04-06 using [phpDocumentor](http://www.phpdoc.org/)
&copy; 2023 YooMoney