Basis-URL
https://{tenant}.logzi.com/api/compensate/
Jede Anfrage liefert eine JSON-Antwort zurück. Bei Erfolg ist result.code == 1, bei einem Fehler result.code == 0. Die Kompensation-API dient dem Verrechnen (Kompensieren) einander gegenüberstehender Forderungen und Verbindlichkeiten, mit Unterstützung für den Massenimport.
/api/compensate/get
Abrufen eines einzelnen Kompensationsbelegs anhand der ID.
Query-Parameter
| Parameter | Typ | Pflichtfeld | Beschreibung |
|---|---|---|---|
id | int | ID der Kompensation |
Beispielanfrage
GET /api/compensate/get?id=1
X-API-KEY: {ihr_api_schluessel}/api/compensate/list
Blätterbare Liste der Kompensationsbelege.
Query-Parameter
| Parameter | Typ | Pflichtfeld | Beschreibung |
|---|---|---|---|
list_offset | int | Offset für die Seitennummerierung (Standard: 0) | |
list_condition | object | Objekt mit Filterbedingungen |
Beispielanfrage
GET /api/compensate/list?list_offset=0
X-API-KEY: {ihr_api_schluessel}/api/compensate/save
Erstellen oder Ändern eines Kompensationsbelegs.
POST-Felder — data-Objekt
Im data-Objekt müssen die Daten der Kompensation angegeben werden (Partner-ID, verknüpfte Belege, Betrag).
Beispielanfrage
POST /api/compensate/save
X-API-KEY: {ihr_api_schluessel}
Content-Type: application/json
{ "data": { "id": 1 } }/api/compensate/save_import
Massenimport von Kompensationsbelegen.
POST-Felder — data-Array
Im data-Array können die Daten mehrerer Kompensationsbelege gleichzeitig für die Massenerfassung angegeben werden.
Beispielanfrage
POST /api/compensate/save_import
X-API-KEY: {ihr_api_schluessel}
Content-Type: application/json
{ "data": [ { "partner_id": 1 }, { "partner_id": 2 } ] }/api/compensate/delete
Löschen eines Kompensationsbelegs.
POST-Felder — data-Objekt
Im data-Objekt müssen die Daten der zu löschenden Kompensation angegeben werden.
Beispielanfrage
POST /api/compensate/delete
X-API-KEY: {ihr_api_schluessel}
Content-Type: application/json
{ "data": { "id": 1 } }Interessierst du dich für unsere Software? Schreib uns einfach!
Jetzt registrieren,
später bezahlen!
