API (JSON)

Mit den API Funktionen der Getränkeliste können andere Systeme automatisiert (wie z.B. ein Zahlungsdienstleister) angebunden werden.
Die API liefert JSON Daten und wird einfach mit GET Parametern aufgerufen.

Unter Verwaltung > Einstellungen kann eine Zahlungs-URL mit variablen festegelegt werden. Mit dieser kann mit der "account" und "amount" Variable bei z.B. beliebigen Zahlungsdienstleistern gestartet werden.

Oder alternativ mit der Liste der offnen Beträge aus 2) selbst Zahlungsanweisungen erzeugen. Ist eine Zahlung erfolgreich, kann es mit 3) wieder mit dem Konto verbucht werden. Der API Key wird in der Verwaltung unter Einstellungen angezeigt.

Bei Fragen, weiteren Funktionen, etc. => Kontaktformular

1) Auslesen Konten

URL Aufruf
https://iqmeta.com/gliste/api/accounts/?email=verwalter@email.com&apikey=01234567890123456789012345678912345678912345678901

Ergebnis Objekt

{
    date_utc (datetime)
    error (boolean)
    msg (string)
    accounts (array) [{
            account (guid)
            name (string)
            email (string)
            rufname (string)
            balance (decimal)
        }]
}

Beispiel Ergebnis

{
  "date_utc": "2018-08-08T14:40:43.0219675Z",
  "error": false,
  "msg": "success",
  "unpaid": [
    {
      "account": "e2a4f338-fe98-488f-a9a4-634174167df3",
      "name": "Wurst, Hans",
      "email": "some@email.com"
      "rufname": "",
      "balance": 32.00,
    },
    {
      "account": "420d4153-d502-40ae-a869-51419e604124",
      "name": "Gemüse, Olga",
      "email": "another@emai.com"
      "rufname": "Alte Karotte",
      "balance": 24.00,
    }
  ]
}

2) Auslesen offener Beträge

URL Aufruf
https://iqmeta.com/gliste/api/unpaid/?email=verwalter@email.com&apikey=01234567890123456789012345678912345678912345678901

Ergebnis Objekt

{
    date_utc (datetime)
    error (boolean)
    msg (string)
    unpaid_sum (decimal)
    unpaid (array) [{
            account (guid)
            unpaid (decimal)
            name (string)
            email (string)
        }]
}

Beispiel Ergebnis

{
  "date_utc": "2018-08-08T14:40:43.0219675Z",
  "error": false,
  "msg": "success",
  "unpaid_sum": 56.00,
  "unpaid": [
    {
      "account": "e2a4f338-fe98-488f-a9a4-634174167df3",
      "unpaid": 32.00,
      "name": "Wurst, Hans",
      "email": "some@email.com"
    },
    {
      "account": "420d4153-d502-40ae-a869-51419e604124",
      "unpaid": 24.00,
      "name": "Gemüse, Olga",
      "email": "another@emai.com"
    }
  ]
}

3) Betrag bezahlen

URL Aufruf
https://iqmeta.com/gliste/api/payment/?email=verwalter@email.com&apikey=01234567890123456789012345678912345678912345678901&account=420d4153-d502-40ae-a869-51419e604124&amount=20.50

Ergebnis Objekt

{
    error (boolean)
    msg (string)
    name (string)
    account (guid)
    date_utc (datetime)
    unpaid_before_fullfilled (decimal)
    unpaid_new (decimal)
    current_balance (decimal)
    payment_fullfilled (decimal)
    credit_overpaid (decimal)
}

Beispiel Ergebnis

{
  "error": false,
  "msg": "success",
  "name": "Gemüse, Olga",
  "account": "420d4153-d502-40ae-a869-51419e604124",
  "date_utc": "2018-08-08T14:41:40.7975722Z",
  "unpaid_before_fullfilled": 24.00,
  "unpaid_new": 4.00,
  "payment_fullfilled": 20.0,
  "current_balance": 4.00,
  "credit_overpaid": 0.0
}

4) Gutschrift

URL Aufruf
https://iqmeta.com/gliste/api/credit/?email=verwalter@email.com&apikey=01234567890123456789012345678912345678912345678901&account=420d4153-d502-40ae-a869-51419e604124&amount=2.4&text=Barzahlung
Hinweis: Text wird nach 30 Zeichen abgeschnitten

Ergebnis Objekt

{
    date_utc (datetime)
    error (boolean)
    msg (string)
    text (string)    
    account (guid)
    name (string)
    rufname (string)
    email (string)
    balance_change (decimal)
}

Beispiel Ergebnis

{
  "date_utc": "2022-04-27T10:37:16.3073954Z",
  "error": false,
  "msg": "success",
  "text": "Barzahlung",
  "account": "420d4153-d502-40ae-a869-51419e604124",
  "name": "Gemüse, Olga",
  "rufname": "",
  "email": "",
  "balance_change": 2.4
}