Belegstatus API

Verwaltung von Belegstatus — Abruf, Übersetzungen und Erstellung

Basis-URL

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

Jede Anfrage liefert eine JSON-Antwort zurück. Bei Erfolg ist result.code == 1, im Fehlerfall result.code == 0. Der Belegstatus ist ein auf Belegen angezeigter Zustand — z. B. geplant, abgeschlossen, bezahlt. Zu den Status können auch Sprachübersetzungen gespeichert werden.

GET /api/receipt_status/get

Abruf eines einzelnen Belegstatus anhand von ID und Sprache.

Query-Parameter

ParameterTypPflichtfeldBeschreibung
idintID des Status
language_idintID der Übersetzungssprache

Beispielanfrage

GET /api/receipt_status/get?id=1&language_id=1
X-API-KEY: {ihr_api_schluessel}
GET /api/receipt_status/get_all

Abruf aller Belegstatus — ohne Filterung.

Query-Parameter

ParameterTypPflichtfeldBeschreibung
idintOptionaler Filter nach Status-ID

Beispielanfrage

GET /api/receipt_status/get_all
X-API-KEY: {ihr_api_schluessel}
GET /api/receipt_status/list

Paginierte Liste der Belegstatus.

Query-Parameter

ParameterTypPflichtfeldBeschreibung
list_offsetintVersatz für die Paginierung (Standard: 0)
list_conditionobjectObjekt mit Filterbedingungen
language_idintID der Übersetzungssprache

Beispielanfrage

GET /api/receipt_status/list?language_id=1
X-API-KEY: {ihr_api_schluessel}
POST /api/receipt_status/save

Erstellen oder Bearbeiten eines Belegstatus. Für einen neuen Status data[id] = 0. Das data-Array kann auch Sprachübersetzungen enthalten.

POST-Felder — data-Objekt

FeldTypPflichtfeldBeschreibung
idint0 = neuer Status, >0 = Bearbeitung
name_keystringStatusschlüsselname (Übersetzungsschlüssel)
outer_resource_namestringStatusname im externen System
dataobjectObjekt mit Übersetzungen: { "1": "Geplant", "2": "Planned" } (Schlüssel = language_id)

Beispielanfrage

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

{
  "data": {
    "id": 0,
    "name_key": "receipt_status_custom",
    "outer_resource_name": "PENDING",
    "data": { "1": "Várakozik", "2": "Pending" }
  }
}
POST /api/receipt_status/delete

Löschen eines Belegstatus anhand der ID. Nur entfernbare (removeable = 1) Status können gelöscht werden.

POST-Felder — data-Objekt

FeldTypPflichtfeldBeschreibung
idintID des zu löschenden Status

Beispielanfrage

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

{ "data": { "id": 5 } }

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!