Belegdruckvorlagen-API

Verwaltung von Belegdruckvorlagen — Konfiguration von Typ, Ausrichtung und HTML-Quelle

Basis-URL

https://{tenant}.logzi.com/api/receipt_template/

Jede Anfrage liefert eine JSON-Antwort zurück. Bei Erfolg ist result.code == 1, im Fehlerfall result.code == 0. Die Belegdruckvorlage ist ein einem bestimmten Belegtyp zugeordnetes HTML/PDF-Drucklayout — mit Ausrichtung und Standardkennzeichnung.

GET /api/receipt_template/get

Abruf einer einzelnen Druckvorlage anhand der ID.

Query-Parameter

ParameterTypPflichtBeschreibung
idintID der Vorlage

Beispielanfrage

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

Paginierte Liste der Druckvorlagen.

Query-Parameter

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

Beispielanfrage

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

Erstellung oder Änderung einer Druckvorlage. Für eine neue Vorlage data[id] = 0. Es können nur entfernbare (removeable = 1) Vorlagen gelöscht werden.

POST-Felder — data-Objekt

FeldTypPflichtBeschreibung
idint0 = neue Vorlage, >0 = Änderung
receipt_type_idintID des Belegtyps
template_namestringName der Vorlage
template_sourcestringHTML-Vorlagenquelle
orientationstringAusrichtung: portrait oder landscape
template_defaultint1 = Standardvorlage für diesen Typ

Beispielanfrage

POST /api/receipt_template/save
X-API-KEY: {ihr_api_schluessel}
Content-Type: application/json

{
  "data": {
    "id": 0,
    "receipt_type_id": 8,
    "template_name": "Számla A4 portrait",
    "template_source": "<html>...</html>",
    "orientation": "portrait",
    "template_default": 1
  }
}
POST /api/receipt_template/delete

Löschen einer Druckvorlage anhand der ID.

POST-Felder

FeldTypPflichtBeschreibung
idintID der zu löschenden Vorlage

Beispielanfrage

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

{ "id": 2 }

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!