Eduframe
Eduframeは、商用トレーニングプロバイダーとビジネススクールが、より多くの学生を引き付け、コース管理を管理および自動化し、究極の学習体験を提供するための完全なソリューションです。 Eduframe は Canvas LMS とシームレスに統合されます。 コネクタを使用すると、既存のソフトウェア アプリケーションを CRM や会計ソフトウェアなどの Eduframe と簡単に統合できます。
このコネクタは、次の製品とリージョンで使用できます。
| サービス | クラス | リージョン |
|---|---|---|
| コピロット スタジオ | Premium | 次を除くすべての Power Automate リージョン : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運営する China Cloud - 米国国防総省 (DoD) |
| ロジック アプリ | Standard | 次を除くすべての Logic Apps リージョン : - Azure Government リージョン - Azure China リージョン - 米国国防総省 (DoD) |
| Power Apps | Premium | 次を除くすべての Power Apps リージョン : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運営する China Cloud - 米国国防総省 (DoD) |
| Power Automate | Premium | 次を除くすべての Power Automate リージョン : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運営する China Cloud - 米国国防総省 (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 には、自動化のトリガーとして機能する Webhook が用意されています。 新しいユーザーが Eduframe に追加されるたびにトリガーされる新しいフローを作成できます。 新しいフローを作成するときに、このコネクタを選択し、トリガーとして [Subscribe to webhook] を選択できます。 次に、[events Item]\(イベント項目\) で [user.created] を選択します。 さらに追加することもできますが、現時点では、この方法にのみ関心があります。
次に、eduframe に追加されたユーザーを確認します。 これを行うには、"ユーザーの取得" という名前の新しい手順をこのコネクタから追加します。 この手順では、ユーザーの ID が必要です。 Webhook のエンティティ ID を使用できます。
これで、新しいユーザーが Eduframe に誰であるかを知ったので、このユーザーにメールを送信できます。 例として Outlook コネクタを使用しますが、これは任意のメール プロバイダーである可能性があります。 新しい手順を追加し、[メールの送信] を選択します。 ここでは、ユーザーからのメール、件名、送信するメールを入力できます。 電子メールの本文では、名や姓などのユーザーの他の属性を使用できることに注意してください。
メールの作成が完了したら、このフローを保存できます。 新しいユーザーが Eduframe に追加されるたびに、このユーザーはウェルカム メールを受け取ります。
調整制限
| 名前 | 呼び出し | 更新期間 |
|---|---|---|
| 接続ごとの API 呼び出し | 100 | 60 秒 |
アクション
| すべてのアカウントを一覧表示する |
すべてのアカウントを取得します。 |
| すべてのカタログ バリアントを取得する |
すべてのカタログ バリアントを取得します。 |
| すべてのカテゴリを一覧表示する |
すべてのカテゴリを取得します。 |
| すべてのコースを一覧表示する |
すべてのコースを取得します。 |
| すべてのユーザーを一覧表示する |
すべてのユーザーを取得します。 |
| すべてのラベルを一覧表示する |
すべてのラベルを取得します。 |
| すべての請求書 VAT を一覧表示する |
すべての請求書 VAT を取得する |
| すべての請求書を一覧表示する |
すべての請求書を取得します。 |
| アカウントを取得する |
ID でアカウントを取得します。 |
| アカウントを追加する |
アカウントを管理に追加します。 |
| カテゴリを取得する |
ID でカテゴリを取得する |
| カテゴリを追加する |
管理にカテゴリを追加します。 |
| コースを取得する |
ID で 1 つのコースを取得する |
| コースを追加する |
管理にコースを追加します。 |
| ユーザーの認証を削除する |
ユーザーの認証のいずれかを削除します。 最後の認証を削除できないことに注意してください。 |
| ユーザーの認証を取得する |
特定のユーザーに属する認証の一覧を取得します。 |
| ユーザーを取得する |
ID で 1 人のユーザーを取得します。 |
| ユーザーを追加する |
ユーザーを管理に追加します。 |
| 認証を追加する |
既存のユーザーに認証方法を追加する |
| 請求書 VAT を追加する |
請求書に使用できる請求書 VAT を追加します。 |
| 請求書を取得する |
ID で 1 つの請求書を取得します。 |
| 請求書を追加する |
請求書を管理に追加します。 |
すべてのアカウントを一覧表示する
すべてのアカウントを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ページ番号
|
page | integer |
取得するページ番号。 |
|
|
1 ページあたりのレコード数
|
per_page | integer |
1 ページあたりのレコード数。 |
戻り値
- response
- array of account
すべてのカタログ バリアントを取得する
すべてのカタログ バリアントを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ページ番号
|
page | integer |
取得するページ番号。 |
|
|
1 ページあたりのレコード数
|
per_page | integer |
1 ページあたりのレコード数。 |
戻り値
- response
- array of catalog_variant
すべてのカテゴリを一覧表示する
すべてのカテゴリを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ページ番号
|
page | integer |
取得するページ番号。 |
|
|
1 ページあたりのレコード数
|
per_page | integer |
1 ページあたりのレコード数。 |
|
|
ソート
|
sort | array |
結果を並べ替えます。 使用して順序を変更する |
戻り値
- response
- array of category
すべてのコースを一覧表示する
すべてのコースを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ページ番号
|
page | integer |
取得するページ番号。 |
|
|
1 ページあたりのレコード数
|
per_page | integer |
1 ページあたりのレコード数。 |
|
|
ソート
|
sort | array |
結果を並べ替えます。 使用して順序を変更する |
戻り値
- response
- array of course
すべてのユーザーを一覧表示する
すべてのユーザーを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ページ番号
|
page | integer |
取得するページ番号。 |
|
|
1 ページあたりのレコード数
|
per_page | integer |
1 ページあたりのレコード数。 |
|
|
ソート
|
sort | array |
結果を並べ替えます。 使用して順序を変更する |
戻り値
- response
- array of user
すべてのラベルを一覧表示する
すべてのラベルを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ページ番号
|
page | integer |
取得するページ番号。 |
|
|
1 ページあたりのレコード数
|
per_page | integer |
1 ページあたりのレコード数。 |
|
|
ラベルのモデルの種類をフィルター処理する
|
model_type | string |
モデルの種類に基づいてラベルをフィルター処理します。 |
戻り値
- response
- array of label
すべての請求書 VAT を一覧表示する
すべての請求書 VAT を取得する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ページ番号
|
page | integer |
取得するページ番号。 |
|
|
1 ページあたりのレコード数
|
per_page | integer |
1 ページあたりのレコード数。 |
戻り値
- response
- array of invoice_vat
すべての請求書を一覧表示する
すべての請求書を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ページ番号
|
page | integer |
取得するページ番号。 |
|
|
1 ページあたりのレコード数
|
per_page | integer |
1 ページあたりのレコード数。 |
戻り値
- response
- array of invoice
アカウントを取得する
アカウントを追加する
アカウントを管理に追加します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
名前
|
name | True | string |
アカウント名。 |
|
メール
|
string |
アカウントの課金電子メールを表す文字列。 |
||
|
id
|
id | integer |
アドレスの一意識別子。 |
|
|
受取人
|
addressee | string |
アドレスの宛先。 |
|
|
address
|
address | True | string |
番地と住宅番号の連結。 |
|
postal_code
|
postal_code | True | string |
郵便番号を表す文字列。 |
|
city
|
city | True | string |
市区町村を表す文字列。 |
|
country
|
country | True | string |
国を表す文字列。 |
|
updated_at
|
updated_at | string |
最後の更新のタイムスタンプ。 |
|
|
作成日時
|
created_at | string |
作成のタイムスタンプ。 |
戻り値
- Body
- account
カテゴリを取得する
カテゴリを追加する
管理にカテゴリを追加します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
id
|
id | integer |
カテゴリの一意識別子。 |
|
|
名前
|
name | True | string |
カテゴリのタイトル。 |
|
Description
|
description | string |
カテゴリの説明。 |
|
|
立場
|
position | number |
カテゴリの並べ替え位置。 低い方が高いです。 |
|
|
parent_id
|
parent_id | number |
親カテゴリの一意識別子 |
|
|
アバター
|
avatar | string |
カテゴリアバターへの URL。 |
|
|
公開済み
|
is_published | boolean |
カテゴリを Web サイトに公開する必要がある場合。 |
|
|
courses_count
|
courses_count | number |
このカテゴリに直接リンクされているコースの数。 |
|
|
children_count
|
children_count | number |
このカテゴリに直接リンクされている子カテゴリの数。 |
|
|
updated_at
|
updated_at | string |
最後の更新のタイムスタンプ。 |
|
|
作成日時
|
created_at | string |
作成のタイムスタンプ。 |
|
|
avatar_url
|
avatar_url | string |
サイズ変更されたアバター画像の URL (300 x 200^)。 |
戻り値
- Body
- category
コースを取得する
コースを追加する
管理にコースを追加します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
id
|
id | integer |
コースの一意識別子 |
|
|
名前
|
name | True | string |
コースの名前。 |
|
立場
|
position | number |
コースの並べ替え位置。 低い方が高いです。 |
|
|
signup_url
|
signup_url | string |
このコースのサインアップ ページへの URL。 |
|
|
slug_history
|
slug_history | array of string |
古いナメクジのリスト、古い呼び出しがリダイレクトされます。 |
|
|
アバター
|
avatar | string |
サイズ変更されたアバター画像の URL (300 x 200^)。 |
|
|
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 |
作成のタイムスタンプ。 |
戻り値
- Body
- course
ユーザーの認証を削除する
ユーザーの認証のいずれかを削除します。 最後の認証を削除できないことに注意してください。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ユーザー ID
|
user_id | True | integer |
ユーザーの識別子。 |
|
認証 ID
|
authentication_id | True | integer |
認証の識別子。 |
ユーザーの認証を取得する
特定のユーザーに属する認証の一覧を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ページ番号
|
page | integer |
取得するページ番号。 |
|
|
1 ページあたりのレコード数
|
per_page | integer |
1 ページあたりのレコード数。 |
|
|
ユーザー ID
|
user_id | True | integer |
ユーザーの識別子。 |
戻り値
- response
- array of authentication
ユーザーを取得する
ユーザーを追加する
ユーザーを管理に追加します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
名(ファーストネーム)
|
first_name | True | string |
ユーザーの名。 |
|
ミドルネーム
|
middle_name | string |
ユーザーのミドル ネーム。 |
|
|
姓
|
last_name | True | string |
ユーザーの姓。 |
|
Email
|
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
|
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 |
ユーザーに関する短いメモ。 |
戻り値
- Body
- user
認証を追加する
既存のユーザーに認証方法を追加する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
user_id
|
user_id | True | integer |
この認証が属するユーザーの ID。 |
|
authentication_provider_type
|
authentication_provider_type | True | string |
認証プロバイダーの種類。 |
|
uid
|
uid | True | string |
IDP からの一意の ID に対応するこの認証の一意識別子。 |
戻り値
- Body
- authentication
請求書 VAT を追加する
請求書に使用できる請求書 VAT を追加します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
id
|
id | integer |
請求書 vat の一意の idenitfier。 |
|
|
名前
|
name | True | string |
請求書 VAT の名前。 |
|
パーセンテージ
|
percentage | True | string |
VAT の割合を表す数値。 |
戻り値
- Body
- invoice_vat
請求書を取得する
請求書を追加する
請求書を管理に追加します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Account
|
account_id | True | number |
アカウントの識別子。 |
|
account_name
|
account_name | string |
支払うアカウントの名前。 請求書にコピーされるため、アカウント名が変更されても自動的には更新されません。 |
|
|
通貨
|
currency | True | string |
請求書の通貨。 |
|
id
|
id | integer |
請求書アイテムの一意の識別子。 |
|
|
単位
|
units | True | number |
請求書明細の単位数。 |
|
Description
|
name | True | string |
請求書アイテムの名前。 |
|
料金
|
unit_price | True | string |
単一ユニットの価格。 |
|
Vat
|
invoice_vat_id | number |
請求書 VAT の識別子。 |
|
|
Catalog Variant
|
catalog_variant_id | number |
カタログバリアントの識別子。 |
|
|
updated_at
|
updated_at | string |
最後の更新のタイムスタンプ。 |
|
|
作成日時
|
created_at | string |
作成のタイムスタンプ。 |
|
|
フィーチャー
|
feature | string |
請求書に表示される請求書の一部の説明。 |
|
|
脚注
|
footnote | string |
請求書の下部に表示されるメモ。 |
戻り値
- Body
- invoice
トリガー
| Webhook をサブスクライブする |
Webhook にサブスクライブして、レコードの更新に関する通知を受け取ります。 |
Webhook をサブスクライブする
Webhook にサブスクライブして、レコードの更新に関する通知を受け取ります。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
id
|
id | string |
Webhook の一意識別子。 (UUID)。 |
|
|
活動中
|
active | boolean |
Webhook の状態。 |
|
|
events
|
events | True | array of string |
この webhook をトリガーするイベントの配列。 |
戻り値
- Body
- webhook_payload
定義
アカウント
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
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
|
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 |
この認証が属するユーザーの ID。 |
|
authentication_provider_id
|
authentication_provider_id | integer |
認証プロバイダーの ID。 |
|
uid
|
uid | string |
IDP からの一意の ID に対応するこの認証の一意識別子。 |
|
このログインに対して OTP が有効になっている場合。
|
otp_enabled |
認証プロバイダーが Eduframe の場合、このログインに対して 1 回限りのパスワードが有効になっているかどうかを示します。他のプロバイダーの場合は 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 |
カテゴリを Web サイトに公開する必要がある場合。 |
|
courses_count
|
courses_count | number |
このカテゴリに直接リンクされているコースの数。 |
|
children_count
|
children_count | number |
このカテゴリに直接リンクされている子カテゴリの数。 |
|
updated_at
|
updated_at | string |
最後の更新のタイムスタンプ。 |
|
作成日時
|
created_at | string |
作成のタイムスタンプ。 |
|
avatar_url
|
avatar_url | string |
サイズ変更されたアバター画像の URL (300 x 200^)。 |
コース
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
id
|
id | integer |
コースの一意識別子 |
|
名前
|
name | string |
コースの名前。 |
|
立場
|
position | number |
コースの並べ替え位置。 低い方が高いです。 |
|
signup_url
|
signup_url | string |
このコースのサインアップ ページへの URL。 |
|
アバター
|
avatar | string |
サイズ変更されたアバター画像の URL (300 x 200^)。 |
|
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 |
ユーザーの姓。 |
|
Email
|
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 |
請求書の参照 ID。 請求書を検索するために使用されます。 |
|
Account
|
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 | string |
請求書の通貨。 |
|
total_incl
|
total_incl | string |
VAT を含む請求書の合計コスト。 |
|
total_excl
|
total_excl | string |
VAT を除く請求書の合計コスト。 |
|
total_open
|
total_open | string |
VAT を含む請求書のオープン コスト。 |
|
pdf_url
|
pdf_url | string |
PDF 形式の請求書のダウンロード パスの URL。 |
|
xml_url
|
xml_url | string |
UML 形式の請求書のダウンロード パスの URL。 |
|
フィーチャー
|
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 |
単一ユニットの価格。 |
|
Vat
|
invoice_vat_id | number |
請求書 VAT の識別子。 |
|
Catalog Variant
|
catalog_variant_id | number |
カタログバリアントの識別子。 |
|
updated_at
|
updated_at | string |
最後の更新のタイムスタンプ。 |
|
作成日時
|
created_at | string |
作成のタイムスタンプ。 |
invoice_vat
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
id
|
id | integer |
請求書 vat の一意の idenitfier。 |
|
名前
|
name | string |
請求書 VAT の名前。 |
|
パーセンテージ
|
percentage | string |
VAT の割合を表す数値。 |
catalog_variant
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
id
|
id | number |
カタログバリアントの一意識別子 |
|
product_id
|
product_id | number |
カタログ製品の一意識別子 |
|
名前
|
name | string |
コースの名前。 |
|
cost_scheme
|
cost_scheme | string |
カタログ バリアントの既定の支払い方法。 |
|
費用
|
cost | string |
このカタログバリアントに対して支払われる価格。 |
|
通貨
|
currency | string |
カタログバリアントの通貨。 |
|
variantable_type
|
variantable_type | string |
請求書の通貨。 |
|
variantable_id
|
variantable_id | number |
バリアント型の一意識別子。 |
|
updated_at
|
updated_at | string |
最後の更新のタイムスタンプ。 |
|
作成日時
|
created_at | string |
作成のタイムスタンプ。 |
|
公開済み
|
is_published | boolean |
カテゴリを Web サイトに公開する必要がある場合。 |
ラベル
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
id
|
id | number |
ラベルの一意識別子 |
|
名前
|
name | string |
ラベルの名前。 |
|
色
|
color | string |
ラベルの色の 16 進コード。 |
|
モデル
|
model_type | string |
このラベルを使用できるようにするモデルの種類。 |
|
updated_at
|
updated_at | string |
最後の更新のタイムスタンプ。 |
|
作成日時
|
created_at | string |
作成のタイムスタンプ。 |
webhook_payload
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
教育者
|
educator | string |
教育者のナメクジ。 |
|
イベント
|
event | string |
Webhook をトリガーしたイベントの種類。 |
|
entity_type
|
entity_type | string |
Webhook をトリガーしたモデルの型。 |
|
entity_id
|
entity_id | number |
Webhook をトリガーしたモデルの一意識別子。 |
|
テナントID
|
tenant_id | string |
教育者の UUID。 |