Anwenderhandbuch (EVI-LIMA)
Einleitung
Dieses Handbuch richtet sich weniger an den Anwender von EVI sondern an Entwickler, die dieses Modul verwenden möchten.
Das EVI-LIMA-Modul ist eine Sammlung von Methoden, die genutzt werden können, um die lima-Restwebservices aufzurufen. Das Muster dieser Methoden kann und sollte beibehalten werden, wenn weitere Services integriert werden.
Zu einem Service gehören immer folgende Methoden:
Auslesen der App-Id
Auslesen des App-Keys
Erzeugen der Header-Parameter
Erzeugen der Query-Parameter
Erzeugen der Path-Parameter
Sammeln der Daten
Senden der gesammelten Daten
Erweiterung der getAllParameters-Methode
Erweiterung der getNeededCredentials-Methode
Funktionsbeschreibung
Kundendaten
Kundendaten lesen
Das Modul ermöglicht es, die Kundenstammdaten sowie die Kontaktinformationen aus lima zu lesen. Hierfür ist die Kundennummer und ggf. die laufende Nummer der Kontaktinformationen notwendig.
Kundendaten anlegen
Die Kundenanlage sowie die Anlage neuer Kontaktinformationen zu einem Kunden können angelegt werden. Hierbei werden die Daten aus dem Geschäftspartner und dessen Kommunikationsdaten gelesen und nach lima übertragen
Kundendaten ändern
Kundenstammdaten und Kontaktinformationen können aktualisiert werden.
Kundendaten löschen
Kunden und Kontaktinformationen können gelöscht werden.
Bankdaten
Bankdaten lesen
Das Modul bietet die Funktion, Bankdaten zu einem Geschäftspartner, Zahlwege und SEPA-Mandate auszulesen.
Bankdaten anlegen
Zu einem Geschäftspartner und Debitor können neue Zahlwege, SEPA-Mandate und Bankverbindungen angelegt werden.
Bankdaten ändern
Bestehende Zahlungsinformationen können aktualisiert werden.
Bankdaten löschen
Bestehende Bankverbindungen, Zahlwege und SEPA-Mandate können gelöscht werden.
Abschläge
Abschlagsdaten lesen
Zu einem Vertrag können Abschlagsdaten aus lima gelesen werden.
Abschlagsdaten anlegen
Es können neue Abschläge zu einem Vertrag angelegt werden.
Abschlagsdaten ändern
Bestehende Abschläge können angepasst werden.
Abschlagsdaten löschen
Bestehende Abschläge können gelöscht werden.
Zählerstände
Zählerstandsdaten lesen
Bereits gemeldete zählerstände können aus lima ausgelesen werden.
Zählerstandsdaten anlegen
Neue Zählerstände können an lima gemeldet werden.
Zählerstandsdaten ändern
Bereits gemeldete Zählerstände können in lima aktualisiert werden.
Zählerstandsdaten löschen
Bestehende Zählerstände können gelöscht werden.
Vertragsdaten
Vertragsdaten lesen
Das Modul stellt die Funktion bereit, einen Vertrag mit bestimmten Kriterien zu ermitteln und dessen Vertragsdaten zu lesen.
Vertragsdaten anlegen
Neue Verträge können angelegt werden. Diese Funktion steht allerdings in lima nicht bereit.
Vertragsdaten ändern
Für bestehende Verträge können Produktwechsel und der Abgang durchgeführt werden.
Dokumente
Dokumente auflisten
Dokumente zu einem Geschäftspartner können aufgelistet werden.
Dokumente herunterladen
Dokumente zu einem Geschäftspartner können heruntergeladen und angezeigt werden.