Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

Link zu dieser Vergleichsansicht

Beide Seiten der vorigen Revision Vorhergehende Überarbeitung
webservices:soap_webservices:payments [2019/06/17 16:09]
andre [crmAddPaymentToInvoice]
webservices:soap_webservices:payments [2020/05/06 14:11] (aktuell)
d0dge
Zeile 1: Zeile 1:
 ====== Payments ====== ====== Payments ======
-<WRAP important>​Diese Seite enthält noch nicht alle Informationen bzw. befindet sich aktuell in der Überarbeitung</​WRAP>​ 
- 
- 
-===== WSDL-URI ====== 
- 
- 
-<​code>​http://​hostname/​dirname/​soap/​index.php?​op=payments&​wsdl</​code>​ 
- 
-z.B. [[https://​test.tecart-system.de/​soap/​index.php?​op=payments&​wsdl|https://​test.tecart-system.de/​soap/​index.php?​op=payments&​wsdl]] 
- 
- 
-===== Methods ====== 
- 
- 
- 
-==== crmAddPaymentToInvoice ===== 
- 
- 
-(Version >= 4.1)  
- 
-**Syntax**: 
-  int crmAddPaymentToInvoice($session_id,​ $crmPaymentItem) 
- 
-**Beschreibung**:​ 
- 
-Erzeugt eine neue Zahlung zu einer Rechnung. Gibt im Erfolgsfall die ID des Datensatzes zurück. 
- 
- 
-Im Falle eines Fehlers wird eine CRMException mit mehr Fehlerdetails geworfen. 
- 
- 
-//​crmPaymentItem//​ ist ein assoziatives Array. 
- 
- 
-**Eigenschaften**:​ 
-  ​ 
-  Type(Length) ​     Eigenschaft ​         Beschreibung 
-  ------------------------------------------------------------------- 
-  int   $cid Kontakt-ID 
-  int   $client_account_id Rechnungskonto-ID 
-  string ​           $realnumber ​          ​Belegnummer 
-  string ​           $src                  Belegart des Rechnungsvorganges (invoice, admonition, voucher, purchase) 
-  string ​           $realnumber_activity ​ Belegnummer des Rechnungsvorganges 
-  double ​           $amount ​              ​Umsatz 
-  string ​           $account_in ​          ​Gegenkonto 
-  string ​           $account_out ​         Buchungskonto 
-  int   $date Datum als Unix-Zeitstempel 
-  string  ​ $text Buchungstext 
-  string  ​ $reference_text_1 Referenztext 1 
-  string  ​ $reference_text_2 Referenztext 2 
-  string ​           $notes ​               Notizen 
-  int               ​$ext_id ​              ​Externe ID ( ab Version 4.2 ) 
-  ​ 
-  string ​       $user12 ​              ​Benutzerdefiniertes Feld Nr. 12 
-  string ​           $user13 ​              ​Benutzerdefiniertes Feld Nr. 13 
-     : ​                : ​                           : 
-  string ​           $user80 ​              ​Benutzerdefiniertes Feld Nr. 80  
- 
- 
-**Beispiel**:​ 
-<sxh php> 
- 
-<?php 
- 
-ini_set("​soap.wsdl_cache_enabled",​ "​0"​);​ 
- 
-try { 
-  $client_logon = new SOAPClient("​https://​test.tecart-system.de/​soap/​index.php?​op=logon&​wsdl"​);​ 
-     ​$session_id = $client_logon->​crmLogin('​test',​ '​test'​);​ 
-     if (!$session_id) die("​invalid login"​);​ 
-  ​ 
-     ​$client_payments = new SOAPClient("​https://​test.tecart-system.de/​soap/​index.php?​op=payments&​wsdl"​);​ 
-  ​ 
-     $data = array( 
-       '​notes'​ =>​ '​API-Test',​ 
-       '​client_account_id'​ =>​ 1, 
-       '​amount'​ =>​ 200, 
-       '​realnumber_activity'​ =>​ '​ABC123',​ 
-       '​reference_text_1'​ =>​ '​Rechnung API-Test 1', 
-       '​reference_text_2'​ =>​ '​Rechnung API-Test 1' 
-     ); 
-  ​ 
-     ​$payment_id = $client_payments->​crmAddPaymentToInvoice($session_id,​ $data); 
- 
-   echo $payment_id;​ 
-} 
-catch (SOAPFault $f) { 
-  print $f->​faultstring;​ 
-} 
- 
-?> 
- 
-</​sxh>​ 
- 
----- 
- 
- 
-==== crmGetPayment ===== 
- 
- 
-(Version >= 4.1)  
- 
-**Syntax**: 
-  array crmGetPayment($session_id,​ array $payment_id) 
- 
-**Beschreibung**:​ 
- 
-Gibt die Zahlung mit der angegebenen ID als array zurück. 
- 
- 
-Im Falle eines Fehlers wird eine CRMException mit mehr Fehlerdetails geworfen. 
- 
- 
-**Eigenschaften des zurückgegebenen Array** 
-  ​ 
-  Type(Length) ​     Eigenschaft ​         Beschreibung 
-  ------------------------------------------------------------------- 
-  int               ​$id ​                  ID des Datensatzes 
-  int               ​$ext_id ​              ​Externe ID ( ab Version 4.2 ) 
-  int   $cid Kontakt-ID 
-  int   $client_account_id Rechnungskonto-ID 
-  string ​           $realnumber ​          ​Belegnummer 
-  string ​           $realnumber_activity ​ Belegnummer-ID 
-  double ​           $amount ​              ​Umsatz 
-  string ​           $account_in ​          ​Gegenkonto 
-  string ​           $account_out ​         Buchungskonto 
-  int   $date Datum als Unit-Zeitstempel 
-  string  ​ $text Buchungstext 
-  string  ​ $reference_text_1 Referenztext 1 
-  string  ​ $reference_text_2 Referenztext 2 
-  string ​           $notes ​               Notizen 
-  ​ 
-  string ​       $user12 ​              ​Benutzerdefiniertes Feld Nr. 12 
-  string ​           $user13 ​              ​Benutzerdefiniertes Feld Nr. 13 
-     : ​                : ​                           : 
-  string ​           $user80 ​              ​Benutzerdefiniertes Feld Nr. 80  
- 
- 
-**Beispiel**:​ 
-<sxh php> 
- 
-<?php 
- 
-try {    ​ 
-  $result = $client_payments->​crmGetPayment($session_id,​ $payment_id);​ 
-} 
-catch (SOAPFault $f) { 
-  print $f->​faultstring;​ 
-} 
- 
-foreach($result as $key => $val) { 
-  echo "$key => $val<​br> ​ \n"; 
-} 
-echo "<​hr/>";​ 
-?> 
- 
-</​sxh>​ 
- 
----- 
- 
- 
-==== crmChangePayment ===== 
- 
- 
-(Version >= 4.1)  
- 
-**Syntax**: 
-  int crmChangePayment($session_id,​ $crmPaymentItem) 
- 
-**Beschreibung**:​ 
- 
-Gibt bei Erfolg "​1"​ zurück. 
- 
- 
-Im Falle eines Fehlers wird eine CRMException mit mehr Fehlerdetails geworfen. 
- 
- 
-//​crmPaymentItem//​ ist ein assoziatives Array. 
- 
- 
-**Eigenschaften**:​ 
-sind die selben wie für **[[#​crmAddPaymentToInvoice]]** 
- 
-**Beispiel**:​ 
-<sxh php> 
- 
-<?php 
- 
-try { 
-  $data = array('​posting_account_in'​=>'​100002','​posting_account_out'​=>'​100003'​);​ 
-     $res = $client_payments->​crmChangePayment($session_id,​ $data); 
- 
-   echo $res; 
-} 
-catch (SOAPFault $f) { 
-  print $f->​faultstring;​ 
-} 
- 
-?> 
- 
-</​sxh>​ 
- 
----- 
- 
- 
-==== crmSearchPayments ===== 
- 
- 
-(Version >= 4.1) 
- 
-**Syntax**: 
-  array crmSearchPayments($session_id,​ array $crmSearchPaymentsParams) 
- 
-**Beschreibung**:​ 
- 
-Sucht nach Zahlungen anhand der übergebenen Suchparameter. Gibt bei Erfolg ein Array mit Zahlungen zurück. 
- 
- 
-Im Falle eines Fehlers wird eine CRMException mit mehr Fehlerdetails geworfen. 
- 
- 
-//​search_params//​ kann ein assoziatives Array oder ein Objekt sein. 
- 
- 
-**Eigenschaften**:​ 
-  ​ 
-  Type(Length) ​     Eigenschaft ​         Beschreibung 
-  ------------------------------------------------------------------- 
-  string ​           $search Suchbegriff 
-  string  ​ $realnumber_activity Belegnummer-ID 
-  int   $client_account_id Rechungskonto 
-  int   $id nach ID $id suchen 
-  int   $id_from alle Zahlungen ab ID $id_from suchen 
-  int   $count maximale Anzahl an Elementen, die zurückgegeben wird 
-  int   $offset Position der Ergebnisse, ab der zurückgegeben werden soll 
-  bool  ​ $sorting Einstellung,​ ob Elemente sortiert zurückgegeben werden 
- 
- 
-**Eigenschaften des zurückgegebenen Array** 
-  ​ 
-  Type(Length) ​     Eigenschaft ​         Beschreibung 
-  ------------------------------------------------------------------- 
-  int   $id ID des Datensatzes 
-  int   $cid Kontakt-ID 
-  int   $client_account_id Rechnungskonto-ID 
-  string  ​ $realnumber Belegnummer 
-  string  ​ $realnumber_activity Belegnummer-ID 
-  double  ​ $amount Umsatz 
-  int   $date Datum als Unit-Zeitstempel 
-  string  ​ $text Buchungstext 
-  string  ​ $reference_text_1 Referenztext 1 
-  string  ​ $reference_text_2 Referenztext 2 
- 
- 
-**Beispiel**:​ 
-<sxh php> 
- 
-<?php 
- 
-try {    ​ 
-  $crmSearchPaymentsParams = array('​search'​ =>​ "​reference_text_1 LIKE '​%Rechnung API-Test 1%'"​);​ 
-     ​$results = $client_payments->​crmSearchPayments($session_id,​ $crmSearchPaymentsParams);​ 
-} 
-catch (SOAPFault $f) { 
-  print $f->​faultstring;​ 
-} 
- 
-foreach($results as $result) { 
-  foreach($result as $key => $val) { 
- echo "$key => $val<​br>​\n";​ 
-  } 
-} 
-echo "<​hr/>";​ 
-?> 
- 
-</​sxh>​ 
- 
-------- 
- 
- 
-==== crmgetIdByExtId ===== 
- 
- 
-(Version >= 4.2) 
- 
-**Syntax:** 
- 
- array crmgetIdByExtId( string $session_id,​ string $external_id )  ​ 
- 
-**Beschreibung** 
- 
-Liefert interne ID(s) von Zahlungen mit der übergebenen externen ID zurück. 
- 
- 
-**Eigenschaften der zurückgegebenen ****//​payment Objekte//​**:​ 
-  ​ 
-  Type(Length) ​           Eigenschaft ​                 Beschreibung 
-  --------------------------------------------------------------------------------------------- 
-  int $id  ​     Payment-Id ​ 
- 
- 
-**Beispiel:​** 
-<sxh php> 
- 
-<?php 
- 
-try { 
-  $result = $client_payments->​crmgetIdByExtId($session_id,​ 12345); 
-} 
-catch (SOAPFault $f) { 
-  print $f->​faultstring;​ 
-} 
- 
-foreach($result as $id) { 
-  ​ 
-     echo $id."<​br> ​ "; 
-} 
- 
-?> 
- 
-</​sxh>​ 
- 
-------- 
- 
- 
-==== crmgetAllExtIds ===== 
- 
- 
-(Version >= 4.2) 
- 
-**Syntax:** 
- 
- array crmgetAllExtIds( string $session_id )  ​ 
- 
-**Beschreibung** 
- 
-Liefert eine Liste aller externen IDs in Zahlungen zurück. 
- 
- 
-**Eigenschaften der zurückgegebenen ****//​payment Objekte//​**:​ 
-  ​ 
-  Type(Length) ​           Eigenschaft ​                 Beschreibung 
-  --------------------------------------------------------------------------------------------- 
-  int $id  ​     externe Payment-Id ​ 
- 
- 
-**Beispiel:​** 
-<sxh php> 
- 
-<?php 
- 
-try {  
-  $result = $client_payments->​crmgetAllExtIds($session_id);​ 
-} 
-catch (SOAPFault $f) { 
-  print $f->​faultstring;​ 
-} 
- 
-foreach($result as $id) { 
-  ​ 
-     echo $id."<​br> ​ "; 
-} 
- 
-?> 
- 
-</​sxh>​ 
- 
-------- 
  
 +Bitte besuchen Sie unsere neue Entwickler-Dokumentation unter [[https://​docs.tecart.de/​display/​public/​WIKI/​Payments+SOAP]]