Basis-URL
https://{tenant}.logzi.com/api/receipt_file/
Jede Anfrage liefert eine JSON-Antwort zurück. Bei Erfolg ist result.code == 1, im Fehlerfall result.code == 0. Die Belegdatei ist eine an einen Beleg (Rechnung, Bestellung, Vertrag usw.) angehängte Binärdatei — gespeichert mit base64-kodiertem Inhalt.
/api/receipt_file/get
Abrufen einer einzelnen Belegdatei anhand der ID.
Query-Parameter
| Parameter | Typ | Pflichtfeld | Beschreibung |
|---|---|---|---|
id | int | ID des Dateidatensatzes |
Beispielanfrage
GET /api/receipt_file/get?id=10
X-API-KEY: {ihr_api_schluessel}/api/receipt_file/list
Paginierbare Liste der Belegdateien mit Filtermöglichkeiten.
Query-Parameter
| Parameter | Typ | Pflichtfeld | Beschreibung |
|---|---|---|---|
list_offset | int | Paginierungs-Offset (Standard: 0) | |
list_condition[receipt_id] | int | Filterung nach Beleg-ID | |
list_condition[receipt_type_id] | int | Filterung nach Belegtyp | |
list_condition[partner_id] | int | Filterung nach allen Belegdateien eines Partners |
Beispielanfrage
GET /api/receipt_file/list?list_condition[receipt_id]=150&list_condition[receipt_type_id]=8
X-API-KEY: {ihr_api_schluessel}/api/receipt_file/list_light
Kompakte Liste der Belegdateien — ohne Dateiinhalt (file_source), nur mit Metadaten.
Query-Parameter
| Parameter | Typ | Pflichtfeld | Beschreibung |
|---|---|---|---|
list_offset | int | Paginierungs-Offset (Standard: 0) | |
list_condition | object | Filterbedingungen (wie beim /list-Endpunkt) |
Beispielanfrage
GET /api/receipt_file/list_light?list_condition[receipt_id]=150&list_condition[receipt_type_id]=8
X-API-KEY: {ihr_api_schluessel}/api/receipt_file/save
Hochladen einer Datei oder Ändern einer bestehenden. Für eine neue Datei data[id] = 0.
POST-Felder — data-Objekt
| Feld | Typ | Pflichtfeld | Beschreibung |
|---|---|---|---|
id | int | 0 = neue Datei, >0 = Änderung | |
receipt_type_id | int | ID des Belegtyps | |
receipt_id | int | Beleg-ID | |
file_name | string | Dateiname mit Erweiterung (z. B. szamla.pdf) | |
file_source | string | Dateiinhalt base64-kodiert | |
file_type_id | int | ID des Dateityps (Standard: 1) | |
file_classification_id | int | ID der Dateiklassifizierung |
Beispielanfrage
POST /api/receipt_file/save
X-API-KEY: {ihr_api_schluessel}
Content-Type: application/json
{
"data": {
"id": 0,
"receipt_type_id": 8,
"receipt_id": 150,
"file_name": "szamla_150.pdf",
"file_source": "JVBERi0x..."
}
}/api/receipt_file/delete
Löschen einer Belegdatei anhand der ID.
POST-Felder — data-Objekt
| Feld | Typ | Pflichtfeld | Beschreibung |
|---|---|---|---|
id | int | ID der zu löschenden Datei |
Beispielanfrage
POST /api/receipt_file/delete
X-API-KEY: {ihr_api_schluessel}
Content-Type: application/json
{ "data": { "id": 10 } }Interessierst du dich für unsere Software? Schreib uns einfach!
Jetzt registrieren,
später bezahlen!
