Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

Link zu dieser Vergleichsansicht

Beide Seiten der vorigen Revision Vorhergehende Überarbeitung
webservices:soap_webservices:vouchers [2017/02/07 17:03]
127.0.0.1 Externe Bearbeitung
webservices:soap_webservices:vouchers [2020/05/06 14:13] (aktuell)
d0dge
Zeile 1: Zeile 1:
 ====== Vouchers ====== ====== Vouchers ======
-<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=vouchers&​wsdl</​code>​ 
- 
-z.B. [[https://​test.tecart-system.de/​soap/​index.php?​op=vouchers&​wsdl|https://​test.tecart-system.de/​soap/​index.php?​op=vouchers&​wsdl]] 
- 
- 
-===== Methods ====== 
- 
- 
- 
-==== crmAddVoucher ===== 
- 
- 
-(Version >= 4.1.10682) ​ 
- 
-**Syntax**: 
-  int crmAddVoucher($session_id,​ $crmVoucherItem) 
- 
-**Beschreibung**:​ 
- 
-Erzeugt eine neue Gutschrift. Gibt im Erfolgsfall die ID des Datensatzes zurück. 
- 
- 
-Im Falle eines Fehlers wird eine CRMException mit mehr Fehlerdetails geworfen. 
- 
- 
-//​crmVoucherItem//​ kann ein assoziatives Array oder ein Objekt sein. 
- 
- 
-**Eigenschaften**:​ 
-  ​ 
-  Type(Length) ​     Eigenschaft ​         Beschreibung 
-  ------------------------------------------------------------------- 
-  int   $cid Kontakt-ID 
-  int   $client_account_id Rechnungskonto-ID 
-  string  ​ $realnumber Belegnummer 
-  int   $date Datum als Unit-Timestamp 
-  int   $printed Druckdatum als Unit-Timestamp 
-  string  ​ $text Text 
-  string  ​ $notes Notizen 
-  int   $accounted entfallen 
-  string  ​ $ust_id Ust-ID 
-  string  ​ $name Name 
-  int   $invoice_id Rechnungs-ID 
-  int   $payment_target Zahlungsziel 
-  int   $payment_appointed Zahlungsstichtag 
-  double  ​ $total_netto Gesamt - netto 
-  double  ​ $tax_value USt-Betrag 
-  double  ​ $total_brutto Gesamt - brutto 
-  double  ​ $ops_value Betrag offener Posten 
-  double  ​ $payed Betrag gezahlt 
-  int   $is_payed Bezahlt-Datum als Unit-Timestamp 
-  int   $flow_status Status 
-  string  ​ $fees Gebühren 
-  string  ​ $billing_postcode Rechnung:​ PLZ 
-  string  ​ $billing_city Rechnung:​ Ort 
-  string  ​ $billing_name_1 Rechnung:​ Name 1 
-  string  ​ $billing_name_2 Rechnung:​ Name 2 
-  string  ​ $billing_name_3 Rechnung:​ Name 3 
-  string  ​ $billing_address_1 Rechnung:​ Adresse 1 
-  string  ​ $billing_address_2 Rechnung:​ Adresse 2 
-  int               ​$ext_id ​              ​Externe ID ( ab Version 4.2 ) 
-  ​ 
-  string  ​ $user29 Benutzerdefiniertes Feld Nr. 29 
-  string  ​ $user30 Benutzerdefiniertes Feld Nr. 30 
-     : ​                : ​                           : 
-  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"​);​ 
- 
-   $data = array( 
-     '​name'​ =>​ '​API-Test Voucher',​ 
-     '​date'​ =>​ time(), 
-     '​cid'​ =>​ 1, 
-     '​client_account_id'​ =>​ 1, 
-     '​flow_status'​ =>​ 0, 
-     '​total_netto'​ =>​ 100.0, 
-     '​total_brutto'​ =>​ 119.0, 
-     '​tax_value'​ =>​ 19.0, 
-   ); 
- 
-   ​$client_vouchers = new SOAPClient("​https://​test.tecart-system.de/​soap/​index.php?​op=vouchers&​wsdl"​);​ 
-   ​$voucher_id = $client_vouchers->​crmAddVoucher($session_id,​ $data); 
- 
-   echo $voucher_id;​ 
- 
-} 
-catch (SOAPFault $f) { 
-  print $f->​faultstring;​ 
-} 
- 
-?> 
- 
-</​sxh>​ 
- 
----- 
- 
- 
-==== crmGetVoucher ===== 
- 
- 
-(Version >= 4.1.10793) ​ 
- 
-**Syntax**: 
-  array crmGetVoucher($session_id,​ , $voucher_id,​ $format = false) 
- 
-**Beschreibung**:​ 
- 
-Gibt die Gutschrift mit der übergebenen ID zurück. Über den Parameter //format// können die Daten schon aufbereitet zurückgegeben werden. 
- 
- 
-Im Falle eines Fehlers wird eine CRMException mit mehr Fehlerdetails geworfen. 
- 
- 
-**Eigenschaften des zurückgegeben Array:**: 
-  ​ 
-  Type(Length)  ​ Eigenschaft Beschreibung 
-  ------------------------------------------------------------------- 
-  int   $id Gutschrift-ID 
-  int               ​$ext_id ​                              ​Externe ID ( ab Version 4.2 ) 
-  int   $cid Kontakt-ID 
-  int   $client_account_id Rechnungskonto-ID 
-  string  ​ $realnumber Belegnummer 
-  int   $date Datum als Unit-Timestamp 
-  int   $printed Druckdatum als Unit-Timestamp 
-  string  ​ $text Text 
-  string  ​ $notes Notizen 
-  int   $accounted entfallen 
-  string  ​ $ust_id Ust-ID 
-  string  ​ $name Name 
-  int   $invoice_id Rechnungs-ID 
-  int   $payment_target Zahlungsziel 
-  int   $payment_appointed Zahlungsstichtag 
-  double  ​ $total_netto Gesamt - netto 
-  double  ​ $tax_value USt-Betrag 
-  double  ​ $total_brutto Gesamt - brutto 
-  double  ​ $ops_value Betrag offener Posten 
-  double  ​ $payed Betrag gezahlt 
-  int   $is_payed Bezahlt-Datum als Unit-Timestamp 
-  int   $flow_status Status 
-  string  ​ $fees Gebühren 
-  string  ​ $billing_postcode Rechnung:​ PLZ 
-  string  ​ $billing_city Rechnung:​ Ort 
-  string  ​ $billing_name_1 Rechnung:​ Name 1 
-  string  ​ $billing_name_2 Rechnung:​ Name 2 
-  string  ​ $billing_name_3 Rechnung:​ Name 3 
-  string  ​ $billing_address_1 Rechnung:​ Adresse 1 
-  string  ​ $billing_address_2 Rechnung:​ Adresse 2 
-  array  ​ $crmOriginalContactElements Original-Daten des Kontaktes 
-  array  ​ $crmOriginalClientAccountElements Original-Daten des Rechnungskontos 
-  int   $createuser Benutzer-ID,​ der Buchung erzeugt hat 
-  int   $createtime Zeitstempel,​ an dem Buchung erzeugt wurde 
-  int   $chguser Benutzer-ID,​ der Buchung zuletzt geändert hat 
-  int   $chgtime Zeitstempel,​ an dem zuletzt geändert wurde 
-  ​ 
-  string  ​ $user29 Benutzerdefiniertes Feld Nr. 29 
-  string  ​ $user30 Benutzerdefiniertes Feld Nr. 30 
-     : ​                :​  ​ : 
-  string  ​ $user80 Benutzerdefiniertes Feld Nr. 80  
- 
- 
-**Beispiel**:​ 
-<sxh php> 
- 
-<?php 
- 
-try { 
-  $result = $client_vouchers->​crmGetVoucher($session_id,​ $voucher_id);​ 
- 
-   ​foreach($result as $key => $val) { 
- echo "$key => $val<​br>​\n";​ 
-  } 
-     echo "<​hr/>";​ 
- 
-} 
-catch (SOAPFault $f) { 
-  print $f->​faultstring;​ 
-} 
- 
-?> 
- 
-</​sxh>​ 
- 
----- 
- 
- 
-==== crmDeleteVoucher ===== 
- 
- 
-(Version >= 4.1.10682) ​ 
- 
-**Syntax**: 
-  array crmDeleteVoucher($session_id,​ $voucher_id) 
- 
-**Beschreibung**:​ 
- 
-Löscht die Gutschrift mit der übergebenen ID. Gibt im Erfolgsfall 1 zurück. 
- 
- 
-Im Falle eines Fehlers wird eine CRMException mit mehr Fehlerdetails geworfen. 
- 
- 
-**Beispiel**:​ 
-<sxh php> 
- 
-<?php 
- 
-try { 
-  $result = $client_vouchers->​crmDeleteVoucher($session_id,​ $voucher_id);​ 
- 
-   echo $result; 
- 
-} 
-catch (SOAPFault $f) { 
-  print $f->​faultstring;​ 
-} 
- 
-?> 
- 
-</​sxh>​ 
- 
----- 
- 
- 
-==== crmChangeVoucher ===== 
- 
- 
-(Version >= 4.1.10682) ​ 
- 
-**Syntax**: 
-  array crmChangeVoucher($session_id,​ $voucher_id,​ $crmVoucherItem) 
- 
-**Beschreibung**:​ 
- 
-Ändert die Gutschrift mit der übergebenen ID zurück. Gibt im Erfolgsfall die ID der Gutschrift zurück. 
- 
- 
-Im Falle eines Fehlers wird eine CRMException mit mehr Fehlerdetails geworfen. 
- 
- 
-//​crmVoucherItem//​ kann ein assoziatives Array oder ein Objekt sein. 
- 
- 
-**Eigenschaften:​**:​ 
- 
-Eigenschaften:​ sind die selben wie für [[#​crmAddVoucher]] 
- 
- 
-**Beispiel**:​ 
-<sxh php> 
- 
-<?php 
- 
-try { 
-  $data = array('​name'​=>​ '​API-Test Voucher with new name'​);​ 
-     ​$result = $client_vouchers->​crmChangeVoucher($session_id,​ $voucher_id,​ $data); 
-  ​ 
-     echo $result; 
- 
-} 
-catch (SOAPFault $f) { 
-  print $f->​faultstring;​ 
-} 
- 
-?> 
- 
-</​sxh>​ 
- 
----- 
- 
- 
-==== crmSearchVouchers ===== 
- 
- 
-(Version >= 4.1.10682) ​ 
- 
-**Syntax**: 
-  array crmSearchVouchers($session_id,​ $crmsearchVouchersParams) 
- 
-**Beschreibung**:​ 
- 
-Sucht anhand der übergebenen Parameter nach Gutschriften. Gibt im Erfolgsfall ein Array mit Gutschriften zurück. 
- 
- 
-Im Falle eines Fehlers wird eine CRMException mit mehr Fehlerdetails geworfen. 
- 
- 
-//​crmsearchVouchersParams//​ kann ein assoziatives Array oder ein Objekt sein. 
- 
- 
-**Eigenschaften von ****//​crmsearchVouchersParams//​**:​ 
-  ​ 
-  Type(Length) ​     Eigenschaft ​         Beschreibung 
-  ------------------------------------------------------------------- 
-  string  ​ $search Suchbegriff 
-  string  ​ $client_account_id Rechnungskonto-ID 
-  string  ​ $is_payed ist Gutschrift bezahlt 
-  int   $status Status 
-  int   $changed_since Äerungsdatum seit 
-  int   $changed_until Äerungsdatum bis 
-  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 
-  bool  ​ $count_only Element suchen und nur zählen 
- 
- 
-**Beispiel**:​ 
-<sxh php> 
- 
-<?php 
- 
-try { 
-  $sparams = array ( 
-       '​search'​ => "name LIKE '​%API-Test Voucher%'",​ 
-       '​client_account_id'​ => 1 
-     ); 
-     ​$vouchers = $client_vouchers->​crmSearchVouchers($session_id,​ $sparams); 
-  ​ 
-     ​foreach($vouchers as $voucher) { 
- foreach($voucher as $key => $val) { 
-     echo "$key => $val<​br>​\n";​ 
- } 
- echo "<​hr/>"; ​   ​ 
-  } 
-} 
-catch (SOAPFault $f) { 
-  print $f->​faultstring;​ 
-} 
- 
-?> 
- 
-</​sxh>​ 
- 
----- 
- 
- 
-==== crmGotoNextFlowStatus ===== 
- 
- 
-(Version >= 4.1.10678) ​ 
- 
-**Syntax**: 
-  void crmGotoNextFlowStatus($session_id,​ $voucher_id) 
- 
-**Beschreibung**:​ 
- 
-Setzt den Status der Gutschrift auf die nächste Stufe. 
- 
- 
-Im Falle eines Fehlers wird eine CRMException mit mehr Fehlerdetails geworfen. 
- 
- 
-**Beispiel**:​ 
-<sxh php> 
- 
-<?php 
- 
-try { 
-  $client_vouchers->​crmGotoNextFlowStatus($session_id,​ $voucher_id);​ 
-} 
-catch (SOAPFault $f) { 
-  print $f->​faultstring;​ 
-} 
- 
-?> 
- 
-</​sxh>​ 
- 
----- 
- 
- 
-==== crmFromInvoice ===== 
- 
- 
-(Version >= 4.1.10682) ​ 
- 
-**Syntax**: 
-  array crmFromInvoice($session_id,​ $invoice_id,​ $item_ids = false) 
- 
-**Beschreibung**:​ 
- 
-Erzeugt eine Gutschrift aus einer Rechnung. Gibt im Erfolgsfall die ID der erzeugten Gutschrift zurück.. 
- 
- 
-Im Falle eines Fehlers wird eine CRMException mit mehr Fehlerdetails geworfen. 
- 
- 
-//​item_ids//​ ist eine Doppelpunkt getrennte Liste von Artikel-IDs. 
- 
- 
-**Beispiel**:​ 
-<sxh php> 
- 
-<?php 
- 
-try { 
-  $result = $client_vouchers->​crmFromInvoice($session_id,​ $invoice_id,​ '​1:​2:​3'​);​ 
-  ​ 
-     echo $result; 
-} 
-catch (SOAPFault $f) { 
-  print $f->​faultstring;​ 
-} 
- 
-?> 
- 
-</​sxh>​ 
- 
----- 
- 
- 
-==== crmGetFlowStatus ===== 
- 
- 
-(Version >= 4.1.10678) ​ 
- 
-**Syntax**: 
-  int crmGetFlowStatus($session_id,​ $voucher_id) 
- 
-**Beschreibung**:​ 
- 
-Holt den aktuellen Status der Gutschrift. 
- 
- 
-Im Falle eines Fehlers wird eine CRMException mit mehr Fehlerdetails geworfen. 
- 
- 
-**Beispiel**:​ 
-<sxh php> 
- 
-<?php 
- 
-try { 
-  $status = $client_vouchers->​crmGetFlowStatus($session_id,​ $voucher_id);​ 
-  ​ 
-     echo $status; 
-} 
-catch (SOAPFault $f) { 
-  print $f->​faultstring;​ 
-} 
- 
-?> 
- 
-</​sxh>​ 
- 
----- 
- 
- 
-==== crmGetDocument ===== 
- 
- 
-(Version >= 4.1.10678) ​ 
- 
-**Syntax**: 
-  array crmGetDocument($session_id,​ $voucher_id) 
- 
-**Beschreibung**:​ 
- 
-Holt das zur Gutschrift gehörige Dokument aus dem CRM. Gibt ein Array zurück. 
- 
- 
-Im Falle eines Fehlers wird eine CRMException mit mehr Fehlerdetails geworfen. 
- 
- 
-**Eigenschaften des zurückgegebenen Array** 
-  ​ 
-  Type(Length) ​     Eigenschaft ​         Beschreibung 
-  ------------------------------------------------------------------- 
-  string  ​ $filename Dateiname des Dokumentes 
-  string  ​ $content base64-codierte Inhalt der Datei 
- 
- 
-**Beispiel**:​ 
-<sxh php> 
- 
-<?php 
- 
-try { 
-  $document = $client_vouchers->​crmGetDocument($session_id,​ $voucher_id);​ 
-  ​ 
-     echo "";​ 
-      var_dump($document);​ 
-      echo "";​ 
-} 
-catch (SOAPFault $f) { 
-  print $f->​faultstring;​ 
-} 
- 
-?> 
- 
-</​sxh>​ 
- 
----- 
- 
- 
-==== crmGetArticles ===== 
- 
- 
-(Version >= 4.1.10678) ​ 
- 
-**Syntax**: 
-  array crmGetArticles($session_id,​ $voucher_id) 
- 
-**Beschreibung**:​ 
- 
-Führt Gutschrift zu Inkasso-Vorgang über. Im Erfolgsfall wird die ID zurückgegeben 
- 
- 
-Im Falle eines Fehlers wird eine CRMException mit mehr Fehlerdetails geworfen. 
- 
- 
-**Beispiel**:​ 
-<sxh php> 
- 
-<?php 
- 
-try { 
-  $articles = $client_vouchers->​crmGetArticles($session_id,​ $voucher_id);​ 
-  ​ 
-     ​foreach($articles as $article) { 
-       ​foreach($article as $key => $val) { 
- echo "$key => $val<​br>​\n";​ 
-  } 
-     } 
-     echo "<​hr/>";​ 
- 
-} 
-catch (SOAPFault $f) { 
-  print $f->​faultstring;​ 
-} 
- 
-?> 
- 
-</​sxh>​ 
- 
----- 
- 
- 
-==== crmAddArticleToList ===== 
- 
- 
-(Version >= 4.1.10678) ​ 
- 
-**Syntax**: 
-  array crmAddArticleToList($session_id,​ $voucher_id,​ $article_id) 
- 
-**Beschreibung**:​ 
- 
-Fügt den Artikel mit der übergebenen ID zu einer Gutschrift hinzu. Im Erfolgsfall wird 1 zurückgegeben. 
- 
- 
-Im Falle eines Fehlers wird eine CRMException mit mehr Fehlerdetails geworfen. 
- 
- 
-**Beispiel**:​ 
-<sxh php> 
- 
-<?php 
- 
-try { 
-  $success = $client_vouchers->​crmAddArticleToList($session_id,​ $voucher_id,​ 10);    ​ 
-     echo $success; 
- 
-} 
-catch (SOAPFault $f) { 
-  print $f->​faultstring;​ 
-} 
- 
-?> 
- 
-</​sxh>​ 
- 
----- 
- 
- 
-==== crmAddTextToList ===== 
- 
- 
-(Version >= 4.1.10678) ​ 
- 
-**Syntax**: 
-  array crmAddTextToList($session_id,​ $voucher_id,​ $text) 
- 
-**Beschreibung**:​ 
- 
-Fügt einen Artikel-Text zu einer Gutschrift hinzu. Im Erfolgsfall wird 1 zurückgegeben. 
- 
- 
-Im Falle eines Fehlers wird eine CRMException mit mehr Fehlerdetails geworfen. 
- 
- 
-**Beispiel**:​ 
-<sxh php> 
- 
-<?php 
- 
-try { 
-  $success = $client_vouchers->​crmAddTextToList($session_id,​ $voucher_id,​ 'Das ist ein Text'​);​ 
-     echo $success; 
- 
-} 
-catch (SOAPFault $f) { 
-  print $f->​faultstring;​ 
-} 
- 
-?> 
- 
-</​sxh>​ 
- 
----- 
- 
- 
-==== crmAddSpecialToList ===== 
- 
- 
-(Version >= 4.1.10678) ​ 
- 
-**Syntax**: 
-  array crmAddSpecialToList($session_id,​ $voucher_id,​ $crmBillingItem) 
- 
-**Beschreibung**:​ 
- 
-Fügt einen Sonderartikel zu einer Gutschrift hinzu. Im Erfolgsfall wird 1 zurückgegeben. 
- 
- 
-Im Falle eines Fehlers wird eine CRMException mit mehr Fehlerdetails geworfen. 
- 
- 
-//​crmBillingItem//​ kann ein assoziatives Array oder ein Objekt sein. 
- 
- 
-**Eigenschaften**:​ 
-  ​ 
-  Typ             ​Eigenschaft ​                         Beschreibung 
-  --------------------------------------------------------------------------------------------- 
-  int             ​$quantity ​                           Menge 
-  string ​         $realnumber ​                         Artikelnummer 
-  string ​         $name                                Bezeichnung 
-  int             ​$taxrate ​                            ​Steuersatz-Index 
-  double ​         $discount ​                           Rabatt 
-  int             ​$interval ​                           Abrechnungszeitraum-Index 
-  string ​         $description ​                        ​Beschreibung 
-  int             ​$ext_id ​                             Externe ID ( ab Version 4.2 ) 
- 
- 
-**Beispiel**:​ 
-<sxh php> 
- 
-<?php 
- 
-try { 
-  $data = array( 
-       '​quantity'​ =>​ 10, 
-       '​realnumber'​ =>​ '​100001',​ 
-       '​name'​ =>​ 'API Special Article',​ 
-       '​description'​ =>​ 'API Special Article',​ 
-       '​taxrate'​ =>​ 19, 
-       '​discount'​ =>​ 100, 
-       '​interval'​ =>​ 1 
-     ); 
- 
-   ​$success = $client_vouchers->​crmAddSpecialToList($session_id,​ $voucher_id,​ $data); 
-   echo $success; 
- 
-} 
-catch (SOAPFault $f) { 
-  print $f->​faultstring;​ 
-} 
- 
-?> 
- 
-</​sxh>​ 
- 
----- 
- 
- 
-==== crmAddGrouplineToList ===== 
- 
- 
-(Version >= 4.1.10678) ​ 
- 
-**Syntax**: 
-  array crmAddGrouplineToList($session_id,​ $voucher_id,​ $crmBillingItem) 
- 
-**Beschreibung**:​ 
- 
-Fügt eine Gruppenzeile zu einer Gutschrift hinzu. Im Erfolgsfall wird 1 zurückgegeben. 
- 
- 
-Im Falle eines Fehlers wird eine CRMException mit mehr Fehlerdetails geworfen. 
- 
- 
-//​crmBillingItem//​ kann ein assoziatives Array oder ein Objekt sein. 
- 
- 
-**Eigenschaften**:​ 
-  ​ 
-  Typ             ​Eigenschaft ​                         Beschreibung 
-  --------------------------------------------------------------------------------------------- 
-  int             ​$quantity ​                            Menge 
-  string ​         $name                                 ​Bezeichnung 
-  int             ​$taxrate ​                             Steuersatz-Index 
-  double ​         $discount ​                            ​Rabatt 
-  int             ​$interval ​                            ​Abrechnungszeitraum-Index 
-  string ​         $description ​                         Beschreibung 
-  int             ​$ext_id ​                             Externe ID ( ab Version 4.2 ) 
- 
- 
-**Beispiel**:​ 
-<sxh php> 
- 
-<?php 
- 
-try { 
-  $data = array( 
-       '​quantity'​ =>​ 3, 
-       '​name'​ =>​ 'API Groupline',​ 
-       '​description'​ =>​ 'API Groupline',​ 
-       '​taxrate'​ =>​ 19, 
-       '​discount'​ =>​ 100, 
-       '​interval'​ =>​ 1 
-     ); 
- 
-   ​$success = $client_vouchers->​crmAddGrouplineToList($session_id,​ $voucher_id,​ $data); 
-   echo $success; 
- 
-} 
-catch (SOAPFault $f) { 
-  print $f->​faultstring;​ 
-} 
- 
-?> 
- 
-</​sxh>​ 
- 
----- 
- 
- 
-==== crmAddMultipleToList ===== 
- 
- 
-(Version >= 4.1.10678) ​ 
- 
-**Syntax**: 
-  array crmAddMultipleToList($session_id,​ $voucher_id,​ $crmMultipleListItems) 
- 
-**Beschreibung**:​ 
- 
-Fügt der Artikelliste mehrere Artikel und Texte und Gruppenzeilen zu einer Gutschrift hinzu. Im Erfolgsfall wird 1 zurückgegeben. 
- 
- 
-Im Falle eines Fehlers wird eine CRMException mit mehr Fehlerdetails geworfen. 
- 
- 
-//​crmMultipleListItems//​ ist ein Array von Artikeln, die Eigenschaften sind die selben wie [[#​crmAddArticleToList]],​ [[#​crmAddTextToList]],​ [[#​crmAddSpecialToList]] und [[#​crmAddGrouplineToList]]. 
-Die Unterscheidung erfolgt über das Feld "​type"​. 
- 
- 
-**Eigenschaften**:​ 
-  ​ 
-  Typ             ​Eigenschaft ​                         Beschreibung 
-  --------------------------------------------------------------------------------------------- 
-  array           ​$crmMultipleListItems ​               Artikelliste 
- 
- 
-**Beispiel**:​ 
-<sxh php> 
- 
-<?php 
- 
-try { 
- 
-   ​$items = array(); 
- 
-   ​$items['​crmMultipleListItems'​][] = array('​type'​ => '​article',​ '​id'​ => 10); 
-   ​$items['​crmMultipleListItems'​][] = array('​type'​ => '​text','​text'​ => '​API-AddMultiple Text'​);​ 
- 
-   ​$specialItem = array( 
- '​quantity'​ =>​ 10, 
- '​realnumber'​ =>​ '​100001',​ 
- '​name'​ =>​ 'API Special Article',​ 
- '​description'​ =>​ 'API Special Article',​ 
- '​taxrate'​ =>​ 19, 
- '​discount'​ =>​ 100, 
- '​interval'​ =>​ 1, 
- '​type'​ =>​ '​special'​ 
-  );    ​ 
-     ​$items['​crmMultipleListItems'​][] = $specialItem;​ 
- 
-   $data = array( 
-     '​quantity'​ =>​ 3, 
-     '​name'​ =>​ 'API Groupline',​ 
-     '​description'​ =>​ 'API Groupline',​ 
-     '​taxrate'​ =>​ 19, 
-     '​discount'​ =>​ 100, 
-     '​interval'​ =>​ 1, 
-     '​type'​ =>​ '​groupline'​ 
-   ); 
-   ​$items['​crmMultipleListItems'​][] = $specialItem;​ 
-  
- 
-   ​$success = $client_vouchers->​crmAddMultipleToList($session_id,​ $voucher_id,​ $items); 
- 
-   echo $success; 
- 
-} 
-catch (SOAPFault $f) { 
-  print $f->​faultstring;​ 
-} 
- 
-?> 
- 
-</​sxh>​ 
- 
----- 
- 
- 
-==== crmRemoveArticleFromList ===== 
- 
- 
-(Version >= 4.1.10678) ​ 
- 
-**Syntax**: 
-  array crmRemoveArticleFromList($session_id,​ $voucher_id,​ $article_id) 
- 
-**Beschreibung**:​ 
- 
-Löscht den Artikel mit der angegeben ID aus der Artikelliste der Gutschrift. Im Erfolgsfall wird 1 zurückgegeben. 
- 
- 
-Im Falle eines Fehlers wird eine CRMException mit mehr Fehlerdetails geworfen. 
- 
- 
-**Beispiel**:​ 
-<sxh php> 
- 
-<?php 
- 
-try { 
-  $success = $client_vouchers->​crmRemoveArticleFromList($session_id,​ $voucher_id,​ 11); 
-  ​ 
-     echo $success; 
- 
-} 
-catch (SOAPFault $f) { 
-  print $f->​faultstring;​ 
-} 
- 
-?> 
- 
-</​sxh>​ 
- 
----- 
- 
- 
-==== crmUnlockVoucher ===== 
- 
- 
-(Version >= 4.1)  
- 
-**Syntax**: 
-  int crmUnlockVoucher($session_id,​ $voucher_id) 
- 
-**Beschreibung**:​ 
- 
-Gibt eine Gutschrift zur Bearbeitung wieder frei. Gibt im Erfolgsfall die ID der Gutschrift zurück. 
- 
- 
-Im Falle eines Fehlers wird eine CRMException mit mehr Fehlerdetails geworfen. 
- 
- 
-**Beispiel**:​ 
-<sxh php> 
- 
-<?php 
- 
-try { 
-  $client_vouchers->​crmUnlockVoucher($session_id,​ $voucher_id);​ 
-} 
-catch (SOAPFault $f) { 
-  print $f->​faultstring;​ 
-} 
- 
-?> 
- 
-</​sxh>​ 
- 
----- 
- 
- 
-==== crmReverseVoucher ===== 
- 
- 
-(Version >= 4.1)  
- 
-**Syntax**: 
-  int crmReverseVoucher($session_id,​ $voucher_id,​ bool $create_invoice = false, array $article_list_ids = false, bool $negate = false) 
- 
-**Beschreibung**:​ 
- 
-Storniert eine Gutschrift. Gibt im Erfolgsfall die ID der Gutschrift zurück. 
- 
- 
-Im Falle eines Fehlers wird eine CRMException mit mehr Fehlerdetails geworfen. 
- 
- 
-//​create_invoice//​ ist ein bool-Wert, über den Sie automatisch eine Ausgangsrechnung erzeugen lassen können. (optional, ab Version 4.5.16733) 
- 
- 
-//​article_list_ids//​ ist ein Array von Artikel-IDs aus der Rechnung. (optional, ab Version 4.5.16733) 
- 
- 
-//negate// ermöglicht,​ den Rechnungsbetrag zu negieren. (optional, ab Version 4.5.16733) 
- 
- 
-**Beispiel**:​ 
-<sxh php> 
- 
-<?php 
- 
-try { 
-  $result = $client_vouchers->​crmReverseVoucher($session_id,​ $voucher_id);​ 
-} 
-catch (SOAPFault $f) { 
-  print $f->​faultstring;​ 
-} 
- 
-   echo $result; 
- 
-?> 
- 
-</​sxh>​ 
- 
----- 
- 
- 
-==== crmDuplicate ===== 
- 
- 
-(Version >= 4.1.10682) ​ 
- 
-**Syntax**: 
-  array crmDuplicate($session_id,​ $invoice_id,​ $item_ids = false) 
- 
-**Beschreibung**:​ 
- 
-Erzeugt ein Duplikat einer Gutschrift. Gibt im Erfolgsfall die ID des erzeugten Duplikats zurück.. 
- 
- 
-Im Falle eines Fehlers wird eine CRMException mit mehr Fehlerdetails geworfen. 
- 
- 
-//​item_ids//​ ist eine Doppelpunkt getrennte Liste von Artikel-IDs. 
- 
- 
-**Beispiel**:​ 
-<sxh php> 
- 
-<?php 
- 
-try { 
-  $result = $client_vouchers->​crmDuplicate($session_id,​ $invoice_id,​ '​1:​2:​3'​);​ 
-  ​ 
-     echo $result; 
-} 
-catch (SOAPFault $f) { 
-  print $f->​faultstring;​ 
-} 
- 
-?> 
- 
-</​sxh>​ 
- 
----- 
- 
- 
-==== crmgetIdByExtId ===== 
- 
- 
-(Version >= 4.2) 
- 
-**Syntax:** 
- 
- array crmgetIdByExtId( string $session_id,​ string $external_id )  ​ 
- 
-**Beschreibung** 
- 
-Liefert interne ID(s) von Gutschriften mit der übergebenen externen ID zurück. 
- 
- 
-**Eigenschaften der zurückgegebenen ****//​voucher Objekte//​**:​ 
-  ​ 
-  Type(Length) ​           Eigenschaft ​                 Beschreibung 
-  --------------------------------------------------------------------------------------------- 
-  int $id  ​     Voucher-Id ​ 
- 
- 
-**Beispiel:​** 
-<sxh php> 
- 
-<?php 
- 
-try { 
-  $result = $client_vouchers->​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 Gutschriften zurück. 
- 
- 
-**Eigenschaften der zurückgegebenen ****//​voucher Objekte//​**:​ 
-  ​ 
-  Type(Length) ​           Eigenschaft ​                 Beschreibung 
-  --------------------------------------------------------------------------------------------- 
-  int $id  ​     externe Voucher-Id ​ 
- 
- 
-**Beispiel:​** 
-<sxh php> 
- 
-<?php 
- 
-try {  
-  $result = $client_vouchers->​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/​Vouchers+SOAP]]