Abrechnung, Produkte

Product

Standardprodukt

{
    "id":"3939ed76e7924a5ca3efafcef2164bb6",
    "owner": "{04596021-DE91-46E0-B5C9-4D44BA7BA8E3}", 
    "name":"Zeiterfassung",
    "application": "{6D664BD1-63F4-4D23-86C4-261CBFC64320}",
    "type": 1,
    "active": {
        "from": "2021-01-01",
        "to": "2021-12-31"
    }
    "subscription": {
        "": 0
    },
    "prices": [
        {
            "price": 5.0,
            "currency": "CHF"
        }
    ],
    "subscription":1,
    "items":[
        {
            "id":"7473d72ca0c44fb88d3bb67c8daa1ba3",
            "quantity": 1
        },
        {
            "id":"0b998db76e2c4749b049ff85a93df20d",
            "quantity": 1
        }
    ]
}

Eigenes Produkt

{
    "id":"{CDB8A045-3B02-44C9-B53D-6ADE3AB59EC2}",
    "name":"Cleanpartner - Standardmitarbeiter",
    "type": 100,
    "owner": "{04596021-DE91-46E0-B5C9-4D44BA7BA8E3}", 
    "items":[
        {
            "id":"{DD3B33EC-6AFC-437A-A98B-A04F31621B6D}"
        },
        {
            "id":"{B9D2FA7A-78C1-410F-9F46-A1674A4183F3}"
        }
    ]
}

Key	Type	Description
id	GUID	Id des Produkts
name	langstring	Name
text	langstring	Beschreibung
owner	guid	Eigentümer (Konto)
type	Integer	1 = Anwendungsmodul 2 = Paket 100 = Benutzerspezifisches Paket
subscription	Boolean	0 = false, 1 = true
items	Array of objects	Array of child products
billing.intervall	Array of objects	Array of child products
application	guid	(optional) Anwendung
active.from	date	(optional) Ab diesem Datum aktiv
active.to	date	(optional) Nur aktiv bis und mit zu diesem Datum
prices	array	Preise
prices.price	float	Preis pro Monat
prices.currency	string	Währungscode https://de.wikipedia.org/wiki/ISO_4217
prices.regions	array of string	(optional) Regionen für Gültigkeit
prices.countries	array of string	(optional) Länderfilter Alpha-3 Country Code : https://www.iban.com/country-codes

List

POST https://aduna.app/api/billing/product/list

Parameter	Type	Description
filter	json	Filter
filter.activeon	date	Aktiv am (Standard: Jetzt)
filter.product	id	Nur dieses Produkt
[return]	array of product	Liste von Produkten

Add

POST https://aduna.app/api/billing/product/add

Parameter	Type	Description
data	json (product)	Filter

Update

POST https://aduna.app/api/billing/product/update

Parameter	Type	Description
data	json (product)	Filter

Purchase

{
    "id":"{CB1DDA8A-B962-44ED-A790-BC89C8987E2E}",
    "date":"2021-10-19T16:51:44.000Z",
    "products":[
        {   
            "id":"3939ed76e7924a5ca3efafcef2164bb6",
            "name":"Kunde",
            "amount":3,
            "activations":[]
        }
    ]
}

List

POST https://aduna.app/api/billing/purchase/list

Get

POST https://aduna.app/api/billing/purchase/get

Buy

POST https://aduna.app/api/billing/purchase/buy

Cancel

POST https://aduna.app/api/billing/purchase/cancel

Subscription

List

POST https://aduna.app/api/billing/subscription/list

Cancel

POST https://aduna.app/api/billing/subscription/cancel

Aktivierung (Activation)

Gekaufte Lizenzen (Produkte) können in den einzelnen Arbeitsbereichen aktiviert werden. Siehe in den Workspaces.

Abrechnung (Bill)

List

POST https://aduna.app/api/billing/bill/list

Get

POST https://aduna.app/api/billing/bill/get

Pay

POST https://aduna.app/api/billing/bill/pay

Zahlung (Payment)

List

POST https://aduna.app/api/billing/payment/list

Get

POST https://aduna.app/api/billing/payment/get

Alt

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.

Product

Add(Data:JSON)
List()
Get(Product:GUID)
Update(Data:JSON)
Remove(Product:GUID)

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)

Lizenz

Jede Anwendung (In-App) hat eigene Lizenzmodule. Diese können pro Arbeitsbereich abonniert werden.

In einem Arbeitsbereich können Lizenzvorlagen erstellt werden, die dann verschiedene

Workspace

Siehe Workspace Dokumenation

Subscribe
Unsubscribe
ListSubscriptions

Lizenzmodul

{
    "id": "{367C81D5-2E8F-4BDF-A6C0-24B0E9E0B0F9}",
    "text": { 0: "Zeiterfassung" },
    "status": 1,
    "prices": [
        {
            "price": "1",
            "currency": "chf",
            "regions": [],
            "countries": []
        }
    ]
}

Key	Typ	Beschreibung
text	langstring	Bezeichnung des Moduls
status	int	1 = Aktiv, 0 = Inaktiv
prices	array	Preise
prices.price	float	Preis pro Monat
prices.currency	string	Währungscode https://de.wikipedia.org/wiki/ISO_4217
prices.regions	array of string	(optional) Regionen für Gültigkeit
prices.countries	array of string	(optional) Länderfilter Alpha-3 Country Code : https://www.iban.com/country-codes

Abonnement

Das Abonnement beschreibt, was in einem Arbeitsbereich lizenziert worden ist. Ein Abonnement beinhaltet jeweils nur ein Modul. Es können beliebig viele Abonnements pro Arbeitsbereich abgeschlossen werden.

{
    "id": "{95B8CA54-C443-4FC3-8F9C-3D0A8B0B8A09}",
    "entitytype": "{7EF8C0C5-71D1-467A-BD7E-915D2E41A06C}",
    "workspace": "{1C10C2F8-9A13-4F78-AB21-F8DEC91B22C1}",
    "metadata": {
        "created": "2020-07-13T09:27:13.847Z",
        }
    },
    "{FB093286-1785-4A9F-8B26-69283CA4C60F}": {
        "module": "{0E8263B0-8910-44E0-820F-399D12BC7340}",
        "template": "{3D91C2BC-7141-460B-9579-960DBE61F3EC}",
        "begin": "2020-01-05",
        "end": "2020-01-31"
    }
}

Datapart - Allgemein {FB093286-1785-4A9F-8B26-69283CA4C60F}

Key	Typ	Beschreibung
module	guid	Lizenziertes Modul
template	guid	(optional) Falls das Module über eine Lizenzvorlage erstellt wurde, ist dieser Wert gesetzt und zeigt auf die Vorlage.
begin	date	Start der Lizenzierung
end	date	(optional) Ende der Lizenzierung. Wenn dieser Wert leer ist oder in der Zukunft, ist es eine aktive Lizenz.

Lizenzvorlage

Eine Lizenzvorlage dient dem Benutzer zur einfachen Lizenzierung von Modulen in Arbeitsbereichen. Beispiel: Mitarbeiter (Zeiterfassung, Tagesjournal); Kunde (Rechnungen, Tagesjournal)

{
    "id": "{77B799FD-F05B-43DE-803D-AC4CE0934C76}",
    "entitytype": "{53E4D444-BC94-4EF7-B019-E7BAE0EAB69A}",
    "workspace": "{1C10C2F8-9A13-4F78-AB21-F8DEC91B22C1}",
    "metadata": {
        "created": "2020-07-13T09:27:13.847Z",
        }
    },
    "{5B03AC07-CDC1-48F2-BF62-52F550B41801}": {
        "modules": [
          "{0E8263B0-8910-44E0-820F-399D12BC7340}",
          "{94CFA4FF-475E-4537-A8FB-AD3240F7C95F}",
          "{7272972B-A167-406B-8EC5-CFBF907A75CF}"
        ]
    }
}

Datapart - Allgemein {5B03AC07-CDC1-48F2-BF62-52F550B41801}

Key	Typ	Beschreibung
modules	array of guid	Beinhaltete Module