Eduframe
Eduframe je kompletní řešení pro komerční poskytovatele školení a obchodní školy, které přilákají více studentů, spravují a automatizují správu kurzů a poskytují dokonalé výukové prostředí. Eduframe se bezproblémově integruje s LMS plátna. Konektor otevře příležitost snadno integrovat vaše stávající softwarové aplikace s Eduframe, jako je váš CRM a účetní software.
Tento konektor je dostupný v následujících produktech a oblastech:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Všechny oblasti Power Automate s výjimkou následujících: – státní správa USA (GCC) – státní správa USA (GCC High) - China Cloud provozovaný společností 21Vianet - Ministerstvo obrany USA (DoD) |
| Logic Apps | Standard | Všechny oblasti Logic Apps s výjimkou následujících: – Oblasti Azure Government – Oblasti Azure China - Ministerstvo obrany USA (DoD) |
| Power Apps | Premium | Všechny oblasti Power Apps s výjimkou následujících: – státní správa USA (GCC) – státní správa USA (GCC High) - China Cloud provozovaný společností 21Vianet - Ministerstvo obrany USA (DoD) |
| Power Automate | Premium | Všechny oblasti Power Automate s výjimkou následujících: – státní správa USA (GCC) – státní správa USA (GCC High) - China Cloud provozovaný společností 21Vianet - Ministerstvo obrany USA (DoD) |
| Kontakt | |
|---|---|
| Název | Vývojový tým Eduframe |
| URL | https://eduframe.co |
| dev@drieam.nl |
| Metadata konektoru | |
|---|---|
| Vydavatel | Microsoft |
| Internetová stránka | https://eduframe.co |
| Zásady ochrany osobních údajů | https://drieam.com/security-and-privacy/ |
| Kategorie | Data |
Eduframe spravuje a automatizuje správu kurzů pro poskytovatele komerčních školení a obchodní školy. Pomocí tohoto konektoru je možné propojit různé nástroje společně s nástrojem Eduframe pro automatickou správu kurzů, uživatelů, faktur a dalších.
Požadavky
K použití tohoto konektoru budete potřebovat licenci Eduframe. Další informace o Eduframe a o tom, jak získat licenci, najdete tady.
Pokud už máte licenci Eduframe, ujistěte se, že je pro vaše prostředí povolená služba Azure Logic Apps. Pokud chcete tuto integraci povolit, můžete poslat e-mail support@eduframe.nl.
Jak získat přihlašovací údaje
Pokud tento konektor použijete poprvé, zobrazí se výzva k přihlášení k Eduframe a autorizaci tohoto konektoru. Po autorizaci budete moct tento konektor a všechny jeho funkce používat.
Začínáme s konektorem
Eduframe poskytuje webhooky, které fungují jako triggery pro vaše automatizace. Můžeme vytvořit nový tok, který se aktivuje při každém přidání nového uživatele do Eduframe. Při vytváření nového toku můžete tento konektor vybrat a jako trigger zvolit Přihlášení k odběru webhooku. Potom v části Položka událostí vyberte user.created. Můžete přidat další, ale prozatím nás zajímá jenom tento.
Dále chceme vědět, který uživatel byl přidán do eduframe. K tomu můžeme přidat nový krok z tohoto konektoru s názvem Získat uživatele. Tento krok bude vyžadovat ID od uživatele. ID entity můžeme použít z webhooku.
Teď, když víme, kdo je nový uživatel v Eduframe, můžeme této osobě poslat e-mail. Jako příklad použijeme konektor outlooku, ale může to být jakýkoli poskytovatel pošty. Přidejte nový krok a vyberte Odeslat e-mail. Tady můžeme vyplnit e-mail od uživatele, předmět a e-mail, který chceme odeslat. Všimněte si, že v textu e-mailu můžete použít další atributy od uživatele, jako je jméno a příjmení.
Až e-mail napíšeme, můžeme tento tok uložit. Při každém přidání nového uživatele do Eduframe obdrží tato osoba uvítací e-mail.
Limity omezování
| Name | Volání | Období obnovení |
|---|---|---|
| Volání rozhraní API na připojení | 100 | 60 sekund |
Akce
| Odstranění ověřování uživatele |
Odstraňte jedno z ověřování uživatele. Všimněte si, že poslední ověření nelze odstranit. |
| Přidání dph na faktuře |
Přidejte dph faktury, kterou můžete použít na faktuře. |
| Přidání faktury |
Přidejte fakturu ke správě. |
| Přidání kategorie |
Přidejte do správy kategorii. |
| Přidání kurzu |
Přidejte kurz do správy. |
| Přidání ověřování |
Přidání metody ověřování k existujícímu uživateli |
| Přidání uživatele |
Přidejte uživatele do správy. |
| Přidání účtu |
Přidejte účet do správy. |
| Výpis všech dph faktur |
Získání všech dph na faktuře |
| Výpis všech faktur |
Získejte všechny faktury. |
| Výpis všech kategorií |
Získejte všechny kategorie. |
| Výpis všech popisků |
Získejte všechny popisky. |
| Výpis všech účtů |
Získejte všechny účty. |
| Zobrazení seznamu všech uživatelů |
Získejte všechny uživatele. |
| Zobrazit seznam všech kurzů |
Získejte všechny kurzy. |
| Získání faktury |
Získejte jednu fakturu podle ID. |
| Získání kategorie |
Získání kategorie podle ID |
| Získání kurzu |
Získání jednoho kurzu podle ID |
| Získání ověřování uživatele |
Získejte seznam ověřování, která patří konkrétnímu uživateli. |
| Získání uživatele |
Získejte jednoho uživatele podle ID. |
| Získání všech variant katalogu |
Získejte všechny varianty katalogu. |
| Získání účtu |
Získejte účet podle ID. |
Odstranění ověřování uživatele
Odstraňte jedno z ověřování uživatele. Všimněte si, že poslední ověření nelze odstranit.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID uživatele
|
user_id | True | integer |
Identifikátor uživatele. |
|
ID ověřování
|
authentication_id | True | integer |
Identifikátor ověřování. |
Přidání dph na faktuře
Přidejte dph faktury, kterou můžete použít na faktuře.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
identifikační číslo
|
id | integer |
Jedinečný idenitfier faktury dph. |
|
|
název
|
name | True | string |
Název faktury dph. |
|
procento
|
percentage | True | string |
Číslo představující procento DPH. |
Návraty
- Body
- invoice_vat
Přidání faktury
Přidejte fakturu ke správě.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Account
|
account_id | True | number |
Identifikátor účtu. |
|
account_name
|
account_name | string |
Název účtu, který platí. Zkopíruje se na fakturu, a proto se při změně názvu účtu automaticky neaktualizuje. |
|
|
měna
|
currency | True | string |
Měna faktury. |
|
identifikační číslo
|
id | integer |
Jedinečný identifikátor položky faktury |
|
|
Units
|
units | True | number |
Počet jednotek položky faktury. |
|
Description
|
name | True | string |
Název položky faktury. |
|
Cena
|
unit_price | True | string |
Cena jedné jednotky. |
|
DPH
|
invoice_vat_id | number |
Identifikátor dph faktury. |
|
|
Varianta katalogu
|
catalog_variant_id | number |
Identifikátor varianty katalogu. |
|
|
updated_at
|
updated_at | string |
Časové razítko poslední aktualizace |
|
|
datum_vytvoření
|
created_at | string |
Časové razítko vytvoření |
|
|
atribut
|
feature | string |
Popis faktury, která se zobrazuje na faktuře |
|
|
poznámka pod čarou
|
footnote | string |
Poznámka zobrazená v dolní části faktury. |
Návraty
- Body
- invoice
Přidání kategorie
Přidejte do správy kategorii.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
identifikační číslo
|
id | integer |
Jedinečný identifikátor kategorie. |
|
|
Název
|
name | True | string |
Název kategorie. |
|
Description
|
description | string |
Popis kategorie. |
|
|
postavení
|
position | number |
Umístění řazení kategorie. Nižší je vyšší. |
|
|
parent_id
|
parent_id | number |
Jedinečný identifikátor nadřazené kategorie |
|
|
avatar
|
avatar | string |
Adresa URL avataru kategorie. |
|
|
Publikováno
|
is_published | boolean |
Pokud by měla být kategorie publikována na webu. |
|
|
courses_count
|
courses_count | number |
Počet kurzů přímo propojených s touto kategorií |
|
|
children_count
|
children_count | number |
Počet podřízených kategorií přímo propojených s touto kategorií |
|
|
updated_at
|
updated_at | string |
Časové razítko poslední aktualizace |
|
|
datum_vytvoření
|
created_at | string |
Časové razítko vytvoření |
|
|
avatar_url
|
avatar_url | string |
Adresa URL obrázku avataru se změněnou velikostí (300x200^). |
Návraty
- Body
- category
Přidání kurzu
Přidejte kurz do správy.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
identifikační číslo
|
id | integer |
Jedinečný identifikátor kurzu |
|
|
název
|
name | True | string |
Název kurzu. |
|
postavení
|
position | number |
Umístění řazení kurzu. Nižší je vyšší. |
|
|
signup_url
|
signup_url | string |
Adresa URL registrační stránky pro tento kurz |
|
|
slug_history
|
slug_history | array of string |
Seznam starých slugů, staré hovory budou přesměrovány. |
|
|
avatar
|
avatar | string |
Adresa URL obrázku avataru se změněnou velikostí (300x200^). |
|
|
certificate_template_id
|
certificate_template_id | number |
Identifikátor volitelně propojené šablony certifikátu. |
|
|
Kategorie
|
category_id | True | number |
Identifikátor kategorie kurzu. |
|
kód
|
code | True | string |
Kód kurzu. |
|
náklady
|
cost | string |
Cena, která má být zaplacena za tento kurz. |
|
|
cost_scheme
|
cost_scheme | string |
Jak by měl být kurz ve výchozím nastavení placen. |
|
|
is_published
|
is_published | boolean |
Logická hodnota představující publikovatelný stav kurzu. |
|
|
updated_at
|
updated_at | string |
Časové razítko poslední aktualizace |
|
|
datum_vytvoření
|
created_at | string |
Časové razítko vytvoření |
Návraty
- Body
- course
Přidání ověřování
Přidání metody ověřování k existujícímu uživateli
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
user_id
|
user_id | True | integer |
ID uživatele, ke kterému toto ověřování patří. |
|
authentication_provider_type
|
authentication_provider_type | True | string |
Typ zprostředkovatele ověřování. |
|
uid
|
uid | True | string |
Jedinečný identifikátor tohoto ověřování, který odpovídá jedinečnému ID z ZDP. |
Návraty
- Body
- authentication
Přidání uživatele
Přidejte uživatele do správy.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Křestní jméno
|
first_name | True | string |
Jméno uživatele. |
|
Druhé jméno
|
middle_name | string |
Křestní jméno uživatele |
|
|
Příjmení
|
last_name | True | string |
Příjmení uživatele. |
|
Email
|
True | string |
E-mail uživatele. |
|
|
Telefonní číslo
|
phone | string |
Telefonní číslo uživatele. |
|
|
Přihlášení k odběru bulletinu
|
wants_newsletter | boolean |
Chce uživatel dostávat bulletiny? |
|
|
Vytvoření ověřování
|
with_authentication | boolean |
Vytvořte pro uživatele ověřování, aby se uživatel mohl přihlásit. |
|
|
národní prostředí
|
locale | string |
Národní prostředí uživatele. |
|
|
label_ids
|
label_ids | array of number | ||
|
identifikační číslo
|
id | integer |
Jedinečný identifikátor adresy. |
|
|
adresát
|
addressee | string |
Adresát adresy. |
|
|
address
|
address | True | string |
Zřetězení ulice a čísla domu. |
|
poštovní směrovací číslo
|
postal_code | True | string |
Řetězec představující PSČ. |
|
město
|
city | True | string |
Řetězec představující město. |
|
země
|
country | True | string |
Řetězec představující zemi. |
|
updated_at
|
updated_at | string |
Časové razítko poslední aktualizace |
|
|
datum_vytvoření
|
created_at | string |
Časové razítko vytvoření |
|
|
notes_user
|
notes_user | string |
Krátká poznámka o uživateli. |
Návraty
- Body
- user
Přidání účtu
Přidejte účet do správy.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
název
|
name | True | string |
Název účtu. |
|
e-mail
|
string |
Řetězec představující fakturační e-mail účtu. |
||
|
identifikační číslo
|
id | integer |
Jedinečný identifikátor adresy. |
|
|
adresát
|
addressee | string |
Adresát adresy. |
|
|
address
|
address | True | string |
Zřetězení ulice a čísla domu. |
|
poštovní směrovací číslo
|
postal_code | True | string |
Řetězec představující PSČ. |
|
město
|
city | True | string |
Řetězec představující město. |
|
země
|
country | True | string |
Řetězec představující zemi. |
|
updated_at
|
updated_at | string |
Časové razítko poslední aktualizace |
|
|
datum_vytvoření
|
created_at | string |
Časové razítko vytvoření |
Návraty
- Body
- account
Výpis všech dph faktur
Získání všech dph na faktuře
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Číslo stránky
|
page | integer |
Číslo stránky, které chcete získat. |
|
|
Záznamy na stránku
|
per_page | integer |
Počet záznamů na stránku |
Návraty
- response
- array of invoice_vat
Výpis všech faktur
Získejte všechny faktury.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Číslo stránky
|
page | integer |
Číslo stránky, které chcete získat. |
|
|
Záznamy na stránku
|
per_page | integer |
Počet záznamů na stránku |
Návraty
- response
- array of invoice
Výpis všech kategorií
Získejte všechny kategorie.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Číslo stránky
|
page | integer |
Číslo stránky, které chcete získat. |
|
|
Záznamy na stránku
|
per_page | integer |
Počet záznamů na stránku |
|
|
Seřadit
|
sort | array |
Seřaďte výsledky. Změna pořadí pomocí příkazu |
Návraty
- response
- array of category
Výpis všech popisků
Získejte všechny popisky.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Číslo stránky
|
page | integer |
Číslo stránky, které chcete získat. |
|
|
Záznamy na stránku
|
per_page | integer |
Počet záznamů na stránku |
|
|
Filtrování podle typu modelu popisku
|
model_type | string |
Filtrujte popisky na základě typu modelu. |
Návraty
- response
- array of label
Výpis všech účtů
Získejte všechny účty.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Číslo stránky
|
page | integer |
Číslo stránky, které chcete získat. |
|
|
Záznamy na stránku
|
per_page | integer |
Počet záznamů na stránku |
Návraty
- response
- array of account
Zobrazení seznamu všech uživatelů
Získejte všechny uživatele.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Číslo stránky
|
page | integer |
Číslo stránky, které chcete získat. |
|
|
Záznamy na stránku
|
per_page | integer |
Počet záznamů na stránku |
|
|
Seřadit
|
sort | array |
Seřaďte výsledky. Změna pořadí pomocí příkazu |
Návraty
- response
- array of user
Zobrazit seznam všech kurzů
Získejte všechny kurzy.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Číslo stránky
|
page | integer |
Číslo stránky, které chcete získat. |
|
|
Záznamy na stránku
|
per_page | integer |
Počet záznamů na stránku |
|
|
Seřadit
|
sort | array |
Seřaďte výsledky. Změna pořadí pomocí příkazu |
Návraty
- response
- array of course
Získání faktury
Získejte jednu fakturu podle ID.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID faktury
|
id | True | integer |
Identifikátor faktury. |
Návraty
- Body
- invoice
Získání kategorie
Získání kategorie podle ID
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID kategorie
|
id | True | integer |
Identifikátor kategorie. |
Návraty
- Body
- category
Získání kurzu
Získání jednoho kurzu podle ID
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID kurzu
|
id | True | integer |
Identifikátor kurzu. |
Návraty
- Body
- course
Získání ověřování uživatele
Získejte seznam ověřování, která patří konkrétnímu uživateli.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Číslo stránky
|
page | integer |
Číslo stránky, které chcete získat. |
|
|
Záznamy na stránku
|
per_page | integer |
Počet záznamů na stránku |
|
|
ID uživatele
|
user_id | True | integer |
Identifikátor uživatele. |
Návraty
- response
- array of authentication
Získání uživatele
Získejte jednoho uživatele podle ID.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID uživatele
|
id | True | integer |
Identifikátor uživatele. |
Návraty
- Body
- user
Získání všech variant katalogu
Získejte všechny varianty katalogu.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Číslo stránky
|
page | integer |
Číslo stránky, které chcete získat. |
|
|
Záznamy na stránku
|
per_page | integer |
Počet záznamů na stránku |
Návraty
- response
- array of catalog_variant
Získání účtu
Získejte účet podle ID.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID účtu
|
id | True | integer |
Identifikátor účtu. |
Návraty
- Body
- account
Aktivační události
| Přihlášení k odběru webhooku |
Přihlaste se k odběru webhooku a získejte oznámení o aktualizacích záznamů. |
Přihlášení k odběru webhooku
Přihlaste se k odběru webhooku a získejte oznámení o aktualizacích záznamů.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
identifikační číslo
|
id | string |
Jedinečný identifikátor webhooku. (UUID). |
|
|
active
|
active | boolean |
Stav webhooku |
|
|
events
|
events | True | array of string |
Pole událostí, které by měly aktivovat tento webhook. |
Návraty
- Body
- webhook_payload
Definice
účet
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
identifikační číslo
|
id | integer |
Jedinečný identifikátor účtu. |
|
název
|
name | string |
Název účtu. |
|
e-mail
|
string |
Řetězec představující fakturační e-mail účtu. |
|
|
account_type
|
account_type | string |
Typ účtu. |
|
address
|
address | address | |
|
telefon
|
phone | string |
Řetězec představující telefonní číslo účtu. |
|
updated_at
|
updated_at | string |
Časové razítko poslední aktualizace |
|
datum_vytvoření
|
created_at | string |
Časové razítko vytvoření |
|
signup_answers
|
signup_answers | array of customField |
Seznam odpovědí na registraci pro tento účet |
address
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
identifikační číslo
|
id | integer |
Jedinečný identifikátor adresy. |
|
adresát
|
addressee | string |
Adresát adresy. |
|
address
|
address | string |
Zřetězení ulice a čísla domu. |
|
poštovní směrovací číslo
|
postal_code | string |
Řetězec představující PSČ. |
|
město
|
city | string |
Řetězec představující město. |
|
země
|
country | string |
Řetězec představující zemi. |
|
updated_at
|
updated_at | string |
Časové razítko poslední aktualizace |
|
datum_vytvoření
|
created_at | string |
Časové razítko vytvoření |
ověřování
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
identifikační číslo
|
id | integer |
Jedinečný identifikátor ověřování. |
|
user_id
|
user_id | integer |
ID uživatele, ke kterému toto ověřování patří. |
|
authentication_provider_id
|
authentication_provider_id | integer |
ID zprostředkovatele ověřování. |
|
uid
|
uid | string |
Jedinečný identifikátor tohoto ověřování, který odpovídá jedinečnému ID z ZDP. |
|
Pokud je pro toto přihlášení povolené jednorázové heslo.
|
otp_enabled |
V případě, že je Eduframe zprostředkovatel ověřování, označuje, jestli je pro toto přihlášení povolené jednorázové heslo, je pro všechny ostatní poskytovatele false. |
|
|
updated_at
|
updated_at | string |
Časové razítko poslední aktualizace |
|
datum_vytvoření
|
created_at | string |
Časové razítko vytvoření |
customField
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
identifikační číslo
|
id | integer |
Jedinečný identifikátor odpovědi registrace. |
|
value
|
value | string |
Formátovaná hodnota odpovědi. |
|
signup_question_id
|
signup_question_id | integer |
Jedinečný identifikátor otázky. |
kategorie
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
identifikační číslo
|
id | integer |
Jedinečný identifikátor kategorie. |
|
Název
|
name | string |
Název kategorie. |
|
Description
|
description | string |
Popis kategorie. |
|
postavení
|
position | number |
Umístění řazení kategorie. Nižší je vyšší. |
|
parent_id
|
parent_id | number |
Jedinečný identifikátor nadřazené kategorie |
|
avatar
|
avatar | string |
Adresa URL avataru kategorie. |
|
Publikováno
|
is_published | boolean |
Pokud by měla být kategorie publikována na webu. |
|
courses_count
|
courses_count | number |
Počet kurzů přímo propojených s touto kategorií |
|
children_count
|
children_count | number |
Počet podřízených kategorií přímo propojených s touto kategorií |
|
updated_at
|
updated_at | string |
Časové razítko poslední aktualizace |
|
datum_vytvoření
|
created_at | string |
Časové razítko vytvoření |
|
avatar_url
|
avatar_url | string |
Adresa URL obrázku avataru se změněnou velikostí (300x200^). |
kurz
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
identifikační číslo
|
id | integer |
Jedinečný identifikátor kurzu |
|
název
|
name | string |
Název kurzu. |
|
postavení
|
position | number |
Umístění řazení kurzu. Nižší je vyšší. |
|
signup_url
|
signup_url | string |
Adresa URL registrační stránky pro tento kurz |
|
avatar
|
avatar | string |
Adresa URL obrázku avataru se změněnou velikostí (300x200^). |
|
certificate_template_id
|
certificate_template_id | number |
Identifikátor volitelně propojené šablony certifikátu. |
|
Kategorie
|
category_id | number |
Identifikátor kategorie kurzu. |
|
kód
|
code | string |
Kód kurzu. |
|
náklady
|
cost | string |
Cena, která má být zaplacena za tento kurz. |
|
cost_scheme
|
cost_scheme | string |
Jak by měl být kurz ve výchozím nastavení placen. |
|
is_published
|
is_published | boolean |
Logická hodnota představující publikovatelný stav kurzu. |
|
updated_at
|
updated_at | string |
Časové razítko poslední aktualizace |
|
datum_vytvoření
|
created_at | string |
Časové razítko vytvoření |
uživatel
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
identifikační číslo
|
id | integer |
Jedinečný identifikátor uživatele. |
|
Číslo zaměstnance
|
employee_number | string |
Číslo zaměstnance tohoto uživatele. |
|
Křestní jméno
|
first_name | string |
Jméno uživatele. |
|
Druhé jméno
|
middle_name | string |
Křestní jméno uživatele |
|
Příjmení
|
last_name | string |
Příjmení uživatele. |
|
Email
|
string |
E-mail uživatele. |
|
|
Telefonní číslo
|
phone | string |
Telefonní číslo uživatele. |
|
labels
|
labels | array of label | |
|
Přihlášení k odběru bulletinu
|
wants_newsletter | boolean |
Chce uživatel dostávat bulletiny? |
|
Vytvoření ověřování
|
with_authentication | boolean |
Vytvořte pro uživatele ověřování, aby se uživatel mohl přihlásit. |
|
národní prostředí
|
locale | string |
Národní prostředí uživatele. |
|
address
|
address | address | |
|
Avatar
|
avatar_url | string |
Relativní cesta url k avataru. |
|
updated_at
|
updated_at | string |
Časové razítko poslední aktualizace |
|
datum_vytvoření
|
created_at | string |
Časové razítko vytvoření |
faktura
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
identifikační číslo
|
id | integer |
Jedinečný identifikátor faktury |
|
reference_id
|
reference_id | string |
Id odkazu na fakturu. Slouží k vyhledání faktury. |
|
Account
|
account_id | number |
Identifikátor účtu. |
|
číslo
|
number | string |
Číslo faktury, které je jedinečné pro vyučující. Pokud zůstane prázdný, automaticky se zvýší. |
|
number_int
|
number_int | number |
Číslo faktury se převede na celočíselnou hodnotu. |
|
stav
|
status | string |
Stav faktury. Počáteční stav bude vždy koncept. |
|
expiration_date
|
expiration_date | string |
Datum vypršení platnosti faktury. Nastaví se, když je faktura nastavená na otevření. |
|
opened_at
|
opened_at | string |
Datum, kdy se změnil stav faktury, aby se otevřel. |
|
popis
|
description | string |
Popis faktury čitelný pro člověka |
|
account_name
|
account_name | string |
Název účtu, který platí. Zkopíruje se na fakturu, a proto se při změně názvu účtu automaticky neaktualizuje. |
|
měna
|
currency | string |
Měna faktury. |
|
total_incl
|
total_incl | string |
Celkové náklady na fakturu včetně DPH. |
|
total_excl
|
total_excl | string |
Celkové náklady na fakturu bez DPH. |
|
total_open
|
total_open | string |
Otevřené náklady na fakturu včetně DPH. |
|
pdf_url
|
pdf_url | string |
Adresa URL cesty ke stažení faktury ve formátu PDF |
|
xml_url
|
xml_url | string |
Adresa URL cesty ke stažení faktury ve formátu UML |
|
atribut
|
feature | string |
Popis faktury, která se zobrazuje na faktuře |
|
poznámka pod čarou
|
footnote | string |
Poznámka zobrazená v dolní části faktury. |
|
invoice_items
|
invoice_items | array of invoice_item | |
|
updated_at
|
updated_at | string |
Časové razítko poslední aktualizace |
|
datum_vytvoření
|
created_at | string |
Časové razítko vytvoření |
invoice_item
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
identifikační číslo
|
id | integer |
Jedinečný identifikátor položky faktury |
|
Units
|
units | number |
Počet jednotek položky faktury. |
|
Description
|
name | string |
Název položky faktury. |
|
Cena
|
unit_price | string |
Cena jedné jednotky. |
|
DPH
|
invoice_vat_id | number |
Identifikátor dph faktury. |
|
Varianta katalogu
|
catalog_variant_id | number |
Identifikátor varianty katalogu. |
|
updated_at
|
updated_at | string |
Časové razítko poslední aktualizace |
|
datum_vytvoření
|
created_at | string |
Časové razítko vytvoření |
invoice_vat
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
identifikační číslo
|
id | integer |
Jedinečný idenitfier faktury dph. |
|
název
|
name | string |
Název faktury dph. |
|
procento
|
percentage | string |
Číslo představující procento DPH. |
catalog_variant
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
identifikační číslo
|
id | number |
Jedinečný identifikátor varianty katalogu |
|
product_id
|
product_id | number |
Jedinečný identifikátor produktu katalogu |
|
název
|
name | string |
Název kurzu. |
|
cost_scheme
|
cost_scheme | string |
Jak by varianta katalogu měla být ve výchozím nastavení placená. |
|
náklady
|
cost | string |
Cena, která má být zaplacena za tuto variantu katalogu. |
|
měna
|
currency | string |
Měna varianty katalogu. |
|
variantable_type
|
variantable_type | string |
Měna faktury. |
|
variantable_id
|
variantable_id | number |
Jedinečný identifikátor variantovatelného. |
|
updated_at
|
updated_at | string |
Časové razítko poslední aktualizace |
|
datum_vytvoření
|
created_at | string |
Časové razítko vytvoření |
|
Publikováno
|
is_published | boolean |
Pokud by měla být kategorie publikována na webu. |
jmenovka
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
identifikační číslo
|
id | number |
Jedinečný identifikátor popisku |
|
Název
|
name | string |
Název popisku. |
|
Barva
|
color | string |
Šestnáctkový kód barvy popisku. |
|
Model
|
model_type | string |
Typ modelu, pro který je tento popisek zpřístupněn. |
|
updated_at
|
updated_at | string |
Časové razítko poslední aktualizace |
|
datum_vytvoření
|
created_at | string |
Časové razítko vytvoření |
webhook_payload
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
vychovatel
|
educator | string |
Slug vyučujícího. |
|
událost
|
event | string |
Typ události, která aktivovala webhook |
|
entity_type
|
entity_type | string |
Typ modelu, který aktivoval webhook. |
|
entity_id
|
entity_id | number |
Jedinečný identifikátor modelu, který aktivoval webhook. |
|
identifikátor nájemce
|
tenant_id | string |
UUID vyučujícího. |