2017/12/22 04:19 1/22 Deliveries. Diese Seite enthält noch nicht alle Informationen bzw. befindet sich aktuell in der Überarbeitung

Transkript

1 2017/12/22 04:19 1/22 Deliveries Deliveries Diese Seite enthält noch nicht alle Informationen bzw. befindet sich aktuell in der Überarbeitung Hinweis API Klassen und deren Funktionen können nur mit TecArt-System Version >= 3.2 genutzt werden Methods add int add($crmdeliveryitem) Erzeugt einen neuen Lieferschein. Gibt bei Erfolg die ID des Datensatzes zurück. 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 TecArt Developer Wiki -

2 Last update: 2017/05/08 15:00 api:deliveries 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 $data = array( 'name' => 'API Test Delivery', 'realnumber' => ' ', '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; Printed on 2017/12/22 04:19

3 2017/12/22 04:19 3/22 Deliveries addarticletolist array addarticletolist($delivery_id, $article_id) Fügt den Artikel mit der übergebenen ID zu einem Lieferschein hinzu. Im Erfolgsfall wird 1 zurückgegeben. $success = $api->addarticletolist($delivery_id, 10); echo $success; addgrouplinetolist array addgrouplinetolist($delivery_id, $crmbillingitem) Fügt eine Gruppenzeile zu einem Lieferschein hinzu. Im Erfolgsfall wird 1 zurückgegeben. crmbillingitem ist ein assoziatives Array. TecArt Developer Wiki -

4 Last update: 2017/05/08 15:00 api:deliveries 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 ) $data = array( 'quantity' => 3, 'name' => 'API Groupline', 'description' => 'API Groupline', 'taxrate' => 19, 'discount' => 100, 'interval' => 1 ); $success = $api->addgrouplinetolist($delivery_id, $data); echo $success; addmultipletolist Printed on 2017/12/22 04:19

5 2017/12/22 04:19 5/22 Deliveries array addmultipletolist($delivery_id, $crmmultiplelistitems) Fügt der Artikelliste mehrere Artikel und Texte und Gruppenzeilen zu einem Lieferschein hinzu. Im Erfolgsfall wird 1 zurückgegeben. 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 $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, TecArt Developer Wiki -

6 Last update: 2017/05/08 15:00 api:deliveries 'interval' => 1, 'type' => 'groupline' ); $items[] = $specialitem; $success = $api->addmultipletolist($admon_id, $items); echo $success; addspecialtolist array addspecialtolist($delivery_id, $crmbillingitem) Fügt einen Sonderartikel zu einem Lieferschein hinzu. Im Erfolgsfall wird 1 zurückgegeben. 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 ) Printed on 2017/12/22 04:19

7 2017/12/22 04:19 7/22 Deliveries $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; addtexttolist array addtexttolist($delivery_id, $text) Fügt einen Artikel-Text zu einem Lieferschein hinzu. Im Erfolgsfall wird 1 zurückgegeben. TecArt Developer Wiki -

8 Last update: 2017/05/08 15:00 api:deliveries $success = $api->addtexttolist($delivery_id, 'Das ist ein Text'); echo $success; change int change($delivery_id, $crmdeliveryitem) Ändert den Lieferschein mit der übergebenen ID. Gibt bei Erfolg die ID des Datensatzes zurück. crmdeliveryitem ist ein assoziatives Array. Eigenschaften:: Eigenschaften: sind die selben wie für add $data = array('name' => 'API Test Updated Delivery'); $res = $api->change($delivery_id, $data); echo $res; Printed on 2017/12/22 04:19

9 2017/12/22 04:19 9/22 Deliveries changearticleinlist int changearticleinlist( int $object_id, $position, $object_data ) Ü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. delete array delete($delivery_id) Entfernt den Lieferschein mit der übergebenen ID. $result = $api->delete($delivery_id); echo $result; TecArt Developer Wiki -

10 Last update: 2017/05/08 15:00 api:deliveries delivered array delivered(int $delivery_id) Setzt des Status eines Lieferschein aus geliefert und im Erfolgsfall die ID des Lieferscheins zurück. $result = $api->delivered($delivery_id); echo $result; frominvoice array frominvoice($invoice_id, $item_ids = false) Erzeugt eine Gutschrift aus einer Rechnung. Gibt im Erfolgsfall die ID der erzeugten Gutschrift zurück.. item_ids ist Array von Artikel-IDs. Printed on 2017/12/22 04:19

11 2017/12/22 04:19 11/22 Deliveries $result = $api->frominvoice($invoice_id, array(1,2,3); echo $result; get array get($delivery_id) Gibt den Lieferschein mit der übergebenen ID als Array zurück. 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 TecArt Developer Wiki -

12 Last update: 2017/05/08 15:00 api:deliveries 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 $result = $api->get($delivery_id); foreach($result as $key => $val) { echo "$key => $val<br>\n"; echo "<hr/>"; Printed on 2017/12/22 04:19

13 2017/12/22 04:19 13/22 Deliveries getallextids (Version >= 4.2) array getallextids( string $external_id ) Beschreibung Liefert eine Liste aller externen IDs in Lieferscheinen zurück. Eigenschaften des zurückgegebenen delivery ids array: Type(Length) Eigenschaft Beschreibung int $id externe Task-Id $api = crmapi::deliveries(); $result = $api->getallextids(); foreach($result as $id) { echo $id."<br> "; getarticles TecArt Developer Wiki -

14 Last update: 2017/05/08 15:00 api:deliveries array getarticles($delivery_id) Gibt Artikelliste des Lieferscheines zurück. $articles = $api->getarticles($delivery_id); foreach($articles as $article) { foreach($article as $key => $val) { echo "$key => $val<br>\n"; echo "<hr/>"; getdocument array getdocument($delivery_id) Holt das zum Lieferschein gehörige Dokument aus dem TecArt-System. Gibt ein Array zurück. Eigenschaften des zurückgegebenen Array Printed on 2017/12/22 04:19

15 2017/12/22 04:19 15/22 Deliveries Type(Length) Eigenschaft Beschreibung string $filename Dateiname des Dokumentes string $content base64-codierte Inhalt der Datei $document = $api->getdocument($delivery_id); echo ""; var_dump($document); echo ""; getduplicatecheckconfig (Version >= 4.4) array string CRMException message getduplicatecheckconfig( ) 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. $api = crmapi::deliveries(); TecArt Developer Wiki -

16 Last update: 2017/05/08 15:00 api:deliveries $fields = $api->getduplicatecheckconfig(); echo ''.print_r($fields, true).''; getflowstatus int getflowstatus($delivery_id) Holt den aktuellen Status des Lieferscheines. $status = $api->getflowstatus($delivery_id); echo $status; getidbyextid (Version >= 4.2) Printed on 2017/12/22 04:19

17 2017/12/22 04:19 17/22 Deliveries array getidbyextid( string $external_id ) Beschreibung Liefert interne ID(s) von Lieferscheinen mit der übergebenen externen ID zurück. Eigenschaften des zurückgegebenen delivery ids array: Type(Length) Eigenschaft Beschreibung int $id Task-Id $api = crmapi::deliveries(); $result = $api->getidbyextid(12345); foreach($result as $id) { echo $id."<br> "; gotonextflowstatus int gotonextflowstatus($delivery_id) Setzt den Status der Gutschrift auf die nächste Stufe. TecArt Developer Wiki -

18 Last update: 2017/05/08 15:00 api:deliveries $api->gotonextflowstatus($delivery_id); removearticlefromlist array removearticlefromlist($delivery_id, $article_id) Löscht den Artikel mit der angegeben ID aus der Artikelliste des Lieferscheines. Im Erfolgsfall wird true zurückgegeben. $success = $api->removearticlefromlist($delivery_id, 11); echo $success; Printed on 2017/12/22 04:19

19 2017/12/22 04:19 19/22 Deliveries reverse array reverse(int $delivery_id) Storniert einen Lieferschein. Gibt im Erfolgsfall 1 zurück. $result = $api->reverse($delivery_id); echo $result; searchdeliveries array searchdeliveries($searchdeliveriesparams) Sucht anhand der übergebenen Parameter nach Gutschriften. Gibt im Erfolgsfall ein Array mit Gutschriften zurück. TecArt Developer Wiki -

20 Last update: 2017/05/08 15:00 api:deliveries 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 $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/>"; setduplicatecheckconfig (Version >= 4.4) boolean string CRMException message setduplicatecheckconfig( [array( [string <fieldname>, string <fieldname>...]) NULL] ) Printed on 2017/12/22 04:19

21 2017/12/22 04:19 21/22 Deliveries 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. $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); echo ($success === true? 'override successful' : $success).''; unlock array unlock(int $delivery_id) Gibt einen Lieferschein zur Bearbeitung wieder frei. Gibt im Erfolgsfall 1 zurück. TecArt Developer Wiki -

22 Last update: 2017/05/08 15:00 api:deliveries $result = $api->unlock($delivery_id); echo $result; From: - TecArt Developer Wiki Permanent link: Last update: 2017/05/08 15:00 Printed on 2017/12/22 04:19