Basis-URL
https://{tenant}.logzi.com/api/cash_register/
Jede Anfrage liefert eine JSON-Antwort zurück. Bei Erfolg ist result.code == 1, im Fehlerfall result.code == 0.
/api/cash_register/get
Abruf eines einzelnen Kassenverkaufsbelegs anhand der ID, mit vollständiger Positionsliste.
Query-Parameter
| Parameter | Typ | Pflichtfeld | Beschreibung |
|---|---|---|---|
id | int | Eindeutige ID des Belegs |
Beispielanfrage
GET /api/cash_register/get?id=101
X-API-KEY: {ihr_api_schluessel}/api/cash_register/list
Paginierter Abruf der Liste von Kassenverkaufsbelegen mit Filtermöglichkeiten.
Query-Parameter
| Parameter | Typ | Pflichtfeld | Beschreibung |
|---|---|---|---|
list_offset | int | Paginierungs-Offset (Standard: 0) | |
list_count | int | Anzahl der Datensätze pro Seite | |
list_condition[identify] | string | Filter nach Belegnummer (LIKE) | |
list_condition[company_name] | string | Filter nach Kundenname (LIKE) | |
list_condition[status_id] | int | Filter nach Status | |
list_condition[date_create_from] | date | Erstellungsdatum — von (YYYY-MM-DD) | |
list_condition[date_create_to] | date | Erstellungsdatum — bis (YYYY-MM-DD) |
Beispielanfrage
GET /api/cash_register/list?list_offset=0&list_condition[status_id]=1
X-API-KEY: {ihr_api_schluessel}/api/cash_register/save
Erstellung oder Änderung eines Kassenverkaufsbelegs. Für einen neuen Beleg data[id] = 0.
POST-Felder — data-Objekt
| Feld | Typ | Pflichtfeld | Beschreibung |
|---|---|---|---|
id | int | 0 = neuer Beleg, >0 = Änderung | |
company_id | int | ID des Unternehmens | |
company_user_id | int | ID des zuständigen Mitarbeiters | |
company_address_id | int | ID des Standorts | |
currency_id | int | ID der Währung | |
paymod_id | int | ID der Zahlungsart | |
partner_id | int | ID des Kunden | |
date_perform | date | Leistungsdatum (YYYY-MM-DD) | |
comment_top | string | Kommentar | |
item | array | Array der Positionen (siehe unten) |
Positionsfelder — data[item][]
| Feld | Typ | Pflichtfeld | Beschreibung |
|---|---|---|---|
product_id | int | ID des Produkts | |
quantity | float | Menge | |
price | float | Brutto-Einzelpreis | |
tax_id | int | ID des MwSt.-Satzes | |
store_id | int | ID des Lagers | |
remove | int | 1 = Position beim Ändern löschen |
Beispielanfrage
POST /api/cash_register/save
X-API-KEY: {ihr_api_schluessel}
Content-Type: application/json
{
"data": {
"id": 0,
"company_id": 1,
"company_user_id": 3,
"company_address_id": 1,
"currency_id": 1,
"paymod_id": 1,
"item": [
{ "product_id": 5, "quantity": 2, "price": 3990, "tax_id": 2 }
]
}
}/api/cash_register/delete
Löschen eines Kassenverkaufsbelegs. Es kann nur ein Beleg mit offenem Status gelöscht werden.
POST-Felder — data-Objekt
| Feld | Typ | Pflichtfeld | Beschreibung |
|---|---|---|---|
receipt_id | int | ID des zu löschenden Belegs |
Beispielanfrage
POST /api/cash_register/delete
X-API-KEY: {ihr_api_schluessel}
Content-Type: application/json
{ "data": { "receipt_id": 101 } }/api/cash_register/close
Abschluss eines Kassenverkaufsbelegs. Beim Abschluss erfolgen die Lagerbewegung und die finanzielle Buchung. Es kann nur ein offener Beleg (status_id=1) abgeschlossen werden.
POST-Felder — data-Objekt
| Feld | Typ | Pflichtfeld | Beschreibung |
|---|---|---|---|
receipt_id | int | ID des abzuschließenden Belegs |
Beispielanfrage
POST /api/cash_register/close
X-API-KEY: {ihr_api_schluessel}
Content-Type: application/json
{ "data": { "receipt_id": 101 } }/api/cash_register/download
Download des Dokuments eines Kassenverkaufsbelegs in verschiedenen Formaten (PDF, druckbarer Bon).
Query-Parameter
| Parameter | Typ | Pflichtfeld | Beschreibung |
|---|---|---|---|
receipt_id | int | ID des Belegs | |
file_type | string | pdf, pdf-string, pdf-thermal, pos-thermal, stream | |
language | string | Name des Sprachordners der Vorlage | |
template_id | int | ID der individuellen Druckvorlage |
Beispielanfrage
GET /api/cash_register/download?receipt_id=101&file_type=pdf
X-API-KEY: {ihr_api_schluessel}Interessierst du dich für unsere Software? Schreib uns einfach!
Jetzt registrieren,
später bezahlen!
