Registrieren Anmelden

Belegparameter-Schema API

Verwaltung des Schemas der individuellen Parameter von Belegtypen - Abfrage, Liste, Speichern und Löschen

Endpunkte

Authentifizierung

Für jede API-Anfrage muss der X-API-KEY-Header gesendet werden.

X-API-KEY: {ihr_api_schluessel}

Haben Sie noch Fragen?

Schreiben Sie uns ein Ticket oder durchsuchen Sie unser Hilfe-Center.

Wenn es Ihnen gefallen hat, teilen Sie es mit anderen

Basis-URL

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

Jede Anfrage liefert eine JSON-Antwort zurück. Bei einer erfolgreichen Antwort gilt result.code == 1, bei einem Fehler result.code == 0. Das Schema legt fest, welche individuellen Parameter zu einem Belegtyp gehören (Name, Typ, Maßeinheit, Reihenfolge). Die konkreten Werte der Parameter werden von der Belegparameter API verwaltet.

Mögliche Werte für param_type_id

Wert Bezeichnung Beschreibung
1 Zahl Numerischer Wert, optional mit Maßeinheit (param_unit_id)
2 Text Freitextwert
3 Logisch Ja-/Nein-Wert
4 Wertemenge Auswahl aus vorgegebenen möglichen Werten (param_enum)
GET /api/receipt_param_schema/get

Abruf eines einzelnen Belegparameter-Schemas anhand der ID. Gelöschte Schemas (remove = 1) werden nicht zurückgegeben.

Query-Parameter

Parameter Typ Erforderlich Beschreibung
id int Eindeutige Kennung des Parameterschemas

Beispielanfrage

GET /api/receipt_param_schema/get?id=3
X-API-KEY: {ihr_api_schluessel}

Beispielantwort

{
  "result": { "code": 1, "message": "success" },
  "data": {
    "id": 3,
    "receipt_type_id": 1,
    "param_type_id": 1,
    "param_name": "Bruttogewicht",
    "param_enum": null,
    "param_order": 1,
    "param_unit_id": 4,
    "remove": 0
  }
}
GET /api/receipt_param_schema/list

Liste der Belegparameter-Schemas (ohne gelöschte Schemas), sortiert nach Belegtyp, Anzeigereihenfolge und ID. Die Liste ist nicht paginierbar. Die Antwort enthält neben den Feldern der Schemas auch die Namen des Parametertyps, des Belegtyps und der Maßeinheit.

Query-Parameter

Parameter Typ Erforderlich Beschreibung
list_condition[receipt_type_id] int Filterung nach Belegtyp-ID

Beispielanfrage

GET /api/receipt_param_schema/list?list_condition[receipt_type_id]=1
X-API-KEY: {ihr_api_schluessel}

Beispielantwort

{
  "result": { "code": 1, "message": "success" },
  "data": [
    {
      "id": 3,
      "receipt_type_id": 1,
      "param_type_id": 1,
      "param_name": "Bruttogewicht",
      "param_enum": null,
      "param_order": 1,
      "param_unit_id": 4,
      "remove": 0,
      "param_type_name": "Zahl",
      "receipt_type_name": "Wareneingang",
      "unit_name_short": "kg"
    },
    {
      "id": 4,
      "receipt_type_id": 1,
      "param_type_id": 4,
      "param_name": "Priorität",
      "param_enum": "[\"Niedrig\",\"Normal\",\"Dringend\"]",
      "param_order": 2,
      "param_unit_id": null,
      "remove": 0,
      "param_type_name": "Wertemenge",
      "receipt_type_name": "Wareneingang",
      "unit_name_short": null
    }
  ]
}
POST /api/receipt_param_schema/save

Erstellung oder Änderung eines Belegparameter-Schemas. Für ein neues Schema data[id] = 0, für eine Änderung die bestehende ID angeben.

POST-Felder - data-Objekt

Feld Typ Erforderlich Beschreibung
id int 0 = neues Schema, >0 = Änderung
receipt_type_id int Kennung des Belegtyps, zu dem der Parameter gehört
param_type_id int Typ des Parameters (1 = Zahl, 2 = Text, 3 = logisch, 4 = Wertemenge)
param_name string Bezeichnung des Parameters (höchstens 150 Zeichen)
param_enum array Array der auswählbaren Werte. Wird nur bei param_type_id = 4 gespeichert (als JSON abgelegt, höchstens 1000 Zeichen), bei anderen Typen ignoriert das System es.
param_order int Anzeigereihenfolge (Standard: 0)
param_unit_id int Kennung der Maßeinheit. Bei 0 oder leerem Wert gibt es keine Maßeinheit.

Beispielanfrage

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

{
  "data": {
    "id": 0,
    "receipt_type_id": 1,
    "param_type_id": 4,
    "param_name": "Priorität",
    "param_enum": ["Niedrig", "Normal", "Dringend"],
    "param_order": 2
  }
}

Beispielantwort

{
  "result": { "code": 1, "message": "success" },
  "data": {
    "id": 4
  }
}
POST /api/receipt_param_schema/delete

Löschung eines Belegparameter-Schemas anhand der ID. Die Löschung erfolgt logisch: Das Schema wird mit remove = 1 markiert und danach von Abfragen nicht mehr zurückgegeben.

POST-Felder

Feld Typ Erforderlich Beschreibung
id int Kennung des zu löschenden Parameterschemas

Beispielanfrage

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

{
  "id": 4
}

Beispielantwort

{
  "result": { "code": 1, "message": "success" },
  "data": {}
}

Nimm Kontakt mit uns auf

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

Anfrage senden

Brauchst du Hilfe?

Wenn du keine Antwort findest und Unterstützung brauchst

Im Help Center stöbern

Jetzt registrieren,
später bezahlen!

Teste es 3 Tage kostenlos, ohne Risiko und Verpflichtungen!
Registrierung erstellen
Registrieren