Belegkommentar API

Verwaltung vordefinierter Belegkommentar-Vorlagen — für die automatische Textbefüllung

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.

GET /api/receipt_comment/get

Abrufen einer einzelnen Kommentarvorlage anhand der ID.

Query-Parameter

ParameterTypPflichtfeldBeschreibung
idintID der Kommentarvorlage

Beispielanfrage

GET /api/receipt_comment/get?id=1
X-API-KEY: {ihr_api_schluessel}
GET /api/receipt_comment/list

Paginierbare Liste der Kommentarvorlagen.

Query-Parameter

ParameterTypPflichtfeldBeschreibung
list_offsetintPaginierungs-Offset (Standard: 0)
list_conditionobjectObjekt mit Filterbedingungen

Beispielanfrage

GET /api/receipt_comment/list?list_offset=0
X-API-KEY: {ihr_api_schluessel}
POST /api/receipt_comment/save

Erstellen oder Bearbeiten einer Kommentarvorlage. Für eine neue Vorlage data[id] = 0.

POST-Felder — data-Objekt

FeldTypPflichtfeldBeschreibung
idint0 = neue Vorlage, >0 = Bearbeitung
comment_namestringName des Kommentars (zur internen Identifikation)
comment_valuestringText des Kommentars
receipt_type_idintID des Belegtyps
receipt_comment_type_idintKommentartyp (Kopf- / Fußzeile)
receipt_comment_auto_fillint1 = automatische Befüllung
receipt_comment_paymod_idintFilter 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
  }
}
POST /api/receipt_comment/delete

Löschen einer Kommentarvorlage anhand der ID.

POST-Felder

FeldTypPflichtfeldBeschreibung
idintID des zu löschenden Kommentars

Beispielanfrage

POST /api/receipt_comment/delete
X-API-KEY: {ihr_api_schluessel}
Content-Type: application/json

{ "id": 1 }

Nimm Kontakt mit uns auf

Interessierst du dich für unsere Software? Schreib uns einfach!

Brauchst du Hilfe?

Wenn du keine Antwort findest und Unterstützung brauchst

Jetzt registrieren,
später bezahlen!

Teste es 3 Tage kostenlos, ohne Risiko und Verpflichtungen!