Rechnung-Ressourcen REST API

Einführung

In diesem Teil erhalten Sie Informationen, wie auf sämtliche Rechnungen zugegriffen werden kann.

Allgemeine Information

Diese Ressource unterstützt die folgenden Operationen:

Name	URL	GET	POST	PUT	DELETE	Status
Rechnung	v1/invoice	Ja	–	–	–

Wenn Sie auf diese Ressource zugreifen möchten, verwenden Sie folgende URL:

Ressource URL

https://api.edoobox.com/v1/invoice

Definitionen

GET Parameter für Abfrage

Sämtliche Parameter, welche bei einer GET Anfrage enthalten sein können oder erforderlich sind:

Parameter	Art	Beschreibung	Erforderlich
language	String	Sprache z.B. „de“ oder en, fr, es, cn, cs	Ja
limit > start	Integer	Ab welcher Position ausgeben, Paging	–
limit > reply	Integer	Anzahl Antworten, max 100	–
filter > id	Array	Nur eine bestimmte Rechnung ausgeben property > invoice.id *value* String, „invoice_abc_1234“	–
filter > user.id	Array	Nur Rechnungen von einem bestimmten Teilnehmer *property* > user.id value String, „user_abc_1234“	–
filter > offer.id	Array	Nur Rechnungen von einem bestimmten Angebot *property* > offer.id value String, „offer_abc_1234“	–
filter > booking.id	Array	Nur Rechnungen von einer bestimmten Buchung *property* > booking.id value String, „booking_abc_1234“	–
filter > status	Array	Nur Rechnungen von einem bestimmten Status *property* > invoice.status value Integer, 1 = offen; 2 = bezahlt; 3 = annulliert	–
order > creation_date	Array	Sortieren nach Erstellungsdatum *property* > invoice.creation_date value String, „ASC“ oder „DESC“	–
order > ability_date	Array	Sortieren nach Fälligkeitsdatum *property* > invoice.ability_date value String, „ASC“ oder „DESC“	–
order > invoice_number	Array	Sortieren nach der Rechnungsnummer *property* > invoice.invoice_number value String, „ASC“ oder „DESC“	–

Rückgabewerte

Feld	Art	Beschreibung
id	String	edoobox ID
status	String	Rechnungsstatus 1 = offen; 2 = bezahlt; 3 = annulliert
invoice_number	String	Rechnungsnummer
user_id	String	edoobox ID vom zugehörigen Teilnehmer
total_amount	Float	Total Betrag der Rechnung
currency	String	Währung im ISO_4217 Format
creation_date	String	Erstellungsdatum im Format ISO_8601
ability_date	String	Fälligkeit im Format ISO_8601
pdf_url	String	URL zum PDF welches 60 Minuten aktiv ist

GET Beispiel

Dazu ein Beispiel, wie diese Parameter im GET-Request übergeben werden. Dieses Beispiel enthält alle Parameter, somit müssen erst die unnötigen Parameter entfernt werden:

	<?php
	$client->get('invoice', array(
	'language' => 'de',
	'filter' => array(
	array(
	'property' => 'invoice.id',
	'value' => 'invoice_abc_1234'
	),
	array(
	'property' => 'user.id',
	'value' => 'user_abc_1234'
	),
	array(
	'property' => 'user.last_name',
	'needle' => 'test'
	),
	array(
	'property' => 'user.first_name',
	'needle' => 'test'
	),
	array(
	'property' => 'offer.id',
	'value' => 'offer_abc_1234'
	),
	array(
	'property' => 'booking.id',
	'value' => 'booking_abc_1234'
	)
	),
	'limit' => array('start' => 0,
	'reply' => 10),
	'order' => array(
	array( 'property' => 'invoice.creation_date',
	'value' => 'DESC'
	),
	array( 'property' => 'invoice.ability_date',
	'value' => 'DESC'
	),
	array( 'property' => 'invoice.invoice_number',
	'value' => 'DESC'
	)
	)
	));

view raw get_invoice_sample1.php hosted with ❤ by GitHub

Updated on 5. März 2020

Was this article helpful?

Yes No

Die Lösung nicht gefunden?

Dann erstellen Sie eine Support-Anfrage.

Support Ticket