Eduframe
Eduframe är en komplett lösning för kommersiella utbildningsleverantörer och företagsskolor för att locka fler elever, hantera och automatisera kursadministration och leverera den ultimata inlärningsupplevelsen. Eduframe integreras sömlöst med Canvas LMS. Anslutningsappen öppnar möjligheten att enkelt integrera dina befintliga program med Eduframe, till exempel crm- och redovisningsprogramvaran.
Den här anslutningsappen är tillgänglig i följande produkter och regioner:
| Tjänster | Class | Regioner |
|---|---|---|
| Copilot Studio | Premie | Alla Power Automate-regioner utom följande: - Amerikanska myndigheter (GCC) - Amerikanska myndigheter (GCC High) – China Cloud drivs av 21Vianet - US Department of Defense (DoD) |
| Logiska appar | Norm | Alla Logic Apps-regioner utom följande: – Azure Government-regioner – Regioner i Azure Kina - US Department of Defense (DoD) |
| Power Apps | Premie | Alla Power Apps-regioner utom följande: - Amerikanska myndigheter (GCC) - Amerikanska myndigheter (GCC High) – China Cloud drivs av 21Vianet - US Department of Defense (DoD) |
| Power Automate | Premie | Alla Power Automate-regioner utom följande: - Amerikanska myndigheter (GCC) - Amerikanska myndigheter (GCC High) – China Cloud drivs av 21Vianet - US Department of Defense (DoD) |
| Kontakt | |
|---|---|
| Namn | Utvecklingsteamet för Eduframe |
| URL | https://eduframe.co |
| E-postmeddelande | dev@drieam.nl |
| Metadata för anslutningsprogram | |
|---|---|
| Utgivare | Microsoft |
| Webbplats | https://eduframe.co |
| Sekretesspolicy | https://drieam.com/security-and-privacy/ |
| Kategorier | Uppgifter |
Eduframe hanterar och automatiserar kursadministration för kommersiella utbildningsleverantörer och företagsskolor. Med den här anslutningsappen kan du ansluta olika verktyg tillsammans med Eduframe för att automatiskt hantera kurser, användare, fakturor med mera.
Förutsättningar
Om du vill använda den här anslutningsappen behöver du en Eduframe-licens. Du hittar mer information om Eduframe och hur du hämtar en licens här.
Om du redan har en Eduframe-licens kontrollerar du att Azure Logic Apps är aktiverat för din miljö. Om du vill aktivera den här integreringen kan du skicka e-post support@eduframe.nltill .
Hämta autentiseringsuppgifter
Om du använder den här anslutningsappen för första gången uppmanas du att logga in på Eduframe och auktorisera den här anslutningsappen. När du har auktoriserats kan du använda den här anslutningsappen och alla dess funktioner.
Kom igång med anslutningsappen
Eduframe tillhandahåller webhooks som fungerar som utlösare för dina automatiseringar. Vi kan skapa ett nytt flöde som utlöses varje gång en ny användare läggs till i Eduframe. När du skapar ett nytt flöde kan du välja den här anslutningsappen och välja "Prenumerera på webhook" som utlösare. Under "händelseobjekt" väljer du sedan "user.created". Du kan lägga till fler, men för tillfället är vi bara intresserade av den här.
Nu vill vi veta vilken användare som har lagts till i eduframe. För att göra detta kan vi lägga till ett nytt steg från den här anslutningsappen med namnet "Hämta en användare". Det här steget kräver ett ID från en användare. Vi kan använda entitets-ID:t från webhooken.
Nu när vi vet vem den nya användaren är i Eduframe kan vi skicka ett e-postmeddelande till den här personen. Som exempel använder vi Outlook-anslutningsappen, men det kan vara vilken e-postprovider som helst. Lägg till ett nytt steg och välj "Skicka ett e-postmeddelande". Här kan vi fylla i e-postmeddelandet från användaren, ett ämne och det e-postmeddelande som vi vill skicka. Observera att du i brödtexten i e-postmeddelandet kan använda andra attribut från användaren, till exempel förnamn och efternamn.
När vi är klara med att skriva e-postmeddelandet kan vi spara det här flödet. Varje gång en ny användare läggs till i Eduframe får den här personen ett välkomstmeddelande.
Begränsningsgränser
| Name | Anrop | Förnyelseperiod |
|---|---|---|
| API-anrop per anslutning | 100 | 60 sekunder |
Åtgärder
| Hämta alla katalogvarianter |
Hämta alla katalogvarianter. |
| Hämta autentiseringar för en användare |
Hämta en lista över autentiseringar som tillhör en specifik användare. |
| Hämta en användare |
Hämta en enskild användare efter ID. |
| Hämta en faktura |
Hämta en enda faktura med ID. |
| Hämta en kategori |
Hämta en kategori efter ID |
| Hämta en kurs |
Hämta en enskild kurs efter ID |
| Hämta ett konto |
Hämta ett konto efter ID. |
| Lägg till en kategori |
Lägg till en kategori i din administration. |
| Lägga till en användare |
Lägg till en användare i din administration. |
| Lägga till en autentisering |
Lägga till en autentiseringsmetod till en befintlig användare |
| Lägga till en faktura |
Lägg till en faktura i din administration. |
| Lägga till en fakturamoms |
Lägg till en fakturamoms som kan användas på fakturan. |
| Lägga till en kurs |
Lägg till en kurs i din administration. |
| Lägga till ett konto |
Lägg till ett konto i din administration. |
| Ta bort en autentisering av en användare |
Ta bort en av autentiseringarna för en användare. Observera att du inte kan ta bort den senaste autentiseringen! |
| Visa en lista över alla användare |
Hämta alla användare. |
| Visa en lista över alla etiketter |
Hämta alla etiketter. |
| Visa en lista över alla fakturafakturor |
Hämta alla fakturafakturor |
| Visa en lista över alla fakturor |
Hämta alla fakturor. |
| Visa en lista över alla kategorier |
Hämta alla kategorier. |
| Visa en lista över alla konton |
Hämta alla konton. |
| Visa en lista över alla kurser |
Hämta alla kurser. |
Hämta alla katalogvarianter
Hämta alla katalogvarianter.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Sidans nummer
|
page | integer |
Sidnummer att hämta. |
|
|
Poster per sida
|
per_page | integer |
Antal poster per sida. |
Returer
- response
- array of catalog_variant
Hämta autentiseringar för en användare
Hämta en lista över autentiseringar som tillhör en specifik användare.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Sidans nummer
|
page | integer |
Sidnummer att hämta. |
|
|
Poster per sida
|
per_page | integer |
Antal poster per sida. |
|
|
Användar-ID
|
user_id | True | integer |
Användarens identifierare. |
Returer
- response
- array of authentication
Hämta en användare
Hämta en enskild användare efter ID.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Användar-ID
|
id | True | integer |
Användarens identifierare. |
Returer
- Body
- user
Hämta en faktura
Hämta en enda faktura med ID.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Faktura-ID
|
id | True | integer |
Identifierare för fakturan. |
Returer
- Body
- invoice
Hämta en kategori
Hämta en kategori efter ID
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Kategori-ID
|
id | True | integer |
Identifierare för kategorin. |
Returer
- Body
- category
Hämta en kurs
Hämta en enskild kurs efter ID
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Kurs-ID
|
id | True | integer |
Kursidentifierare. |
Returer
- Body
- course
Hämta ett konto
Hämta ett konto efter ID.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Konto-ID
|
id | True | integer |
Identifierare för kontot. |
Returer
- Body
- account
Lägg till en kategori
Lägg till en kategori i din administration.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Id-nummer
|
id | integer |
Unik identifierare för kategorin. |
|
|
Namn
|
name | True | string |
Rubrik för kategorin. |
|
Description
|
description | string |
Beskrivningen av kategorin. |
|
|
position
|
position | number |
Sorteringsposition för kategorin. Lägre är högre. |
|
|
parent_id
|
parent_id | number |
Unik identifierare för den överordnade kategorin |
|
|
avatar
|
avatar | string |
URL till kategorin avatar. |
|
|
Publicerad
|
is_published | boolean |
Om kategorin ska publiceras på webbplatsen. |
|
|
courses_count
|
courses_count | number |
Antal kurser som är direkt kopplade till den här kategorin. |
|
|
children_count
|
children_count | number |
Antal underordnade kategorier som är direkt länkade till den här kategorin. |
|
|
updated_at
|
updated_at | string |
Tidsstämpel för den senaste uppdateringen. |
|
|
skapad_tid
|
created_at | string |
Tidsstämpel för skapande. |
|
|
avatar_url
|
avatar_url | string |
URL till en storleksanpassad avatarbild (300x200^). |
Returer
- Body
- category
Lägga till en användare
Lägg till en användare i din administration.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Förnamn
|
first_name | True | string |
Användarens förnamn. |
|
Mellannamn
|
middle_name | string |
Användarens mellannamn. |
|
|
Efternamn
|
last_name | True | string |
Användarens efternamn. |
|
E-postmeddelande
|
True | string |
E-postmeddelandet till användaren. |
|
|
Telefonnummer
|
phone | string |
Användarens telefonnummer. |
|
|
Prenumerera på nyhetsbrev
|
wants_newsletter | boolean |
Vill användaren ta emot nyhetsbrev? |
|
|
Skapa autentisering
|
with_authentication | boolean |
Skapa en autentisering för användaren, så att användaren kan logga in. |
|
|
Lokalisering
|
locale | string |
Användarens nationella inställningar. |
|
|
label_ids
|
label_ids | array of number | ||
|
Id-nummer
|
id | integer |
Unik identifierare för adressen. |
|
|
adressat
|
addressee | string |
Adressens adress. |
|
|
address
|
address | True | string |
Sammanlänkning av gatan och husnummer. |
|
postnummer
|
postal_code | True | string |
En sträng som representerar postnumret. |
|
city
|
city | True | string |
En sträng som representerar staden. |
|
country
|
country | True | string |
En sträng som representerar landet. |
|
updated_at
|
updated_at | string |
Tidsstämpel för den senaste uppdateringen. |
|
|
skapad_tid
|
created_at | string |
Tidsstämpel för skapande. |
|
|
notes_user
|
notes_user | string |
Kort anteckning om användaren. |
Returer
- Body
- user
Lägga till en autentisering
Lägga till en autentiseringsmetod till en befintlig användare
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
user_id
|
user_id | True | integer |
ID:t för användaren som den här autentiseringen tillhör. |
|
authentication_provider_type
|
authentication_provider_type | True | string |
Typ av autentiseringsprovider. |
|
uid
|
uid | True | string |
Den unika identifieraren för den här autentiseringen som motsvarar ett unikt ID från IDP:t. |
Returer
- Body
- authentication
Lägga till en faktura
Lägg till en faktura i din administration.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Account
|
account_id | True | number |
Identifierare för kontot. |
|
account_name
|
account_name | string |
Namnet på det konto som betalar. Kopieras till fakturan och uppdateras därför inte automatiskt om kontonamnet ändras. |
|
|
valuta
|
currency | True | string |
Fakturans valuta. |
|
Id-nummer
|
id | integer |
Unik identifierare för fakturaobjektet. |
|
|
Units
|
units | True | number |
Antalet enheter för fakturaobjektet. |
|
Description
|
name | True | string |
Namnet på fakturaobjektet. |
|
Pris
|
unit_price | True | string |
Priset för en enda enhet. |
|
Moms
|
invoice_vat_id | number |
Identifierare för fakturamomsen. |
|
|
Katalogvariant
|
catalog_variant_id | number |
Identifierare för katalogvarianten. |
|
|
updated_at
|
updated_at | string |
Tidsstämpel för den senaste uppdateringen. |
|
|
skapad_tid
|
created_at | string |
Tidsstämpel för skapande. |
|
|
feature
|
feature | string |
En beskrivning av fakturan som visas på fakturan. |
|
|
fotnot
|
footnote | string |
Anteckningen visas längst ned på fakturan. |
Returer
- Body
- invoice
Lägga till en fakturamoms
Lägg till en fakturamoms som kan användas på fakturan.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Id-nummer
|
id | integer |
Unik idenitfier för fakturamomsen. |
|
|
name
|
name | True | string |
Namnet på fakturan. |
|
procentandel
|
percentage | True | string |
Tal som representerar momsprocenten. |
Returer
- Body
- invoice_vat
Lägga till en kurs
Lägg till en kurs i din administration.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Id-nummer
|
id | integer |
Unik identifierare för kursen |
|
|
name
|
name | True | string |
Kursens namn. |
|
position
|
position | number |
Sorteringsposition för kursen. Lägre är högre. |
|
|
signup_url
|
signup_url | string |
URL till registreringssidan för den här kursen. |
|
|
slug_history
|
slug_history | array of string |
Lista över gamla sniglar, gamla anrop omdirigeras. |
|
|
avatar
|
avatar | string |
URL till en storleksanpassad avatarbild (300x200^). |
|
|
certificate_template_id
|
certificate_template_id | number |
Identifierare för den valfria länkade certifikatmallen. |
|
|
Kategori
|
category_id | True | number |
Identifierare för kursens kategori. |
|
kod
|
code | True | string |
Kursens kod. |
|
kostnad
|
cost | string |
Priset som ska betalas för denna kurs. |
|
|
cost_scheme
|
cost_scheme | string |
Hur ska kursen betalas som standard. |
|
|
is_published
|
is_published | boolean |
Boolesk som representerar kursens publiceringsbara status. |
|
|
updated_at
|
updated_at | string |
Tidsstämpel för den senaste uppdateringen. |
|
|
skapad_tid
|
created_at | string |
Tidsstämpel för skapande. |
Returer
- Body
- course
Lägga till ett konto
Lägg till ett konto i din administration.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
name
|
name | True | string |
Kontonamnet. |
|
Mejladress
|
string |
En sträng som representerar faktureringens e-post för kontot. |
||
|
Id-nummer
|
id | integer |
Unik identifierare för adressen. |
|
|
adressat
|
addressee | string |
Adressens adress. |
|
|
address
|
address | True | string |
Sammanlänkning av gatan och husnummer. |
|
postnummer
|
postal_code | True | string |
En sträng som representerar postnumret. |
|
city
|
city | True | string |
En sträng som representerar staden. |
|
country
|
country | True | string |
En sträng som representerar landet. |
|
updated_at
|
updated_at | string |
Tidsstämpel för den senaste uppdateringen. |
|
|
skapad_tid
|
created_at | string |
Tidsstämpel för skapande. |
Returer
- Body
- account
Ta bort en autentisering av en användare
Ta bort en av autentiseringarna för en användare. Observera att du inte kan ta bort den senaste autentiseringen!
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Användar-ID
|
user_id | True | integer |
Användarens identifierare. |
|
Autentiserings-ID
|
authentication_id | True | integer |
Identifierare för autentiseringen. |
Visa en lista över alla användare
Hämta alla användare.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Sidans nummer
|
page | integer |
Sidnummer att hämta. |
|
|
Poster per sida
|
per_page | integer |
Antal poster per sida. |
|
|
Sortera
|
sort | array |
Sortera resultatet. Ändra ordning med hjälp av |
Returer
- response
- array of user
Visa en lista över alla etiketter
Hämta alla etiketter.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Sidans nummer
|
page | integer |
Sidnummer att hämta. |
|
|
Poster per sida
|
per_page | integer |
Antal poster per sida. |
|
|
Filtrera efter modelltyp för etiketten
|
model_type | string |
Filtrera etiketter baserat på modelltyp. |
Returer
- response
- array of label
Visa en lista över alla fakturafakturor
Hämta alla fakturafakturor
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Sidans nummer
|
page | integer |
Sidnummer att hämta. |
|
|
Poster per sida
|
per_page | integer |
Antal poster per sida. |
Returer
- response
- array of invoice_vat
Visa en lista över alla fakturor
Hämta alla fakturor.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Sidans nummer
|
page | integer |
Sidnummer att hämta. |
|
|
Poster per sida
|
per_page | integer |
Antal poster per sida. |
Returer
- response
- array of invoice
Visa en lista över alla kategorier
Hämta alla kategorier.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Sidans nummer
|
page | integer |
Sidnummer att hämta. |
|
|
Poster per sida
|
per_page | integer |
Antal poster per sida. |
|
|
Sortera
|
sort | array |
Sortera resultatet. Ändra ordning med hjälp av |
Returer
- response
- array of category
Visa en lista över alla konton
Hämta alla konton.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Sidans nummer
|
page | integer |
Sidnummer att hämta. |
|
|
Poster per sida
|
per_page | integer |
Antal poster per sida. |
Returer
- response
- array of account
Visa en lista över alla kurser
Hämta alla kurser.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Sidans nummer
|
page | integer |
Sidnummer att hämta. |
|
|
Poster per sida
|
per_page | integer |
Antal poster per sida. |
|
|
Sortera
|
sort | array |
Sortera resultatet. Ändra ordning med hjälp av |
Returer
- response
- array of course
Utlösare
| Prenumerera på en webhook |
Prenumerera på en webhook för att få aviseringar om postuppdateringar. |
Prenumerera på en webhook
Prenumerera på en webhook för att få aviseringar om postuppdateringar.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Id-nummer
|
id | string |
Unik identifierare för webhooken. (ett UUID). |
|
|
active
|
active | boolean |
Tillstånd för webhook. |
|
|
events
|
events | True | array of string |
Matris med händelser som ska utlösa den här webhooken. |
Returer
- Body
- webhook_payload
Definitioner
account
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Id-nummer
|
id | integer |
Unik identifierare för kontot. |
|
name
|
name | string |
Kontonamnet. |
|
Mejladress
|
string |
En sträng som representerar faktureringens e-post för kontot. |
|
|
account_type
|
account_type | string |
Kontotypen. |
|
address
|
address | address | |
|
phone
|
phone | string |
En sträng som representerar kontots telefonnummer. |
|
updated_at
|
updated_at | string |
Tidsstämpel för den senaste uppdateringen. |
|
skapad_tid
|
created_at | string |
Tidsstämpel för skapande. |
|
signup_answers
|
signup_answers | array of customField |
Lista över registreringssvar för det här kontot. |
address
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Id-nummer
|
id | integer |
Unik identifierare för adressen. |
|
adressat
|
addressee | string |
Adressens adress. |
|
address
|
address | string |
Sammanlänkning av gatan och husnummer. |
|
postnummer
|
postal_code | string |
En sträng som representerar postnumret. |
|
city
|
city | string |
En sträng som representerar staden. |
|
country
|
country | string |
En sträng som representerar landet. |
|
updated_at
|
updated_at | string |
Tidsstämpel för den senaste uppdateringen. |
|
skapad_tid
|
created_at | string |
Tidsstämpel för skapande. |
autentisering
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Id-nummer
|
id | integer |
Unik identifierare för autentiseringen. |
|
user_id
|
user_id | integer |
ID:t för användaren som den här autentiseringen tillhör. |
|
authentication_provider_id
|
authentication_provider_id | integer |
ID för autentiseringsprovidern. |
|
uid
|
uid | string |
Den unika identifieraren för den här autentiseringen som motsvarar ett unikt ID från IDP:t. |
|
Om OTP är aktiverat för den här inloggningen.
|
otp_enabled |
Om autentiseringsprovidern är Eduframe, anger om ett engångslösenord är aktiverat för den här inloggningen är falskt för andra leverantörer. |
|
|
updated_at
|
updated_at | string |
Tidsstämpel för den senaste uppdateringen. |
|
skapad_tid
|
created_at | string |
Tidsstämpel för skapande. |
customField
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Id-nummer
|
id | integer |
Unik identifierare för registreringssvaret. |
|
värde
|
value | string |
Det formaterade värdet för svaret. |
|
signup_question_id
|
signup_question_id | integer |
Unik identifierare för frågan. |
kategori
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Id-nummer
|
id | integer |
Unik identifierare för kategorin. |
|
Namn
|
name | string |
Rubrik för kategorin. |
|
Description
|
description | string |
Beskrivningen av kategorin. |
|
position
|
position | number |
Sorteringsposition för kategorin. Lägre är högre. |
|
parent_id
|
parent_id | number |
Unik identifierare för den överordnade kategorin |
|
avatar
|
avatar | string |
URL till kategorin avatar. |
|
Publicerad
|
is_published | boolean |
Om kategorin ska publiceras på webbplatsen. |
|
courses_count
|
courses_count | number |
Antal kurser som är direkt kopplade till den här kategorin. |
|
children_count
|
children_count | number |
Antal underordnade kategorier som är direkt länkade till den här kategorin. |
|
updated_at
|
updated_at | string |
Tidsstämpel för den senaste uppdateringen. |
|
skapad_tid
|
created_at | string |
Tidsstämpel för skapande. |
|
avatar_url
|
avatar_url | string |
URL till en storleksanpassad avatarbild (300x200^). |
kurs
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Id-nummer
|
id | integer |
Unik identifierare för kursen |
|
name
|
name | string |
Kursens namn. |
|
position
|
position | number |
Sorteringsposition för kursen. Lägre är högre. |
|
signup_url
|
signup_url | string |
URL till registreringssidan för den här kursen. |
|
avatar
|
avatar | string |
URL till en storleksanpassad avatarbild (300x200^). |
|
certificate_template_id
|
certificate_template_id | number |
Identifierare för den valfria länkade certifikatmallen. |
|
Kategori
|
category_id | number |
Identifierare för kursens kategori. |
|
kod
|
code | string |
Kursens kod. |
|
kostnad
|
cost | string |
Priset som ska betalas för denna kurs. |
|
cost_scheme
|
cost_scheme | string |
Hur ska kursen betalas som standard. |
|
is_published
|
is_published | boolean |
Boolesk som representerar kursens publiceringsbara status. |
|
updated_at
|
updated_at | string |
Tidsstämpel för den senaste uppdateringen. |
|
skapad_tid
|
created_at | string |
Tidsstämpel för skapande. |
user
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Id-nummer
|
id | integer |
Unik identifierare för användaren. |
|
Antal anställda
|
employee_number | string |
Den här användarens personalnummer. |
|
Förnamn
|
first_name | string |
Användarens förnamn. |
|
Mellannamn
|
middle_name | string |
Användarens mellannamn. |
|
Efternamn
|
last_name | string |
Användarens efternamn. |
|
E-postmeddelande
|
string |
E-postmeddelandet till användaren. |
|
|
Telefonnummer
|
phone | string |
Användarens telefonnummer. |
|
labels
|
labels | array of label | |
|
Prenumerera på nyhetsbrev
|
wants_newsletter | boolean |
Vill användaren ta emot nyhetsbrev? |
|
Skapa autentisering
|
with_authentication | boolean |
Skapa en autentisering för användaren, så att användaren kan logga in. |
|
Lokalisering
|
locale | string |
Användarens nationella inställningar. |
|
address
|
address | address | |
|
Avatar
|
avatar_url | string |
Den relativa URL-sökvägen till avataren. |
|
updated_at
|
updated_at | string |
Tidsstämpel för den senaste uppdateringen. |
|
skapad_tid
|
created_at | string |
Tidsstämpel för skapande. |
faktura
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Id-nummer
|
id | integer |
Unik identifierare för fakturan. |
|
reference_id
|
reference_id | string |
Referens-ID för fakturan. Används för att hitta fakturan. |
|
Account
|
account_id | number |
Identifierare för kontot. |
|
nummer
|
number | string |
Fakturanumret som är unikt per lärare. Om det lämnas tomt, autoincrements. |
|
number_int
|
number_int | number |
Fakturanumret konverterades till ett heltalsvärde. |
|
status
|
status | string |
Status för fakturan. Den inledande statusen kommer alltid att vara begrepp. |
|
expiration_date
|
expiration_date | string |
Förfallodatumet för fakturan. Anges när fakturan är inställd på att öppnas. |
|
opened_at
|
opened_at | string |
Det datum då fakturastatusen ändrades för att öppnas. |
|
beskrivning
|
description | string |
Mänsklig läsbar beskrivning av fakturan. |
|
account_name
|
account_name | string |
Namnet på det konto som betalar. Kopieras till fakturan och uppdateras därför inte automatiskt om kontonamnet ändras. |
|
valuta
|
currency | string |
Fakturans valuta. |
|
total_incl
|
total_incl | string |
Den totala kostnaden för fakturan inklusive moms. |
|
total_excl
|
total_excl | string |
Den totala kostnaden för fakturan exklusive moms. |
|
total_open
|
total_open | string |
Den öppna kostnaden för fakturan inklusive moms. |
|
pdf_url
|
pdf_url | string |
Url till nedladdningssökvägen för fakturan i PDF-format. |
|
xml_url
|
xml_url | string |
Url till nedladdningssökvägen för fakturan i UML-format. |
|
feature
|
feature | string |
En beskrivning av fakturan som visas på fakturan. |
|
fotnot
|
footnote | string |
Anteckningen visas längst ned på fakturan. |
|
invoice_items
|
invoice_items | array of invoice_item | |
|
updated_at
|
updated_at | string |
Tidsstämpel för den senaste uppdateringen. |
|
skapad_tid
|
created_at | string |
Tidsstämpel för skapande. |
invoice_item
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Id-nummer
|
id | integer |
Unik identifierare för fakturaobjektet. |
|
Units
|
units | number |
Antalet enheter för fakturaobjektet. |
|
Description
|
name | string |
Namnet på fakturaobjektet. |
|
Pris
|
unit_price | string |
Priset för en enda enhet. |
|
Moms
|
invoice_vat_id | number |
Identifierare för fakturamomsen. |
|
Katalogvariant
|
catalog_variant_id | number |
Identifierare för katalogvarianten. |
|
updated_at
|
updated_at | string |
Tidsstämpel för den senaste uppdateringen. |
|
skapad_tid
|
created_at | string |
Tidsstämpel för skapande. |
invoice_vat
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Id-nummer
|
id | integer |
Unik idenitfier för fakturamomsen. |
|
name
|
name | string |
Namnet på fakturan. |
|
procentandel
|
percentage | string |
Tal som representerar momsprocenten. |
catalog_variant
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Id-nummer
|
id | number |
Unik identifierare för katalogvarianten |
|
product_id
|
product_id | number |
Unik identifierare för katalogprodukten |
|
name
|
name | string |
Kursens namn. |
|
cost_scheme
|
cost_scheme | string |
Hur ska katalogvarianten betalas som standard. |
|
kostnad
|
cost | string |
Det pris som ska betalas för den här katalogvarianten. |
|
valuta
|
currency | string |
Valutan för katalogvarianten. |
|
variantable_type
|
variantable_type | string |
Fakturans valuta. |
|
variantable_id
|
variantable_id | number |
Unik identifierare för det variantbara. |
|
updated_at
|
updated_at | string |
Tidsstämpel för den senaste uppdateringen. |
|
skapad_tid
|
created_at | string |
Tidsstämpel för skapande. |
|
Publicerad
|
is_published | boolean |
Om kategorin ska publiceras på webbplatsen. |
label
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Id-nummer
|
id | number |
Unik identifierare för etiketten |
|
Namn
|
name | string |
Namnet på etiketten. |
|
Färg
|
color | string |
Hexkod för etikettens färg. |
|
Model
|
model_type | string |
Den modelltyp som den här etiketten är tillgänglig för. |
|
updated_at
|
updated_at | string |
Tidsstämpel för den senaste uppdateringen. |
|
skapad_tid
|
created_at | string |
Tidsstämpel för skapande. |
webhook_payload
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
lärare
|
educator | string |
Pedagogens snigel. |
|
händelse
|
event | string |
Typ av händelse som utlöste webhooken. |
|
entity_type
|
entity_type | string |
Typ av modell som utlöste webhooken. |
|
entity_id
|
entity_id | number |
Unik identifierare för modellen som utlöste webhooken. |
|
hyresgäst-ID
|
tenant_id | string |
UUID för lärare. |