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(array $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
int               $ext_id               Externe ID ( ab Version 4.2 )
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

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 Voucher',
		'date'				=> time(),
		'cid'				=> 1,
		'client_account_id'	=> 1,
		'flow_status'		=> 0,
		'total_netto'		=> 100.0,
		'total_brutto'		=> 119.0,
		'tax_value'			=> 19.0,
	);
 
	$api		= crmapi::vouchers();    
	$voucher_id	= $api->add($data);
 
	echo $voucher_id;
}
catch (CRMException $e) {
	echo $e->getMessage();
}



1.2. addArticleToList

(Version >= 4.1)

Syntax:

array addArticleToList(int $voucher_id, int $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:

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



1.3. addGrouplineToList

(Version >= 4.1)

Syntax:

array addGrouplineToList(int $voucher_id, array $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

Beispiel:

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



1.4. addMultipleToList

(Version >= 4.1)

Syntax:

array addMultipleToList(int $voucher_id, array $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 addArticleToList, addTextToList, addSpecialToList und addGrouplineToList. Die Unterscheidung erfolgt über das Feld "type".

Eigenschaften:

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

Beispiel:

<?php
 
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($voucher_id, $items);
 
	echo $success;
}
catch (CRMException $e) {
	echo $e->getMessage();
}



1.5. addSpecialToList

(Version >= 4.1)

Syntax:

array addSpecialToList(int $voucher_id, array $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

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($voucher_id, $data);
	echo $success;
}
catch (CRMException $e) {
	echo $e->getMessage();
}



1.6. addTextToList

(Version >= 4.1)

Syntax:

array addTextToList(int $voucher_id, string $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:

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



1.7. change

(Version >= 4.1)

Syntax:

array change(int $voucher_id, array $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 Vouchers#add

Beispiel:

<?php
 
try {
	$data	= array('name'=> 'API-Test Voucher with new name');
	$result = $api->change($voucher_id, $data);
   
	echo $result;
}
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 der Gutschrift $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(int $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:

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



1.10. duplicate

(Version >= 4.1)

Syntax:

array duplicate(int $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 FALSE zurückgegeben.

item_ids ist eine Doppelpunkt getrennte Liste von Artikel-IDs.

Beispiel:

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



1.11. fromInvoice

(Version >= 4.1)

Syntax:

array fromInvoice(int $invoice_id, bool $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 von Artikel-IDs.

Beispiel:

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



1.12. get

(Version >= 4.1)

Syntax:

array get(int $voucher_id, bool $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		          $cid					Kontakt-ID
int		          $client_account_id	Rechnungskonto-ID
int               $ext_id               Externe ID ( ab Version 4.2 )
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:

<?php
 
try {
	$result = $api->get($voucher_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 Gutschriften zurück.

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

Eigenschaften des zurückgegebenen voucher ids array:

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

Beispiel:

<?php
 
try {   
	$api	= crmapi::vouchers();
	$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($voucher_id)

Beschreibung:

Gibt Artikelliste der Gutschrift zurück.

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

Beispiel:

<?php
 
try {
	$articles = $api->getArticles($voucher_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($voucher_id)

Beschreibung:

Holt das zur Gutschrift 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($voucher_id);
   
	var_dump($document);
}
catch (CRMException $e) {
	echo $e->getMessage();
}



1.16. getFlowStatus

(Version >= 4.1)

Syntax:

int getFlowStatus($voucher_id)

Beschreibung:

Holt den aktuellen Status der Gutschrift.

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

Beispiel:

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



1.17. getIdByExtId

(Version >= 4.2)

Syntax:

array getIdByExtId( string $external_id )

Beschreibung

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

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

Eigenschaften des zurückgegebenen voucher ids array:

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

Beispiel:

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



1.18. gotoNextFlowStatus

(Version >= 4.1)

Syntax:

void gotoNextFlowStatus(int $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:

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



1.19. removeArticleFromList

(Version >= 4.1)

Syntax:

array removeArticleFromList($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:

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



1.20. reverse

(Version >= 4.1)

Syntax:

array reverse(int $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 FALSE zurückgegeben.

create_invoice ist ein bool-Wert, über den Sie automatisch eine Ausgangsrechnung erzeugen lassen können. (optional, ab Version 4.5.16663)

article_list_ids ist ein Array von Artikel-IDs aus der Rechnung. (optional, ab Version 4.5.16663)

negate ermöglicht, den Rechnungsbetrag zu negieren. (optional, ab Version 4.5.16663)

Beispiel:

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



1.21. searchVouchers

(Version >= 4.1)

Syntax:

array searchVouchers(array $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	Änderungsdatum seit
int		      $changed_until	Änderungsdatum 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:

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



1.22. unlock

(Version >= 4.1)

Syntax:

array unlock(int $voucher_id)

Beschreibung:

Gibt eine Gutschrift 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($voucher_id);
 
	echo $result;
}
catch (CRMException $e) {
	echo $e->getMessage();
}
  • No labels