Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

Link zu dieser Vergleichsansicht

Beide Seiten der vorigen Revision Vorhergehende Überarbeitung
webservices:rest_webservices:purchases [2020/03/02 16:50]
andre
webservices:rest_webservices:purchases [2020/03/03 08:55] (aktuell)
andre
Zeile 390: Zeile 390:
  
 try { try {
-  $invoice ​= $client_invoices->​crmCreateFromContract(array('​session_id'​=>​$session_id,​ 1, 1, '​article_list_ids'​=>'​1:​2:​3'​));​+  $purchase ​= $client_purchases->​crmCreateFromContract(array('​session_id'​=>​$session_id,​ 1, 1, '​article_list_ids'​=>'​1:​2:​3'​));​
   ​   ​
-     ​foreach($invoice ​as $key => $val) {+     ​foreach($purchase ​as $key => $val) {
        echo "$key => $val<​br> ​ \n";        echo "$key => $val<​br> ​ \n";
      }      }
Zeile 408: Zeile 408:
  
  
-==== crmSearchInvoices ​=====+==== crmSearchPurchases ​=====
  
  
Zeile 414: Zeile 414:
  
 **Syntax**: **Syntax**:
-  array crmSearchInvoices(array($session_id,​ $crmInvoiceSearchParams))+  array crmSearchPurchases(array($session_id,​ $crmPurchaseSearchParams))
  
 **Beschreibung**:​ **Beschreibung**:​
  
-Sucht anhand der übergebenen Parameter nach Ausgangsrechnungen. Gibt im Erfolgsfall ein Array mit Ausgangsrechnungen ​zurück.+Sucht anhand der übergebenen Parameter nach Eingangsrechnungen. Gibt im Erfolgsfall ein Array mit Eingangsrechnungen ​zurück.
  
  
Zeile 424: Zeile 424:
  
  
-//crmInvoiceSearchParams// kann ein assoziatives Array oder ein Objekt sein.+//crmPurchaseSearchParams// kann ein assoziatives Array oder ein Objekt sein.
  
  
-**Eigenschaften von ****//crmInvoiceSearchParams//**:+**Eigenschaften von ****//crmPurchaseSearchParams//**:
   ​   ​
   Type(Length) ​     Eigenschaft ​         Beschreibung   Type(Length) ​     Eigenschaft ​         Beschreibung
Zeile 454: Zeile 454:
 try { try {
   $sparams = array (   $sparams = array (
-       '​search'​ => "name LIKE '​%API ​Invoice ​Test%'"​+       '​search'​ => "name LIKE '​%API ​Purchase ​Test%'"​
      );      );
-     $vouchers ​= $client_invoices->​crmSearchInvoices(array('​session_id'​=>​$session_id,​ 'crmInvoiceSearchParams'​=>​$sparams));​+     $purchases ​= $client_invoices->​crmSearchPurchases(array('​session_id'​=>​$session_id,​ 'crmPurchaseSearchParams'​=>​$sparams));​
   ​   ​
-     ​foreach($vouchers ​as $voucher) { +     ​foreach($purchases ​as $purchase) { 
- foreach($voucher ​as $key => $val) {+ foreach($purchase ​as $key => $val) {
      echo "$key => $val<​br>​\n";​      echo "$key => $val<​br>​\n";​
  }  }
Zeile 474: Zeile 474:
  
 ---- ----
- 
- 
-==== crmToAdmonition ===== 
- 
- 
-(Version >= 4.1) 
- 
-**Syntax**: 
-  int crmToAdmonition(array($session_id,​ $invoice_id)) 
- 
-**Beschreibung**:​ 
- 
-Erzeugt aus einer Rechnung eine Mahnung. Gibt im Erfolgsfall die ID der neuen Mahnung zurück. 
- 
- 
-Im Falle eines Fehlers wird eine CRMException mit mehr Fehlerdetails geworfen. 
- 
- 
-**Beispiel**:​ 
-<sxh php> 
- 
-<?php 
- 
-try { 
-  $result = $client_invoices->​crmToAdmonition(array('​session_id'​=>​$session_id,​ '​invoice_id'​=>​$invoice_id));​ 
-  ​ 
-     echo $result; 
-} 
-catch (Exception $e) { 
-  echo '​Exception abgefangen: ' .$e->​getMessage(). "​\n";​ 
-} 
- 
-?> 
- 
-</​sxh>​ 
- 
----- 
- 
- 
-==== crmToDelivery ===== 
- 
- 
-(Version >= 4.1) 
- 
-**Syntax**: 
-  int crmToDelivery(array($session_id,​ $invoice_id)) 
- 
-**Beschreibung**:​ 
- 
-Erzeugt aus einer Rechnung einen Lieferschein. Gibt im Erfolgsfall die ID des neuen Lieferscheins zurück. 
- 
- 
-Im Falle eines Fehlers wird eine CRMException mit mehr Fehlerdetails geworfen. 
- 
- 
-//​article_list_ids//​ ist eine Doppelpunkt-getrennte Liste von Artikel-IDs aus drer Artikelliste. 
- 
- 
-**Beispiel**:​ 
-<sxh php> 
- 
-<?php 
- 
-try { 
-  $result = $client_invoices->​crmToDelivery(array('​session_id'​=>​$session_id,​ '​invoice_id'​=>​$invoice_id,​ '​2:​3'​));​ 
-  ​ 
-     echo $result; 
-} 
-catch (Exception $e) { 
-  echo '​Exception abgefangen: ' .$e->​getMessage(). "​\n";​ 
-} 
- 
-?> 
- 
-</​sxh>​ 
- 
----- 
- 
  
 ==== crmGetFlowStatus ===== ==== crmGetFlowStatus =====
Zeile 559: Zeile 481:
  
 **Syntax**: **Syntax**:
-  int crmGetFlowStatus(array($session_id,​ $invoice_id))+  int crmGetFlowStatus(array($session_id,​ $purchase_id))
  
 **Beschreibung**:​ **Beschreibung**:​
  
-Holt den aktuellen Status der Ausgangsrechnung.+Holt den aktuellen Status der Eingangsrechnung.
  
  
Zeile 575: Zeile 497:
  
 try { try {
-  $status = $client_invoices->​crmGetFlowStatus(array('​session_id'​ => $session_id,​ '​object_id'​ => $invoice_id));+  $status = $client_purchases->​crmGetFlowStatus(array('​session_id'​ => $session_id,​ '​object_id'​ => $purchase_id));
   ​   ​
      echo $status;      echo $status;
Zeile 596: Zeile 518:
  
 **Syntax**: **Syntax**:
-  array crmGetDocument(array($session_id,​ $invoice_id))+  array crmGetDocument(array($session_id,​ $object_id))
  
 **Beschreibung**:​ **Beschreibung**:​
  
-Holt das zur Ausgangsrechnung ​gehörige Dokument aus dem TecArt-System. Gibt ein Array zurück.+Holt das zur Eingangsrechnung ​gehörige Dokument aus dem TecArt-System. Gibt ein Array zurück.
  
  
Zeile 620: Zeile 542:
  
 try { try {
-  $document = $client_invoices->​crmGetDocument(array('​session_id'​ => $session_id,​ '​object_id'​ => $invoice_id));+  $document = $client_purchases->​crmGetDocument(array('​session_id'​ => $session_id,​ '​object_id'​ => $purchase_id));
   ​   ​
      echo "";​      echo "";​
Zeile 643: Zeile 565:
  
 **Syntax**: **Syntax**:
-  array crmGetArticles(array($session_id,​ $invoice_id))+  array crmGetArticles(array($session_id,​ $purchase_id))
  
 **Beschreibung**:​ **Beschreibung**:​
Zeile 659: Zeile 581:
  
 try { try {
-  $articles = $client_invoices->​crmGetArticles(array('​session_id'​ => $session_id,​ '​object_id'​ => $invoice_id));+  $articles = $client_invoices->​crmGetArticles(array('​session_id'​ => $session_id,​ '​object_id'​ => $purchase_id));
   ​   ​
      ​foreach($articles as $article) {      ​foreach($articles as $article) {
Zeile 686: Zeile 608:
  
 **Syntax**: **Syntax**:
-  array crmAddArticleToList(array($session_id,​ $invoice_id, $article_id))+  array crmAddArticleToList(array($session_id,​ $purchase_id, $article_id))
  
 **Beschreibung**:​ **Beschreibung**:​
  
-Fügt den Artikel mit der übergebenen ID zu einer Ausgangsrechnung ​hinzu. Im Erfolgsfall wird 1 zurückgegeben.+Fügt den Artikel mit der übergebenen ID zu einer Eingangsrechnung ​hinzu. Im Erfolgsfall wird 1 zurückgegeben.
  
  
Zeile 702: Zeile 624:
  
 try { try {
-  $success = $client_invoices->​crmAddArticleToList(array('​session_id'​ => $session_id,​ '​object_id'​ => $invoice_id, '​article_id'​ => 10));    ​+  $success = $client_purchases->​crmAddArticleToList(array('​session_id'​ => $session_id,​ '​object_id'​ => $purchase_id, '​article_id'​ => 10));    ​
      echo $success;      echo $success;
  
Zeile 723: Zeile 645:
  
 **Syntax**: **Syntax**:
-  array crmAddTextToList(array($session_id,​ $invoice_id, $text))+  array crmAddTextToList(array($session_id,​ $purchase_id, $text))
  
 **Beschreibung**:​ **Beschreibung**:​
  
-Fügt einen Artikel-Text zu einer Ausgangsrechnung ​hinzu. Im Erfolgsfall wird 1 zurückgegeben.+Fügt einen Artikel-Text zu einer Eingangsrechnung ​hinzu. Im Erfolgsfall wird 1 zurückgegeben.
  
  
Zeile 739: Zeile 661:
  
 try { try {
-  $success = $client_invoices->​crmAddTextToList(array('​session_id'​ => $session_id,​ '​object_id'​ => $invoice_id, '​text'​ => 'Das ist ein Text'​));​+  $success = $client_purchases->​crmAddTextToList(array('​session_id'​ => $session_id,​ '​object_id'​ => $purchase_id, '​text'​ => 'Das ist ein Text'​));​
      echo $success;      echo $success;
  
Zeile 760: Zeile 682:
  
 **Syntax**: **Syntax**:
-  array crmAddSpecialToList(array($session_id,​ $invoice_id, $crmBillingItem))+  array crmAddSpecialToList(array($session_id,​ $purchase_id, $crmBillingItem))
  
 **Beschreibung**:​ **Beschreibung**:​
  
-Fügt einen Sonderartikel zu einer Ausgangsrechnung ​hinzu. Im Erfolgsfall wird 1 zurückgegeben.+Fügt einen Sonderartikel zu einer Eingangsrechnung ​hinzu. Im Erfolgsfall wird 1 zurückgegeben.
  
  
Zeile 803: Zeile 725:
      );      );
  
-   ​$success = $client_invoices->​crmAddSpecialToList(array('​session_id'​ => $session_id,​ '​object_id'​ => $invoice_id, '​crmBillingItem'​ => $data));+   ​$success = $client_purchases->​crmAddSpecialToList(array('​session_id'​ => $session_id,​ '​object_id'​ => $purchase_id, '​crmBillingItem'​ => $data));
    echo $success;    echo $success;
  
Zeile 824: Zeile 746:
  
 **Syntax**: **Syntax**:
-  array crmAddGrouplineToList(array($session_id,​ $invoice_id, $crmBillingItem))+  array crmAddGrouplineToList(array($session_id,​ $purchase_id, $crmBillingItem))
  
 **Beschreibung**:​ **Beschreibung**:​
  
-Fügt eine Gruppenzeile zu einer Ausgangsrechnung ​hinzu. Im Erfolgsfall wird 1 zurückgegeben.+Fügt eine Gruppenzeile zu einer Eingangsrechnung ​hinzu. Im Erfolgsfall wird 1 zurückgegeben.
  
  
Zeile 865: Zeile 787:
      );      );
  
-   ​$success = $client_invoices->​crmAddGrouplineToList(array('​session_id'​ => $session_id,​ '​object_id'​ => $invoice_id, '​crmBillingItem'​ => $data));+   ​$success = $client_purchases->​crmAddGrouplineToList(array('​session_id'​ => $session_id,​ '​object_id'​ => $purchase_id, '​crmBillingItem'​ => $data));
    echo $success;    echo $success;
  
Zeile 886: Zeile 808:
  
 **Syntax**: **Syntax**:
-  array crmAddMultipleToList(array($session_id,​ $invoice_id, $crmMultipleListItems))+  array crmAddMultipleToList(array($session_id,​ $purchase_id, $crmMultipleListItems))
  
 **Beschreibung**:​ **Beschreibung**:​
  
-Fügt der Artikelliste mehrere Artikel und Texte und Gruppenzeilen zu einer Ausgangsrechnung ​hinzu. Im Erfolgsfall wird 1 zurückgegeben.+Fügt der Artikelliste mehrere Artikel und Texte und Gruppenzeilen zu einer Eingangsrechnung ​hinzu. Im Erfolgsfall wird 1 zurückgegeben.
  
  
Zeile 943: Zeile 865:
   
  
-   ​$success = $client_invoices->​crmAddMultipleToList(array('​session_id'​ => $session_id,​ '​object_id'​ => $invoice_id, '​crmBillingItem'​ => $items));+   ​$success = $client_purchases->​crmAddMultipleToList(array('​session_id'​ => $session_id,​ '​object_id'​ => $purchase_id, '​crmBillingItem'​ => $items));
  
    echo $success;    echo $success;
Zeile 965: Zeile 887:
  
 **Syntax**: **Syntax**:
-  array crmRemoveArticleFromList(array($session_id,​ $invoice_id, $article_id))+  array crmRemoveArticleFromList(array($session_id,​ $purchase_id, $article_id))
  
 **Beschreibung**:​ **Beschreibung**:​
  
-Löscht den Artikel mit der angegeben ID aus der Artikelliste der Ausgangsrechnung. Im Erfolgsfall wird 1 zurückgegeben.+Löscht den Artikel mit der angegeben ID aus der Artikelliste der Eingangsrechnung. Im Erfolgsfall wird 1 zurückgegeben.
  
  
Zeile 981: Zeile 903:
  
 try { try {
-  $success = $client_invoices->​crmRemoveArticleFromList(array('​session_id'​ => $session_id,​ , '​object_id'​ => $invoice_id, '​article_id'​ => 11));+  $success = $client_purchases->​crmRemoveArticleFromList(array('​session_id'​ => $session_id,​ , '​object_id'​ => $purchase_id, '​article_id'​ => 11));
   ​   ​
      echo $success;      echo $success;
Zeile 997: Zeile 919:
  
  
-==== crmUnlockInvoice ​=====+==== crmUnlockPurchase ​=====
  
  
Zeile 1003: Zeile 925:
  
 **Syntax**: **Syntax**:
-  int crmUnlockInvoice(array($session_id,​ $invoice_id))+  int crmUnlockPurchase(array($session_id,​ $purchase_id))
  
 **Beschreibung**:​ **Beschreibung**:​
Zeile 1019: Zeile 941:
  
 try { try {
-  $result = $client_invoices->crmUnlockInvoice(array('​session_id'​=>​$session_id,​ 'invoice_id'​=>​$invoice_id));+  $result = $client_purchases->crmUnlockPurchase(array('​session_id'​=>​$session_id,​ 'purchase_id'​=>​$purchase_id));
      echo $result;      echo $result;
 } }
Zeile 1039: Zeile 961:
  
 **Syntax**: **Syntax**:
-  int crmReverse(array($session_id,​ $invoice_id, $create_voucher = false, $article_list_ids = false, $negate = false))+  int crmReverse(array($session_id,​ $purchase_id, $create_voucher = false, $article_list_ids = false, $negate = false))
  
 **Beschreibung**:​ **Beschreibung**:​
Zeile 1064: Zeile 986:
  
 try { try {
-  $result = $client_invoices->​crmReverse(array('​session_id'​=>​$session_id,​ 'invoice_id'​=>​$invoice_id));+  $result = $client_purchases->​crmReverse(array('​session_id'​=>​$session_id,​ 'purchase_id'​=>​$purchase_id));
      echo $result;      echo $result;
 } }
Zeile 1084: Zeile 1006:
  
 **Syntax**: **Syntax**:
-  int crmDuplicate(array($session_id,​ $invoice_id, $article_list_ids = false))+  int crmDuplicate(array($session_id,​ $purchase_id, $article_list_ids = false))
  
 **Beschreibung**:​ **Beschreibung**:​
Zeile 1103: Zeile 1025:
  
 try { try {
-  $result = $client_invoices->​crmDuplicate(array('​session_id'​=>​$session_id,​ 'invoice_id'​=>​$invoice_id));+  $result = $client_purchases->​crmDuplicate(array('​session_id'​=>​$session_id,​ 'purchase_id'​=>​$purchase_id));
      echo $result;      echo $result;
 } }
Zeile 1128: Zeile 1050:
 **Beschreibung** **Beschreibung**
  
-Liefert interne ID(s) von Ausgangsrechnungen ​mit der übergebenen externen ID zurück.+Liefert interne ID(s) von Eingangsrechnungen ​mit der übergebenen externen ID zurück.
  
  
Zeile 1140: Zeile 1062:
  
 try { try {
-  $result = $client_invoices->​crmgetIdByExtId(array('​session_id'​ => $session_id,​ '​ext_id'​ => 12345));+  $result = $client_purchases->​crmgetIdByExtId(array('​session_id'​ => $session_id,​ '​ext_id'​ => 12345));
 } }
 catch (CRMException $e) { catch (CRMException $e) {
Zeile 1169: Zeile 1091:
 **Beschreibung** **Beschreibung**
  
-Liefert eine Liste aller externen IDs in Ausgangsrechnungen ​zurück.+Liefert eine Liste aller externen IDs in Eingangsrechnungen ​zurück.
  
  
Zeile 1181: Zeile 1103:
  
 try {  try { 
-  $result = $client_invoices->​crmgetAllExtIds(array('​session_id'​ => $session_id));​+  $result = $client_purchases->​crmgetAllExtIds(array('​session_id'​ => $session_id));​
 } }
 catch (CRMException $e) { catch (CRMException $e) {
Zeile 1222: Zeile 1144:
 try { try {
   include_once '​crm_rest_api.php';​   include_once '​crm_rest_api.php';​
-     ​$rest_url ​       = '​https://<​hostname>/<​dirname>/​rest/​index.php/​invoices';+     ​$rest_url ​       = '​https://<​hostname>/<​dirname>/​rest/​index.php/​purchases';
      ​$session_id ​     = session_id();​      ​$session_id ​     = session_id();​
-     $client_invoices ​= new crm_rest_api($rest_url);​+     $client_purchases ​= new crm_rest_api($rest_url);​
  
    ​$params ​ = array(    ​$params ​ = array(
Zeile 1230: Zeile 1152:
        '​fields' ​    => array('​realnumber',​ '​notes'​)        '​fields' ​    => array('​realnumber',​ '​notes'​)
    );    );
-   ​$success = $client_invoices->​crmsetDuplicateConfig($params);​+   ​$success = $client_purchases->​crmsetDuplicateConfig($params);​
 } }
 catch (CRMException $e) { catch (CRMException $e) {
Zeile 1268: Zeile 1190:
 try { try {
   include_once '​crm_rest_api.php';​   include_once '​crm_rest_api.php';​
-     ​$rest_url ​       = '​https://<​hostname>/<​dirname>/​rest/​index.php/​invoices';+     ​$rest_url ​       = '​https://<​hostname>/<​dirname>/​rest/​index.php/​purchases';
      ​$session_id ​     = session_id();​      ​$session_id ​     = session_id();​
-     $client_invoices ​= new crm_rest_api($rest_url);​+     $client_purchases ​= new crm_rest_api($rest_url);​
  
    ​$params ​ = array('​session_id'​ => $session_id);​    ​$params ​ = array('​session_id'​ => $session_id);​