Lexware-php-api: Unterschied zwischen den Versionen

Aus Baebeca Solutions GmbH - Wiki
Zur Navigation springen Zur Suche springen
← Zum vorherigen VersionsunterschiedZum nächsten Versionsunterschied →
VisuellWikitext
Slutz (Diskussion | Beiträge)
Prayce_Hosting, Projekt_service.melanin-business.com, Bürokraten, confirmed_user, service.melanin-business.com, Administratoren
295 Bearbeitungen
Slutz (Diskussion | Beiträge)
Prayce_Hosting, Projekt_service.melanin-business.com, Bürokraten, confirmed_user, service.melanin-business.com, Administratoren
295 Bearbeitungen
Zeile 211: Zeile 211:
:"both", "true" oder "false" als String ob archivierte/nicht archivierte Belege ausgegeben werden sollen
:"both", "true" oder "false" als String ob archivierte/nicht archivierte Belege ausgegeben werden sollen


=== Beleg hochladen ===
=== Belegbild hochladen (nicht zugeordnet) ===
<syntaxhighlight lang="php">$lexoffice->upload_file($file) : object</syntaxhighlight>
<syntaxhighlight lang="php">$lexoffice->upload_file($file) : object</syntaxhighlight>
;Parameter
;Parameter
Zeile 231: Zeile 231:
)
)
</syntaxhighlight>
</syntaxhighlight>
=== Beleg hochladen (zugeordnet) ===
<syntaxhighlight lang="php">$lexoffice->upload_voucher($uuid, $file) : object</syntaxhighlight>
;Parameter
*uuid
**Die ID des Beleges dem der Upload zugeordnet werden soll
*file
**Der Pfad zur Datei die hochgeladen werden soll
; Rückgabe
* id
** Die eindeutige Datei-ID von lexoffice


=== Beleg Dateien herunterladen ===
=== Beleg Dateien herunterladen ===

Version vom 12. Juni 2020, 22:02 Uhr

Übersicht & Informationen

PHP Client für Lexoffice REST API

Wir lieben Automatisierung und die nahtlose Verzahnung von Systemen!

Lexoffice stellt seinen Kunden eine öffentliche API-Schnittstelle zur Verfügung über die bestehende Systeme integriert oder Prozesse automatisiert werden können.
Für diesen Ansatz haben wir einen PHP-Client entwickelt und stellen diesen kostenfrei zur Verfügung.

Alle weiteren Informationen finden Sie auf unserer Projektseite.

Baebeca Solutions bei lexoffice.de

Download

Die aktuelle Version können Sie jeweils in unserem Github Repository herunterladen: https://github.com/Baebeca-Solutions/lexoffice-php-api

Lizenz

Unsere Software wurde unter der "GNU Affero General Public License v3.0" Lizenz veröffentlicht. Dies bedeutet, dass Sie unsere Software gerne in Ihren Projekten und Produkten nutzen dürfen, solange Sie Ihr Projekt dann ebenso Quelloffen unter den in der Lizenz genannten Rahmenbedingungen zur Verfügung stellen.

Wenn Sie Ihre Lösung nicht veröffentlichen möchten, Support benötigen, individuelle Erweiterungen benötigen oder dieses Projekt einfach Unterstützen möchten, können Sie für 99,- EUR/Netto eine lifetime Nutzungslizenz erhalten. Setzten Sie sich diesbezüglich bitte kurz mit uns in Verbindung.

Support

An wen kann ich mich wenden, wenn ich Probleme oder Fragen habe?
Für diese Frage ist entscheidend, ob Sie eine Nutzungslizenz für unsere lexoffice-php-api erworben haben oder die kostenlose Variante nutzen.

  • Sofern eine Nutzungslizenz vorhanden ist, können sich jederzeit per Mail an support@baebeca.de wenden und erhalten vorrangigen Support.
  • Wenn Sie die kostenlose Version nutzen bitten wir Sie auf Github einen issue zu erstellen.

Lexoffice API Account erstellen

Erstellen Sie in Ihrem Lexoffice Account einen API Key.

Einstellungen :: Erweiterungen :: lexoffice Public API :: "Schlüssel neu erstellen"

Klasse einbinden

// include the class file, check the correct folder
require_once (__DIR__.'/lexoffice-php-api.php');
    
// initiate client with your settings
$lexoffice = new lexoffice_client(array(
  'api_key' => 'xyz',
));

Start Parameter

api_key [string]
API Schlüssel
callback [string]
Ihre Standard Callback URL für Webhooks von Lexoffice
ssl_verify [bool] (default true)
Soll die SSL verbindung zu Lexoffice validiert werden

Methoden

Account

Account abfragen

$lexoffice->get_profile() : object

Beispiel Rückgabe: 

{
  "organizationId": "42b1fbdd-c4e0-4bb4-8c20-1d3d0b9432e8",
  "companyName": "Testfirma GmbH",
  "created": {
    "userName": "Frau Erika Musterfrau",
    "userEmail": "erika.musterfrau@testfirma.de",
    "date": "2017-01-03T13:15:45+0100"
  },
  "connectionId": "3dea098a-fae5-4458-a85c-f97965966c25",
  "features": [
    "cashbox"
  ],
  "subscriptionStatus": "active",
  "taxType": "net",
  "isSmallBusiness": false
}

Rechnungen

Rechnung abfragen

$lexoffice->get_invoice( string $uuid ) : object
uuid
Die eindeutige uuid des Eintrages der abgefragt werden soll

Alle Rechnungen abfragen

$lexoffice->get_invoices_all() : object

Die letzten n Rechnungen abfragen

$lexoffice->get_last_invoices(int $count) : object

Rechnung PDF herunterladen

legacy function - will be removed in futere releases, use get_pdf($type, $uuid, $filename) instead 

$lexoffice->get_invoice_pdf( string $uuid, string $filename) : bool
uuid
Die eindeutige uuid des Eintrages der abgefragt werden soll
filename
Der lokale Dateiname an dem das PDF abgelegt werden soll

Rechnung anlegen

$lexoffice->create_invoice( array $data [, bool $finalized = false ] ) : object
data
Ein Array der Rechnungsdaten nach der nötigen Lexoffice Formatierung
Beispiel
 array(
     'voucherDate' => substr(date('c'), 0, 19).'.000'.substr(date('c'), 19),
     'introduction' => 'Einleitungstext',
     'remark' => "Fußzeile\r\nMehrzeilig",
     'address' => array(
     	#'contactId' => '<id>',
     	'name' => 'Frau Jane Doe',
     	'street' => 'Str. 1',
     	'zip' => '12345',
     	'city' => 'Stadt',
     	'countryCode' => 'DE',
      ),
      'lineItems' => array(
      	array(
       		'type' => 'custom',
       		'name' => 'Produktname',
       		'description' => 'Beschreibung',
       		'quantity' => 1,
       		'unitName' => 'Stück',
       		'unitPrice' => array(
       			'currency' => 'EUR',
       			'netAmount' => 10.99,
           		'taxRatePercentage' => 19,
       		),
       		#'discountPercentage' => 0,
       	),
      ),
      'totalPrice' => array(
       	'currency' => 'EUR',
       	#'totalDiscountAbsolute' => 0,
       	#'totalDiscountPercentage' => 0,
      ),
      'taxConditions' => array(
      	'taxType' => 'net',
      ),
      'shippingConditions' => array(
      	'shippingDate' => date('Y-m-d').'T00:00:01.000+02:00',
      	'shippingType' => 'delivery',
      ),
      'paymentConditions' => array(
      	'paymentTermLabel' => 'Vorkasse',
      	'paymentTermDuration' => 1,
      ),
    )
finalized
Entscheidet ob die Rechnung fertiggestellt werden soll.

Gutschriften

Gutschrift Abfragen

$lexoffice->get_creditnote( string $uuid ) : object
uuid
Die eindeutige uuid der Gutschrift die abgefragt werden soll

Angebote

Angebot Abfragen

$lexoffice->get_quotation( string $uuid ) : object
uuid
Die eindeutige uuid des Angebotes das abgefragt werden soll

Auftragsbestätigungen

Auftragsbestätigung Abfragen

$lexoffice->get_orderconfirmation( string $uuid ) : object
uuid
Die eindeutige uuid der Auftragsbestätigung die abgefragt werden soll

Belege

Beleg anlegen

$lexoffice->create_voucher( array $data ) : object
Paramater
data
Ein Array der Belegdaten nach der nötigen Lexoffice Formatierung

Beleg abfragen

$lexoffice->get_voucher( string $uuid ) : object
Paramater
  • uuid
    • Die eindeutige uuid des Beleges der abgefragt werden soll

Belege Abfragen

$lexoffice->get_vouchers( string $type = 'invoice,creditnote,orderconfirmation', string $state = 'draft,open,paid,paidoff,voided,transferred', string $archived = 'both') : object
type
Einen oder mehrere Typen von Belegen (komma getrennt) die abgefragt werden sollen
state
Status der Belege die abgefragt werden sollen
archived
"both", "true" oder "false" als String ob archivierte/nicht archivierte Belege ausgegeben werden sollen

Belegbild hochladen (nicht zugeordnet)

$lexoffice->upload_file($file) : object
Parameter
  • file
    • Der Pfad zur Datei die hochgeladen werden soll
Rückgabe
  • id
    • Die eindeutige Datei-ID von lexoffice
Beispiel Anfrage
$lexoffice->upload_file(__DIR__.'/invoice.pdf');
Beispiel Rückgabe
stdClass Object (
    [id] => 221fd5ed-5547-4bd3-b7c2-9796c1a0e4a6
)

Beleg hochladen (zugeordnet)

$lexoffice->upload_voucher($uuid, $file) : object
Parameter
  • uuid
    • Die ID des Beleges dem der Upload zugeordnet werden soll
  • file
    • Der Pfad zur Datei die hochgeladen werden soll
Rückgabe
  • id
    • Die eindeutige Datei-ID von lexoffice

Beleg Dateien herunterladen

$lexoffice->get_voucher_files(string $uuid, string $filename_prefix) : array
Parameter
  • uiui
    • Die ID des Beleges dessen Dateien heruntergeladen werden sollen
  • filename_prefix
    • Der Dateipfad inkl. eines Dateiprefixes.
Rückgabe

Ein Array der Dateinamen

Beispiel Anfrage
$lexoffice->get_voucher_files($uuid, '/files/IN_1234');
Beispiel Rückgabe
array (
    [0] => /files/IN_1234_1.jpg
    [1] => /files/IN_1234_2.png
    [2] => /files/IN_1234_3.pdf
)

Kontakte

Kontakt abfragen

$lexoffice->get_contact( string $uuid ) : object
Paramater
  • uuid
    • Die eindeutige uuid des Eintrages der abgefragt werden soll

Kontakt suchen

$lexoffice->search_contact( array $filter ) : object
Paramater
  • filter
    • Array bestehend aus den möglichen Filtern. Mehere Filter werden mit einem UND verknüpft.
      • email (mindestens 3 Zeichen)
      • name (mindestens 3 Zeichen)
      • number
      • customer (true/false)
      • vendor (true/false)
Beispiel Anfrage
$lexoffice->search_contact(array(
	'email' => '',
	'name' => 'John Doe',
	'number' => '',
	'customer' => '',
	'venodr' => '',
));

Alle Kontakte abfragen

$lexoffice->get_contacts_all() : object

Kontakt anlegen

$lexoffice->create_contact( array $data) : object
Parameter
Beispiel Anfrage
$lexoffice->create_contact(array(
	'version' => 0,
	'roles' => array(
		'customer' => array(
			'number' => '',
		),
	),
	'company' => array(
		'name' => 'Baebeca Solutions GmbH',
		'street' => 'Genklerhardt 6',
		'zip' => '51647',
		'city' => 'Gummersbach',
		'countryCode' => 'DE',
		'contactPersons' => array(
			array(
				'salutation' => 'Herr',
				'firstName' => 'Jon',
				'lastName' => 'Doe',
				'emailAddress' =>'support@baebeca.de',
        			'phoneNumber' => '022619202930',
			)
		),
	),
	'addresses' => array(
		'billing' => array(
			array(
				'street' => 'Genklerhardt 6',
				'zip' => '51647',
				'city' => 'Gummersbach',
				'countryCode' => 'DE',
			),
		),
		'shipping' => array(
			array(
				'street' => 'Genklerhardt 6',
				'zip' => '51647',
				'city' => 'Gummersbach',
				'countryCode' => 'DE',
			),
		),
	),
	'emailAddresses' => array(
		'business' => array(
			'support@baebeca.de'
		),
	),
	'phoneNumbers' => array(
		'business' => array(
			'022619202930'
		),
	),
	'note' => '',
));

Kontakt aktualisieren

$lexoffice->update_contact( string $uuid, array $data) : object
Parameter
  • uuid
    • Die eindeutige uuid des Eintrages der abgefragt werden soll
  • data

Events / Webhooks

Event anlegen

$lexoffice->create_event( string $event [, bool $callback = false ] ) : array|bool
event
Mögliche sind alle von Lexoffice angebotenen Events.
callback
Die Callback URL für diesen Aufruf. Wenn keine angegeben wird, wird die Standard URL aus der initialisierung genutzt.

Aktives Event abfragen

$lexoffice->get_event( string $uuid ) : array
uuid
Die eindeutige uuid des Eintrages der abgefragt werden soll

Alle aktiven Events abfragen

$lexoffice->get_events_all() : object

Event löschen

$lexoffice->delete_event( string $iiud ) : object
uuid
Die ID eines zuvor erstellten Events.

Sonstiges

PDFs herunterladen

$lexoffice->get_pdf( string $type, string $uuid, string $filename) : bool
type
Die Art des Beleges. Möglich Varianten sind: "invoices", "credit-notes"
uuid
Die eindeutige uuid des Eintrages der abgefragt werden soll
filename
Der lokale Dateiname an dem das PDF abgelegt werden soll

Webhook Anfragen

Wir liefern eine callback.php mit, die als callback URL angegeben werden kann. Bei allen Aufrufen wird die X-Lxo-Signature überprüft und sichergestellt, dass der Aufruf wirklich von einem lexoffice Server erstellt wurde.

Error Handling

Alle Methoden sollten stets in einem try/catch Block verwendet werden.
Unser Client bietet eine erweiterte Execption Klasse, die via "$e->get_error()" sofern vorhanden weitere Details zur Anfrage und dem API Response zurück gibt.

Beispiel: Versuch eines PDF Downloads von einer nicht fertig gestellten Rechnung 

try {
    $lexoffice->get_invoice_pdf('7f0f0f7f-dd61-4bf7-a9f7-a67b0530c7e9', 'test.pdf');
} catch (lexoffice_exception $e) {
    echo $e->getMessage();
    // lexoffice-php-api: error in api request - check details via $e->get_error()
 
    print_r($e->get_error());
    /*
    Array (
        [HTTP Status] => 500
        [Requested URI] => https://api.lexoffice.io/v1/invoices/7f0f0f7f-dd61-4bf7-a9f7-a67b0530c7e9/document
        [Requested Payload] => 
        [Response] => stdClass Object
           (
                [timestamp] => 2019-11-20T17:34:53.360+01:00
                [status] => 500
                [error] => Internal Server Error
                [path] => /v1/invoices/7f0f0f7f-dd61-4bf7-a9f7-a67b0530c7e9/document
                [traceId] => f9f241666675
                [message] => A technical error has occurred that is not specified in more detail.
            )
    )
    */
}
Abgerufen von „https://wiki.baebeca.de/index.php?title=Lexware-php-api&oldid=250“