Basis-URL
https://{tenant}.logzi.com/api/delivery_note_out/
Jede Anfrage liefert eine JSON-Antwort zurück. Bei Erfolg gilt result.code == 1, bei Fehler result.code == 0.
/api/delivery_note_out/get
Abrufen eines einzelnen ausgehenden Lieferscheins anhand der Kennung, mit vollständigen Details.
Query-Parameter
| Parameter | Typ | Pflicht | Beschreibung |
|---|---|---|---|
id | int | Eindeutige Kennung des Lieferscheins |
Beispielanfrage
GET /api/delivery_note_out/get?id=22
X-API-KEY: {ihr_api_schluessel}/api/delivery_note_out/list
Paginierbarer Abruf der Liste ausgehender Lieferscheine mit Filtermöglichkeiten.
Query-Parameter
| Parameter | Typ | Pflicht | Beschreibung |
|---|---|---|---|
list_offset | int | Versatz der Paginierung (Standard: 0) | |
list_count | int | Anzahl der Datensätze pro Seite | |
list_condition[identify] | string | Filterung nach Kennung (LIKE) | |
list_condition[company_name] | string | Filterung nach Partnername (LIKE) | |
list_condition[status_id] | int | Filterung 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/delivery_note_out/list?list_offset=0&list_condition[status_id]=1
X-API-KEY: {ihr_api_schluessel}/api/delivery_note_out/save
Erstellen oder Ändern eines ausgehenden Lieferscheins. Für einen neuen Datensatz data[id] = 0.
POST-Felder — data-Objekt
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
id | int | 0 = neuer Lieferschein, >0 = Änderung | |
company_id | int | Kennung des Unternehmens | |
company_user_id | int | Kennung des zuständigen Mitarbeiters | |
company_address_id | int | Kennung der Unternehmens-Niederlassung | |
currency_id | int | Kennung der Währung | |
partner_id | int | Kennung des Partners/Kunden | |
partner_shipping_id | int | Kennung der Partner-Lieferadresse | |
date_perform | date | Lieferdatum (YYYY-MM-DD) | |
comment_top | string | Für den Kunden sichtbare Bemerkung | |
comment_bottom | string | Interne Bemerkung | |
jobnumber_id | int | Kennung der Auftragsnummer | |
item | array | Array der Positionen (siehe unten) |
Positionsfelder — data[item][]
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
product_id | int | Kennung des Produkts | |
quantity | float | Menge | |
price | float | Netto-Einzelpreis | |
tax_id | int | Kennung des MwSt.-Satzes | |
store_id | int | Kennung des Lagers | |
remove | int | 1 = Position bei Änderung löschen |
Beispielanfrage
POST /api/delivery_note_out/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,
"partner_id": 12,
"date_perform": "2024-06-20",
"item": [
{ "product_id": 5, "quantity": 3, "price": 12000, "tax_id": 2 }
]
}
}/api/delivery_note_out/delete
Löschen eines ausgehenden Lieferscheins. Nur ein Lieferschein mit offenem Status kann gelöscht werden.
POST-Felder — data-Objekt
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
receipt_id | int | Kennung des zu löschenden Lieferscheins |
Beispielanfrage
POST /api/delivery_note_out/delete
X-API-KEY: {ihr_api_schluessel}
Content-Type: application/json
{ "data": { "receipt_id": 22 } }/api/delivery_note_out/close
Abschließen eines ausgehenden Lieferscheins. Nur ein Lieferschein mit offenem Status (status_id=1) kann abgeschlossen werden.
POST-Felder — data-Objekt
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
receipt_id | int | Kennung des abzuschließenden Lieferscheins |
Beispielanfrage
POST /api/delivery_note_out/close
X-API-KEY: {ihr_api_schluessel}
Content-Type: application/json
{ "data": { "receipt_id": 22 } }/api/delivery_note_out/download
Download des Dokuments des ausgehenden Lieferscheins in verschiedenen Formaten.
Query-Parameter
| Parameter | Typ | Pflicht | Beschreibung |
|---|---|---|---|
receipt_id | int | Kennung des Lieferscheins | |
file_type | string | pdf, pdf-string, pdf-string-sample, stream | |
language | string | Name des Sprachordners der Vorlage | |
template_id | int | Kennung der individuellen Druckvorlage |
Beispielanfrage
GET /api/delivery_note_out/download?receipt_id=22&file_type=pdf
X-API-KEY: {ihr_api_schluessel}Interessierst du dich für unsere Software? Schreib uns einfach!
Jetzt registrieren,
später bezahlen!
