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

(Version >= 4.5.16915)

Syntax:

int addCashJournal(array $journal)

Beschreibung:

Erzeugt ein neues Kassenbuch. Gibt im Erfolgsfall die ID des Datensatzes zurück. Benötigt Administrator-Rechte!

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

$journal muss ein assoziatives Array sein.

Eigenschaften:

Type(Length)      Eigenschaft           Beschreibung
--------------------------------------------------------------------
int               $start                Start der Kassenbuch-Nummern im angegebenen Nummernkreis
string            $name                 Name des Kassenbuches
string            $description          Beschreibung des Kassenbuches
int               $booking_account      Buchungskonto des Kassenbuches
int               $numberrange          Nummernkreis des Kassenbuches
string            $default_print_layout Standard-Druckvorlage
int               $mandator_id          Mandant (0 für Standard-Mandant)
array             $allow_grp            Gruppen-IDs, welche Zugriff auf das Kassenbuch erhalten (-1 = Keine, 0 = "Alle") 

Beispiel:

<?php
 
try {
    $api = crmapi::cash_journals();
 
    $journal = array(
		'name'                 => 'Kassenbuch #1',
        'start'                => 1,
        'description'          => 'Dies ist ein Test-Kassenbuch!',
        'booking_account'      => '100001',
        'numberrange'          => '10000'
    );
 
    $id = $api->addCashJournal($journal);
}
catch (CRMException $e) {
    echo $e->getMessage();
}
 
echo "Journal id: $id<br>";



1.2. changeCashJournal

(Version >= 4.5.16915)

Syntax:

int changeCashJournal($journal_id, array $journal)

Beschreibung:

Ändert Eigenschaften des Kassenbuches mit der übergebenen ID. Gibt im Erfolgsfall true zurück. Benötigt Administrator-Rechte!

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

$journal muss ein assoziatives Array sein. Die Eigenschaften entsprechen denen von addCashJournal

Beispiel:

<?php
 
try {
	$journal = array('start' => 1000);
 
    $success = $api->changeCashJournal($id, $journal);
}
catch (CRMException $e) {
    echo $e->getMessage();
}
 
echo "Success: $success<br>";



1.3. deleteCashJournal

(Version >= 4.5.16915)

Syntax:

int deleteCashJournal($journal_id)

Beschreibung:

Löscht das Kassenbuches mit der übergebenen ID. Gibt im Erfolgsfall true zurück. Benötigt Administrator-Rechte!

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

Ein Kassenbuch kann nur gelöscht werden, solange keine Einträge enthalten.

Beispiel:

<?php
 
try {
    $success = $api->deleteCashJournal($id);
}
catch (CRMException $e) {
    echo $e->getMessage();
}
 
echo "Success: $success<br>";



1.4. getCashJournal

(Version >= 4.5.16915)

Syntax:

array getCashJournal($journal_id)

Beschreibung:

Liefert die Daten das Kassenbuches mit der übergebenen ID als array zurück.

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

Eigenschaften:

Type(Length)      Eigenschaft           Beschreibung
--------------------------------------------------------------------
int               $id                	ID des Kassenbuches
int               $start                Start der Kassenbuch-Nummern im angegebenen Nummernkreis
string            $name                 Name des Kassenbuches
string            $description          Beschreibung des Kassenbuches
int               $booking_account      Buchungskonto des Kassenbuches
int               $numberrange          Nummernkreis des Kassenbuches
string            $default_print_layout Standard-Druckvorlage
int               $mandator_id          Mandant (0 für Standard-Mandant)
float		  $saldo		Aktueller Saldo des Kassenbuches

Beispiel:

<?php
 
try {
    $journal = $api->getCashJournal($id);
}
catch (CRMException $e) {
    echo $e->getMessage();
}
 
foreach($journal as $key => $value) {
    echo "{$key}: {$value}<br>  ";
}



1.5. getCashJournals

(Version >= 4.5.16915)

Syntax:

array getCashJournals(array $mandators)

Beschreibung:

Liefert die Kassenbücher für die in $mandators angegebenen Mandaten zurück. Wird ein leeres Array übergeben, so werden alle Kassenbücher zurückgeliefert.

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

Eigenschaften:

Type(Length)      Eigenschaft           Beschreibung
--------------------------------------------------------------------
int               $start                Start der Kassenbuch-Nummern im angegebenen Nummernkreis
string            $name                 Name des Kassenbuches
string            $description          Beschreibung des Kassenbuches
int               $booking_account      Buchungskonto des Kassenbuches
int               $numberrange          Nummernkreis des Kassenbuches
int               $mandator_id          Mandant (0 für Standard-Mandant)

Beispiel:

<?php
 
try {
    $journals = $api->getCashJournals(array());
}
catch (CRMException $e) {
    echo $e->getMessage();
}
 
foreach($journals as $id => $journal) {
   
    echo "Journal-ID: {$id}";
   
    foreach($journal as $key => $value) {
        echo "{$key}: {$value}<br>  ";
    } 
}



1.6. addEntry

(Version >= 4.5.16915)

Syntax:

int addEntry(array $entry)

Beschreibung:

Fügt einen neuen Eintrag das Kassenbuch mit der übergebenen ID ein. Gibt im Erfolgsfall die ID des Datensatzes zurück.

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

$entry muss ein assoziatives Array sein.

Eigenschaften:

Type(Length)      Eigenschaft           Beschreibung
--------------------------------------------------------------------
int               $cash_journal_id      Kassenbuch-ID
int               $date                 Timestamp des Eintrags-Datums
string            $realnumber           Belegnummer
string            $description		Kurzbeschreibung des Eintrages
string            $notes                Zusätzliche Notizen zum EIntrag
int               $tax_rate             Steuerrate
float             $tax          	enthaltene Steuer
float             $amount_in          	Eingang
float             $amount_out          	Ausgang
string(255)       $user20               Benutzerdefiniertes Feld Nr. 28
   :                 :                          :
string(255)       $userN                Benutzerdefiniertes Feld Nr. N

Beispiel:

<?php
 
try {
    $api = crmapi::cash_journals();
 
    $entry = array(
        'name'                 => 'Kassenbuch #1',
        'start'                => 1,
        'description'          => 'Dies ist ein Test-Kassenbuch!',
        'booking_account'      => '100001',
        'numberrange'          => '10000'
    );
 
    $entry_id = $api->addEntry($entry);
}
catch (CRMException $e) {
    echo $e->getMessage();
}
 
echo "Entry id: $entry_id<br>";
 



1.7. deleteEntry

(Version >= 4.5.16915)

Syntax:

int deleteEntry($entry_id)

Beschreibung:

Setzt des Kassenbuch-Eintrag mit der übergebenen ID auf "gelöscht". Gibt im Erfolgsfall true zurück.

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

Beispiel:

<?php
 
try {
    $id = $api->deleteEntry($entry_id);
}
catch (CRMException $e) {
	echo $e->getMessage();
}
 
echo "Entry id: $id<br>";



1.8. getEntry

(Version >= 4.5.16915)

Syntax:

int getEntry($entry_id)

Beschreibung:

Liefert die Daten des Kassenbuch-Eintrag mit der übergebenen ID als array zurück.

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

Eigenschaften:

Type(Length)      Eigenschaft           Beschreibung
--------------------------------------------------------------------
int               $cash_journal_id      Kassenbuch-ID
int               $mandator_id          Mandant
int               $date                 Timestamp des Eintrags-Datums
int               $tax_rate             Steuerrate
int               $deleted              Flag ob Eintrag gelöscht wurde
string            $realnumber           Belegnummer
string            $description		Kurzbeschreibung des Eintrages
string            $notes                Zusätzliche Notizen zum EIntrag
float             $tax          	enthaltene Steuer
float             $amount_in          	Eingang
float             $amount_out          	Ausgang
int               $createuser           Benutzer-ID des Erstellers
int               $createtime           Zeitpunkt der Erstellung
int               $chguser              Benutzer-ID der letzten Änderung
int               $chgtime              Zeitpunkt der letzten Änderung
string            $user20               Benutzerdefiniertes Feld Nr. 28
   :                 :                          :
string            $userN                Benutzerdefiniertes Feld Nr. N

Beispiel:

<?php
 
try {
    $entry = $api->getEntry($entry_id);
}
catch (CRMException $e) {
    echo $e->getMessage();
}
 
foreach($entry as $key => $value) {
    echo "{$key}: {$value}<br>  ";
}



1.9. searchEntries

(Version >= 4.5.16915)

Syntax:

int searchEntries($journal_id, array $search)

Beschreibung:

Liefert Einträge aus Kassenbuch mit der übergebenen ID zurück, welche via $search noch zusätzlich eingeschränkt werden können.

Die Eigenschaften entsprechen denen von getEntry

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

$search ist ein assoziatives Array und kann folgende Parameter enthalten:

$search Suchbegriff, nach dem zusätzlich gefiltert werden soll (optional, Default = )

$mandator Mandanten-ID, nach der gefiltert werden soll (optional, Default = 0)

$id_from Start-ID, aber welcher gefiltert werden sollen (optional, Default = 0)

$count maximale Anzahl an Elementen, welche zurückgegeben werden sollen (optional, Default = 5000)

$offset Anzahl-Offset (optional, Default = 0)

$sorting Sortiert-Reihenfolge der Rückgabe (optional, Default = )

Beispiel:

<?php
 
try {
    $entries = $api->searchEntries($entry_id, array());
}
catch (CRMException $e) {
    echo $e->getMessage();
}
 
foreach($entries as $id => $entry) {
   
    echo "Entry-ID: {$id}";
   
    foreach($entry as $key => $value) {
        echo "{$key}: {$value}<br>  ";
    } 
}
  • No labels