13 KiB
YooKassa API SDK
Interface: SelfEmployedInterface
Namespace: \YooKassa\Model\SelfEmployed
Summary:
Класс, представляющий модель SelfEmployed.
Description:
Объект самозанятого.
Constants
| Visibility | Name | Flag | Summary |
|---|
Methods
| Visibility | Name | Flag | Summary |
|---|---|---|---|
| public | getConfirmation() | Возвращает сценарий подтверждения. | |
| public | getCreatedAt() | Возвращает время создания объекта самозанятого | |
| public | getId() | Возвращает идентификатор самозанятого. | |
| public | getItn() | Возвращает ИНН самозанятого | |
| public | getPhone() | Возвращает телефон самозанятого. | |
| public | getStatus() | Возвращает статус самозанятого. | |
| public | getTest() | Возвращает признак тестовой операции. | |
| public | setConfirmation() | Устанавливает сценарий подтверждения. | |
| public | setCreatedAt() | Устанавливает время создания объекта самозанятого | |
| public | setId() | Устанавливает идентификатор самозанятого. | |
| public | setItn() | Устанавливает ИНН самозанятого | |
| public | setPhone() | Устанавливает телефон самозанятого. | |
| public | setStatus() | Устанавливает статус самозанятого. | |
| public | setTest() | Устанавливает признак тестовой операции. |
Details
- File: lib/Model/SelfEmployed/SelfEmployedInterface.php
- Package: \YooKassa\Model
Tags
| Tag | Version | Description |
|---|---|---|
| author | cms@yoomoney.ru | |
| property | Идентификатор самозанятого в ЮKassa. | |
| property | Статус подключения самозанятого и выдачи ЮMoney прав на регистрацию чеков. | |
| property | Время создания объекта самозанятого. | |
| property | Время создания объекта самозанятого. | |
| property | ИНН самозанятого. | |
| property | Телефон самозанятого, который привязан к личному кабинету в сервисе Мой налог. | |
| property | Сценарий подтверждения пользователем заявки ЮMoney на получение прав для регистрации чеков в сервисе Мой налог. | |
| property | Идентификатор самозанятого в ЮKassa. |
Constants
MIN_LENGTH_ID
MIN_LENGTH_ID = 36 : int
MAX_LENGTH_ID
MAX_LENGTH_ID = 50 : int
Methods
public getId() : string
public getId() : string
Summary
Возвращает идентификатор самозанятого.
Details:
- Inherited From: \YooKassa\Model\SelfEmployed\SelfEmployedInterface
Returns: string -
public setId() : $this
public setId(string $id) : $this
Summary
Устанавливает идентификатор самозанятого.
Details:
- Inherited From: \YooKassa\Model\SelfEmployed\SelfEmployedInterface
Parameters:
| Type | Name | Description |
|---|---|---|
string |
id | Идентификатор самозанятого в ЮKassa |
Returns: $this -
public getStatus() : string
public getStatus() : string
Summary
Возвращает статус самозанятого.
Details:
- Inherited From: \YooKassa\Model\SelfEmployed\SelfEmployedInterface
Returns: string - Статус самозанятого
public setStatus() : $this
public setStatus(string $status) : $this
Summary
Устанавливает статус самозанятого.
Details:
- Inherited From: \YooKassa\Model\SelfEmployed\SelfEmployedInterface
Parameters:
| Type | Name | Description |
|---|---|---|
string |
status | Статус самозанятого |
Returns: $this -
public getCreatedAt() : \DateTime
public getCreatedAt() : \DateTime
Summary
Возвращает время создания объекта самозанятого
Details:
- Inherited From: \YooKassa\Model\SelfEmployed\SelfEmployedInterface
Returns: \DateTime - Время создания объекта самозанятого
public setCreatedAt() : $this
public setCreatedAt(\DateTime|string|int $created_at) : $this
Summary
Устанавливает время создания объекта самозанятого
Details:
- Inherited From: \YooKassa\Model\SelfEmployed\SelfEmployedInterface
Parameters:
| Type | Name | Description |
|---|---|---|
\DateTime OR string OR int |
created_at | Время создания объекта самозанятого |
Throws:
| Type | Description |
|---|---|
| \YooKassa\Common\Exceptions\EmptyPropertyValueException | Выбрасывается если в метод была передана пустая дата |
| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если передали строку, которую не удалось привести к дате |
| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | \Exception |
Returns: $this -
public getItn() : string|null
public getItn() : string|null
Summary
Возвращает ИНН самозанятого
Details:
- Inherited From: \YooKassa\Model\SelfEmployed\SelfEmployedInterface
Returns: string|null - ИНН самозанятого
public setItn() : $this
public setItn(string|null $itn = null) : $this
Summary
Устанавливает ИНН самозанятого
Details:
- Inherited From: \YooKassa\Model\SelfEmployed\SelfEmployedInterface
Parameters:
| Type | Name | Description |
|---|---|---|
string OR null |
itn | ИНН самозанятого |
Returns: $this -
public getPhone() : string|null
public getPhone() : string|null
Summary
Возвращает телефон самозанятого.
Details:
- Inherited From: \YooKassa\Model\SelfEmployed\SelfEmployedInterface
Returns: string|null - Телефон самозанятого
public setPhone() : $this
public setPhone(string|null $phone = null) : $this
Summary
Устанавливает телефон самозанятого.
Details:
- Inherited From: \YooKassa\Model\SelfEmployed\SelfEmployedInterface
Parameters:
| Type | Name | Description |
|---|---|---|
string OR null |
phone | Телефон самозанятого |
Returns: $this -
public getConfirmation() : \YooKassa\Model\SelfEmployed\SelfEmployedConfirmation|null
public getConfirmation() : \YooKassa\Model\SelfEmployed\SelfEmployedConfirmation|null
Summary
Возвращает сценарий подтверждения.
Details:
- Inherited From: \YooKassa\Model\SelfEmployed\SelfEmployedInterface
Returns: \YooKassa\Model\SelfEmployed\SelfEmployedConfirmation|null - Сценарий подтверждения
public setConfirmation() : $this
public setConfirmation(\YooKassa\Model\SelfEmployed\SelfEmployedConfirmation|array|null $confirmation = null) : $this
Summary
Устанавливает сценарий подтверждения.
Details:
- Inherited From: \YooKassa\Model\SelfEmployed\SelfEmployedInterface
Parameters:
| Type | Name | Description |
|---|---|---|
\YooKassa\Model\SelfEmployed\SelfEmployedConfirmation OR array OR null |
confirmation | Сценарий подтверждения |
Returns: $this -
public getTest() : bool
public getTest() : bool
Summary
Возвращает признак тестовой операции.
Details:
- Inherited From: \YooKassa\Model\SelfEmployed\SelfEmployedInterface
Returns: bool - Признак тестовой операции.
public setTest() : $this
public setTest(bool $test) : $this
Summary
Устанавливает признак тестовой операции.
Details:
- Inherited From: \YooKassa\Model\SelfEmployed\SelfEmployedInterface
Parameters:
| Type | Name | Description |
|---|---|---|
bool |
test | Признак тестовой операции. |
Returns: $this -
Top Namespaces
Reports
This document was automatically generated from source code comments on 2023-04-06 using phpDocumentor
© 2023 YooMoney