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

Bitte beachten Sie, dass seit TecArt Version 4.10 und aufwärts der SOAP Webservice nicht mehr weiterentwickelt wird. Ab der TecArt Version 5.1 ist der SOAP Webservice nicht mehr unterstützt.

Please note: with the release of TecArt version 4.10 onwards SOAP Webservice will no longer be updated or expanded. With the release of TecArt version 5.1, the soap webservice will be deprecated.

1. WSDL-URI

http://hostname/dirname/soap/index.php?op=bookingrecords&wsdl

z.B. https://test.tecart-system.de/soap/index.php?op=bookingrecords&wsdl

2. Methods

2.1. crmAddBookingRecord

(Version >= 4.1)

Syntax:

int crmAddBookingRecord( string $session_id, $crmBookingRecordItem)

Beschreibung:

Erzeugt eine neue Buchung im Buchungsjournal. Gibt im Erfolgsfall die ID des Datensatzes zurück.

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

crmBookingRecordItem kann ein assoziatives Array oder ein Objekt sein.

Eigenschaften:

Type(Length)      Eigenschaft          Beschreibung
-------------------------------------------------------------------
int               $payment_id          ID der Zahlung, zu der Buchungssatz zugewiesen werden soll
string            $realnumber          Belegnummer
string            $realnumber_activity Belegnummer-ID
string            $account_in          Gegenkonto
string            $account_out         Buchungskonto
string            $description         Beschreibung
string            $notes               Notizen
double            $amount              Umsatz
double            $tax                 Steuer
double            $amount_brutto       Betrag
int               $tstamp              Datum als Unix-Timestamp
int               $ext_id              Externe ID ( ab Version 4.2 )

Beispiel:

<?php
 
ini_set("soap.wsdl_cache_enabled", "0");
 
try {
  $client_logon = new SOAPClient("https://test.tecart-system.de/soap/index.php?op=logon&wsdl");
     $session_id = $client_logon->crmLogin('test', 'test');
     if (!$session_id) die("invalid login");
   
     $client_booking_records = new SOAPClient("https://test.tecart-system.de/soap/index.php?op=bookingrecords&wsdl");
   
     $data = array(
  'payment_id'    => 1000,
  'realnumber'    => 100000,
  'realnumber_activity' => 1000,
  'account_in'    => '100000',
  'account_out'   => '100001',
  'description'   => 'API-Test',
  'notes'     => 'API-Test',
  'amount'    => 100,
  'tax'     => 19,
  'amount_brutto'   => 119,
  'tstamp'    => time()
  );
   
     $booking_record_id = $client_booking_records->crmAddBookingRecord($session_id, $data);
 
   echo $booking_record_id;
}
catch (SOAPFault $f) {
  print $f->faultstring;
}



2.2. crmChangeBookingRecord

(Version >= 4.1)

Syntax:

int crmChangeBookingRecord( string $session_id, int $booking_record_id, $crmBookingRecordItem)

Beschreibung:

Aktualisiert eine die Buchung mit der übergebenen ID anhand der übergebenen Daten.

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

crmBookingRecordItem kann ein assoziatives Array oder ein Objekt sein.

Eigenschaften:

Eigenschaften: sind die selben wie für crmAddBookingRecord

Beispiel:

<?php
 
try {
  $data = array('notes' => 'Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.');
   
     echo $client_booking_records->crmChangeBookingRecord($session_id, $booking_record_id, $data);
}
catch (SOAPFault $f) {
  print $f->faultstring;
}

2.3. crmDeleteBookingRecord

(Version >= 4.1)

Syntax:

int crmDeleteBookingRecord( string $session_id, int $booking_record_id)

Beschreibung:

Löscht die Buchung mit der übergebenen ID aus dem Buchungsjournal. Gibt im Erfolgsfall 1 zurück.

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

Beispiel:

<?php
 
try {
  echo $client_booking_records->crmDeleteBookingRecord($session_id, $booking_record_id);
}
catch (SOAPFault $f) {
  print $f->faultstring;
}

2.4. crmSearchBookingRecords

(Version >= 4.1)

Syntax:

array crmSearchBookingRecords( string $session_id, array $search_params)

Beschreibung:

Sucht nach Buchungen anhand der übergebenen Suchparameter. Gibt bei Erfolg ein Array mit Buchungssätzen 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		      $posting_account      Buchungskonto
string		      $realnumber_activity  Belegnummer-ID
string		      $payment_id		    Zahlung-ID
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 der zurückgegebenen Array

Type(Length)      Eigenschaft          Beschreibung
-------------------------------------------------------------------
int               $id                  ID des Datensatzes
int               $payment_id          ID der Zahlung
string            $realnumber          Belegnummer
string            $realnumber_activity Belegnummer-ID
string            $account_in          Gegenkonto
string            $account_out         Buchungskonto
string            $description         Beschreibung
string            $notes               Notizen
double            $amount              Umsatz
double            $tax                 Steuer
double            $amount_brutto       Betrag
int               $tstamp              Datum als Unix-Timestamp          
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

Beispiel:

<?php
 
try {
  $params = array(
  'search'    => "description LIKE '%API-Test%'",
  'payment_id'    => 1000
  );
   
     $results = $client_booking_records->crmSearchBookingRecords($session_id, $params);
}
catch (SOAPFault $f) {
  print $f->faultstring;
}
 
foreach($results as $result) {
  foreach($result as $key => $val) {
         echo "$key => $val<br>  \n";
     }
     echo "<hr/>";
}

2.5. crmGetBookingRecord

(Version >= 4.1)

Syntax:

array crmGetBookingRecord( string $session_id, int $booking_record_id)

Beschreibung:

Gibt den Buchungssatz mit der gewählten ID als Array zurück.

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

Eigenschaften der zurückgegebenen Array

Type(Length)      Eigenschaft          Beschreibung
-------------------------------------------------------------------
int               $id                  ID des Datensatzes
int               $ext_id              Externe ID ( ab Version 4.2 )
int               $payment_id          ID der Zahlung
string            $realnumber          Belegnummer
string            $realnumber_activity Belegnummer-ID
string            $account_in          Gegenkonto
string            $account_out         Buchungskonto
string            $description         Beschreibung
string            $notes               Notizen
double            $amount              Umsatz
double            $tax                 Steuer
double            $amount_brutto       Betrag
int               $tstamp              Datum als Unix-Timestamp          
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

Beispiel:

<?php
 
try {
  $results = $client_booking_records->crmGetBookingRecord($session_id, $booking_record_id);
}
catch (SOAPFault $f) {
  print $f->faultstring;
}
 
foreach($results as $result) {
  foreach($result as $key => $val) {
         echo "$key => $val<br>  \n";
     }
     echo "<hr/>";
}

2.6. crmgetIdByExtId

(Version >= 4.2)

Syntax:

array crmgetIdByExtId( string $session_id, string $external_id )

Beschreibung

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

Eigenschaften der zurückgegebenen booking record Objekte:

Type(Length)            Eigenschaft                  Beschreibung
---------------------------------------------------------------------------------------------
int			            $id			                 Booking record-Id 

Beispiel:

<?php
 
try {
  $result = $client_booking_records->crmgetIdByExtId($session_id, 12345);
}
catch (SOAPFault $f) {
  print $f->faultstring;
}
 
foreach($result as $id) {
   
     echo $id."<br>  ";
}

2.7. crmgetAllExtIds

(Version >= 4.2 )

Syntax:

array crmgetAllExtIds( string $session_id )

Beschreibung

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

Eigenschaften der zurückgegebenen booking record Objekte:

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

Beispiel:

<?php
 
try { 
  $result = $client_booking_records->crmgetAllExtIds($session_id);
}
catch (SOAPFault $f) {
  print $f->faultstring;
}
 
foreach($result as $id) {
   
     echo $id."<br>  ";
}
  • No labels