Um Informationen zu einem bestimmten Vorgang abzurufen, kannst du folgenden Aufruf verwenden:
api.php?call=get_booking&no=XXX&token=xyz
Hier sind die Parameter erläutert:
call=get_booking
: Dieser Parameter gibt an, dass du Informationen zu einem Vorgang abrufen möchtest.no
: Dies ist der Vorgangsnummer oder der Buchungscode aus einer Onlinezahlung, den du angeben musst, um den gewünschten Vorgang zu identifizieren.token=xyz
: Hier gibst du dein API-Token an, um auf die Vorgangsinformationen zugreifen zu können.
Die Rückgabe erfolgt in einem JSON-Array mit den folgenden Feldern:
kunde_nachname
: Nachname des Kunden.kunde_vorname
: Vorname des Kunden.kunde_firma
: Name der Firma des Kunden.vorgang_nr
: Die Vorgangsnummer.rechnung_nr
: Die Rechnungsnummer. Wenn sie 0 ist, wurde sie noch nicht vergeben.mietbeginn_datum
: Das Datum der Anmietung.gesamtbetrag_brutto
: Der Bruttobetrag des Vorgangs.gesamtbetrag_netto
: Der Nettobetrag des Vorgangs.mwst_satz
: Der Mehrwertsteuer-Satz des Vorgangs.offen_betrag
: Der noch offene Betrag des Vorgangs.
Die Vorgangspositionen werden ebenfalls im JSON-Array „Positionen“ dargestellt, wobei jede Position die folgenden Informationen enthält:
value
: Einzelbetrag der Position.bezeichnung
: Bezeichnung der Position.anzahl
: Die Anzahl oder Menge der Positionen.
Hier ist ein Beispielaufruf mit Curl:
curl -X GET 'https://deine-frontend-url/api.php?call=get_booking&no=XXX&token=xyz'
Und ein Beispiel für das Ergebnis, das du erhalten würdest:
{
"kunde_nachname": "Mustermann",
"kunde_vorname": "Max",
"kunde_firma": "Musterfirma",
"vorgang_nr": "V123456",
"rechnung_nr": 12345,
"mietbeginn_datum": "2023-08-04",
"gesamtbetrag_brutto": 150.00,
"gesamtbetrag_netto": 126.05,
"mwst_satz": 19,
"offen_betrag": 25.00,
"Positionen": [
{
"value": "Position 1",
"bezeichnung": "Produkt A",
"anzahl": 2
},
{
"value": "Position 2",
"bezeichnung": "Produkt B",
"anzahl": 1
}
]
}
Dies ermöglicht es dir, detaillierte Informationen zu einem bestimmten Vorgang in deinem Buchungssystem abzurufen.