Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

--- develop:xmlrpc:umsatz [d.m.Y H:i] – willuhn
+++ develop:xmlrpc:umsatz [d.m.Y H:i] (aktuell) – [Schlüssel-Namen] willuhn
@@ Zeile 1: / Zeile 1: @@
-====== XML-RPC: Konten ======
+====== XML-RPC: Umsätze ======
   * Name des Service: **hibiscus.xmlrpc.umsatz**
-===== Schüssel-Namen =====
+===== Schlüssel-Namen =====
 ^ Bezeichnung      ^ Beschreibung                                          ^
+| id               | ID des Umsatzes (eindeutig auch konto-übergreifend)   |
 | konto_id         | ID des Kontos, dem der Umsatz zugeordnet ist          |
 | empfaenger_name  | Inhaber-Name des Gegenkontos                          |
@@ Zeile 11: / Zeile 12: @@
 | empfaenger_blz   | Bankleitzahl des Gegenkontos                          |
 | art              | Buchungsart                                           |
-| betrag           | Betrag im Format "0,00"                               |
+| 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, alle Zeilen in einem String         |
+| zweck            | Verwendungszweck, bereinigt um SEPA-Tags. Er enthält also keine EREF-,KREF,...-Tags |
-| saldo            | Saldo des Kontos zu diesem Zeitpunkt im Format "0,00" |
+| 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                                        |
@@ Zeile 27: / Zeile 29: @@
 ==== Liste der Umsätze ermitteln ====
-| **deprecated** Diese Funktion existiert aus Gründen der Abwärtskompatibilität weiterhin. \\ Verwende künftig jedoch bitte die andere Funktion **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;
+public List<Map<String,Object>> list(HashMap<String,Object> options) throws RemoteException;
 </code>
   * Name der Funktion: **list**
   * Liste der Parameter
-    - **String** Suchbegriff (darf leer sein)
+    - **struct** Struct mit Suchkriterien. Folgende Schlüssel können im Struct verwendet werden:
-    - **String** Start-Datum im Format "dd.mm.yyyy" oder "yyyy-mm-dd" (darf leer sein)
+      * **konto_id** ID des Kontos, dem der Umsatz zugeordnet ist
-    - **String** End-Datum im Format "dd.mm.yyyy" oder "yyyy-mm-dd" (darf leer sein)
+      * **art** Buchungsart
-  * 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>
+      * **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
@@ Zeile 47: / Zeile 69: @@
 <code java>
-Object[] list = (Object[]) client.execute("hibiscus.xmlrpc.umsatz.list",new String[]{"","01.01.2010","31.12.2011"});
+import java.util.Map;
-for (Object o:list)
+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);
@@ Zeile 58: / Zeile 88: @@
 <code php>
-$msg = new xmlrpcmsg("hibiscus.xmlrpc.umsatz.list",array(new xmlrpcval("","string"),
+$params = new xmlrpcval(
-                                                         new xmlrpcval("01.01.2010","string"),
+  array(
-                                                         new xmlrpcval("31.12.2011","string")));
+    "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++)
 {
-  print($value->arrayMem($i)->scalarVal()."\n");
+  $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. |
-==== Liste der Umsätze ermitteln ====
 <code java>
-public List<Map<String,Object>> list(HashMap<String,Object> options) throws RemoteException;
+public String[] list(String text, String von, String bis) throws RemoteException;
 </code>
   * Name der Funktion: **list**
   * Liste der Parameter
-    - **struct** Struct mit Suchkriterien. Folgende Schlüssel können im Struct verwendet werden:
+    - **String** Suchbegriff (darf leer sein)
-      * **konto_id** ID des Kontos, dem der Umsatz zugeordnet ist
+    - **String** Start-Datum im Format "dd.mm.yyyy" oder "yyyy-mm-dd" (darf leer sein)
-      * **art** Buchungsart
+    - **String** End-Datum im Format "dd.mm.yyyy" oder "yyyy-mm-dd" (darf leer sein)
-      * **empfaenger_name** Inhaber-Name des Gegenkontos
+  * 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>
-      * **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
@@ Zeile 115: / Zeile 135: @@
 <code java>
-Object[] list = (Object[]) client.execute("hibiscus.xmlrpc.umsatz.list",TODO);
+Object[] list = (Object[]) client.execute("hibiscus.xmlrpc.umsatz.list",new String[]{"","01.01.2010","31.12.2011"});
 for (Object o:list)
 {
@@ Zeile 126: / Zeile 146: @@
 <code php>
-$msg = new xmlrpcmsg("hibiscus.xmlrpc.umsatz.list",array(TODO);
+$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();
@@ Zeile 135: / Zeile 157: @@
 }
 </code>

Impressum | Datenschutz