Page tree
Skip to end of metadata
Go to start of metadata


 

Diese Seite enthält noch nicht alle Informationen bzw. befindet sich aktuell in der Überarbeitung

API Klassen und deren Funktionen können nur mit TecArt-System Version >= 3.2 genutzt werden

1. Methods

1.1. add

(Version >= 4.1)

Syntax:

int add($crmDeliveryItem)

Beschreibung:

Erzeugt einen neuen Lieferschein. Gibt bei Erfolg die ID des Datensatzes zurück.

Im Falle eines Fehlers wird eine CRMException mit mehr Fehlerdetails geworfen.

crmDeliveryItem ist ein assoziatives Array.

Eigenschaften:

Type(Length)      Eigenschaft          Beschreibung
-------------------------------------------------------------------
int		          $cid			        Kontakt-ID
int               $ext_id               Externe ID ( ab Version 4.2 )
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		          $reversed		        zurückgerufen
string		      $name			        Name
int		          $invoice_id		    Rechnungs-ID
int		          $delivery_target	    Lieferziel
int		          $delivery_appointed	Lieferungstichtag
double		      $total_netto	    	Gesamt - netto
double		      $tax_value	    	USt-Betrag
double		      $total_brutto		    Gesamt - brutto
int		          $is_delivered	    	Lieferdatum als Unit-Timestamp
int		          $flow_status	    	Status
string		  $shipping_postcode	    Lieferschein: PLZ
string		  $shipping_city	Lieferschein: Ort
string		  $shipping_county	Lieferschein: Land
string		  $shipping_name_1	Lieferschein: Name 1
string		  $shipping_name_2	Lieferschein: Name 2
string		  $shipping_name_3	Lieferschein: Name 3
string		  $shipping_address_1	Lieferschein: Adresse 1
string		  $shipping_address_2	Lieferschein: Adresse 2

string		  $user29		Benutzerdefiniertes Feld Nr. 29
string		  $user30		Benutzerdefiniertes Feld Nr. 30
   :                 :                            :
string		  $user80		Benutzerdefiniertes Feld Nr. 80 

Beispiel:

<?php
 
try {
    $data = array(
        'name'              => 'API Test Delivery',
        'realnumber'        => '10000001',
        'notes'             => 'Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.',
        'cid'               => 1,
        'client_account_id' => 1,
        'invoice_id'        => 1
	);
 
    $api = crmapi::deliveries();
    $delivery_id = $api->add($data);
 
    echo $delivery_id;
 
}
catch (CRMException $e) {
    echo $e->getMessage();
}



1.2. addArticleToList

(Version >= 4.1)

Syntax:

array addArticleToList($delivery_id, $article_id)

Beschreibung:

Fügt den Artikel mit der übergebenen ID zu einem Lieferschein hinzu. Im Erfolgsfall wird 1 zurückgegeben.

Im Falle eines Fehlers wird eine CRMException mit mehr Fehlerdetails geworfen.

Beispiel:

<?php
 
try {
    $success = $api->addArticleToList($delivery_id, 10);    
    echo $success;
 
}
catch (CRMException $e) {
    echo $e->getMessage();
}



1.3. addGrouplineToList

(Version >= 4.1)

Syntax:

array addGrouplineToList($delivery_id, $crmBillingItem)

Beschreibung:

Fügt eine Gruppenzeile zu einem Lieferschein hinzu. Im Erfolgsfall wird 1 zurückgegeben.

Im Falle eines Fehlers wird eine CRMException mit mehr Fehlerdetails geworfen.

crmBillingItem ist ein assoziatives Array.

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:

<?php
 
try {
    $data = array(
        'quantity'    => 3,
        'name'        => 'API Groupline',
        'description' => 'API Groupline',
        'taxrate'     => 19,
        'discount'    => 100,
        'interval'    => 1
    );
 
    $success = $api->addGrouplineToList($delivery_id, $data);
    echo $success;
 
}
catch (CRMException $e) {
    echo $e->getMessage();
}



1.4. addMultipleToList

(Version >= 4.1)

Syntax:

array addMultipleToList($delivery_id, $crmMultipleListItems)

Beschreibung:

Fügt der Artikelliste mehrere Artikel und Texte und Gruppenzeilen zu einem Lieferschein 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 addArticleToList, addTextToList, addSpecialToList und addGrouplineToList. Die Unterscheidung erfolgt über das Feld "type".

Eigenschaften:

Typ             Eigenschaft                          Beschreibung
---------------------------------------------------------------------------------------------
array           $crmMultipleListItems                Artikelliste

Beispiel:

try { 
    $items = array();
 
    $items[] = array('type' => 'article', 'id' => 10);
    $items[] = 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[] = $specialItem;
 
    $data = array(
        'quantity'    => 3,
        'name'        => 'API Groupline',
        'description' => 'API Groupline',
        'taxrate'     => 19,
        'discount'    => 100,
        'interval'    => 1,
        'type'        => 'groupline'
    );
    $items[] = $specialItem;
   
    $success = $api->addMultipleToList($admon_id, $items);
 
    echo $success;
}
catch (CRMException $e) {
    echo $e->getMessage();
}



1.5. addSpecialToList

(Version >= 4.1)

Syntax:

array addSpecialToList($delivery_id, $crmBillingItem)

Beschreibung:

Fügt einen Sonderartikel zu einem Lieferschein hinzu. Im Erfolgsfall wird 1 zurückgegeben.

Im Falle eines Fehlers wird eine CRMException mit mehr Fehlerdetails geworfen.

crmBillingItem ist ein assoziatives Array.

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:

<?php
 
try {
    $data = array(
        'quantity'    => 10,
        'realnumber'  => '100001',
        'name'        => 'API Special Article',
        'description' => 'API Special Article',
        'taxrate'     => 19,
        'discount'    => 100,
        'interval'    => 1
    );
 
    $success = $api->addSpecialToList($delivery_id, $data);
    echo $success; 
}
catch (CRMException $e) {
    echo $e->getMessage();
}



1.6. addTextToList

(Version >= 4.1)

Syntax:

array addTextToList($delivery_id, $text)

Beschreibung:

Fügt einen Artikel-Text zu einem Lieferschein hinzu. Im Erfolgsfall wird 1 zurückgegeben.

Im Falle eines Fehlers wird eine CRMException mit mehr Fehlerdetails geworfen.

Beispiel:

<?php
 
try {
    $success = $api->addTextToList($delivery_id, 'Das ist ein Text');
    echo $success; 
}
catch (CRMException $e) {
    echo $e->getMessage();
}



1.7. change

(Version >= 4.1)

Syntax:

int change($delivery_id, $crmDeliveryItem)

Beschreibung:

Ändert den Lieferschein mit der übergebenen ID. Gibt bei Erfolg die ID des Datensatzes zurück.

Im Falle eines Fehlers wird eine CRMException mit mehr Fehlerdetails geworfen.

crmDeliveryItem ist ein assoziatives Array.

Eigenschaften::

Eigenschaften: sind die selben wie für add

Beispiel:

<?php
 
try {
    $data = array('name' => 'API Test Updated Delivery');
    $res = $api->change($delivery_id, $data);
 
    echo $res;
}
catch (CRMException $e) {
    echo $e->getMessage();
}



1.8. changeArticleInList

Syntax:

int changeArticleInList( int $object_id, $position, $object_data )

Beschreibung: Überschreibt den Artikel an Position $position in der Artikelliste des Lieferscheins $object_id mit den Daten aus $object_data. Gibt true zurück bei Erfolg. Im Fehlerfall wird eine CRMException geworfen.


1.9. delete

(Version >= 4.1)

Syntax:

array delete($delivery_id)

Beschreibung:

Entfernt den Lieferschein mit der übergebenen ID.

Im Falle eines Fehlers wird eine CRMException mit mehr Fehlerdetails geworfen.

Beispiel:

<?php
 
try {
    $result = $api->delete($delivery_id);
 
    echo $result;
}
catch (CRMException $e) {
    echo $e->getMessage();
}



1.10. delivered

(Version >= 4.1)

Syntax:

array delivered(int $delivery_id)

Beschreibung:

Setzt des Status eines Lieferschein aus geliefert und im Erfolgsfall die ID des Lieferscheins zurück.

Im Falle eines Fehlers wird eine CRMException mit mehr Fehlerdetails geworfen.

Beispiel:

<?php
 
try {
    $result = $api->delivered($delivery_id);
 
    echo $result; 
}
catch (CRMException $e) {
    echo $e->getMessage();
}



1.11. fromInvoice

(Version >= 4.1)

Syntax:

array fromInvoice($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 Array von Artikel-IDs.

Beispiel:

<?php
 
try {
    $result = $api->fromInvoice($invoice_id, array(1,2,3);
   
    echo $result;
}
catch (CRMException $e) {
    echo $e->getMessage();
}



1.12. get

(Version >= 4.1)

Syntax:

array get($delivery_id)

Beschreibung:

Gibt den Lieferschein mit der übergebenen 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					Delivery-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		  $reversed				zurückgerufen
string		  $name					Name
int		  $invoice_id				Rechnungs-ID
int		  $delivery_target			Lieferziel
int		  $delivery_appointed			Lieferungstichtag
double		  $total_netto				Gesamt - netto
double		  $tax_value				USt-Betrag
double		  $total_brutto				Gesamt - brutto
int		  $is_delivered				Lieferdatum als Unit-Timestamp
int		  $flow_status				Status
string		  $shipping_postcode			Lieferschein: PLZ
string		  $shipping_city			Lieferschein: Ort
string		  $shipping_county			Lieferschein: Land
string		  $shipping_name_1			Lieferschein: Name 1
string		  $shipping_name_2			Lieferschein: Name 2
string		  $shipping_name_3			Lieferschein: Name 3
string		  $shipping_address_1			Lieferschein: Adresse 1
string		  $shipping_address_2			Lieferschein: 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:

<?php
 
try {
    $result = $api->get($delivery_id);
 
    foreach($result as $key => $val) {
        echo "$key => $val<br>\n";
    }
    echo "<hr/>";
}
catch (CRMException $e) {
    echo $e->getMessage();
}



1.13. getAllExtIds

(Version >= 4.2)

Syntax:

array getAllExtIds( string $external_id )

Beschreibung

Liefert eine Liste aller externen IDs in Lieferscheinen zurück.

Im Falle eines Fehlers wird eine CRMException mit mehr Fehlerdetails geworfen.

Eigenschaften des zurückgegebenen delivery ids array:

Type(Length)            Eigenschaft                  Beschreibung
---------------------------------------------------------------------------------------------
int			$id			      externe Task-Id 

Beispiel:

<?php
 
try {   
    $api = crmapi::deliveries();
   
    $result = $api->getAllExtIds();
}
catch (CRMException $e) {
    echo $e->getMessage();
}
 
foreach($result as $id) {
    echo $id."<br>  ";
}



1.14. getArticles

(Version >= 4.1)

Syntax:

array getArticles($delivery_id)

Beschreibung:

Gibt Artikelliste des Lieferscheines zurück.

Im Falle eines Fehlers wird eine CRMException mit mehr Fehlerdetails geworfen.

Beispiel:

<?php
 
try {
    $articles = $api->getArticles($delivery_id);
   
    foreach($articles as $article) {
        foreach($article as $key => $val) {
            echo "$key => $val<br>\n";
        }
    }
    echo "<hr/>";
 
}
catch (CRMException $e) {
    echo $e->getMessage();
}



1.15. getDocument

(Version >= 4.1)

Syntax:

array getDocument($delivery_id)

Beschreibung:

Holt das zum Lieferschein gehörige Dokument aus dem TecArt-System. 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:

<?php
 
try {
    $document = $api->getDocument($delivery_id);
   
    var_dump($document);
}
catch (CRMException $e) {
    echo $e->getMessage();
}



1.16. getDuplicatecheckConfig

(Version >= 4.4)

Syntax:

array | string CRMException message getDuplicatecheckConfig( )

Beschreibung:

Gibt Array mit aktueller Feldkonfiguration der Dublettenprüfung zurück.

Sollte aktuell keine temporäre Überschreibung der Feldkonfiguration aktiv sein (siehe setDuplicatecheckConfig), wird die durch die Administration konfigurierte Feldliste als Array zurückgegeben.

Beispiel:

<?php
 
try { 
    $api    = crmapi::deliveries();
    $fields = $api->getDuplicatecheckConfig();
}
catch (CRMException $e) {
    echo $e->getMessage();
}
 
echo print_r($fields, true);



1.17. getFlowStatus

(Version >= 4.1)

Syntax:

int getFlowStatus($delivery_id)

Beschreibung:

Holt den aktuellen Status des Lieferscheines.

Im Falle eines Fehlers wird eine CRMException mit mehr Fehlerdetails geworfen.

Beispiel:

<?php
 
try {
    $status = $api->getFlowStatus($delivery_id);
   
    echo $status;
}
catch (CRMException $e) {
    echo $e->getMessage();
}



1.18. getIdByExtId

(Version >= 4.2)

Syntax:

array getIdByExtId( string $external_id )

Beschreibung

Liefert interne ID(s) von Lieferscheinen mit der übergebenen externen ID zurück.

Im Falle eines Fehlers wird eine CRMException mit mehr Fehlerdetails geworfen.

Eigenschaften des zurückgegebenen delivery ids array:

Type(Length)            Eigenschaft                  Beschreibung
---------------------------------------------------------------------------------------------
int			$id			      Task-Id 

Beispiel:

<?php
 
try {   
    $api = crmapi::deliveries();
   
    $result = $api->getIdByExtId(12345);
}
catch (CRMException $e) {
    echo $e->getMessage();
}
 
foreach($result as $id) {
    echo $id."<br>  ";
}



1.19. gotoNextFlowStatus

(Version >= 4.1)

Syntax:

int gotoNextFlowStatus($delivery_id)

Beschreibung:

Setzt den Status der Gutschrift auf die nächste Stufe.

Im Falle eines Fehlers wird eine CRMException mit mehr Fehlerdetails geworfen.

Beispiel:

<?php
 
try {
    $api->gotoNextFlowStatus($delivery_id);
}
catch (CRMException $e) {
    echo $e->getMessage();
}



1.20. removeArticleFromList

(Version >= 4.1)

Syntax:

array removeArticleFromList($delivery_id, $article_id)

Beschreibung:

Löscht den Artikel mit der angegeben ID aus der Artikelliste des Lieferscheines. Im Erfolgsfall wird true zurückgegeben.

Im Falle eines Fehlers wird eine CRMException mit mehr Fehlerdetails geworfen.

Beispiel:

<?php
 
try {
    $success = $api->removeArticleFromList($delivery_id, 11);
   
    echo $success; 
}
catch (CRMException $e) {
    echo $e->getMessage();
}
 



1.21. reverse

(Version >= 4.1)

Syntax:

array reverse(int $delivery_id)

Beschreibung:

Storniert einen Lieferschein. Gibt im Erfolgsfall 1 zurück.

Im Falle eines Fehlers wird eine CRMException mit mehr Fehlerdetails geworfen.

Beispiel:

<?php
 
try {
    $result = $api->reverse($delivery_id);
 
    echo $result; 
}
catch (CRMException $e) {
    echo $e->getMessage();
}



1.22. searchDeliveries

(Version >= 4.1)

Syntax:

array searchDeliveries($searchDeliveriesParams)

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.

searchDeliveriesParams ist ein assoziatives Array.

Eigenschaften von searchDeliveriesParams:

Type(Length)      Eigenschaft          Beschreibung
-------------------------------------------------------------------
string		      $search		        Suchbegriff
string		      $client_account_id	Rechnungskonto-ID
string		      $is_payed		        ist Lieferschein bezahlt
int		          $status	         	Status
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

Beispiel:

<?php
 
try {
    $sparams = array('search' => "name LIKE '%API Test Delivery%'");
    $deliveries = $api->searchDeliveries($sparams);
   
    foreach($deliveries as $voucher) {
        foreach($voucher as $key => $val) {
            echo "$key => $val<br>\n";
        }
        echo "<hr/>";    
    }
}
catch (CRMException $e) {
    echo $e->getMessage();
}



1.23. setDuplicatecheckConfig

(Version >= 4.4)

Syntax:

boolean|string CRMException message setDuplicatecheckConfig( [array( [string <fieldname>, string <fieldname>...]) | NULL] )

Beschreibung:

Ermöglicht eine temporäre Überschreibung der Dublettenprüfungsfelder für die Laufzeit der angemeldeten Session.

Standardübergabe ist ein leeres Array, was gleichbedeutend mit einer nicht stattfindenden Dublettenprüfung ist.

Zurückgesetzt werden kann die temporäre Dublettenprüfung Feldkonfiguration, wenn NULL anstatt eines Array übergeben wird.

Beispiel:

<?php
 
try {   
    $api     = crmapi::deliveries();
    $fields  = array('name', 'notes');
    // adding a delivery will execute an exists-check looking for identical values in fields "name" and "notes" 
    // and will result in an "object already exists" trigger
    $success = $api->setDuplicatecheckConfig($fields);
}
catch (CRMException $e) {
    echo $e->getMessage();
}
 
echo ($success === true ? 'override successful' : $success);



1.24. unlock

(Version >= 4.1)

Syntax:

array unlock(int $delivery_id)

Beschreibung:

Gibt einen Lieferschein zur Bearbeitung wieder frei. Gibt im Erfolgsfall 1 zurück.

Im Falle eines Fehlers wird eine CRMException mit mehr Fehlerdetails geworfen.

Beispiel:

<?php
 
try {
    $result = $api->unlock($delivery_id);
 
    echo $result; 
}
catch (CRMException $e) {
    echo $e->getMessage();
}
  • No labels