Basis-URL
https://{tenant}.logzi.com/api/receipt_comment/
Jede Anfrage liefert eine JSON-Antwort zurück. Bei Erfolg ist result.code == 1, im Fehlerfall result.code == 0. Der Belegkommentar ist ein vordefinierter Text, der automatisch in die Kopf- oder Fußzeile des Belegs eingefügt werden kann — basierend auf Zahlungsart oder Belegtyp.
/api/receipt_comment/get
Abrufen einer einzelnen Kommentarvorlage anhand der ID.
Query-Parameter
| Parameter | Typ | Pflichtfeld | Beschreibung |
|---|---|---|---|
id | int | ID der Kommentarvorlage |
Beispielanfrage
GET /api/receipt_comment/get?id=1
X-API-KEY: {ihr_api_schluessel}
/api/receipt_comment/list
Paginierbare Liste der Kommentarvorlagen.
Query-Parameter
| Parameter | Typ | Pflichtfeld | Beschreibung |
|---|---|---|---|
list_offset | int | Paginierungs-Offset (Standard: 0) | |
list_condition | object | Objekt mit Filterbedingungen |
Beispielanfrage
GET /api/receipt_comment/list?list_offset=0
X-API-KEY: {ihr_api_schluessel}
/api/receipt_comment/save
Erstellen oder Bearbeiten einer Kommentarvorlage. Für eine neue Vorlage data[id] = 0.
POST-Felder — data-Objekt
| Feld | Typ | Pflichtfeld | Beschreibung |
|---|---|---|---|
id | int | 0 = neue Vorlage, >0 = Bearbeitung | |
comment_name | string | Name des Kommentars (zur internen Identifikation) | |
comment_value | string | Text des Kommentars | |
receipt_type_id | int | ID des Belegtyps | |
receipt_comment_type_id | int | Kommentartyp (Kopf- / Fußzeile) | |
receipt_comment_auto_fill | int | 1 = automatische Befüllung | |
receipt_comment_paymod_id | int | Filter nach Zahlungsart (bei NULL: für alle Zahlungsarten) |
Beispielanfrage
POST /api/receipt_comment/save
X-API-KEY: {ihr_api_schluessel}
Content-Type: application/json
{
"data": {
"id": 0,
"comment_name": "Átutalásos megjegyzés",
"comment_value": "Kérjük az összeget 8 napon belül átutalni.",
"receipt_type_id": 8,
"receipt_comment_type_id": 2,
"receipt_comment_auto_fill": 1,
"receipt_comment_paymod_id": 2
}
}
/api/receipt_comment/delete
Löschen einer Kommentarvorlage anhand der ID.
POST-Felder
| Feld | Typ | Pflichtfeld | Beschreibung |
|---|---|---|---|
id | int | ID des zu löschenden Kommentars |
Beispielanfrage
POST /api/receipt_comment/delete
X-API-KEY: {ihr_api_schluessel}
Content-Type: application/json
{ "id": 1 }
Interessierst du dich für unsere Software? Schreib uns einfach!
Jetzt registrieren,
später bezahlen!