Eduframe
Eduframe est une solution complète pour les fournisseurs de formation commerciale et les écoles d’affaires pour attirer davantage d’étudiants, gérer et automatiser l’administration des cours et offrir l’expérience d’apprentissage ultime. Eduframe s’intègre parfaitement à Canvas LMS. Le connecteur ouvre la possibilité d’intégrer facilement vos applications logicielles existantes à Eduframe, comme votre logiciel CRM et comptable.
Ce connecteur est disponible dans les produits et régions suivants :
| Service | classe | Régions |
|---|---|---|
| Copilot Studio | Premium | Toutes les régions Power Automate , à l’exception des éléments suivants : - Us Government (GCC) - Us Government (GCC High) - China Cloud géré par 21Vianet - Us Department of Defense (DoD) |
| Applications logiques | Norme | Toutes les régions Logic Apps , à l’exception des suivantes : - Régions Azure Government - Régions Azure Chine - Us Department of Defense (DoD) |
| Power Apps | Premium | Toutes les régions Power Apps , à l’exception des suivantes : - Us Government (GCC) - Us Government (GCC High) - China Cloud géré par 21Vianet - Us Department of Defense (DoD) |
| Power Automate | Premium | Toutes les régions Power Automate , à l’exception des éléments suivants : - Us Government (GCC) - Us Government (GCC High) - China Cloud géré par 21Vianet - Us Department of Defense (DoD) |
| Contact | |
|---|---|
| Nom | Équipe de développement Eduframe |
| URL | https://eduframe.co |
| Messagerie électronique | dev@drieam.nl |
| Métadonnées du connecteur | |
|---|---|
| Éditeur | Microsoft |
| Site internet | https://eduframe.co |
| Politique de confidentialité | https://drieam.com/security-and-privacy/ |
| Catégories | Data |
Eduframe gère et automatise l’administration des cours pour les fournisseurs de formation commerciale et les écoles d’affaires. À l’aide de ce connecteur, il est possible de connecter différents outils avec Eduframe pour gérer automatiquement des cours, des utilisateurs, des factures et bien plus encore.
Prerequisites
Pour utiliser ce connecteur, vous aurez besoin d’une licence Eduframe. Vous trouverez plus d’informations sur Eduframe et sur la façon d’obtenir une licence ici.
Si vous disposez déjà d’une licence Eduframe, vérifiez qu’Azure Logic Apps est activé pour votre environnement. Si vous souhaitez activer cette intégration, vous pouvez envoyer un e-mail support@eduframe.nl.
Comment obtenir des informations d’identification
Si vous utilisez ce connecteur pour la première fois, vous êtes invité à vous connecter à Eduframe et à autoriser ce connecteur. Une fois autorisé, vous pourrez utiliser ce connecteur et toutes ses fonctionnalités.
Bien démarrer avec votre connecteur
Eduframe fournit des webhooks qui agissent en tant que déclencheurs pour vos automatisations. Nous pouvons créer un flux qui se déclenche chaque fois qu’un nouvel utilisateur est ajouté à Eduframe. Lors de la création d’un flux, vous pouvez sélectionner ce connecteur et choisir « S’abonner au webhook » comme déclencheur. Ensuite, sous « élément d’événements », sélectionnez « user.created ». Vous pouvez en ajouter d’autres, mais pour l’instant, nous ne sommes intéressés que par celui-ci.
Ensuite, nous voulons savoir quel utilisateur a été ajouté à eduframe. Pour ce faire, nous pouvons ajouter une nouvelle étape à partir de ce connecteur appelé « Obtenir un utilisateur ». Cette étape nécessite un ID d’un utilisateur. Nous pouvons utiliser l’ID d’entité à partir du webhook.
Maintenant que nous savons qui est le nouvel utilisateur dans Eduframe, nous pouvons envoyer à cette personne un e-mail. Par exemple, nous allons utiliser le connecteur Outlook, mais il peut s’agir de n’importe quel fournisseur de messagerie. Ajoutez une nouvelle étape et sélectionnez « Envoyer un e-mail ». Ici, nous pouvons renseigner l’e-mail de l’utilisateur, un objet et l’e-mail que nous voulons envoyer. Notez que dans le corps de l’e-mail, vous pouvez utiliser d’autres attributs de l’utilisateur comme le prénom et le nom.
Lorsque nous avons terminé d’écrire l’e-mail, nous pouvons enregistrer ce flux. À présent, chaque fois qu’un nouvel utilisateur est ajouté à Eduframe, cette personne recevra un e-mail de bienvenue.
Limitations
| Nom | Appels | Période de renouvellement |
|---|---|---|
| Appels d’API par connexion | 100 | 60 secondes |
Actions
| Ajouter un compte |
Ajoutez un compte à votre administration. |
| Ajouter un cours |
Ajoutez un cours à votre administration. |
| Ajouter un utilisateur |
Ajoutez un utilisateur à votre administration. |
| Ajouter une authentification |
Ajouter une méthode d’authentification à un utilisateur existant |
| Ajouter une catégorie |
Ajoutez une catégorie à votre administration. |
| Ajouter une facture |
Ajoutez une facture à votre administration. |
| Ajouter une tva de facture |
Ajoutez une tva de facture qui peut être utilisée sur la facture. |
| Lister tous les utilisateurs |
Obtenez tous les utilisateurs. |
| Obtenir les authentifications d’un utilisateur |
Obtenez la liste des authentifications appartenant à un utilisateur spécifique. |
| Obtenir toutes les variantes de catalogue |
Obtenir toutes les variantes de catalogue. |
| Obtenir un compte |
Obtenez un compte par ID. |
| Obtenir un cours |
Obtenir un cours unique par ID |
| Obtenir un utilisateur |
Obtenez un seul utilisateur par ID. |
| Obtenir une catégorie |
Obtenir une catégorie par ID |
| Obtenir une facture |
Obtenez une seule facture par ID. |
| Répertorier tous les comptes |
Obtenez tous les comptes. |
| Répertorier tous les cours |
Obtenez tous les cours. |
| Répertorier toutes les catégories |
Obtenez toutes les catégories. |
| Répertorier toutes les factures |
Obtenez toutes les factures. |
| Répertorier toutes les tvas de facture |
Obtenir toutes les tvas de facture |
| Répertorier toutes les étiquettes |
Obtenez toutes les étiquettes. |
| Supprimer une authentification d’un utilisateur |
Supprimez l’une des authentifications d’un utilisateur. Notez que vous ne pouvez pas supprimer la dernière authentification ! |
Ajouter un compte
Ajoutez un compte à votre administration.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
nom
|
name | True | string |
Nom du compte. |
|
Messagerie électronique
|
string |
Chaîne représentant le courrier électronique de facturation du compte. |
||
|
pièce d'identité
|
id | integer |
Identificateur unique de l’adresse. |
|
|
destinataire
|
addressee | string |
Destinataire de l’adresse. |
|
|
address
|
address | True | string |
Concaténation du numéro de la rue et de la maison. |
|
postal_code
|
postal_code | True | string |
Chaîne représentant le code postal. |
|
city
|
city | True | string |
Chaîne représentant la ville. |
|
country
|
country | True | string |
Chaîne représentant le pays. |
|
updated_at
|
updated_at | string |
Horodatage de la dernière mise à jour. |
|
|
date_de_création
|
created_at | string |
Horodatage de la création. |
Retours
- Corps
- account
Ajouter un cours
Ajoutez un cours à votre administration.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
pièce d'identité
|
id | integer |
Identificateur unique du cours |
|
|
nom
|
name | True | string |
Nom du cours. |
|
position
|
position | number |
Position de tri du cours. Plus faible est plus élevé. |
|
|
signup_url
|
signup_url | string |
URL de la page d’inscription pour ce cours. |
|
|
slug_history
|
slug_history | array of string |
Liste des vieilles, les anciens appels seront redirigés. |
|
|
avatar
|
avatar | string |
URL vers une image d’avatar redimensionnée (300x200^). |
|
|
certificate_template_id
|
certificate_template_id | number |
Identificateur du modèle de certificat lié éventuellement. |
|
|
Catégorie
|
category_id | True | number |
Identificateur de la catégorie du cours. |
|
code
|
code | True | string |
Code du cours. |
|
coût
|
cost | string |
Le prix à payer pour ce cours. |
|
|
cost_scheme
|
cost_scheme | string |
Comment le cours doit-il être payé par défaut. |
|
|
is_published
|
is_published | boolean |
Valeur booléenne représentant l’état pouvant être publié du cours. |
|
|
updated_at
|
updated_at | string |
Horodatage de la dernière mise à jour. |
|
|
date_de_création
|
created_at | string |
Horodatage de la création. |
Retours
- Corps
- course
Ajouter un utilisateur
Ajoutez un utilisateur à votre administration.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Prénom
|
first_name | True | string |
Prénom de l’utilisateur. |
|
Deuxième prénom
|
middle_name | string |
Nom intermédiaire de l’utilisateur. |
|
|
Nom
|
last_name | True | string |
Nom de l’utilisateur. |
|
Messagerie électronique
|
True | string |
Courrier électronique de l’utilisateur. |
|
|
Numéro de téléphone
|
phone | string |
Numéro de téléphone de l’utilisateur. |
|
|
S’abonner au bulletin d’informations
|
wants_newsletter | boolean |
L’utilisateur souhaite-t-il recevoir des bulletins d’information ? |
|
|
Créer une authentification
|
with_authentication | boolean |
Créez une authentification pour l’utilisateur, afin que l’utilisateur puisse se connecter. |
|
|
paramètres régionaux
|
locale | string |
Paramètres régionaux de l’utilisateur. |
|
|
label_ids
|
label_ids | array of number | ||
|
pièce d'identité
|
id | integer |
Identificateur unique de l’adresse. |
|
|
destinataire
|
addressee | string |
Destinataire de l’adresse. |
|
|
address
|
address | True | string |
Concaténation du numéro de la rue et de la maison. |
|
postal_code
|
postal_code | True | string |
Chaîne représentant le code postal. |
|
city
|
city | True | string |
Chaîne représentant la ville. |
|
country
|
country | True | string |
Chaîne représentant le pays. |
|
updated_at
|
updated_at | string |
Horodatage de la dernière mise à jour. |
|
|
date_de_création
|
created_at | string |
Horodatage de la création. |
|
|
notes_user
|
notes_user | string |
Remarque courte sur l’utilisateur. |
Retours
- Corps
- user
Ajouter une authentification
Ajouter une méthode d’authentification à un utilisateur existant
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
user_id
|
user_id | True | integer |
ID de l’utilisateur auquel cette authentification appartient. |
|
authentication_provider_type
|
authentication_provider_type | True | string |
Type du fournisseur d’authentification. |
|
uid
|
uid | True | string |
Identificateur unique de cette authentification qui correspond à l’ID unique du fournisseur d’identité. |
Retours
- Corps
- authentication
Ajouter une catégorie
Ajoutez une catégorie à votre administration.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
pièce d'identité
|
id | integer |
Identificateur unique de la catégorie. |
|
|
Nom
|
name | True | string |
Titre de la catégorie. |
|
Descriptif
|
description | string |
Description de la catégorie. |
|
|
position
|
position | number |
Position de tri de la catégorie. Plus faible est plus élevé. |
|
|
parent_id
|
parent_id | number |
Identificateur unique de la catégorie parente |
|
|
avatar
|
avatar | string |
URL de l’avatar de catégorie. |
|
|
Publiée
|
is_published | boolean |
Si la catégorie doit être publiée sur le site web. |
|
|
courses_count
|
courses_count | number |
Nombre de cours directement liés à cette catégorie. |
|
|
children_count
|
children_count | number |
Nombre de catégories d’enfants directement liées à cette catégorie. |
|
|
updated_at
|
updated_at | string |
Horodatage de la dernière mise à jour. |
|
|
date_de_création
|
created_at | string |
Horodatage de la création. |
|
|
avatar_url
|
avatar_url | string |
URL vers une image d’avatar redimensionnée (300x200^). |
Retours
- Corps
- category
Ajouter une facture
Ajoutez une facture à votre administration.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Compte
|
account_id | True | number |
Identificateur du compte. |
|
account_name
|
account_name | string |
Nom du compte payant. Est copié dans la facture et n’est donc pas automatiquement mis à jour si le nom du compte change. |
|
|
monnaie
|
currency | True | string |
Devise de la facture. |
|
pièce d'identité
|
id | integer |
Identificateur unique de l’élément de facture. |
|
|
Unités
|
units | True | number |
Nombre d’unités de l’élément de facture. |
|
Descriptif
|
name | True | string |
Nom de l’élément de facture. |
|
Prix
|
unit_price | True | string |
Prix d’une unité unique. |
|
TVA
|
invoice_vat_id | number |
Identificateur de la tva de facture. |
|
|
Variant de catalogue
|
catalog_variant_id | number |
Identificateur de la variante de catalogue. |
|
|
updated_at
|
updated_at | string |
Horodatage de la dernière mise à jour. |
|
|
date_de_création
|
created_at | string |
Horodatage de la création. |
|
|
feature
|
feature | string |
Description de la facture affichée sur la facture. |
|
|
note de bas de page
|
footnote | string |
Note affichée en bas de la facture. |
Retours
- Corps
- invoice
Ajouter une tva de facture
Ajoutez une tva de facture qui peut être utilisée sur la facture.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
pièce d'identité
|
id | integer |
Idenitfier unique de la tva de facture. |
|
|
nom
|
name | True | string |
Nom de la tva de facture. |
|
pourcentage
|
percentage | True | string |
Nombre représentant le pourcentage de TVA. |
Retours
- Corps
- invoice_vat
Lister tous les utilisateurs
Obtenez tous les utilisateurs.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Nombre de pages
|
page | integer |
Numéro de page à obtenir. |
|
|
Enregistrements par page
|
per_page | integer |
Nombre d’enregistrements par page. |
|
|
Trier
|
sort | array |
Triez les résultats. Modifier l’ordre à l’aide de |
Retours
- response
- array of user
Obtenir les authentifications d’un utilisateur
Obtenez la liste des authentifications appartenant à un utilisateur spécifique.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Nombre de pages
|
page | integer |
Numéro de page à obtenir. |
|
|
Enregistrements par page
|
per_page | integer |
Nombre d’enregistrements par page. |
|
|
Identifiant utilisateur
|
user_id | True | integer |
Identificateur de l’utilisateur. |
Retours
- response
- array of authentication
Obtenir toutes les variantes de catalogue
Obtenir toutes les variantes de catalogue.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Nombre de pages
|
page | integer |
Numéro de page à obtenir. |
|
|
Enregistrements par page
|
per_page | integer |
Nombre d’enregistrements par page. |
Retours
- response
- array of catalog_variant
Obtenir un compte
Obtenez un compte par ID.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de compte
|
id | True | integer |
Identificateur du compte. |
Retours
- Corps
- account
Obtenir un cours
Obtenir un cours unique par ID
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de cours
|
id | True | integer |
Identificateur du cours. |
Retours
- Corps
- course
Obtenir un utilisateur
Obtenez un seul utilisateur par ID.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Identifiant utilisateur
|
id | True | integer |
Identificateur de l’utilisateur. |
Retours
- Corps
- user
Obtenir une catégorie
Obtenir une catégorie par ID
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de catégorie
|
id | True | integer |
Identificateur de la catégorie. |
Retours
- Corps
- category
Obtenir une facture
Obtenez une seule facture par ID.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de facture
|
id | True | integer |
Identificateur de la facture. |
Retours
- Corps
- invoice
Répertorier tous les comptes
Obtenez tous les comptes.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Nombre de pages
|
page | integer |
Numéro de page à obtenir. |
|
|
Enregistrements par page
|
per_page | integer |
Nombre d’enregistrements par page. |
Retours
- response
- array of account
Répertorier tous les cours
Obtenez tous les cours.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Nombre de pages
|
page | integer |
Numéro de page à obtenir. |
|
|
Enregistrements par page
|
per_page | integer |
Nombre d’enregistrements par page. |
|
|
Trier
|
sort | array |
Triez les résultats. Modifier l’ordre à l’aide de |
Retours
- response
- array of course
Répertorier toutes les catégories
Obtenez toutes les catégories.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Nombre de pages
|
page | integer |
Numéro de page à obtenir. |
|
|
Enregistrements par page
|
per_page | integer |
Nombre d’enregistrements par page. |
|
|
Trier
|
sort | array |
Triez les résultats. Modifier l’ordre à l’aide de |
Retours
- response
- array of category
Répertorier toutes les factures
Obtenez toutes les factures.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Nombre de pages
|
page | integer |
Numéro de page à obtenir. |
|
|
Enregistrements par page
|
per_page | integer |
Nombre d’enregistrements par page. |
Retours
- response
- array of invoice
Répertorier toutes les tvas de facture
Obtenir toutes les tvas de facture
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Nombre de pages
|
page | integer |
Numéro de page à obtenir. |
|
|
Enregistrements par page
|
per_page | integer |
Nombre d’enregistrements par page. |
Retours
- response
- array of invoice_vat
Répertorier toutes les étiquettes
Obtenez toutes les étiquettes.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Nombre de pages
|
page | integer |
Numéro de page à obtenir. |
|
|
Enregistrements par page
|
per_page | integer |
Nombre d’enregistrements par page. |
|
|
Filtrer sur le type de modèle de l’étiquette
|
model_type | string |
Filtrez les étiquettes en fonction du type de modèle. |
Retours
- response
- array of label
Supprimer une authentification d’un utilisateur
Supprimez l’une des authentifications d’un utilisateur. Notez que vous ne pouvez pas supprimer la dernière authentification !
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Identifiant utilisateur
|
user_id | True | integer |
Identificateur de l’utilisateur. |
|
ID d’authentification
|
authentication_id | True | integer |
Identificateur de l’authentification. |
Déclencheurs
| S’abonner à un webhook |
S’abonner à un webhook pour recevoir une notification sur les mises à jour d’enregistrement. |
S’abonner à un webhook
S’abonner à un webhook pour recevoir une notification sur les mises à jour d’enregistrement.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
pièce d'identité
|
id | string |
Identificateur unique du webhook. (un UUID). |
|
|
active
|
active | boolean |
État du webhook. |
|
|
events
|
events | True | array of string |
Tableau d’événements qui doivent déclencher ce webhook. |
Retours
- Corps
- webhook_payload
Définitions
account
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
pièce d'identité
|
id | integer |
Identificateur unique du compte. |
|
nom
|
name | string |
Nom du compte. |
|
Messagerie électronique
|
string |
Chaîne représentant le courrier électronique de facturation du compte. |
|
|
account_type
|
account_type | string |
Type de compte. |
|
address
|
address | address | |
|
phone
|
phone | string |
Chaîne représentant le numéro de téléphone du compte. |
|
updated_at
|
updated_at | string |
Horodatage de la dernière mise à jour. |
|
date_de_création
|
created_at | string |
Horodatage de la création. |
|
signup_answers
|
signup_answers | array of customField |
Liste des réponses d’inscription pour ce compte. |
address
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
pièce d'identité
|
id | integer |
Identificateur unique de l’adresse. |
|
destinataire
|
addressee | string |
Destinataire de l’adresse. |
|
address
|
address | string |
Concaténation du numéro de la rue et de la maison. |
|
postal_code
|
postal_code | string |
Chaîne représentant le code postal. |
|
city
|
city | string |
Chaîne représentant la ville. |
|
country
|
country | string |
Chaîne représentant le pays. |
|
updated_at
|
updated_at | string |
Horodatage de la dernière mise à jour. |
|
date_de_création
|
created_at | string |
Horodatage de la création. |
Authentification
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
pièce d'identité
|
id | integer |
Identificateur unique de l’authentification. |
|
user_id
|
user_id | integer |
ID de l’utilisateur auquel cette authentification appartient. |
|
authentication_provider_id
|
authentication_provider_id | integer |
ID du fournisseur d’authentification. |
|
uid
|
uid | string |
Identificateur unique de cette authentification qui correspond à l’ID unique du fournisseur d’identité. |
|
Si le mot de passe par mot de passe est activé pour cette connexion.
|
otp_enabled |
Si le fournisseur d’authentification est Eduframe, indique si un mot de passe est activé pour cette connexion, a la valeur false pour tous les autres fournisseurs. |
|
|
updated_at
|
updated_at | string |
Horodatage de la dernière mise à jour. |
|
date_de_création
|
created_at | string |
Horodatage de la création. |
customField
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
pièce d'identité
|
id | integer |
Identificateur unique de la réponse d’inscription. |
|
value
|
value | string |
Valeur mise en forme de la réponse. |
|
signup_question_id
|
signup_question_id | integer |
Identificateur unique de la question. |
catégorie
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
pièce d'identité
|
id | integer |
Identificateur unique de la catégorie. |
|
Nom
|
name | string |
Titre de la catégorie. |
|
Descriptif
|
description | string |
Description de la catégorie. |
|
position
|
position | number |
Position de tri de la catégorie. Plus faible est plus élevé. |
|
parent_id
|
parent_id | number |
Identificateur unique de la catégorie parente |
|
avatar
|
avatar | string |
URL de l’avatar de catégorie. |
|
Publiée
|
is_published | boolean |
Si la catégorie doit être publiée sur le site web. |
|
courses_count
|
courses_count | number |
Nombre de cours directement liés à cette catégorie. |
|
children_count
|
children_count | number |
Nombre de catégories d’enfants directement liées à cette catégorie. |
|
updated_at
|
updated_at | string |
Horodatage de la dernière mise à jour. |
|
date_de_création
|
created_at | string |
Horodatage de la création. |
|
avatar_url
|
avatar_url | string |
URL vers une image d’avatar redimensionnée (300x200^). |
cours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
pièce d'identité
|
id | integer |
Identificateur unique du cours |
|
nom
|
name | string |
Nom du cours. |
|
position
|
position | number |
Position de tri du cours. Plus faible est plus élevé. |
|
signup_url
|
signup_url | string |
URL de la page d’inscription pour ce cours. |
|
avatar
|
avatar | string |
URL vers une image d’avatar redimensionnée (300x200^). |
|
certificate_template_id
|
certificate_template_id | number |
Identificateur du modèle de certificat lié éventuellement. |
|
Catégorie
|
category_id | number |
Identificateur de la catégorie du cours. |
|
code
|
code | string |
Code du cours. |
|
coût
|
cost | string |
Le prix à payer pour ce cours. |
|
cost_scheme
|
cost_scheme | string |
Comment le cours doit-il être payé par défaut. |
|
is_published
|
is_published | boolean |
Valeur booléenne représentant l’état pouvant être publié du cours. |
|
updated_at
|
updated_at | string |
Horodatage de la dernière mise à jour. |
|
date_de_création
|
created_at | string |
Horodatage de la création. |
utilisateur
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
pièce d'identité
|
id | integer |
Identificateur unique de l’utilisateur. |
|
Numéro d’employé
|
employee_number | string |
Numéro d’employé de cet utilisateur. |
|
Prénom
|
first_name | string |
Prénom de l’utilisateur. |
|
Deuxième prénom
|
middle_name | string |
Nom intermédiaire de l’utilisateur. |
|
Nom
|
last_name | string |
Nom de l’utilisateur. |
|
Messagerie électronique
|
string |
Courrier électronique de l’utilisateur. |
|
|
Numéro de téléphone
|
phone | string |
Numéro de téléphone de l’utilisateur. |
|
labels
|
labels | array of label | |
|
S’abonner au bulletin d’informations
|
wants_newsletter | boolean |
L’utilisateur souhaite-t-il recevoir des bulletins d’information ? |
|
Créer une authentification
|
with_authentication | boolean |
Créez une authentification pour l’utilisateur, afin que l’utilisateur puisse se connecter. |
|
paramètres régionaux
|
locale | string |
Paramètres régionaux de l’utilisateur. |
|
address
|
address | address | |
|
Avatar
|
avatar_url | string |
Chemin d’accès d’URL relatif à l’avatar. |
|
updated_at
|
updated_at | string |
Horodatage de la dernière mise à jour. |
|
date_de_création
|
created_at | string |
Horodatage de la création. |
facture
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
pièce d'identité
|
id | integer |
Identificateur unique de la facture. |
|
reference_id
|
reference_id | string |
ID de référence de la facture. Permet de trouver la facture. |
|
Compte
|
account_id | number |
Identificateur du compte. |
|
nombre
|
number | string |
Numéro de facture unique par enseignant. S’il est laissé vide, il est automatiquement créé. |
|
number_int
|
number_int | number |
Numéro de facture converti en valeur entière. |
|
status
|
status | string |
État de la facture. L’état initial sera toujours concept. |
|
expiration_date
|
expiration_date | string |
Date d’expiration de la facture. Est défini lorsque la facture est définie pour s’ouvrir. |
|
opened_at
|
opened_at | string |
Date à laquelle l’état de la facture a été modifié pour s’ouvrir. |
|
descriptif
|
description | string |
Description lisible humaine de la facture. |
|
account_name
|
account_name | string |
Nom du compte payant. Est copié dans la facture et n’est donc pas automatiquement mis à jour si le nom du compte change. |
|
monnaie
|
currency | string |
Devise de la facture. |
|
total_incl
|
total_incl | string |
Coût total de la facture, y compris la TVA. |
|
total_excl
|
total_excl | string |
Coût total de la facture à l’exclusion de la TVA. |
|
total_open
|
total_open | string |
Coût ouvert de la facture, y compris la TVA. |
|
pdf_url
|
pdf_url | string |
URL du chemin de téléchargement de la facture au format PDF. |
|
xml_url
|
xml_url | string |
URL du chemin de téléchargement de la facture au format UML. |
|
feature
|
feature | string |
Description de la facture affichée sur la facture. |
|
note de bas de page
|
footnote | string |
Note affichée en bas de la facture. |
|
invoice_items
|
invoice_items | array of invoice_item | |
|
updated_at
|
updated_at | string |
Horodatage de la dernière mise à jour. |
|
date_de_création
|
created_at | string |
Horodatage de la création. |
invoice_item
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
pièce d'identité
|
id | integer |
Identificateur unique de l’élément de facture. |
|
Unités
|
units | number |
Nombre d’unités de l’élément de facture. |
|
Descriptif
|
name | string |
Nom de l’élément de facture. |
|
Prix
|
unit_price | string |
Prix d’une unité unique. |
|
TVA
|
invoice_vat_id | number |
Identificateur de la tva de facture. |
|
Variant de catalogue
|
catalog_variant_id | number |
Identificateur de la variante de catalogue. |
|
updated_at
|
updated_at | string |
Horodatage de la dernière mise à jour. |
|
date_de_création
|
created_at | string |
Horodatage de la création. |
invoice_vat
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
pièce d'identité
|
id | integer |
Idenitfier unique de la tva de facture. |
|
nom
|
name | string |
Nom de la tva de facture. |
|
pourcentage
|
percentage | string |
Nombre représentant le pourcentage de TVA. |
catalog_variant
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
pièce d'identité
|
id | number |
Identificateur unique de la variante de catalogue |
|
product_id
|
product_id | number |
Identificateur unique du produit catalogue |
|
nom
|
name | string |
Nom du cours. |
|
cost_scheme
|
cost_scheme | string |
Comment la variante de catalogue doit-elle être payée par défaut. |
|
coût
|
cost | string |
Prix à payer pour cette variante de catalogue. |
|
monnaie
|
currency | string |
Devise de la variante de catalogue. |
|
variantable_type
|
variantable_type | string |
Devise de la facture. |
|
variantable_id
|
variantable_id | number |
Identificateur unique du variant. |
|
updated_at
|
updated_at | string |
Horodatage de la dernière mise à jour. |
|
date_de_création
|
created_at | string |
Horodatage de la création. |
|
Publiée
|
is_published | boolean |
Si la catégorie doit être publiée sur le site web. |
label
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
pièce d'identité
|
id | number |
Identificateur unique de l’étiquette |
|
Nom
|
name | string |
Nom de l’étiquette. |
|
Color
|
color | string |
Code hexadécimal de la couleur de l’étiquette. |
|
Model
|
model_type | string |
Type de modèle pour lequel cette étiquette est mise à disposition. |
|
updated_at
|
updated_at | string |
Horodatage de la dernière mise à jour. |
|
date_de_création
|
created_at | string |
Horodatage de la création. |
webhook_payload
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
éducateur
|
educator | string |
Slug de l’éducateur. |
|
événement
|
event | string |
Type d’événement qui a déclenché le webhook. |
|
entity_type
|
entity_type | string |
Type du modèle qui a déclenché le webhook. |
|
entity_id
|
entity_id | number |
Identificateur unique du modèle qui a déclenché le webhook. |
|
identifiant_de_locataire
|
tenant_id | string |
UUID de l’enseignant. |