Subscriptions

  • Pro Applikation (Application) gibt es verschiedene Produkte (Product).
  • Ein Produkt kann auch ein Paket aus verschiedenen Produkten (ProductItem) sein.
  • Ein Kauf (Purchase) beinhaltet Produkte (PurchaseItem).
  • Ein Produkt eines Kaufes kann mittels einer Aktivierung (Activation) einem Arbeitsbereich (Workspace) zugewiesen werden.
  • Ein aktiviertes Produkt in einem Arbeitsbereich schaltet Funktionalität frei.
  • Ein Produkt eines Kaufes kann Rechnungspositionen erzeugen (BillPosition).
  • Mehrere Rechnungspositionen werden als Rechnung (Bill) zusammengefasst.
  • Eine Rechnung ist dem Benutzer (Account) zugewiesen, welcher der Besitzer des Arbeitsbereiches (WorkspaceAccount) ist.

Endpoints

Product

  • Add(Data:JSON)
  • List()
  • Get(Product:GUID)
  • Update(Data:JSON)
  • Remove(Product:GUID)
{
    "id":"3939ed76e7924a5ca3efafcef2164bb6",
    "name":"Zeiterfassung",
    "type":1,
    "price":3,
    "subscription":1,
    "items":[
        {
            "id":"7473d72ca0c44fb88d3bb67c8daa1ba3",
            "name":"Stempelung",
            "type":1,
            "price":2,
            "subscription":1,
            "items":[]
        },
        {
            "id":"0b998db76e2c4749b049ff85a93df20d",
            "name":"Disposition",
            "type":1,
            "price":2,
            "subscription":1,
            "items":[]
        }

    ]
}
Key Type Description
ID GUID Product identifier
Name String Product name
Type Integer 1 = package, 2 = custom
Price Float Costs
Subscription Boolean 0 = false, 1 = true
Items Array of objects Array of child products

Purchase

  • Add(Data:JSON)
  • List(Account:GUID)
  • Get(Purchase:GUID)
  • Update(Data:JSON)
  • Remove(Purchase:GUID)
{
    "id":"a3ceb4335af44dc188452497f29ce346",
    "date":"2021-10-19T16:51:44.000Z",
    "products":[
        {   
            "id":"3939ed76e7924a5ca3efafcef2164bb6",
            "name":"Kunde",
            "amount":3,
            "activations":[]
        }
    ]
}
Key Type Description
ID GUID Purchase identifier
Name String Purchase name
Products Array of objects Array of purchased products
Products.ID GUID Product identifier
Products.Name string Product name
Products.Amount Integer Purchased product amount
Products.Activations Array of objects Array of product activations

Activation

  • Add(Data:JSON)
  • List(Account:GUID/Workspace:GUID)
  • Get(Activation:GUID)
  • Remove(Activation:GUID)
{
    "id":"d6b0997898fb4c2a9d5da54b6624aadb",
    "from":"2021-10-19T16:51:44.000Z",
    "workspaceid":"28b779db14da491089d2f818dc5e3b28",
    "workspacename":"Clean Parter - Super Immobilien",
    "product":{}
}
Key Type Description
ID GUID Activation identifier
From DateTime Activation start
To DateTime Activation end
WorkspaceID GUID Workspace identifier of activation
WorkspaceName string Workspace name of activation
Product Object Activated product

Bill

  • Billing()
  • List(Account:GUID)
  • Paid(Bill:GUID)