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:
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
| – |
| filter > user.id | Array | Nur Rechnungen von einem bestimmten Teilnehmer
| – |
| filter > offer.id | Array | Nur Rechnungen von einem bestimmten Angebot
| – |
| filter > booking.id | Array | Nur Rechnungen von einer bestimmten Buchung
| – |
| filter > status | Array | Nur Rechnungen von einem bestimmten Status
| – |
| order > creation_date | Array | Sortieren nach Erstellungsdatum
| – |
| order > ability_date | Array | Sortieren nach Fälligkeitsdatum
| – |
| order > invoice_number | Array | Sortieren nach der Rechnungsnummer
| – |
Rückgabewerte
| Feld | Art | Beschreibung | Objekt |
|---|---|---|---|
| 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:
