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. addPaymentToInvoice

(Version >= 4.0.9357)

Syntax:

int addPaymentToInvoice(array $crm_payment_item)

Beschreibung:

Erzeugt eine neue Zahlung zu einer Rechnung. Gibt im Erfolgsfall die ID des Datensatzes zurück.

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

crmPaymentItem 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
string            $src                  Belegart des Rechnungsvorganges (invoice, admonition, voucher, purchase)
string            $realnumber_activity  Belegnummer des Rechnungsvorganges
double            $amount               Umsatz
string            $account_in           Gegenkonto
string            $account_out          Buchungskonto
int		          $date			        Datum als Unix-Zeitstempel
string		      $text			        Buchungstext
string		      $reference_text_1	    Referenztext 1
string		      $reference_text_2	    Referenztext 2
string            $notes                Notizen

string      	  $user12               Benutzerdefiniertes Feld Nr. 12
string            $user13               Benutzerdefiniertes Feld Nr. 13
   :                 :                            :
string            $user80               Benutzerdefiniertes Feld Nr. 80 

Beispiel:

<?php
 
try {
	$api = crmapi::payments();
 
	$data = array(
		'notes'					=> 'API-Test',
		'client_account_id'		=> 1,
		'amount'				=> 200,
		'realnumber_activity'	=> 'ABC123',
		'reference_text_1'		=> 'Rechnung API-Test 1',
		'reference_text_2'		=> 'Rechnung API-Test 1'
	);
	$payment_id = $api->addPaymentToInvoice($data);
}
catch (CRMException $e) {
	echo $e->getMessage();
}
 
echo "Payment id: $payment_id<br>";



1.2. get

(Version >= 4.0.9357)

Syntax:

int get(int $payment_id)

Beschreibung:

Gibt die Zahlung mit der angegebenen ID als array.

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

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
string            $realnumber_activity  Belegnummer-ID
double            $amount               Umsatz
string            $account_in           Gegenkonto
string            $account_out          Buchungskonto
int		          $date			        Datum als Unit-Zeitstempel
string		      $text			        Buchungstext
string		      $reference_text_1	    Referenztext 1
string		      $reference_text_2  	Referenztext 2
string            $notes                Notizen

string      	  $user12               Benutzerdefiniertes Feld Nr. 12
string            $user13               Benutzerdefiniertes Feld Nr. 13
   :                 :                            :
string            $user80               Benutzerdefiniertes Feld Nr. 80 

Beispiel:

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



1.3. changePayment

(Version >= 4.0.9357)

Syntax:

int changePayment(int $payment_id, array $crm_payment_item)

Beschreibung:

Gibt bei Erfolg "1" zurück.

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

crmPaymentItem ist ein assoziatives Array.

Eigenschaften: sind die selben wie für addPaymentToInvoice

Beispiel:

<?php
 
try {
	$data	= array(
		'posting_account_in'	=> '100002',
		'posting_account_out'	=> '100003'
	);
	$res	= $api->changePayment($payment_id, $data);
}
catch (CRMException $e) {
	echo $e->getMessage();
}
 
echo $res;



1.4. searchPayments

(Version >= 4.1)

Syntax:

array searchPayments(array $search_params)

Beschreibung:

Sucht nach Zahlungen anhand der übergebenen Suchparameter. Gibt bei Erfolg ein Array mit Zahlungen zurück.

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

search_params kann ein assoziatives Array oder ein Objekt sein.

Eigenschaften:

Type(Length)      Eigenschaft          Beschreibung
-------------------------------------------------------------------
string            $search		        Suchbegriff
string		      $realnumber_activity	Belegnummer-ID
int		          $client_account_id	Rechungskonto
int		          $id			        nach ID $id suchen
int		          $id_from		        alle Zahlungen ab ID $id_from suchen
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

Eigenschaften des zurückgegebenen Array

Type(Length)      Eigenschaft          Beschreibung
-------------------------------------------------------------------
int		      $id			          ID des Datensatzes
int		      $cid			          Kontakt-ID
int		      $client_account_id	  Rechnungskonto-ID
string		  $realnumber		      Belegnummer
string		  $realnumber_activity	  Belegnummer-ID
double		  $amount		          Umsatz
int		      $date			          Datum als Unit-Zeitstempel
string		  $text			          Buchungstext
string		  $reference_text_1	      Referenztext 1
string		  $reference_text_2	      Referenztext 2

Beispiel:

<?php
 
try {    
	$searchPaymentsParams	= array('search'  => "reference_text_1 LIKE '%Rechnung API-Test 1%'");
	$results				= $client_payments->searchPayments($searchPaymentsParams);
}
catch (CRMException $e) {
	echo $e->getMessage();
}
 
foreach($results as $result) {
	foreach($result as $key => $val) {
		echo "$key => $val<br>\n";
	}
}
echo "<hr/>";



1.5. getIdByExtId

(Version >= 4.2)

Syntax:

array getIdByExtId( string $external_id )

Beschreibung

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

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

Eigenschaften des zurückgegebenen payment ids array:

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

Beispiel:

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



1.6. getAllExtIds

(Version >= 4.2)

Syntax:

array getAllExtIds()

Beschreibung

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

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

Eigenschaften des zurückgegebenen payment ids array:

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

Beispiel:

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