Inventur Export API
Inventur Export API
Die Inventur Export API ermoeglicht das Abrufen freigegebener Inventurdaten fuer die Uebernahme in wme.fact. Der Export erfolgt Gruppe fuer Gruppe - jede Gruppe muss nach erfolgreichem Import bestaetigt werden.
Hinweis: Die API verwendet das gleiche Muster wie die Wiegeschein Export API: Daten werden einzeln (gruppe-weise) abgerufen und nach Bestaetigung geloescht.
Uebersicht der Endpoints
| Endpoint | Methode | Beschreibung |
|---|---|---|
| /v1/inventur/export/next | GET | Naechste exportierbare Gruppe abrufen |
| /v1/inventur/export/confirm | POST | Export einer Gruppe bestaetigen (loescht die Daten) |
| /v1/inventur/export/count | GET | Anzahl der exportierbaren Gruppen |
1. Naechste Gruppe abrufen
Ruft die naechste freigegebene Inventur-Gruppe ab. Eine Gruppe besteht aus allen Eintraegen mit gleicher Anlage, Artikel, Vertrag und Lagerort.
Request
GET /v1/inventur/export/next?apiKey=ihr-api-key
Response (200 OK)
{
"groupKey": "Anlage Sued|Altholz AI|V-2026-001|LA01",
"anlage": "Anlage Sued",
"artikel": "Altholz AI",
"vertrag": "V-2026-001",
"lagerort": "LA01",
"lagerart": "EINGANGSLAGER",
"stichtag": "2026-01-15",
"periode": "2026-01",
"gesamtGewicht": 12.750,
"volumen": 150.5,
"dichte": 0.085,
"entries": [
{
"id": 1001,
"kostentraegerNummer": "KST001",
"tonnage": 7.65,
"prozent": 60.0,
"volumen": 90.3,
"dichte": 0.085
},
{
"id": 1002,
"kostentraegerNummer": "KST002",
"tonnage": 5.10,
"prozent": 40.0,
"volumen": 60.2,
"dichte": 0.085
}
]
}
Response (204 No Content)
Keine weiteren Gruppen zum Exportieren vorhanden.
Gruppen-Felder
| Feld | Typ | Beschreibung |
|---|---|---|
| groupKey | String | Eindeutiger Schluessel der Gruppe (Format: anlage|artikel|vertrag|lagerort) |
| anlage | String | Anlagenbezeichnung |
| artikel | String | Artikelbezeichnung |
| vertrag | String | Vertragsnummer |
| lagerort | String | Lagerort |
| lagerart | String | EINGANGSLAGER oder AUSGANGSLAGER |
| stichtag | String | Stichtag der Inventur (YYYY-MM-DD) |
| periode | String | Abrechnungsperiode (YYYY-MM) |
| gesamtGewicht | Double | Gesamtgewicht der Gruppe in Tonnen |
| volumen | Double | Gesamtvolumen in m3 |
| dichte | Double | Dichte (t/m3) |
| entries | Array | Liste der Kostenstellen-Eintraege |
Kostenstellen-Eintrag Felder
| Feld | Typ | Beschreibung |
|---|---|---|
| id | Integer | Eindeutige ID des Eintrags |
| kostentraegerNummer | String | Kostentraegernummer |
| tonnage | Double | Anteilige Tonnage in Tonnen |
| prozent | Double | Prozentualer Anteil (Summe aller Eintraege = 100%) |
| volumen | Double | Anteiliges Volumen in m3 |
| dichte | Double | Dichte (t/m3) |
2. Export bestaetigen
Bestaetigt den erfolgreichen Import einer Gruppe. Nach Bestaetigung werden alle Eintraege der Gruppe aus der Datenbank geloescht.
Request
POST /v1/inventur/export/confirm
Content-Type: application/json
{
"apiKey": "ihr-api-key",
"groupKey": "Anlage Sued|Altholz AI|V-2026-001|LA01"
}
Request mit Fehlermeldung (optional)
{
"apiKey": "ihr-api-key",
"groupKey": "Anlage Sued|Altholz AI|V-2026-001|LA01",
"errorMessage": "Import fehlgeschlagen: Vertrag nicht gefunden"
}
Response (200 OK)
Gruppe erfolgreich bestaetigt und geloescht.
Request-Felder
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
| apiKey | String | Ja | API-Schluessel des Benutzers |
| groupKey | String | Ja | Schluessel der zu bestaetigenden Gruppe |
| errorMessage | String | Nein | Fehlermeldung falls Import fehlgeschlagen |
3. Anzahl exportierbarer Gruppen
Gibt die Anzahl der noch zu exportierenden Gruppen zurueck.
Request
GET /v1/inventur/export/count?apiKey=ihr-api-key
Response (200 OK)
{
"count": 5
}
Response-Codes (alle Endpoints)
| Code | Beschreibung |
|---|---|
| 200 | Anfrage erfolgreich |
| 204 | Keine Daten vorhanden (nur bei /next) |
| 400 | Ungueltige Anfrage (z.B. groupKey nicht gefunden) |
| 401 | API-Key ungueltig |
Typischer Export-Ablauf
- Anzahl pruefen: GET /v1/inventur/export/count - Anzahl der zu exportierenden Gruppen ermitteln
- Schleife starten: Solange count > 0:
- GET /v1/inventur/export/next - Naechste Gruppe abrufen
- Daten in wme.fact importieren
- POST /v1/inventur/export/confirm - Import bestaetigen
- Fertig: Wenn /next den Status 204 zurueckgibt, sind alle Gruppen exportiert
Curl-Beispiele
# 1. Anzahl der exportierbaren Gruppen pruefen
curl -X GET "https://linux.wme-fact.online/api/v1/inventur/export/count?apiKey=ihr-api-key"
# 2. Naechste Gruppe abrufen
curl -X GET "https://linux.wme-fact.online/api/v1/inventur/export/next?apiKey=ihr-api-key"
# 3. Export bestaetigen
curl -X POST "https://linux.wme-fact.online/api/v1/inventur/export/confirm" \
-H "Content-Type: application/json" \
-d '{"apiKey": "ihr-api-key", "groupKey": "Anlage Sued|Altholz AI|V-2026-001|LA01"}'
Wichtige Hinweise
- Gruppe fuer Gruppe: Der Export erfolgt einzeln pro Gruppe. Jede Gruppe muss nach erfolgreichem Import bestaetigt werden.
- Automatische Loeschung: Nach Bestaetigung werden die Daten unwiderruflich geloescht.
- Prozent-Summe: Die Summe aller Prozent-Werte innerhalb einer Gruppe betraegt immer 100%.
- Gewichtsverteilung: Tonnage und Volumen sind bereits anteilig nach Prozent berechnet.
- Fehlerbehandlung: Bei Import-Fehlern kann eine errorMessage mitgegeben werden zur Protokollierung.
No comments to display
No comments to display