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

API Klassen und deren Funktionen können nur mit TecArt-System Version >= 3.2 genutzt werden.

Für die Benutzung benötigen Sie Zugriff auf folgende Module:

  • Artikelverwaltung

1. Methoden

1.1. add

Syntax:

int add(array $object_data)

Beschreibung:

Fügt einen neuen Artikel zur Artikelverwaltung hinzu.

Im Fehlerfall wird eine CRMException geworfen.

Parameter:

$object_data: Daten des Artikels

Rückgabe:

Die ID des angelegten Artikels

Eigenschaften von $object_data:

TypEigenschaftBeschreibung
stringnameBezeichnung des Artikels
intrealnumberArtikelnummer (optional)
doubleprice_purchaseEinkaufspreis
doubleprice_nettoNetto-Preis
inttax_rateSteuersatz-Index
intarticlegroupWarengruppe-ID
intvendorKontakt-ID des Lieferanten
boolpartslistIst ein Stücklistenartikel?
boolautopriceWenn Stücklistenartikel, dann automatische Preisberechnung
intbilling_intervalAbrechnungszeitraum-Index
intposting_account_sourceQuelle zur Ermittlung der Buchungskonten (0=Steuersatz, 1=Warengruppe, 2=Artikel)
stringposting_account_revenueWenn posting_account_source=2: Buchungskonto für Umsatz
stringposting_account_shipment_egWenn posting_account_source=2: Buchungskonto für Lieferung in die EG ohne UstID
stringposting_account_shipment_eg_ustidWenn posting_account_source=2: Buchungskonto für Lieferung in die EG mit UstID
stringposting_account_shipment_foreignWenn posting_account_source=2: Buchungskonto für Lieferung in die Nicht-EG
stringposting_account_purchaseWenn posting_account_source=2: Buchungskonto für Einkauf Inland
stringposting_account_purchase_egWenn posting_account_source=2: Buchungskonto für Einkauf EG ohne UstID
stringposting_account_purchase_eg_ustidWenn posting_account_source=2: Buchungskonto für Einkauf EG mit UstID
stringposting_account_purchase_foreignWenn posting_account_source=2: Buchungskonto für Einkauf aus Nicht-EG
booldeactivatedArtikel deaktiviert
stringnotesNotizen
intext_idExterne ID ( ab Version 4.2 )
booluse_pricesVerwendet die Preisverwaltung?
booluse_vendorsVerwendet Lieferanten?
boolis_vendor_articleIst ein Lieferanten-Artikel?
intpackaging_unitPackungseinheit
intpackaging_sizePackungsgröße
stringeanEAN
stringupcUPC


Beispiel:

<?php
 
require_once '/var/www/crm/class/api/crmapi.php';
 
try {
	//Bitte hier Ihre Zugangsdaten eintragen
	crmapi::logon()->Login('root', 'root');
} 
catch (CRMException $e) {
    die($e->getMessage());
}
 
try {
	$data = array(
		'name'        => 'Demoartikel',
		'realnumber'  => '1',
		'price_netto' => 10,
		'tax_rate'    => 0
	);
 
	$api    = crmapi::articles();
	$result = $api->add($data);
 
	echo $result."<br/>";
}
catch (CRMException $e) {
	echo $e->getMessage();
}



1.2. addArticleToList

Syntax:

boolean addArticleToList(int $oid, int $art_id, boolean $hidden = false)

Beschreibung:

Fügt den existierenden Artikel mit ID $article_id der Artikelliste eines Beleges oder Artikels hinzu.

Handelt es sich bei der Artikelliste um einen Stückliste zu einem Artikel, muss die Option entsprechend aktiviert sein.

Im Fehlerfall wird eine CRMException geworfen.

Parameter:

$oid: ID des Beleges

$art_id: ID des Artikels

$hidden: Artikel in der Artikelliste anzeigen (True=nein)

Rückgabe:

True, wenn erfolgreich

Beispiel:

<?php
 
require_once '/var/www/crm/class/api/crmapi.php';
 
try {
    //Bitte hier Ihre Zugangsdaten eintragen
    crmapi::logon()->Login('root', 'root');
}
catch (CRMException $e) {
    die($e->getMessage());
}
 
try {
	$api    = crmapi::invoices(); //Set your desired receipt class here
	$result = $api->addArticleToList(5, 2);
	echo $result; //Should be 1
}
catch (CRMException $e) {
	echo $e->getMessage();
}



1.3. addDescription

Syntax:

boolean|int addDescription(int $article_id, string $lang, string $short, string $long)

Beschreibung:

Fügt einen Beschreibungstext zu dem Artikel hinzu.

Im Fehlerfall wird eine CRMException geworfen.

Parameter:

$article_id: ID des Artikels

$lang: ISO2-Sprachbezeichner (z.B. 'de')

$short: Kurzbeschreibung

$long: Langbeschreibung

Rückgabe:

WertBedeutung
trueSpeichern erfolgreich
falseArtikel nicht gefunden
-1Sprache nicht erkannt
-3Beschreibung existiert bereits


Beispiel:

<?php
 
require_once '/var/www/crm/class/api/crmapi.php';
 
try {
    //Bitte hier Ihre Zugangsdaten eintragen
    crmapi::logon()->Login('root', 'root');
}
catch (CRMException $e) {
    die($e->getMessage());
}
 
try {
	$api    = crmapi::articles();
	$result = $api->addDescription(5, 'de', 'Kurzbezeichnung', 'Langbezeichnung');
 
	echo $result; //Should be 1
}
catch (CRMException $e) {
	echo $e->getMessage();
}



1.4. addGrouplineToList

Syntax:

boolean addGrouplineToList(int $oid, int $data, boolean $hidden = false)

Beschreibung:

Fügt eine Gruppenzeile der Artikelliste eines Beleges oder Artikels hinzu.

Handelt es sich bei der Artikelliste um einen Stückliste zu einem Artikel, muss die Option entsprechend aktiviert sein.

Im Fehlerfall wird eine CRMException geworfen.

Parameter:

$oid: ID des Beleges

$data: Daten der Gruppenzeile

$hidden: Artikel in der Artikelliste anzeigen (True=nein)

Rückgabe:

True, wenn erfolgreich

Eigenschaften von $data:

TypEigenschaftBeschreibung
floatquantityMenge
stringtextBezeichnung
inttaxrateSteuersatz-Index
doublediscountRabatt
intintervalAbrechnungszeitraum-Index
booloptionalOptional
stringdescriptionBeschreibung


Beispiel:

<?php
 
require_once '/var/www/crm/class/api/crmapi.php';
 
try {
    //Bitte hier Ihre Zugangsdaten eintragen
    crmapi::logon()->Login('root', 'root');
}
catch (CRMException $e) {
    die($e->getMessage());
}
 
try {
	$data = array(
		'quantity'    => 1,
		'name'        => 'Gruppe',
		'taxrate'     => 0,
	);
 
	$api    = crmapi::invoices(); //Set your desired receipt class here
	$result = $api->addGrouplineToList(5, $data);
	echo $result; //Should be 1
}
catch (CRMException $e) {
	echo $e->getMessage();
}



1.5. addMultipleToList

Syntax:

bool addMultipleToList(int $oid, array $articles)

Beschreibung:

Fügt der Artikelliste eines Beleges oder Artikels mehrere Artikel, Texte und Gruppenzeilen hinzu.

Im Fehlerfall wird eine CRMException geworfen.

Parameter:

$oid: ID des Vorgangs

$articles: Die Artikeldaten

Rückgabe:

True, wenn erfolgreich

Eigenschaften von $articles:

$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

Beispiel:

<?php
 
require_once '/var/www/crm/class/api/crmapi.php';
 
try {
    //Bitte hier Ihre Zugangsdaten eintragen
    crmapi::logon()->Login('root', 'root');
}
catch (CRMException $e) {
    die($e->getMessage());
}



1.6. addSpecialToList

Syntax:

boolean addSpecialToList(int $oid, int $data, boolean $hidden = false)

Beschreibung:

Fügt einen Sonderposten der Artikelliste eines Beleges oder Artikels hinzu.

Handelt es sich bei der Artikelliste um einen Stückliste zu einem Artikel, muss die Option entsprechend aktiviert sein.

Im Fehlerfall wird eine CRMException geworfen.

Parameter:

$oid: ID des Beleges

$data: Daten des Sonderpostens

$hidden: Artikel in der Artikelliste anzeigen (True=nein)

Rückgabe:

True, wenn erfolgreich

Eigenschaften von $data:

TypEigenschaftBeschreibung
floatquantityMenge
stringrealnumberArtikelnummer
stringnameBezeichnung
inttaxrateSteuersatz-Index
doublediscountRabatt
intintervalAbrechnungszeitraum-Index
stringdescriptionBeschreibung
intext_idExterne ID ( ab Version 4.2 )
floatprice_nettoNetto-Preis (alternativ zu Brutto-Preis)
floatprice_bruttoBrutto-Preis (alternativ zu Netto-Preis)
boolprintDrucken
stringext_dataExterne Daten
floatprice_netto_origOriginal-Preis Netto
floatprice_purchaseEinkaufspreis
intintervalAbrechnungsinterval
booloptionalOptional?
stringnotesNotizen


Beispiel:

<?php
 
require_once '/var/www/crm/class/api/crmapi.php';
 
try {
    //Bitte hier Ihre Zugangsdaten eintragen
    crmapi::logon()->Login('root', 'root');
}
catch (CRMException $e) {
    die($e->getMessage());
}
 
try {
	$data = array(
		'quantity'    => 1,
		'name'        => 'Sonderposten',
		'taxrate'     => 0,
		'price_netto' => 10
	);
 
	$api    = crmapi::invoices(); //Set your desired receipt class here
	$result = $api->addSpecialToList(5, $data);
	echo $result; //Should be 1
}
catch (CRMException $e) {
	echo $e->getMessage();
}



1.7. addTextToList

Syntax:

boolean addTextToList(int $oid, int $text, boolean $hidden = false)

Beschreibung:

Fügt eine Textzeile der Artikelliste eines Beleges oder Artikels hinzu.

Handelt es sich bei der Artikelliste um einen Stückliste zu einem Artikel, muss die Option entsprechend aktiviert sein.

Im Fehlerfall wird eine CRMException geworfen.

Parameter:

$oid: ID des Beleges

$text: Text

$hidden: Text in der Artikelliste anzeigen (True=nein)

Rückgabe:

True, wenn erfolgreich

Beispiel:

<?php
 
require_once '/var/www/crm/class/api/crmapi.php';
 
try {
    //Bitte hier Ihre Zugangsdaten eintragen
    crmapi::logon()->Login('root', 'root');
}
catch (CRMException $e) {
    die($e->getMessage());
}
 
try {
	$api    = crmapi::invoices(); //Set your desired receipt class here
	$result = $api->addTextToList(5, 'Mein Text');
	echo $result; //Should be 1
}
catch (CRMException $e) {
	echo $e->getMessage();
}



1.8. addVariant

Syntax:

int addVariant(int $article_id, array $article)

Beschreibung:

Erstellt zu einem Artikel eine Artikelvariante.

Im Fehlerfall wird eine CRMException geworfen.

Parameter:

$article_id: ID des Artikels

$article: Daten der Variante, siehe add

Rückgabe:

ID der Variante, wenn erfolgreich, sonst false

Beispiel:

<?php
 
require_once '/var/www/crm/class/api/crmapi.php';
 
try {
    //Bitte hier Ihre Zugangsdaten eintragen
    crmapi::logon()->Login('root', 'root');
}
catch (CRMException $e) {
    die($e->getMessage());
}
 
try {
	$data   = array(
		'name'        => 'Demoartikel-Variante',
		'realnumber'  => '1',
		'price_netto' => 10,
		'tax_rate'    => 0
	);
 
	$api    = crmapi::articles();
	$result = $api->addVariant(5, $data);
 
	echo $result."<br/>";
}
catch (CRMException $e) {
	echo $e->getMessage();
}



1.9. addVendorArticle

(Version >= V4.7.21419)

Syntax:

int addVendorArticle(int $article_id, array $article)

Beschreibung:

Erstellt zu einem Artikel einen Lieferantenartikel.

Im Fehlerfall wird eine CRMException geworfen.

Parameter:

$article_id: ID des Artikels

$article: Daten des Lieferantenartikels, siehe add

Rückgabe:

ID der Variante, wenn erfolgreich, sonst false

Beispiel:

<?php
 
require_once '/var/www/crm/class/api/crmapi.php';
 
try {
    //Bitte hier Ihre Zugangsdaten eintragen
    crmapi::logon()->Login('root', 'root');
}
catch (CRMException $e) {
    die($e->getMessage());
}
 
try {
	$data = array(
		'name'        => 'Bezugsquelle von Demoartikel',
		'realnumber'  => '1',
		'price_netto' => 10,
		'tax_rate'    => 0
	);
 
	$api    = crmapi::articles();
	$result = $api->addVendorArticle(5, $data);
 
	echo $result."<br/>";
}
catch (CRMException $e) {
	echo $e->getMessage();
}



1.10. change

Syntax:

int change(int $object_id, array $data)

Beschreibung:

Überschreibt den Artikel mit ID $object_id mit den Daten aus $object_data.

Im Fehlerfall wird eine CRMException geworfen.

Parameter:

$object_id: ID des Artikels

$data: Artikeldaten, siehe add

Rückgabe:

Artikel-ID, wenn erfolgreich

Beispiel:

<?php
 
require_once '/var/www/crm/class/api/crmapi.php';
 
try {
    //Bitte hier Ihre Zugangsdaten eintragen
    crmapi::logon()->Login('root', 'root');
}
catch (CRMException $e) {
    die($e->getMessage());
}
 
try {
	$data = array(
		'name'        => 'Demoartikel',
		'realnumber'  => '2',
		'price_netto' => 10,
		'tax_rate'    => 0
	);
 
	$api    = crmapi::articles();
	$result = $api->change(5, $data);
 
	echo $result; //Should be 5
}
catch (CRMException $e) {
	echo $e->getMessage();
}



1.11. changeArticleInList

Syntax:

boolean changeArticleInList(int $oid, int $line_id, int $data, int $ext_id = false)

Beschreibung:

Überschreibt die Zeile mit Posten-ID $line_id in der Artikelliste des Beleges $oid mit den Daten aus $data.

Im Fehlerfall wird eine CRMException geworfen.

Parameter:

$oid: ID des Beleges

$line_id: ID der Zeile in der Artikelliste (nicht in der Artikelverwaltung)

$data: Daten der Zeile

$ext_id: Externe ID des Artikels (alternativ zu $line_id)

Rückgabe:

True, wenn erfolgreich

Eigenschaften von $data:

TypEigenschaftBeschreibung
stringext_id
stringext_data
intposition
floatquantity
stringname
stringtitle
stringdescription
stringrealnumber
floatprice_purchase
floatprice_netto_orig
floatdiscount
floatprice_netto
floatprice_brutto
inttax_rate
intinterval
boolprint
boolprint_all
stringnotes
booloptional


Beispiel:

<?php
 
require_once '/var/www/crm/class/api/crmapi.php';
 
try {
    //Bitte hier Ihre Zugangsdaten eintragen
    crmapi::logon()->Login('root', 'root');
}
catch (CRMException $e) {
    die($e->getMessage());
}
 
try {
	$data = array(
		'quantity'    => 1,
		'name'        => 'Gruppe',
		'taxrate'     => 0,
	);
 
	$api    = crmapi::invoices(); //Set your desired receipt class here
	$result = $api->changeArticleInList(5, 1, $data);
	echo $result; //Should be 1
}
catch (CRMException $e) {
	echo $e->getMessage();
}



1.12. changeDescription

Syntax:

boolean changeDescription(int $article_id, string $lang, string $short, string $long)

Beschreibung:

Ändert einen Beschreibungstext zu einem Artikel

Im Fehlerfall wird eine CRMException geworfen.

Parameter:

$article_id: ID des Artikels

$lang: ISO2-Sprachbezeichner (z.B. 'de')

$short: Langbeschreibung

$long: Long description

Rückgabe:

True, wenn erfolgreich, sonst false

Beispiel:

<?php
 
require_once '/var/www/crm/class/api/crmapi.php';
 
try {
    //Bitte hier Ihre Zugangsdaten eintragen
    crmapi::logon()->Login('root', 'root');
}
catch (CRMException $e) {
    die($e->getMessage());
}
 
try {
	$api    = crmapi::articles();
	$result = $api->changeDescription(5, 'de', 'Kurzbezeichnung Neu', 'Langbezeichnung Neu');
 
	echo $result; //Should be 1
}
catch (CRMException $e) {
	echo $e->getMessage();
}



1.13. delDescription

Syntax:

boolean delDescription(int $article_id, string $lang)

Beschreibung:

Löscht einen Beschreibungstext.

Im Fehlerfall wird eine CRMException geworfen.

Parameter:

$article_id: ID des Artikels

$lang: ISO2-Sprachbezeichner (z.B. 'de')

Rückgabe:

True, wenn erfolgreich, sonst false

Beispiel:

<?php
 
require_once '/var/www/crm/class/api/crmapi.php';
 
try {
    //Bitte hier Ihre Zugangsdaten eintragen
    crmapi::logon()->Login('root', 'root');
}
catch (CRMException $e) {
    die($e->getMessage());
}
 
try {
	$api    = crmapi::articles();
	$result = $api->delDescription(5, 'de');
 
	echo $result; //Should be 1
}
catch (CRMException $e) {
	echo $e->getMessage();
}



1.14. delete

Syntax:

bool delete(int $oid)

Beschreibung:

Löscht einen Artikel.

Im Fehlerfall wird eine CRMException geworfen.

Parameter:

$oid: ID des Artikels

Rückgabe:

True, wenn erfolgreich

Beispiel:

<?php
 
require_once '/var/www/crm/class/api/crmapi.php';
 
try {
    //Bitte hier Ihre Zugangsdaten eintragen
    crmapi::logon()->Login('root', 'root');
}
catch (CRMException $e) {
    die($e->getMessage());
}
 
try {
	$api    = crmapi::articles();
	$result = $api->delete(5);
 
	echo $result; //Should be 1
}
catch (CRMException $e) {
	echo $e->getMessage();
}



1.15. get

Syntax:

array get(int $oid, boolean $format = false)

Beschreibung:

Liefert die Daten zu einem Artikel. Ist $format true, werden die Daten entsprechend den Feldeinstellungen formatiert.

Parameter:

$oid: ID des Artikels

$format: Wenn true, werden die Daten formatiert

Rückgabe:

Die Artikeldaten als Array

TypEigenschaftBeschreibung
intidID des Datensatzes
intparent_idID des Elternartikels
stringrealnumberArtikelnummer
stringnameBezeichnung
inttax_rateSteuersatz
doubletax_valueSteuer-Wert
doubleprice_nettoNetto-Preis
doubleprice_bruttoBrutto-Preis
doubleprice_purchaseEinkaufspreis
intcreateuserErsteller
intcreatetimeErstellungszeitpunkt (timestamp)
intchguserÄnderungsbenutzer
intchgtimeÄnderungszeitpunkt (timestamp)
stringnotesBeschreibung
intmandator_idID des Mandanten
intarticlegroupID der Warengruppe
intvendorID des Hersteller-Kontaktes
boolpartslistStückliste
boolautopricePreis-Berechnung
intbilling_intervalAbrechnungsinterval
booldeactivatedDeaktiviert
stringext_idExterne ID
intprice_precisionPreis-Präzision
stringposting_account_sourceBuchungskonten-Quelle
stringposting_account_revenueBuchungskonto Erlös
stringposting_account_shipment_eg_ustidBuchungskonto EG-Lieferung mit UST-ID
stringposting_account_shipment_egBuchungskonto EG-Lieferung ohne UST-ID
stringposting_account_shipment_foreignBuchungskonto Lieferung Ausland
stringposting_account_purchaseBuchungskonto Erwerb
stringposting_account_purchase_eg_ustidBuchungskonto EG-Erwerb mit UST-ID
stringposting_account_purchase_egBuchungskonto EG-Erwerb ohne UST-ID
stringposting_account_purchase_foreignBuchungskonto Erwerb Ausland


Beispiel:

<?php
 
require_once '/var/www/crm/class/api/crmapi.php';
 
try {
    //Bitte hier Ihre Zugangsdaten eintragen
    crmapi::logon()->Login('root', 'root');
}
catch (CRMException $e) {
    die($e->getMessage());
}
 
try {
	$api    = crmapi::articles();
	$result = $api->get(5);
 
	print_r($result);
}
catch (CRMException $e) {
	echo $e->getMessage();
}



1.16. getAllExtIds

Syntax:

array getAllExtIds()

Beschreibung:

Liefert eine Liste aller externen IDs einer Vorgangsart zurück.

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

Parameter:

Rückgabe:

Liste aller Externen IDs (Key ⇒ interne ID, Value ⇒ externe ID)

Beispiel:

<?php
 
require_once '/var/www/crm/class/api/crmapi.php';
 
try {
    //Bitte hier Ihre Zugangsdaten eintragen
    crmapi::logon()->Login('root', 'root');
}
catch (CRMException $e) {
    die($e->getMessage());
}
 
try {
    $api = crmapi::invoices();
    $result = $api->getAllExtIds();
}
catch (CRMException $e) {
    echo $e->getMessage();
}
 
foreach($result as $key => $id) { 
    echo $key.' => '.$id."<br>  ";
}



1.17. getArticleIds

(Version >= v4.5)

Syntax:

array getArticleIds(int $timestamp)

Beschreibung:

Liefert eine Liste aller IDs von Artikeln zurück, welche seit $timestamp geändert wurden.

Im Fehlerfall wird eine CRMException geworfen.

Parameter:

$timestamp: Zeitstempel der Änderung

Rückgabe:

Liste mit Artikel-IDs

Beispiel:

<?php
 
require_once '/var/www/crm/class/api/crmapi.php';
 
try {
    //Bitte hier Ihre Zugangsdaten eintragen
    crmapi::logon()->Login('root', 'root');
}
catch (CRMException $e) {
    die($e->getMessage());
}
 
try {
    $api = crmapi::articles();
    $result = $api->getArticleIds(1234567);
}
catch (CRMException $e) {
    echo $e->getMessage();
}
 
foreach($result as $id) {
    echo $id."<br>  ";
}
 



1.18. getArticles

Syntax:

array getArticles(int $oid)

Beschreibung:

Liefert alle Posten eines Vorganges

Im Fehlerfall wird eine CRMException geworfen.

Parameter:

$oid: ID des Vorgangs bzw. des Stücklistenartikels

Rückgabe:

Liste aller Posten des Vorgangs (siehe getArticle)

Beispiel:

<?php
 
require_once '/var/www/crm/class/api/crmapi.php';
 
try {
    //Bitte hier Ihre Zugangsdaten eintragen
    crmapi::logon()->Login('root', 'root');
}
catch (CRMException $e) {
    die($e->getMessage());
}
 
try {
	$api    = crmapi::invoices();
	$result = $api->getArticles(5);
 
	print_r($result); //Should be 1
}
catch (CRMException $e) {
	echo $e->getMessage();
}



1.19. getDescription

Syntax:

array|boolean getDescription(int $article_id, string $lang)

Beschreibung:

Lädt eine Beschreibung zu einem Artikel

Im Fehlerfall wird eine CRMException geworfen.

Parameter:

$article_id: ID des Artikels

$lang: ISO2-Sprachbezeichner (z.B. 'de')

Rückgabe:

Die Beschreibung, wenn möglich, sonst false

TypEigenschaftBeschreibung
intidID des Datensatzes
intarticle_idID des Artikels
stringlangcodeISO2-Sprachbezeichner
stringtitleKurzbeschreibung
stringdescriptionLangbeschreibung


Beispiel:

<?php
 
require_once '/var/www/crm/class/api/crmapi.php';
 
try {
    //Bitte hier Ihre Zugangsdaten eintragen
    crmapi::logon()->Login('root', 'root');
}
catch (CRMException $e) {
    die($e->getMessage());
}
 
try {
	$api    = crmapi::articles();
	$result = $api->getDescription(5, 'de');
 
	print_r($result);
}
catch (CRMException $e) {
	echo $e->getMessage();
}

1.20. getDuplicatecheckConfig

Syntax:

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

Parameter:

Rückgabe:

Liste aller aktuell geprüften Felder

Beispiel:

<?php
 
require_once '/var/www/crm/class/api/crmapi.php';
 
try {
    //Bitte hier Ihre Zugangsdaten eintragen
    crmapi::logon()->Login('root', 'root');
}
catch (CRMException $e) {
    die($e->getMessage());
}
 
try {
    $api    = crmapi::invoices();
    $fields = $api->getDuplicatecheckConfig();
}
catch (CRMException $e) {
    echo $e->getMessage();
}
 
echo print_r($fields, true);


1.21. getIdByExtId

Syntax:

int getIdByExtId(string $ext_id)

Beschreibung:

Liefert die interne ID eines Vorgangs mit der übergebenen externen ID zurück.

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

Parameter:

$ext_id: Externe ID des Vorgangs

Rückgabe:

Interne ID des Vorgangs

Beispiel:

<?php
 
require_once '/var/www/crm/class/api/crmapi.php';
 
try {
    //Bitte hier Ihre Zugangsdaten eintragen
    crmapi::logon()->Login('root', 'root');
}
catch (CRMException $e) {
    die($e->getMessage());
}
 
try { 
    $api	= crmapi::invoices();
	$result = $api->getIdByExtId(12345);
}
catch (CRMException $e) {
	echo $e->getMessage();
}
 
foreach($result as $id) {
    echo $id."<br>  ";
}
 


1.22. getVariants

Syntax:

array getVariants(int $article_id)

Beschreibung:

Gibt eine Liste mit den Varianten-Artikeln des Original-Artikels zurück.

Im Fehlerfall wird eine CRMException geworfen.

Parameter:

$article_id: ID des Artikels

Rückgabe:

Liste der Varianten, siehe get

Beispiel:

<?php
 
require_once '/var/www/crm/class/api/crmapi.php';
 
try {
    //Bitte hier Ihre Zugangsdaten eintragen
    crmapi::logon()->Login('root', 'root');
}
catch (CRMException $e) {
    die($e->getMessage());
}
 
try {
	$api    = crmapi::articles();
	$result = $api->getVariants(5);
 
	print_r($result);
}
catch (CRMException $e) {
	echo $e->getMessage();
}


1.23. getVendorArticle

(Version >= V4.7.21419)

Syntax:

array getVendorArticle($vendor_id, boolean $format)

Beschreibung:

Liefert die Daten zu einem Lieferantenartikel. Ist $format true, werden die Daten entsprechend den Feldeinstellungen formatiert.

Im Fehlerfall wird eine CRMException geworfen.

Parameter:

$article_id: Vendor Article ID

$format: Wenn true, werden die Daten formatiert

$oid: ID des Lieferantenartikels

Rückgabe:

Der Lieferanten-Artikel, Daten siehe get

Beispiel:

<?php
 
require_once '/var/www/crm/class/api/crmapi.php';
 
try {
    //Bitte hier Ihre Zugangsdaten eintragen
    crmapi::logon()->Login('root', 'root');
}
catch (CRMException $e) {
    die($e->getMessage());
}
 
try {
	$api    = crmapi::articles();
	$result = $api->getVendor(6);
 
	print_r($result);
}
catch (CRMException $e) {
	echo $e->getMessage();
}



1.24. getVendorArticles

(Version >= V4.7.21419)

Syntax:

array getVendorArticles(int $article_id)

Beschreibung:

Gibt eine Liste mit den Lieferanten-Artikeln des Original-Artikels zurück.

Im Fehlerfall wird eine CRMException geworfen.

Parameter:

$article_id: ID des Artikels

Rückgabe:

Liste der Lieferanten-Artikel, Daten siehe get

Beispiel:

<?php
 
require_once '/var/www/crm/class/api/crmapi.php';
 
try {
    //Bitte hier Ihre Zugangsdaten eintragen
    crmapi::logon()->Login('root', 'root');
}
catch (CRMException $e) {
    die($e->getMessage());
}
 
try {
	$api    = crmapi::articles();
	$result = $api->getVendors(5);
 
	print_r($result);
}
catch (CRMException $e) {
	echo $e->getMessage();
}



1.25. removeArticleFromList

Syntax:

boolean removeArticleFromList(int $oid, int $article_id)

Beshreibung:

Löscht einen Posten aus einem Vorgang bzw. Stücklistenartikel

Im Fehlerfall wird eine CRMException geworfen.

Parameter:

$oid: ID des Vorgangs bzw. Stücklistenartikels

$article_id: ID des Artikelpostens (nicht des Artikels in der Artikelverwaltung)

Rückgabe:

True, wenn erfolgreich

Beispiel:

<?php
 
require_once '/var/www/crm/class/api/crmapi.php';
 
try {
    //Bitte hier Ihre Zugangsdaten eintragen
    crmapi::logon()->Login('root', 'root');
}
catch (CRMException $e) {
    die($e->getMessage());
}
 
try {
	$api    = crmapi::invoices();
	$result = $api->removeItemFromList(1, 3);
 
	echo $result; //Should be 1
}
catch (CRMException $e) {
	echo $e->getMessage();
}
 



1.26. searchArticles

Syntax:

array searchArticles(array $params)

Beschreibung:

Sucht innerhalb der Artikel.

Im Fehlerfall wird eine CRMException geworfen.

Parameter:

$params: Search parameters

Rückgabe:

Eine Liste von gefundenen Artikeln. Die enthaltenen Werte entsprechen denen von get

Eigenschaften von $params:

TypEigenschaftBeschreibung
intcountAnzahl
arrayidsBeschränkung auf bestimmte Artikel
intoffsetStartposition
stringsearchSuchwort
inttax_rateSteuersatz-ID
stringsortingSortierung


Beispiel:

<?php
 
require_once '/var/www/crm/class/api/crmapi.php';
 
try {
    //Bitte hier Ihre Zugangsdaten eintragen
    crmapi::logon()->Login('root', 'root');
}
catch (CRMException $e) {
    die($e->getMessage());
}
 
try {
	$data   = array('search' => 'demo');
	$api    = crmapi::articles();
	$result = $api->search($data);
 
	print_r($result);
}
catch (CRMException $e) {
	echo $e->getMessage();
}



1.27. setDuplicatecheckConfig

Syntax:

boolean|string setDuplicatecheckConfig(array $fields = array())

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.

Parameter:

$fields: Liste der Felder, die überschrieben werden sollen

Rückgabe:

Beispiel:

<?php
 
require_once '/var/www/crm/class/api/crmapi.php';
 
try {
    //Bitte hier Ihre Zugangsdaten eintragen
    crmapi::logon()->Login('root', 'root');
}
catch (CRMException $e) {
    die($e->getMessage());
}
 
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);



2. Weitere Informationen

  • No labels