Basis-URL
https://{tenant}.logzi.com/api/compensate/
Jede Anfrage liefert eine JSON-Antwort zurück. Bei Erfolg ist result.code == 1, im Fehlerfall result.code == 0. Der Ausgleich ist die Erfassung der Zahlung eines Belegs (Rechnung oder Kassenbeleg).
/api/compensate/get
Abruf eines einzelnen Ausgleichs anhand der ID, zusammen mit den Daten des zugehörigen Belegs.
Abfrageparameter
| Parameter | Typ | Pflichtfeld | Beschreibung |
|---|---|---|---|
id | int | Eindeutiger Bezeichner des Ausgleichs |
Beispielanfrage
GET /api/compensate/get?id=55
X-API-KEY: {ihr_api_schluessel}/api/compensate/list
Abruf der paginierbaren Liste der Ausgleiche mit Filtermöglichkeiten.
Abfrageparameter
| Parameter | Typ | Pflichtfeld | Beschreibung |
|---|---|---|---|
list_offset | int | Versatz für die Seitenblätterung (Standard: 0) | |
list_condition[search_text] | string | Freitextsuche nach Belegnummer und Partnername | |
list_condition[partner_company_name] | string | Filter nach Partnername (LIKE) | |
list_condition[receipt_identify] | string | Filter nach Belegnummer (LIKE) | |
list_condition[invoice_receipt_type_id] | int | Filter nach Belegtyp | |
list_condition[invoice_receipt_id] | int | Filter nach Beleg-ID | |
list_condition[company_id] | int | Firmen-ID (Standard: 1) |
Beispielanfrage
GET /api/compensate/list?list_offset=0&list_condition[partner_company_name]=Minta
X-API-KEY: {ihr_api_schluessel}/api/compensate/save
Erfassen eines Ausgleichs zu einem bestehenden Beleg (Rechnung oder Kassenbeleg). Der Beleg kann über Belegnummer, Kundenbestellnummer oder E-Mail-Adresse identifiziert werden.
POST-Felder — data-Objekt
| Feld | Typ | Pflichtfeld | Beschreibung |
|---|---|---|---|
receipt_id | int | 0 = neuer Ausgleich (mit vorhandener ID), >0 = Bearbeitung | |
amount | float | Ausgeglichener Betrag | |
company_user_id | int | Bezeichner des erfassenden Mitarbeiters | |
identify_invoice | string | Belegnummer der Rechnung (bei Suche anhand der Rechnung) | |
identify_customer | string | Kundenbestellnummer (bei Suche anhand der Bestellung) | |
customer_email | string | E-Mail-Adresse des Kunden (bei Suche anhand der E-Mail) | |
parcel_number | string | Paketnummer (bei Suche anhand der Sendung) |
Beispielanfrage
POST /api/compensate/save
X-API-KEY: {ihr_api_schluessel}
Content-Type: application/json
{
"data": {
"receipt_id": 0,
"amount": 127000,
"company_user_id": 3,
"identify_invoice": "2024/00123"
}
}/api/compensate/delete
Löschen eines Ausgleichs. Nach dem Löschen gilt der zugehörige Beleg wieder als offen.
POST-Felder — data-Objekt
| Feld | Typ | Pflichtfeld | Beschreibung |
|---|---|---|---|
receipt_id | int | Bezeichner des zu löschenden Ausgleichs |
Beispielanfrage
POST /api/compensate/delete
X-API-KEY: {ihr_api_schluessel}
Content-Type: application/json
{ "data": { "receipt_id": 55 } }Interessierst du dich für unsere Software? Schreib uns einfach!
Jetzt registrieren,
später bezahlen!
