Basis-URL
https://{tenant}.logzi.com/api/receipt_param/
Jede Anfrage liefert eine JSON-Antwort zurück. Bei einer erfolgreichen Antwort gilt result.code == 1, bei einem Fehler result.code == 0. Ein Datensatz speichert den Wert eines einzelnen Parameters eines Belegs; die Struktur des Parameters wird in der Belegparameter-Schema API beschrieben.
/api/receipt_param/get
Abruf eines einzelnen Belegparameter-Werts. Die Suche erfolgt anhand der ID des Parameterschemas und/oder der ID des Belegs; von den gefundenen Zeilen wird die erste zurückgegeben. Mindestens einer der Parameter muss angegeben werden, andernfalls lautet die Antwort Not found.
Query-Parameter
| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
param_schema_id |
int | Kennung des Parameterschemas (mindestens dieser oder receipt_id ist erforderlich) |
|
receipt_id |
int | Kennung des Belegs (mindestens dieser oder param_schema_id ist erforderlich) |
Beispielanfrage
GET /api/receipt_param/get?param_schema_id=3&receipt_id=42
X-API-KEY: {ihr_api_schluessel}Beispielantwort
{
"result": { "code": 1, "message": "success" },
"data": {
"id": 17,
"param_schema_id": 3,
"param_value": "125.5",
"receipt_type_id": 1,
"receipt_id": 42
}
}/api/receipt_param/list
Liste der Belegparameter-Werte. Die Liste ist nicht paginierbar, die Treffer werden in einem Array zurückgegeben. Ohne Filter werden alle Datensätze zurückgegeben.
Query-Parameter
| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
list_condition[receipt_id] |
int | Filterung nach Beleg-ID | |
list_condition[receipt_type_id] |
int | Filterung nach Belegtyp-ID |
Beispielanfrage
GET /api/receipt_param/list?list_condition[receipt_id]=42
X-API-KEY: {ihr_api_schluessel}Beispielantwort
{
"result": { "code": 1, "message": "success" },
"data": [
{
"id": 17,
"param_schema_id": 3,
"param_value": "125.5",
"receipt_type_id": 1,
"receipt_id": 42
},
{
"id": 18,
"param_schema_id": 4,
"param_value": "Dringend",
"receipt_type_id": 1,
"receipt_id": 42
}
]
}/api/receipt_param/save
Speichern eines Belegparameter-Werts. Existiert für den angegebenen Beleg und das Parameterschema bereits ein Datensatz (param_schema_id + receipt_id), wird dieser geändert, andernfalls wird ein neuer Datensatz erstellt. Die Antwort enthält die Kennung des Datensatzes.
POST-Felder - data-Objekt
| Feld | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
param_schema_id |
int | Kennung des Parameterschemas (größer als 0) | |
receipt_id |
int | Kennung des Belegs (größer als 0) | |
receipt_type_id |
int | Kennung des Belegtyps | |
param_value |
string | Wert des Parameters als Text (höchstens 1500 Zeichen). Je nach param_type_id-Typ des Schemas eine Zahl, ein Text, ein boolescher Wert oder ein Element der Wertemenge. |
Beispielanfrage
POST /api/receipt_param/save
X-API-KEY: {ihr_api_schluessel}
Content-Type: application/json
{
"data": {
"param_schema_id": 3,
"receipt_id": 42,
"receipt_type_id": 1,
"param_value": "125.5"
}
}Beispielantwort
{
"result": { "code": 1, "message": "success" },
"data": {
"id": 17
}
}Interessierst du dich für unsere Software? Schreib uns einfach!
Jetzt registrieren,
später bezahlen!
