25 KiB
YooKassa API SDK
Interface: CreatePostReceiptRequestInterface
Namespace: \YooKassa\Request\Receipts
Summary:
Interface CreateReceiptRequestInterface
Constants
- No constants found
Methods
| Visibility | Name | Flag | Summary |
|---|---|---|---|
| public | addItem() | Добавляет товар в чек | |
| public | getAdditionalUserProps() | Возвращает дополнительный реквизит пользователя | |
| public | getCustomer() | Возвращает информацию о плательщике. | |
| public | getItems() | Возвращает список товаров в заказе | |
| public | getObjectId() | Возвращает идентификатор объекта, для которого формируется чек | |
| public | getObjectType() | Возвращает тип объекта чека | |
| public | getOnBehalfOf() | Возвращает идентификатор магазина, от имени которого нужно отправить чек | |
| public | getReceiptIndustryDetails() | Возвращает отраслевой реквизит чека | |
| public | getReceiptOperationalDetails() | Возвращает операционный реквизит чека | |
| public | getSend() | Возвращает признак отложенной отправки чека | |
| public | getSettlements() | Возвращает Массив оплат, обеспечивающих выдачу товара | |
| public | getTaxSystemCode() | Возвращает код системы налогообложения | |
| public | getType() | Возвращает тип чека в онлайн-кассе | |
| public | notEmpty() | Проверяет есть ли в чеке хотя бы одна позиция | |
| public | setAdditionalUserProps() | Устанавливает дополнительный реквизит пользователя | |
| public | setCustomer() | Устанавливает информацию о пользователе | |
| public | setItems() | Устанавливает список товаров чека | |
| public | setObjectId() | Устанавливает идентификатор объекта, для которого формируется чек | |
| public | setObjectType() | Устанавливает тип объекта чека | |
| public | setOnBehalfOf() | Устанавливает идентификатор магазина, от имени которого нужно отправить чек. | |
| public | setReceiptIndustryDetails() | Устанавливает отраслевой реквизит чека | |
| public | setReceiptOperationalDetails() | Устанавливает операционный реквизит чека | |
| public | setSend() | Устанавливает признак отложенной отправки чека | |
| public | setSettlements() | Устанавливает массив оплат, обеспечивающих выдачу товара | |
| public | setTaxSystemCode() | Устанавливает код системы налогообложения | |
| public | setType() | Устанавливает тип чека в онлайн-кассе |
Details
- File: lib/Request/Receipts/CreatePostReceiptRequestInterface.php
- Package: \YooKassa
Tags
| Tag | Version | Description |
|---|---|---|
| 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
public getObjectId() : string
public getObjectId() : string
Summary
Возвращает идентификатор объекта, для которого формируется чек
Details:
- Inherited From: \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface
Returns: string - Идентификатор объекта
public setObjectId() : \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface
public setObjectId(string $value) : \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface
Summary
Устанавливает идентификатор объекта, для которого формируется чек
Details:
- Inherited From: \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface
Parameters:
| Type | Name | Description |
|---|---|---|
string |
value | Идентификатор объекта |
Returns: \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface -
public getType() : string
public getType() : string
Summary
Возвращает тип чека в онлайн-кассе
Details:
- Inherited From: \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface
Returns: string - Тип чека в онлайн-кассе: приход "payment" или возврат "refund"
public setType() : \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface
public setType(string $value) : \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface
Summary
Устанавливает тип чека в онлайн-кассе
Details:
- Inherited From: \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface
Parameters:
| Type | Name | Description |
|---|---|---|
string |
value | Тип чека в онлайн-кассе: приход "payment" или возврат "refund" |
Returns: \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface -
public getObjectType() : string
public getObjectType() : string
Summary
Возвращает тип объекта чека
Details:
- Inherited From: \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface
Returns: string - Тип объекта чека
public setObjectType() : \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface
public setObjectType(string $value) : \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface
Summary
Устанавливает тип объекта чека
Details:
- Inherited From: \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface
Parameters:
| Type | Name | Description |
|---|---|---|
string |
value | Тип объекта чека |
Returns: \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface -
public getSend() : mixed
public getSend() : mixed
Summary
Возвращает признак отложенной отправки чека
Description
@return bool Признак отложенной отправки чека
Details:
- Inherited From: \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface
Returns: mixed -
public setSend() : \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface
public setSend(bool $value) : \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface
Summary
Устанавливает признак отложенной отправки чека
Details:
- Inherited From: \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface
Parameters:
| Type | Name | Description |
|---|---|---|
bool |
value | Признак отложенной отправки чека |
Returns: \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface -
public getTaxSystemCode() : mixed
public getTaxSystemCode() : mixed
Summary
Возвращает код системы налогообложения
Description
@return int Код системы налогообложения. Число 1-6
Details:
- Inherited From: \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface
Returns: mixed -
public setTaxSystemCode() : \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface
public setTaxSystemCode(int $value) : \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface
Summary
Устанавливает код системы налогообложения
Details:
- Inherited From: \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface
Parameters:
| Type | Name | Description |
|---|---|---|
int |
value | Код системы налогообложения. Число 1-6 |
Returns: \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface -
public getAdditionalUserProps() : mixed
public getAdditionalUserProps() : mixed
Summary
Возвращает дополнительный реквизит пользователя
Description
@return AdditionalUserProps Дополнительный реквизит пользователя
Details:
- Inherited From: \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface
Returns: mixed -
public setAdditionalUserProps() : \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface
public setAdditionalUserProps(\YooKassa\Model\Receipt\AdditionalUserProps $value) : \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface
Summary
Устанавливает дополнительный реквизит пользователя
Details:
- Inherited From: \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface
Parameters:
| Type | Name | Description |
|---|---|---|
\YooKassa\Model\Receipt\AdditionalUserProps |
value | Дополнительный реквизит пользователя |
Returns: \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface -
public getReceiptIndustryDetails() : \YooKassa\Model\Receipt\IndustryDetails[]
public getReceiptIndustryDetails() : \YooKassa\Model\Receipt\IndustryDetails[]
Summary
Возвращает отраслевой реквизит чека
Details:
- Inherited From: \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface
Returns: \YooKassa\Model\Receipt\IndustryDetails[] - Отраслевой реквизит чека
public setReceiptIndustryDetails() : mixed
public setReceiptIndustryDetails(array|\YooKassa\Model\Receipt\IndustryDetails[] $value) : mixed
Summary
Устанавливает отраслевой реквизит чека
Details:
- Inherited From: \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface
Parameters:
| Type | Name | Description |
|---|---|---|
array OR \YooKassa\Model\Receipt\IndustryDetails[] |
value | Отраслевой реквизит чека |
Returns: mixed -
public getReceiptOperationalDetails() : \YooKassa\Model\Receipt\OperationalDetails
public getReceiptOperationalDetails() : \YooKassa\Model\Receipt\OperationalDetails
Summary
Возвращает операционный реквизит чека
Details:
- Inherited From: \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface
Returns: \YooKassa\Model\Receipt\OperationalDetails - Операционный реквизит чека
public setReceiptOperationalDetails() : mixed
public setReceiptOperationalDetails(array|\YooKassa\Model\Receipt\OperationalDetails $value) : mixed
Summary
Устанавливает операционный реквизит чека
Details:
- Inherited From: \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface
Parameters:
| Type | Name | Description |
|---|---|---|
array OR \YooKassa\Model\Receipt\OperationalDetails |
value | Операционный реквизит чека |
Returns: mixed -
public getCustomer() : \YooKassa\Model\ReceiptCustomerInterface
public getCustomer() : \YooKassa\Model\ReceiptCustomerInterface
Summary
Возвращает информацию о плательщике.
Details:
- Inherited From: \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface
Returns: \YooKassa\Model\ReceiptCustomerInterface - Информация о плательщике
public setCustomer() : \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface
public setCustomer(\YooKassa\Model\ReceiptCustomerInterface $value) : \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface
Summary
Устанавливает информацию о пользователе
Details:
- Inherited From: \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface
Parameters:
| Type | Name | Description |
|---|---|---|
\YooKassa\Model\ReceiptCustomerInterface |
value | Информация о плательщике |
Returns: \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface -
public getItems() : mixed
public getItems() : mixed
Summary
Возвращает список товаров в заказе
Description
@return ReceiptItemInterface[]
Details:
- Inherited From: \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface
Returns: mixed -
public setItems() : \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface
public setItems(\YooKassa\Model\ReceiptItemInterface[]|array $value) : \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface
Summary
Устанавливает список товаров чека
Details:
- Inherited From: \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface
Parameters:
| Type | Name | Description |
|---|---|---|
\YooKassa\Model\ReceiptItemInterface[] OR array |
value | Список товаров чека |
Returns: \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface -
public addItem() : \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface
public addItem(\YooKassa\Model\ReceiptItemInterface|array $value) : \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface
Summary
Добавляет товар в чек
Details:
- Inherited From: \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface
Parameters:
| Type | Name | Description |
|---|---|---|
\YooKassa\Model\ReceiptItemInterface OR array |
value | Информация о товаре |
Returns: \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface -
public getSettlements() : mixed
public getSettlements() : mixed
Summary
Возвращает Массив оплат, обеспечивающих выдачу товара
Description
@return SettlementInterface[]
Details:
- Inherited From: \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface
Returns: mixed -
public setSettlements() : \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface
public setSettlements(\YooKassa\Model\SettlementInterface[]|array $value) : \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface
Summary
Устанавливает массив оплат, обеспечивающих выдачу товара
Details:
- Inherited From: \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface
Parameters:
| Type | Name | Description |
|---|---|---|
\YooKassa\Model\SettlementInterface[] OR array |
value | Массив оплат, обеспечивающих выдачу товара |
Returns: \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface -
public getOnBehalfOf() : string|null
public getOnBehalfOf() : string|null
Summary
Возвращает идентификатор магазина, от имени которого нужно отправить чек
Details:
- Inherited From: \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface
Returns: string|null - Идентификатор магазина, от имени которого нужно отправить чек
public setOnBehalfOf() : mixed
public setOnBehalfOf(string $value) : mixed
Summary
Устанавливает идентификатор магазина, от имени которого нужно отправить чек.
Description
Выдается ЮKassa, отображается в разделе Продавцы личного кабинета (столбец shopId). Необходимо передавать, если вы используете решение ЮKassa для платформ.
Details:
- Inherited From: \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface
Parameters:
| Type | Name | Description |
|---|---|---|
string |
value | Идентификатор магазина, от имени которого нужно отправить чек |
Returns: mixed -
public notEmpty() : bool
public notEmpty() : bool
Summary
Проверяет есть ли в чеке хотя бы одна позиция
Details:
- Inherited From: \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface
Returns: bool - True если чек не пуст, false если в чеке нет ни одной позиции
Top Namespaces
Reports
This document was automatically generated from source code comments on 2023-04-06 using phpDocumentor
© 2023 YooMoney