Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

--- develop:xmlrpc:umsatz [d.m.Y H:i] – angelegt willuhn
+++ develop:xmlrpc:umsatz [d.m.Y H:i] (aktuell) – [Schlüssel-Namen] willuhn
@@ Zeile 1: / Zeile 1: @@
-==== hibiscus.xmlrpc.umsatz ====
+====== XML-RPC: Umsätze ======
-| Name der Funktion | //list// |
+  * Name des Service: **hibiscus.xmlrpc.umsatz**
-| Verwendung        | Abrufen von Umsätzen (Kontoauszügen) aus der Hibiscus-Datenbank |
-| Aufruf-Parameter  | **1** //String// Suchbegriff\\ **2** //String// Start-Datum im Format "dd.mm.yyyy"\\ **3** //String// End-Datum im Format "dd.mm.yyyy"\\ \\ Alle drei Parameter sind optional. Falls bei der Suche keine Einschränkungen vorgenommen werden sollen, können auch Leer-Strings oder //NULL//-Werte übergeben werden. In jedem Fall jedoch müssen 3 Parameter (wenn auch leere) angegeben sein. |
-| Rückgabe-Wert     | //String[]// (String-Array)\\ Jede Zeile des Arrays enthält die Daten zu einem Umsatz. Die Werte in jeder Zeile sind durch Doppelpunkte getrennt.\\ \\ Aufbau der Zeilen <code><ID des Kontos>:<Kontonummer Gegenkonto>:<BLZ Gegenkonto>:<Inhaber Gegenkonto>:<Betrag im Format "0,00">:
-<Valuta-Datum im Format "dd.mm.yyyy">:<Buchungsdatum-Datum im Format "dd.mm.yyyy">:<Verwendungszweck 1>:
-<Verwendungszweck 2>:<Saldo zu diesem Zeitpunkt im Format "0,00">:<Primanota>:<Kundenreferenz>:
-<Umsatz-Kategorie>:<Kommentar></code> |
+===== Schlüssel-Namen =====
-| Name der Funktion | //list// |
+^ Bezeichnung      ^ Beschreibung                                          ^
-| Verwendung        | Abrufen von Umsätzen (Kontoauszügen) aus der Hibiscus-Datenbank |
+| id               | ID des Umsatzes (eindeutig auch konto-übergreifend)   |
-| Aufruf-Parameter  | **1** //Map// (struct) Suchparameter\\ Die Map kann folgende Schlüssel enthalten:\\ konto_id (ID des Kontos)\\ art\\ empfaenger_name\\ empfaenger_konto\\ empfaenger_blz\\ id\\ id:min\\ id:max\\ saldo\\ saldo:min\\ saldo:max\\ valuta (im Format "YYYY-MM-DD")\\ valuta:min (im Format "YYYY-MM-DD")\\ valuta:max (im Format "YYYY-MM-DD")\\ datum (im Format "YYYY-MM-DD")\\ datum:min (im Format "YYYY-MM-DD")\\ datum:max (im Format "YYYY-MM-DD")\\ betrag\\ betrag:min\\ betrag:max\\ primanota\\ customer_ref\\ umsatz_typ\\ Endet der Schlüssel auf ":min" oder ":max" werden nur Datensätze geliefert, bei denen das zugehörige Attribut (also "id", "saldo", "valuta", "datum", "betrag") größer oder gleich bzw kleiner oder gleich als das übergebene Value in der Map ist. Alle Parameter sind optional. Sind keine angegeben, werden ALLE Umsätze aus Hibiscus geliefert. |
+| konto_id         | ID des Kontos, dem der Umsatz zugeordnet ist          |
-| Rückgabe-Wert     | //List<Map>// (Liste mit Elementen vom Typ Map bzw. struct)\\ Jedes Element der zurückgelieferten Liste ist eine Map (struct) mit folgenden Schlüsseln:\\ id\\ konto_id\\ empfaenger_name\\ empfaenger_konto\\ empfaenger_blz\\ saldo\\ valuta\\ datum\\ betrag\\ primanota\\ customer_ref\\ umsatz_typ\\ zweck\\ kommentar |
+| empfaenger_name  | Inhaber-Name des Gegenkontos                          |
+| empfaenger_konto | Kontonummer des Gegenkontos                           |
+| empfaenger_blz   | Bankleitzahl des Gegenkontos                          |
+| art              | Buchungsart                                           |
+| betrag           | Betrag im Locale-spezifischen Format des Systems      |
+| valuta           | Valuta-Datum im Format dd.mm.yyyy                     |
+| datum            | Buchungsdatum im Format dd.mm.yyyy                    |
+| zweck            | Verwendungszweck, bereinigt um SEPA-Tags. Er enthält also keine EREF-,KREF,...-Tags |
+| zweck_raw        | Der originale Verwendungszweck incl. der SEPA-Tags    |
+| saldo            | Saldo des Kontos zu diesem Zeitpunkt im Locale-spezifischen Format des Systems |
+| primanota        | Primanota-Kennzeichen                                 |
+| customer_ref     | Kundenreferenz                                        |
+| umsatz_typ       | Name der Umsatzkategorie (falls zugeordnet)           |
+| kommentar        | Kommentar (Freitext)                                  |
+===== Verfügbare Funktionen =====
+==== Liste der Umsätze ermitteln ====
+<code java>
+public List<Map<String,Object>> list(HashMap<String,Object> options) throws RemoteException;
+</code>
+  * Name der Funktion: **list**
+  * Liste der Parameter
+    - **struct** Struct mit Suchkriterien. Folgende Schlüssel können im Struct verwendet werden:
+      * **konto_id** ID des Kontos, dem der Umsatz zugeordnet ist
+      * **art** Buchungsart
+      * **empfaenger_name** Inhaber-Name des Gegenkontos
+      * **empfaenger_konto** Kontonummer des Gegenkontos
+      * **empfaenger_blz** Bankleitzahl des Gegenkontos
+      * **id** ID des Umsatzes
+      * **id:min** niedrigste zulässige ID des Umsatzes
+      * **id:max** höchste zulässige ID des Umsatzes
+      * **saldo** Saldo des Kontos bei diesem Umsatz
+      * **saldo:min** niedrigster zulässiger Saldo des Kontos bei diesem Umsatz
+      * **saldo:max** höchster zulässiger Saldo des Kontos bei diesem Umsatz
+      * **valuta** Valuta-Datum im Format "dd.mm.yyyy" oder "yyyy-mm-dd"
+      * **valuta:min** niedrigstes Valuta-Datum im Format "dd.mm.yyyy" oder "yyyy-mm-dd"
+      * **valuta:max** höchstes Valuta-Datum im Format "dd.mm.yyyy" oder "yyyy-mm-dd"
+      * **datum** Buchungsdatum im Format "dd.mm.yyyy" oder "yyyy-mm-dd"
+      * **datum:min** niedrigstes Buchungsdatum im Format "dd.mm.yyyy" oder "yyyy-mm-dd"
+      * **datum:max** höchstes Buchungsdatum im Format "dd.mm.yyyy" oder "yyyy-mm-dd"
+      * **betrag** Betrag des Umsatzes
+      * **betrag:min** niedrigster zulässiger Betrag des Umsatz
+      * **betrag:max** höchster zulässiger Betrag des Umsatzes
+      * **primanota** Primanota-Kennzeichen
+      * **customer_ref** Kunden-Referenz
+      * **umsatz_typ** Name oder ID der Umsatz-Kategorie
+      * **zweck** Verwendungszweck
+  * Rückgabe-Werte: **array<struct>** (Liste mit "struct"-Elementen) \\ Liste der gefundenen Umsätze. Jedes Element der Liste enthält einen Umsatz in Form eines Struct mit den o.g. Schlüsseln
+=== Code-Beispiele ===
+== Java ==
+<code java>
+import java.util.Map;
+import java.util.HashMap;
+Map params = new HashMap();
+params.put("zweck","test");
+params.put("datum:min","01.01.2010");
+params.put("datum:max","31.12.2011");
+Object[] l = (Object[]) client.execute("hibiscus.xmlrpc.umsatz.list",new Object[]{params});
+for (Object o:l)
+{
+  System.out.println(o);
+}
+</code>
+== PHP ==
+<code php>
+$params = new xmlrpcval(
+  array(
+    "zweck"     => new xmlrpcval("test","string"),
+    "datum:min" => new xmlrpcval("01.01.2010","string"),
+    "datum:max" => new xmlrpcval("31.12.2011","string")
+  ),"struct");
+$msg = new xmlrpcmsg("hibiscus.xmlrpc.umsatz.list",array($params));
+$response = $client->send($msg);
+$value = $response->value();
+for ($i=0;$i<$value->arraySize();$i++)
+{
+  $umsatz = $value->arrayMem($i);
+  print("ID    : ".$umsatz->structMem("id")->scalarVal()."\n");
+  print("Name  : ".$umsatz->structMem("empfaenger_name")->scalarVal()."\n");
+  print("Konto : ".$umsatz->structMem("empfaenger_konto")->scalarVal()."\n");
+  print("BLZ   : ".$umsatz->structMem("empfaenger_blz")->scalarVal()."\n");
+  print("Betrag: ".$umsatz->structMem("betrag")->scalarVal()."\n");
+  print("Zweck : ".$umsatz->structMem("zweck")->scalarVal()."\n");
+  print("\n");
+}
+</code>
+==== Liste der Umsätze ermitteln (veraltet) ====
+| **deprecated** Diese Funktion existiert aus Gründen der Abwärtskompatibilität weiterhin. \\ Verwende künftig jedoch bitte die andere Funktion **[[develop:xmlrpc:umsatz#liste_der_umsaetze_ermitteln|list]]** mit dem "struct"-Parameter - die neue Funktion liefert zudem detailliertere Rückgabe-Werte. |
+<code java>
+public String[] list(String text, String von, String bis) throws RemoteException;
+</code>
+  * Name der Funktion: **list**
+  * Liste der Parameter
+    - **String** Suchbegriff (darf leer sein)
+    - **String** Start-Datum im Format "dd.mm.yyyy" oder "yyyy-mm-dd" (darf leer sein)
+    - **String** End-Datum im Format "dd.mm.yyyy" oder "yyyy-mm-dd" (darf leer sein)
+  * Rückgabe-Werte: **array<string>** (Liste mit "String"-Elementen) \\ Liste der gefundenen Umsätze. Die Werte in jeder Zeile sind durch Doppelpunkte getrennt.\\ \\ Aufbau der Zeilen <code><konto_id>:<empfaenger_konto>:<empfaenger_blz>:<empfaenger_name>:<betrag>:<valuta>:<datum>:<zweck (nur Zeile 1)>:<zweck (nur Zeile 2)>:<saldo>:<primanota>:<customer_ref>:<umsatz_typ>:<kommentar></code>
+=== Code-Beispiele ===
+== Java ==
+<code java>
+Object[] list = (Object[]) client.execute("hibiscus.xmlrpc.umsatz.list",new String[]{"","01.01.2010","31.12.2011"});
+for (Object o:list)
+{
+  System.out.println(o);
+}
+</code>
+== PHP ==
+<code php>
+$msg = new xmlrpcmsg("hibiscus.xmlrpc.umsatz.list",array(new xmlrpcval("","string"),
+                                                         new xmlrpcval("01.01.2010","string"),
+                                                         new xmlrpcval("31.12.2011","string")));
+$response = $client->send($msg);
+$value = $response->value();
+for ($i=0;$i<$value->arraySize();$i++)
+{
+  print($value->arrayMem($i)->scalarVal()."\n");
+}
+</code>

Impressum | Datenschutz