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

1.1. add

Syntax:

int add( array $invoice_data )

Eigenschaften von $invoice_data:

Typ(Länge)        Eigenschaft           Beschreibung
--------------------------------------------------------------------------------------------------------
string            realnumber            Rechnungsnummer (optional, wird automatisch vergeben, wenn leer)
string            cid                   Contact-Id (Format: Contact-Id:Person-Id;Contact-Id2:Person-Id2;...)
int               client_account_id     Rechnungskonto-ID
int               contract_id           Vertrags-ID
int               project_id            Projekt-ID
int               ext_id                Externe ID ( ab Version 4.2 )
string            name                  Name der Rechnung (optional, wird automatisch ausgefüllt, wenn leer)
timestamp         date                  Rechnungsdatum
int               payment_target        Index (bzw. Zeitraum in Tagen) für das Zahlungsziel
timestamp         payment_appointed     Alternative Angabe des Zahlungsziels
int               skonto                Skonto in %
int               skontodays            Index (bzw. Zeitraum in Tagen) Skonto
timestamp         skonto_appointed      Alternative Angabe des Skontoziels
string            discount              Rabatt auf die Gesamtrechnung (in Prozent oder Absolut)
string            fees                  Rechnungsgebühren
bool              is_deposit            Abschlagsrechnung
string            notes                 Notizen
int               serie
int               intrval
timestamp         serieend

Beschreibung: Der Rückgabewert ist die ID der angelegten Rechnung. Im Fehlerfall wird eine CRMException geworfen.


1.2. addArticleToList

Syntax:

boolean addArticleToList( int $object_id, int $article_id )

Beschreibung: Fügt den existierenden Artikel mit ID $article_id der Artikelliste hinzu. Gibt true zurück, wenn der Artikel hinzugefügt werden konnte. Im Fehlerfall wird eine CRMException geworfen.


1.3. addGrouplineToList

Syntax:

int addGrouplineToList( int $object_id, array $group_data )

Eigenschaften von$group_data:

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 )

Beschreibung: Fügt der Artikelliste eine Gruppenzeile hinzu. Gibt true zurück, wenn die Gruppenzeile hinzugefügt werden konnte. Im Fehlerfall wird eine CRMException geworfen.


1.4. addMultipleToList

Syntax:

int addMultipleToList( int $object_id, array $article_data )

Eigenschaften von$article_data: $article_data ist eine Liste von Artikeln, die hinzugefügt werden sollen. Die Unterscheidung erfolgt über das Feld "type". Es wird für jeden Typ die entsprechende API-Funktion verwendet. Typen: article, groupline, text, special

Beschreibung: Fügt der Artikelliste mehrere Artikel und Texte und Gruppenzeilen hinzu. Gibt true zurück, wenn die Zeilen hinzugefügt werden konnten. Im Fehlerfall wird eine CRMException geworfen.


1.5. addSpecialToList

Syntax:

int addSpecialToList( int $object_id, array $object_data )

Eigenschaften von$object_data:

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 )

Beschreibung: Fügt der Artikelliste eine Sonderartikel hinzu. Gibt true zurück, wenn der Sonderartikel hinzugefügt werden konnte. Im Fehlerfall wird eine CRMException geworfen.


1.6. addTextToList

Syntax:

int addTextToList( int $object_id, string $text )

Beschreibung: Fügt der Artikelliste eine Textzeile hinzu. Gibt true zurück, wenn die Textzeile hinzugefügt werden konnte. Im Fehlerfall wird eine CRMException geworfen.


1.7. change

Syntax:

int change( int $object_id, array $object_data )

$object_data siehe add()

Beschreibung: Überschreibt die Rechnung mit ID $object_id mit den Daten aus $object_data. Gibt die Rechungs-ID zurück bei Erfolg. Im Fehlerfall wird eine CRMException geworfen.


1.8. changeArticleInList

Syntax:

int changeArticleInList( int $object_id, $position, $object_data )

Beschreibung: Überschreibt den Artikel an Position $position in der Artikelliste der Rechnung $object_id mit den Daten aus $object_data. Gibt true zurück bei Erfolg. Im Fehlerfall wird eine CRMException geworfen.


1.9. delete

Syntax:

int delete( int $object_id )

Beschreibung: Löscht eine Rechnung.


1.10. duplicate

Syntax:

int duplicate( int $object_id, array $article_list_ids = false)

Beschreibung:

Erzeugt ein Duplikat aus einer Rechnung und gibt im Erfolgsfall die ID des Duplikats zurück.

Im Falle eines Fehlers wird FALSE zurückgegeben.

article_list_ids ist ein Array von Artikel-IDs aus der Rechnung. (optional)


1.11. get

Syntax:

int get(int $object_id, boolean $format = false)

Beschreibung: Liefert die Daten zu einer Rechnung. Ist $format true, werden die Daten entsprechend den Feldeinstellungen formatiert.


1.12. getAllExtIds

(Version >= 4.2)

Syntax:

array getAllExtIds( string $external_id )

Beschreibung

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

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

Eigenschaften des zurückgegebenen invoice ids array:

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

Beispiel:

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



1.13. getArticles

Syntax:

int getArticle( int $object_id )

Beschreibung: Zurückgegeben wird die Stückliste der Rechnung.


1.14. getDuplicatecheckConfig

(Version >= 4.4)

Syntax:

array | string CRMException message getDuplicatecheckConfig( )

Beschreibung:

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.

Beispiel:

<?php
 
try { 
    $api    = crmapi::invoices();
    $fields = $api->getDuplicatecheckConfig();
}
catch (CRMException $e) {
    echo $e->getMessage();
}
 
echo print_r($fields, true);



1.15. getFlowStatus

Syntax:

int getFlowStatus( int $object_id )

Beschreibung: Liefert den aktuellen Bearbeitungsstand.


1.16. getIdByExtId

(Version >= 4.2)

Syntax:

array getIdByExtId( string $external_id ) 

Beschreibung

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

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

Eigenschaften des zurückgegebenen invoice ids array:

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

Beispiel:

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



1.17. gotoNextFlowStatus

Syntax:

int gotoNextFlowStatus( int $object_id )

Beschreibung: Überführt die Rechnung in den nächsten Bearbeitungsstand


1.18. removeArticleFromList

Syntax:

int removeArticle( int $object_id, int $article_id )

Beschreibung: Löscht den Artikel mit ID $article_id aus der Artikelliste der Rechnung mit ID $object_id.


1.19. reverse

Syntax:

int reverse( int $object_id, bool $create_voucher = false, array $article_list_ids = false, bool $negate = false)

Beschreibung:

Storniert eine Rechnung und gibt im Erfolgsfall die ID der Rechnungskorrektur zurück.

Im Falle eines Fehlers wird FALSE zurückgegeben.

create_voucher ist ein bool-Wert, über den die automatisch eine Gutschrift erzeugen lassen können. (optional)

article_list_ids ist ein Array von Artikel-IDs aus der Rechnung. (optional)

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


1.20. searchArticles

Syntax:

int add( array $parameter )

Eigenschaften von $parameter:

Typ         Eigenschaft           Beschreibung
---------------------------------------------------------------------------------------------
string      search                Suchbegriff
int         client_account_id     ID vom Rechnungskonto
bool        is_payed              Zahlstatus
timestamp   payment_appointed     Zahlungsziel (0:00 Uhr des jeweiligen Tages)
int         flow_status           aktueller Bearbeitungsstand
int         flow_status_not       Nicht in diesem Bearbeitungsstand
timestamp   changed_since         Geändert seit
timestamp   changed_until         Geändert vor
bool        outdated              Zahlungsziel abgelaufen
int         contract_id           Vertrags-ID

int         count
int         offset
string      sorting

Beschreibung: Sucht innerhalb der Rechnungen.


1.21. setDuplicatecheckConfig

(Version >= 4.4)

Syntax:

boolean|string CRMException message setDuplicatecheckConfig( [array( [string <fieldname>, string <fieldname>...]) | NULL] )

Beschreibung:

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.

Beispiel:

<?php
 
try {   
    $api     = crmapi::invoices();
    $fields  = array('mandator_id', 'name');
    // adding an invoice will execute an exists-check looking for identical values in fields "mandator_id" and "name" 
    // and will result in an "object already exists" trigger
    $success = $api->setDuplicatecheckConfig($fields);
}
catch (CRMException $e) {
    echo $e->getMessage();
}
 
echo ($success === true ? 'override successful' : $success);



1.22. toAdmonition

Syntax:

int toAdmonition( int $object_id )

Beschreibung: Erzeugt aus der Rechnung eine Mahnung. Zurückgegeben wird die ID der Mahnung.


1.23. toDelivery

Syntax:

int toDelivery( int $object_id, array $article_list_ids = array())

Beschreibung: Erzeugt aus der Rechnung einen Lieferschein. Zurückgegeben wird die ID des Lieferscheins. Wird $article_list_ids verwendet, werden nur diese Artikel aus der Artikelliste übernommen.


1.24. unlock

Syntax:

int unlock( int $object_id )

Beschreibung: Gibt eine Rechnung zur Bearbeitung frei.


  • No labels