Operation:

Description:

GET /invoices

Liefert ein NREI-Objekt im angegebenen Zeitraum zurück, dass alle Rechnungs-Objekte zu allen Mandanten mit Rechnungsdatum enthält.

Request Parameters:

Description:

Annotation:

invoice_date_from / invoice_date_to:

(date string)

Gibt den Zeitraum an, von dem die Rechnungs-Objekte abgerufen werden sollen. Format des Datum gemäß ISO 8601: JJJJ-MM-TT ohne Uhrzeit! Die Rechnungs-Objekte können nur ganztätig abgerufen werden. Somit werden auch nur Rechnungs-Objekte bis einen Tag vor API-Abruf bereitgestellt. Bei einer Angabe von einer Uhrzeit oder bei einem Rechnungs-Enddatum (invoice_date_to) größer oder gleich dem Datum des API-Aufrufs wird dementsprechend eine Exception zurückgeliefert.

pflicht

client_id: (int)

Filtert alle Rechnungs-Objekte zu einem Mandanten heraus, falls die URL mehrere Mandanten liefern kann.

optional

shop_id: (int)

Filtert alle Rechnungs-Objekte zu einer Firma heraus.

optional

invoice_number: (string)

Filtert aus allen Rechnungs-Objekten ein Rechnungs-Objekt mit entsprechender Rechnungsnummer heraus.

optional

exclude_countries: (string)

Filtert alle Rechnungs-Objekte heraus, die nicht aus diesen Rechnungsländern stammen. Die Rechnungsländer sind in einer, durch  Komma  getrennten, Liste mit ISO-Codes anzugeben.

optional

top: (int)

Gibt die maximale Anzahl der zurückzuliefernden Rechnungs-Objekte an. Solange ausreichend viele Rechnungs-Objekte vorhanden sind, wird genau diese Anzahl an Objekten zurückgeliefert. Ansonsten wird die verbliebene Anzahl an vorhandenen Rechnungs-Objekten zurückgeliefert.

optional

skip: (int)

Gibt die Anzahl der Rechnungs-Objekte an, die übersprungen und somit nicht angefordert werden sollen.

optional

Request Header:

(application/json)

Description:

Annotation:

Authorization:

Bearer {Token}

Kenner "Bearer" zusammen mit einen JSON Web Token des Login-Endpunktes. Wird für die Authentifizierung des Requests benötigt.

pflicht

Beispiel:

{

  "Authorization":  Bearer "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.

                             eyJ1c2VybmFtZSI6Ik11c3Rlcm1hbm4iLCJwYXNzd29yZCI6IjEyM2FiYyJ9.

                             mqC0GFF85PucbpPW7h1G5C1r69flVABWz2_nszBDvKY"

}

Response:

Liefert ein NREI-Objekt in Form eines Json-Objekts zurück mit allen angeforderten Rechnungs-Objekten. Der Aufbau des NREI-Objekts entspricht der NREI-Definition (siehe Abschnitt für NREI (JSON)).