Эдуфрейм
Eduframe — это полное решение для коммерческих поставщиков обучения и бизнес-школ, чтобы привлечь больше учащихся, управлять и автоматизировать администрирование курса и обеспечить конечный опыт обучения. Eduframe легко интегрируется с Canvas LMS. Соединитель открывает возможность легко интегрировать существующие приложения программного обеспечения с Eduframe, например с программным обеспечением CRM и бухгалтерского учета.
Этот соединитель доступен в следующих продуктах и регионах:
| Услуга | Class | Регионы |
|---|---|---|
| Copilot Studio | Премия | Все регионы Power Automate , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Логические приложения | Стандарт | Все регионы Logic Apps , кроме следующих: — Регионы Azure для государственных организаций — Регионы Azure Для Китая - Министерство обороны США (DoD) |
| Power Apps | Премия | Все регионы Power Apps , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Power Automate | Премия | Все регионы Power Automate , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Контакт | |
|---|---|
| Имя | Группа разработки Eduframe |
| URL | https://eduframe.co |
| Адрес электронной почты | dev@drieam.nl |
| Метаданные соединителя | |
|---|---|
| Publisher | Microsoft |
| Website | https://eduframe.co |
| Политика конфиденциальности | https://drieam.com/security-and-privacy/ |
| Категории | Данные |
Eduframe управляет и автоматизирует администрирование курсов для коммерческих поставщиков обучения и бизнес-школ. С помощью этого соединителя можно подключить различные средства вместе с Eduframe для автоматического управления курсами, пользователями, счетами и т. д.
Предпосылки
Чтобы использовать этот соединитель, вам потребуется лицензия Eduframe. Дополнительные сведения об Eduframe и о том, как получить лицензию здесь.
Если у вас уже есть лицензия Eduframe, убедитесь, что Azure Logic Apps включена для вашей среды. Если вы хотите включить эту интеграцию, вы можете отправить сообщение электронной почты support@eduframe.nl.
Получение учетных данных
Если вы используете этот соединитель в первый раз, вам будет предложено войти в Eduframe и авторизовать этот соединитель. После авторизации вы сможете использовать этот соединитель и все его функции.
Начало работы с соединителем
Eduframe предоставляет веб-перехватчики, которые выполняют роль триггеров для автоматизации. Мы можем создать новый поток, который будет запускаться каждый раз, когда новый пользователь добавляется в Eduframe. При создании нового потока можно выбрать этот соединитель и выбрать "Подписаться на веб-перехватчик" в качестве триггера. Затем в разделе "Элемент событий" выберите user.created. Вы можете добавить больше, но сейчас мы заинтересованы только в этом.
Далее мы хотим узнать, какой пользователь был добавлен в eduframe. Для этого можно добавить новый шаг из этого соединителя под названием "Получить пользователя". На этом шаге потребуется идентификатор пользователя. Мы можем использовать идентификатор сущности из веб-перехватчика.
Теперь, когда мы знаем, кто новый пользователь находится в Eduframe, мы можем отправить этому лицу сообщение электронной почты. В качестве примера мы будем использовать соединитель Outlook, но это может быть любой поставщик почты. Добавьте новый шаг и нажмите кнопку "Отправить сообщение электронной почты". Здесь мы можем заполнить сообщение электронной почты от пользователя, тему и электронную почту, которую мы хотим отправить. Обратите внимание, что в тексте сообщения электронной почты можно использовать другие атрибуты пользователя, например имя и фамилию.
Когда мы закончим писать сообщение электронной почты, мы можем сохранить этот поток. Теперь каждый раз, когда новый пользователь добавляется в Eduframe, этот пользователь получит приветственное сообщение электронной почты.
Ограничения регулирования
| Имя | Вызовы | Период обновления |
|---|---|---|
| Вызовы API для каждого подключения | 100 | 60 секунд |
Действия
| Вывод списка всех курсов |
Получите все курсы. |
| Вывод списка всех меток |
Получение всех меток. |
| Вывод списка всех счетов |
Получение всех счетов. |
| Добавление категории |
Добавьте категорию в администрирование. |
| Добавление курса |
Добавьте курс в администрирование. |
| Добавление ндса счета |
Добавьте ндс счета, который можно использовать в счете. |
| Добавление пользователя |
Добавьте пользователя в администрирование. |
| Добавление проверки подлинности |
Добавление метода проверки подлинности для существующего пользователя |
| Добавление счета |
Добавьте счет в администрирование. |
| Добавление учетной записи |
Добавьте учетную запись в администрирование. |
| Перечисление всех ндс счета |
Получение всех ндс счета |
| Получение всех вариантов каталога |
Получение всех вариантов каталога. |
| Получение категории |
Получение категории по идентификатору |
| Получение курса |
Получение одного курса по идентификатору |
| Получение пользователя |
Получение отдельного пользователя по идентификатору. |
| Получение проверки подлинности пользователя |
Получите список аутентификаций, принадлежащих конкретному пользователю. |
| Получение счета |
Получение единого счета по идентификатору. |
| Получение учетной записи |
Получение учетной записи по идентификатору. |
| Список всех категорий |
Получение всех категорий. |
| Список всех пользователей |
Получите всех пользователей. |
| Список всех учетных записей |
Получение всех учетных записей. |
| Удаление проверки подлинности пользователя |
Удалите одну из аутентификаций пользователя. Обратите внимание, что вы не можете удалить последнюю проверку подлинности! |
Вывод списка всех курсов
Получите все курсы.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Номер страницы
|
page | integer |
Номер страницы для получения. |
|
|
Записи на страницу
|
per_page | integer |
Количество записей на страницу. |
|
|
Сортировать
|
sort | array |
Сортируйте результаты. Изменение порядка с помощью |
Возвращаемое значение
- response
- array of course
Вывод списка всех меток
Получение всех меток.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Номер страницы
|
page | integer |
Номер страницы для получения. |
|
|
Записи на страницу
|
per_page | integer |
Количество записей на страницу. |
|
|
Фильтрация по типу модели метки
|
model_type | string |
Фильтрация меток на основе типа модели. |
Возвращаемое значение
- response
- array of label
Вывод списка всех счетов
Получение всех счетов.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Номер страницы
|
page | integer |
Номер страницы для получения. |
|
|
Записи на страницу
|
per_page | integer |
Количество записей на страницу. |
Возвращаемое значение
- response
- array of invoice
Добавление категории
Добавьте категорию в администрирование.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
id
|
id | integer |
Уникальный идентификатор категории. |
|
|
Имя
|
name | True | string |
Заголовок категории. |
|
Description
|
description | string |
Описание категории. |
|
|
позиция
|
position | number |
Сортировка позиции категории. Ниже. |
|
|
parent_id
|
parent_id | number |
Уникальный идентификатор родительской категории |
|
|
аватар
|
avatar | string |
URL-адрес аватара категории. |
|
|
Опубликовано
|
is_published | boolean |
Если категория должна быть опубликована на веб-сайте. |
|
|
courses_count
|
courses_count | number |
Количество курсов, непосредственно связанных с этой категорией. |
|
|
children_count
|
children_count | number |
Число дочерних категорий, непосредственно связанных с этой категорией. |
|
|
updated_at
|
updated_at | string |
Метка времени последнего обновления. |
|
|
создано_в
|
created_at | string |
Метка времени создания. |
|
|
avatar_url
|
avatar_url | string |
URL-адрес изображения аватара с изменением размера (300x200^). |
Возвращаемое значение
- Тело
- category
Добавление курса
Добавьте курс в администрирование.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
id
|
id | integer |
Уникальный идентификатор курса |
|
|
имя
|
name | True | string |
Имя курса. |
|
позиция
|
position | number |
Сортировка позиции курса. Ниже. |
|
|
signup_url
|
signup_url | string |
URL-адрес страницы регистрации для этого курса. |
|
|
slug_history
|
slug_history | array of string |
Список старых slugs, старые вызовы будут перенаправлены. |
|
|
аватар
|
avatar | string |
URL-адрес изображения аватара с изменением размера (300x200^). |
|
|
certificate_template_id
|
certificate_template_id | number |
Идентификатор необязательно связанного шаблона сертификата. |
|
|
Категория
|
category_id | True | number |
Идентификатор категории курса. |
|
код
|
code | True | string |
Код курса. |
|
стоимость
|
cost | string |
Цена, которую нужно заплатить за этот курс. |
|
|
cost_scheme
|
cost_scheme | string |
Как следует платить курс по умолчанию. |
|
|
is_published
|
is_published | boolean |
Логическое значение, представляющее состояние публикации курса. |
|
|
updated_at
|
updated_at | string |
Метка времени последнего обновления. |
|
|
создано_в
|
created_at | string |
Метка времени создания. |
Возвращаемое значение
- Тело
- course
Добавление ндса счета
Добавьте ндс счета, который можно использовать в счете.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
id
|
id | integer |
Уникальный idenitfier ндс счета. |
|
|
имя
|
name | True | string |
Имя ндс счета. |
|
процент
|
percentage | True | string |
Число, представляющее процент НДС. |
Возвращаемое значение
- Тело
- invoice_vat
Добавление пользователя
Добавьте пользователя в администрирование.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя (первое имя)
|
first_name | True | string |
Имя пользователя. |
|
Отчество/второе имя
|
middle_name | string |
По промежуточному имени пользователя. |
|
|
Фамилия
|
last_name | True | string |
Фамилия пользователя. |
|
Адрес электронной почты
|
True | string |
Электронная почта пользователя. |
|
|
Номер телефона
|
phone | string |
Номер телефона пользователя. |
|
|
Подписка на информационный бюллетень
|
wants_newsletter | boolean |
Хочет ли пользователь получать информационные бюллетени? |
|
|
Создание проверки подлинности
|
with_authentication | boolean |
Создайте проверку подлинности для пользователя, чтобы пользователь мог войти в систему. |
|
|
местность
|
locale | string |
Языковой стандарт пользователя. |
|
|
label_ids
|
label_ids | array of number | ||
|
id
|
id | integer |
Уникальный идентификатор адреса. |
|
|
адресат
|
addressee | string |
Адрес адреса. |
|
|
address
|
address | True | string |
Объединение номера улицы и дома. |
|
почтовый индекс
|
postal_code | True | string |
Строка, представляющая почтовый индекс. |
|
city
|
city | True | string |
Строка, представляющая город. |
|
country
|
country | True | string |
Строка, представляющая страну. |
|
updated_at
|
updated_at | string |
Метка времени последнего обновления. |
|
|
создано_в
|
created_at | string |
Метка времени создания. |
|
|
notes_user
|
notes_user | string |
Краткое примечание о пользователе. |
Возвращаемое значение
- Тело
- user
Добавление проверки подлинности
Добавление метода проверки подлинности для существующего пользователя
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
user_id
|
user_id | True | integer |
Идентификатор пользователя, которому принадлежит эта проверка подлинности. |
|
authentication_provider_type
|
authentication_provider_type | True | string |
Тип поставщика проверки подлинности. |
|
uid
|
uid | True | string |
Уникальный идентификатор этой проверки подлинности, соответствующий уникальному идентификатору поставщика удостоверений. |
Возвращаемое значение
- Тело
- authentication
Добавление счета
Добавьте счет в администрирование.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Счет
|
account_id | True | number |
Идентификатор учетной записи. |
|
account_name
|
account_name | string |
Имя платной учетной записи. Копируется в счет и, таким образом, не обновляется автоматически, если имя учетной записи изменяется. |
|
|
currency
|
currency | True | string |
Валюта счета. |
|
id
|
id | integer |
Уникальный идентификатор элемента счета. |
|
|
Единицы
|
units | True | number |
Количество единиц элемента счета. |
|
Description
|
name | True | string |
Имя элемента счета. |
|
Цена
|
unit_price | True | string |
Цена одной единицы. |
|
Чан
|
invoice_vat_id | number |
Идентификатор ндса счета. |
|
|
Вариант каталога
|
catalog_variant_id | number |
Идентификатор варианта каталога. |
|
|
updated_at
|
updated_at | string |
Метка времени последнего обновления. |
|
|
создано_в
|
created_at | string |
Метка времени создания. |
|
|
feature
|
feature | string |
Описание счета, отображаемого в счете. |
|
|
сноска
|
footnote | string |
Заметка, отображаемая в нижней части счета. |
Возвращаемое значение
- Тело
- invoice
Добавление учетной записи
Добавьте учетную запись в администрирование.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
имя
|
name | True | string |
Имя учетной записи. |
|
электронная почта
|
string |
Строка, представляющая электронную почту выставления счетов учетной записи. |
||
|
id
|
id | integer |
Уникальный идентификатор адреса. |
|
|
адресат
|
addressee | string |
Адрес адреса. |
|
|
address
|
address | True | string |
Объединение номера улицы и дома. |
|
почтовый индекс
|
postal_code | True | string |
Строка, представляющая почтовый индекс. |
|
city
|
city | True | string |
Строка, представляющая город. |
|
country
|
country | True | string |
Строка, представляющая страну. |
|
updated_at
|
updated_at | string |
Метка времени последнего обновления. |
|
|
создано_в
|
created_at | string |
Метка времени создания. |
Возвращаемое значение
- Тело
- account
Перечисление всех ндс счета
Получение всех ндс счета
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Номер страницы
|
page | integer |
Номер страницы для получения. |
|
|
Записи на страницу
|
per_page | integer |
Количество записей на страницу. |
Возвращаемое значение
- response
- array of invoice_vat
Получение всех вариантов каталога
Получение всех вариантов каталога.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Номер страницы
|
page | integer |
Номер страницы для получения. |
|
|
Записи на страницу
|
per_page | integer |
Количество записей на страницу. |
Возвращаемое значение
- response
- array of catalog_variant
Получение категории
Получение категории по идентификатору
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор категории
|
id | True | integer |
Идентификатор категории. |
Возвращаемое значение
- Тело
- category
Получение курса
Получение одного курса по идентификатору
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор курса
|
id | True | integer |
Идентификатор курса. |
Возвращаемое значение
- Тело
- course
Получение пользователя
Получение отдельного пользователя по идентификатору.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор пользователя
|
id | True | integer |
Идентификатор пользователя. |
Возвращаемое значение
- Тело
- user
Получение проверки подлинности пользователя
Получите список аутентификаций, принадлежащих конкретному пользователю.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Номер страницы
|
page | integer |
Номер страницы для получения. |
|
|
Записи на страницу
|
per_page | integer |
Количество записей на страницу. |
|
|
Идентификатор пользователя
|
user_id | True | integer |
Идентификатор пользователя. |
Возвращаемое значение
- response
- array of authentication
Получение счета
Получение единого счета по идентификатору.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор счета
|
id | True | integer |
Идентификатор счета. |
Возвращаемое значение
- Тело
- invoice
Получение учетной записи
Получение учетной записи по идентификатору.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор учетной записи
|
id | True | integer |
Идентификатор учетной записи. |
Возвращаемое значение
- Тело
- account
Список всех категорий
Получение всех категорий.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Номер страницы
|
page | integer |
Номер страницы для получения. |
|
|
Записи на страницу
|
per_page | integer |
Количество записей на страницу. |
|
|
Сортировать
|
sort | array |
Сортируйте результаты. Изменение порядка с помощью |
Возвращаемое значение
- response
- array of category
Список всех пользователей
Получите всех пользователей.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Номер страницы
|
page | integer |
Номер страницы для получения. |
|
|
Записи на страницу
|
per_page | integer |
Количество записей на страницу. |
|
|
Сортировать
|
sort | array |
Сортируйте результаты. Изменение порядка с помощью |
Возвращаемое значение
- response
- array of user
Список всех учетных записей
Получение всех учетных записей.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Номер страницы
|
page | integer |
Номер страницы для получения. |
|
|
Записи на страницу
|
per_page | integer |
Количество записей на страницу. |
Возвращаемое значение
- response
- array of account
Удаление проверки подлинности пользователя
Удалите одну из аутентификаций пользователя. Обратите внимание, что вы не можете удалить последнюю проверку подлинности!
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор пользователя
|
user_id | True | integer |
Идентификатор пользователя. |
|
Идентификатор проверки подлинности
|
authentication_id | True | integer |
Идентификатор проверки подлинности. |
Триггеры
| Подписка на веб-перехватчик |
Подпишитесь на веб-перехватчик, чтобы получать уведомления об обновлениях записей. |
Подписка на веб-перехватчик
Подпишитесь на веб-перехватчик, чтобы получать уведомления об обновлениях записей.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
id
|
id | string |
Уникальный идентификатор веб-перехватчика. (UUID). |
|
|
активный
|
active | boolean |
Состояние веб-перехватчика. |
|
|
events
|
events | True | array of string |
Массив событий, которые должны активировать этот веб-перехватчик. |
Возвращаемое значение
- Тело
- webhook_payload
Определения
account
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
id | integer |
Уникальный идентификатор учетной записи. |
|
имя
|
name | string |
Имя учетной записи. |
|
электронная почта
|
string |
Строка, представляющая электронную почту выставления счетов учетной записи. |
|
|
account_type
|
account_type | string |
Тип учетной записи. |
|
address
|
address | address | |
|
phone
|
phone | string |
Строка, представляющая номер телефона учетной записи. |
|
updated_at
|
updated_at | string |
Метка времени последнего обновления. |
|
создано_в
|
created_at | string |
Метка времени создания. |
|
signup_answers
|
signup_answers | array of customField |
Список ответов на регистрацию для этой учетной записи. |
address
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
id | integer |
Уникальный идентификатор адреса. |
|
адресат
|
addressee | string |
Адрес адреса. |
|
address
|
address | string |
Объединение номера улицы и дома. |
|
почтовый индекс
|
postal_code | string |
Строка, представляющая почтовый индекс. |
|
city
|
city | string |
Строка, представляющая город. |
|
country
|
country | string |
Строка, представляющая страну. |
|
updated_at
|
updated_at | string |
Метка времени последнего обновления. |
|
создано_в
|
created_at | string |
Метка времени создания. |
аутентификация
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
id | integer |
Уникальный идентификатор проверки подлинности. |
|
user_id
|
user_id | integer |
Идентификатор пользователя, которому принадлежит эта проверка подлинности. |
|
authentication_provider_id
|
authentication_provider_id | integer |
Идентификатор поставщика проверки подлинности. |
|
uid
|
uid | string |
Уникальный идентификатор этой проверки подлинности, соответствующий уникальному идентификатору поставщика удостоверений. |
|
Если OTP включен для этого имени входа.
|
otp_enabled |
Если поставщик проверки подлинности является Eduframe, указывает, включен ли один пароль для этого имени входа, имеет значение false для других поставщиков. |
|
|
updated_at
|
updated_at | string |
Метка времени последнего обновления. |
|
создано_в
|
created_at | string |
Метка времени создания. |
customField
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
id | integer |
Уникальный идентификатор ответа на регистрацию. |
|
value
|
value | string |
Форматируемое значение ответа. |
|
signup_question_id
|
signup_question_id | integer |
Уникальный идентификатор вопроса. |
категория
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
id | integer |
Уникальный идентификатор категории. |
|
Имя
|
name | string |
Заголовок категории. |
|
Description
|
description | string |
Описание категории. |
|
позиция
|
position | number |
Сортировка позиции категории. Ниже. |
|
parent_id
|
parent_id | number |
Уникальный идентификатор родительской категории |
|
аватар
|
avatar | string |
URL-адрес аватара категории. |
|
Опубликовано
|
is_published | boolean |
Если категория должна быть опубликована на веб-сайте. |
|
courses_count
|
courses_count | number |
Количество курсов, непосредственно связанных с этой категорией. |
|
children_count
|
children_count | number |
Число дочерних категорий, непосредственно связанных с этой категорией. |
|
updated_at
|
updated_at | string |
Метка времени последнего обновления. |
|
создано_в
|
created_at | string |
Метка времени создания. |
|
avatar_url
|
avatar_url | string |
URL-адрес изображения аватара с изменением размера (300x200^). |
курс
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
id | integer |
Уникальный идентификатор курса |
|
имя
|
name | string |
Имя курса. |
|
позиция
|
position | number |
Сортировка позиции курса. Ниже. |
|
signup_url
|
signup_url | string |
URL-адрес страницы регистрации для этого курса. |
|
аватар
|
avatar | string |
URL-адрес изображения аватара с изменением размера (300x200^). |
|
certificate_template_id
|
certificate_template_id | number |
Идентификатор необязательно связанного шаблона сертификата. |
|
Категория
|
category_id | number |
Идентификатор категории курса. |
|
код
|
code | string |
Код курса. |
|
стоимость
|
cost | string |
Цена, которую нужно заплатить за этот курс. |
|
cost_scheme
|
cost_scheme | string |
Как следует платить курс по умолчанию. |
|
is_published
|
is_published | boolean |
Логическое значение, представляющее состояние публикации курса. |
|
updated_at
|
updated_at | string |
Метка времени последнего обновления. |
|
создано_в
|
created_at | string |
Метка времени создания. |
Пользователь
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
id | integer |
Уникальный идентификатор пользователя. |
|
Номер сотрудника
|
employee_number | string |
Номер сотрудника этого пользователя. |
|
Имя (первое имя)
|
first_name | string |
Имя пользователя. |
|
Отчество/второе имя
|
middle_name | string |
По промежуточному имени пользователя. |
|
Фамилия
|
last_name | string |
Фамилия пользователя. |
|
Адрес электронной почты
|
string |
Электронная почта пользователя. |
|
|
Номер телефона
|
phone | string |
Номер телефона пользователя. |
|
labels
|
labels | array of label | |
|
Подписка на информационный бюллетень
|
wants_newsletter | boolean |
Хочет ли пользователь получать информационные бюллетени? |
|
Создание проверки подлинности
|
with_authentication | boolean |
Создайте проверку подлинности для пользователя, чтобы пользователь мог войти в систему. |
|
местность
|
locale | string |
Языковой стандарт пользователя. |
|
address
|
address | address | |
|
Аватар
|
avatar_url | string |
Относительный путь URL-адреса к аватару. |
|
updated_at
|
updated_at | string |
Метка времени последнего обновления. |
|
создано_в
|
created_at | string |
Метка времени создания. |
накладная
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
id | integer |
Уникальный идентификатор счета. |
|
reference_id
|
reference_id | string |
Идентификатор ссылки счета. Используется для поиска счета. |
|
Счет
|
account_id | number |
Идентификатор учетной записи. |
|
число/номер
|
number | string |
Номер счета, уникальный для каждого преподавателя. Если он остается пустым, он автоматически увеличивается. |
|
number_int
|
number_int | number |
Номер счета, преобразованный в целочисленное значение. |
|
статус
|
status | string |
Состояние счета. Начальное состояние всегда будет концепцией. |
|
expiration_date
|
expiration_date | string |
Дата окончания срока действия счета. Устанавливается при открытии счета. |
|
opened_at
|
opened_at | string |
Дата изменения состояния счета на открытие. |
|
описание
|
description | string |
Удобочитаемое описание счета. |
|
account_name
|
account_name | string |
Имя платной учетной записи. Копируется в счет и, таким образом, не обновляется автоматически, если имя учетной записи изменяется. |
|
currency
|
currency | string |
Валюта счета. |
|
total_incl
|
total_incl | string |
Общая стоимость счета, включая НДС. |
|
total_excl
|
total_excl | string |
Общая стоимость счета, за исключением НДС. |
|
total_open
|
total_open | string |
Открытая стоимость счета, включая НДС. |
|
pdf_url
|
pdf_url | string |
Url-адрес пути скачивания счета в формате PDF. |
|
xml_url
|
xml_url | string |
Url-адрес пути скачивания счета в формате UML. |
|
feature
|
feature | string |
Описание счета, отображаемого в счете. |
|
сноска
|
footnote | string |
Заметка, отображаемая в нижней части счета. |
|
invoice_items
|
invoice_items | array of invoice_item | |
|
updated_at
|
updated_at | string |
Метка времени последнего обновления. |
|
создано_в
|
created_at | string |
Метка времени создания. |
invoice_item
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
id | integer |
Уникальный идентификатор элемента счета. |
|
Единицы
|
units | number |
Количество единиц элемента счета. |
|
Description
|
name | string |
Имя элемента счета. |
|
Цена
|
unit_price | string |
Цена одной единицы. |
|
Чан
|
invoice_vat_id | number |
Идентификатор ндса счета. |
|
Вариант каталога
|
catalog_variant_id | number |
Идентификатор варианта каталога. |
|
updated_at
|
updated_at | string |
Метка времени последнего обновления. |
|
создано_в
|
created_at | string |
Метка времени создания. |
invoice_vat
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
id | integer |
Уникальный idenitfier ндс счета. |
|
имя
|
name | string |
Имя ндс счета. |
|
процент
|
percentage | string |
Число, представляющее процент НДС. |
catalog_variant
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
id | number |
Уникальный идентификатор варианта каталога |
|
product_id
|
product_id | number |
Уникальный идентификатор продукта каталога |
|
имя
|
name | string |
Имя курса. |
|
cost_scheme
|
cost_scheme | string |
Как следует платить вариант каталога по умолчанию. |
|
стоимость
|
cost | string |
Плата за этот вариант каталога. |
|
currency
|
currency | string |
Валюта варианта каталога. |
|
variantable_type
|
variantable_type | string |
Валюта счета. |
|
variantable_id
|
variantable_id | number |
Уникальный идентификатор варианта. |
|
updated_at
|
updated_at | string |
Метка времени последнего обновления. |
|
создано_в
|
created_at | string |
Метка времени создания. |
|
Опубликовано
|
is_published | boolean |
Если категория должна быть опубликована на веб-сайте. |
label
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
id | number |
Уникальный идентификатор метки |
|
Имя
|
name | string |
Имя метки. |
|
Цвет
|
color | string |
Шестнадцатеричный код цвета метки. |
|
Модель
|
model_type | string |
Тип модели, для которого доступна эта метка. |
|
updated_at
|
updated_at | string |
Метка времени последнего обновления. |
|
создано_в
|
created_at | string |
Метка времени создания. |
webhook_payload
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
воспитатель
|
educator | string |
Слизь преподавателя. |
|
событие
|
event | string |
Тип события, активировав веб-перехватчик. |
|
entity_type
|
entity_type | string |
Тип модели, которая активировала веб-перехватчик. |
|
entity_id
|
entity_id | number |
Уникальный идентификатор модели, которая активировала веб-перехватчик. |
|
идентификатор арендатора
|
tenant_id | string |
UUID преподавателя. |