# holzleitner_api.api.AdminApi ## Load the API package ```dart import 'package:holzleitner_api/api.dart'; ``` All URIs are relative to *http://localhost* Method | HTTP request | Description ------------- | ------------- | ------------- [**belegeDetails**](AdminApi.md#belegedetails) | **GET** /admin/belege/{belegnummer} | Liefert das **volle Detail-Paket** zu einer ERP-Belegnummer: die Lieferung mit Positionen (inkl. Scan-Ständen), Kunde + Ansprechpartner, referenzierte Artikel/Lager, Notizen, Geld-Gutschrift, Dienstleistungswerte und Kontakte — destilliert aus dem Tour-Aggregat. Jede Lieferung, unabhängig vom Status. `404`, wenn die Belegnummer unbekannt ist. [**completedDeliveries**](AdminApi.md#completeddeliveries) | **GET** /admin/completed-deliveries | Liefert **alle** abgeschlossenen (ausgelieferten) Lieferungen — optional auf einen Datumsbereich eingegrenzt, unabhängig vom Mail-Versand-Status. Gefiltert wird über den **Berliner** Kalendertag des Abschluss-Zeitpunkts (`completed_at`). [**deliveredBelegnummern**](AdminApi.md#deliveredbelegnummern) | **GET** /admin/delivered-belegnummern | Liefert die Belegnummern ausgelieferter (abgeschlossener) Lieferungen, **deren Liefermail noch nicht versendet wurde** (`mail_sent_at IS NULL`). „Ausgeliefert\" = es existiert ein Abschluss. Mit `day` (DD-MM-YYYY) nur Abschlüsse dieses Berliner Kalendertages; **ohne `day` alle offenen** (über alle Tage) — so bleiben Belege über Mitternacht nicht hängen. [**importErp**](AdminApi.md#importerp) | **POST** /admin/import-erp | Stößt den ERP-Import für ein Datum an und liefert die Zusammenfassung. [**listReviews**](AdminApi.md#listreviews) | **GET** /admin/reviews | Listet alle geänderten Lieferscheine, die noch auf eine manuelle Bestätigung (Vier-Augen) warten — Entfernungen und/oder Geld-Gutschriften. [**markMailSent**](AdminApi.md#markmailsent) | **POST** /admin/mark-mail-sent | Markiert die Liefermails der angegebenen Belegnummern als **versendet** (`mail_sent_at = now()`, nur wo noch offen). Vom Mailclient aufzurufen, NACHDEM ERPframe die Mails erfolgreich verschickt hat — danach erscheinen die Belege nicht mehr in `GET /admin/delivered-belegnummern`. [**positionsModified**](AdminApi.md#positionsmodified) | **GET** /admin/belege/{belegnummer}/positions-modified | Liefert zu **einer** ERP-Belegnummer, ob an der Lieferung Positionen verändert wurden (Menge reduziert/Zeile entfernt oder Geld-Gutschrift) — unabhängig vom Zustand der Lieferung. `404`, wenn die Belegnummer unbekannt ist. Gibt es mehrere Lieferungen mit derselben Belegnummer, ist das Flag `true`, sobald **eine** davon verändert ist. [**pushCompletion**](AdminApi.md#pushcompletion) | **POST** /admin/push-completion | Stößt das ERP-Rückschreiben eines bereits lokal abgeschlossenen Lieferabschlusses erneut an (idempotenter Retry, falls der automatische Push beim Abschluss fehlschlug). [**resolveReview**](AdminApi.md#resolvereview) | **POST** /admin/reviews/{delivery_id}/resolve | Bestätigt die Prüfung einer geänderten Lieferung (Vier-Augen) — die Lieferung verschwindet danach aus `GET /admin/reviews` (sofern nicht erneut geändert). # **belegeDetails** > DeliveryDetails belegeDetails(belegnummer) Liefert das **volle Detail-Paket** zu einer ERP-Belegnummer: die Lieferung mit Positionen (inkl. Scan-Ständen), Kunde + Ansprechpartner, referenzierte Artikel/Lager, Notizen, Geld-Gutschrift, Dienstleistungswerte und Kontakte — destilliert aus dem Tour-Aggregat. Jede Lieferung, unabhängig vom Status. `404`, wenn die Belegnummer unbekannt ist. ### Example ```dart import 'package:holzleitner_api/api.dart'; // TODO Configure API key authorization: admin_api_key //defaultApiClient.getAuthentication('admin_api_key').apiKey = 'YOUR_API_KEY'; // uncomment below to setup prefix (e.g. Bearer) for API key, if needed //defaultApiClient.getAuthentication('admin_api_key').apiKeyPrefix = 'Bearer'; final api = HolzleitnerApi().getAdminApi(); final String belegnummer = belegnummer_example; // String | ERP-Belegnummer, z. B. V-30690291 try { final response = api.belegeDetails(belegnummer); print(response); } catch on DioException (e) { print('Exception when calling AdminApi->belegeDetails: $e\n'); } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **belegnummer** | **String**| ERP-Belegnummer, z. B. V-30690291 | ### Return type [**DeliveryDetails**](DeliveryDetails.md) ### Authorization [admin_api_key](../README.md#admin_api_key) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **completedDeliveries** > CompletedDeliveriesResponse completedDeliveries(day, from, to) Liefert **alle** abgeschlossenen (ausgelieferten) Lieferungen — optional auf einen Datumsbereich eingegrenzt, unabhängig vom Mail-Versand-Status. Gefiltert wird über den **Berliner** Kalendertag des Abschluss-Zeitpunkts (`completed_at`). Parameter (alle `DD-MM-YYYY`, alle optional): `day` = Einzeltag (Kurzform `from=to=day`), sonst `from`/`to` als **inklusive** Bereichsgrenzen (je offen). **Ohne jeden Parameter → ALLE ausgelieferten Belege** (kein Datumsfilter). Pro Lieferung: Belegnummer + `positions_modified` (Menge reduziert/Zeile entfernt oder Geld-Gutschrift). Die Halb-Grenzen-Variante ist für Range-Filter gedacht: `?from=…` und `?to=…` liefern je eine Menge, deren SQL-`AND`-Schnitt den Zeitraum ergibt. ### Example ```dart import 'package:holzleitner_api/api.dart'; // TODO Configure API key authorization: admin_api_key //defaultApiClient.getAuthentication('admin_api_key').apiKey = 'YOUR_API_KEY'; // uncomment below to setup prefix (e.g. Bearer) for API key, if needed //defaultApiClient.getAuthentication('admin_api_key').apiKeyPrefix = 'Bearer'; final api = HolzleitnerApi().getAdminApi(); final String day = day_example; // String | Einzeltag DD-MM-YYYY (Kurzform from=to) final String from = from_example; // String | Untere Grenze DD-MM-YYYY (inklusive) final String to = to_example; // String | Obere Grenze DD-MM-YYYY (inklusive) try { final response = api.completedDeliveries(day, from, to); print(response); } catch on DioException (e) { print('Exception when calling AdminApi->completedDeliveries: $e\n'); } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **day** | **String**| Einzeltag DD-MM-YYYY (Kurzform from=to) | [optional] **from** | **String**| Untere Grenze DD-MM-YYYY (inklusive) | [optional] **to** | **String**| Obere Grenze DD-MM-YYYY (inklusive) | [optional] ### Return type [**CompletedDeliveriesResponse**](CompletedDeliveriesResponse.md) ### Authorization [admin_api_key](../README.md#admin_api_key) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **deliveredBelegnummern** > DeliveredBelegnummernResponse deliveredBelegnummern(day) Liefert die Belegnummern ausgelieferter (abgeschlossener) Lieferungen, **deren Liefermail noch nicht versendet wurde** (`mail_sent_at IS NULL`). „Ausgeliefert\" = es existiert ein Abschluss. Mit `day` (DD-MM-YYYY) nur Abschlüsse dieses Berliner Kalendertages; **ohne `day` alle offenen** (über alle Tage) — so bleiben Belege über Mitternacht nicht hängen. ### Example ```dart import 'package:holzleitner_api/api.dart'; // TODO Configure API key authorization: admin_api_key //defaultApiClient.getAuthentication('admin_api_key').apiKey = 'YOUR_API_KEY'; // uncomment below to setup prefix (e.g. Bearer) for API key, if needed //defaultApiClient.getAuthentication('admin_api_key').apiKeyPrefix = 'Bearer'; final api = HolzleitnerApi().getAdminApi(); final String day = day_example; // String | Tag DD-MM-YYYY; ohne Angabe ALLE offenen Belege try { final response = api.deliveredBelegnummern(day); print(response); } catch on DioException (e) { print('Exception when calling AdminApi->deliveredBelegnummern: $e\n'); } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **day** | **String**| Tag DD-MM-YYYY; ohne Angabe ALLE offenen Belege | [optional] ### Return type [**DeliveredBelegnummernResponse**](DeliveredBelegnummernResponse.md) ### Authorization [admin_api_key](../README.md#admin_api_key) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **importErp** > ImportSummary importErp(date) Stößt den ERP-Import für ein Datum an und liefert die Zusammenfassung. ### Example ```dart import 'package:holzleitner_api/api.dart'; // TODO Configure API key authorization: admin_api_key //defaultApiClient.getAuthentication('admin_api_key').apiKey = 'YOUR_API_KEY'; // uncomment below to setup prefix (e.g. Bearer) for API key, if needed //defaultApiClient.getAuthentication('admin_api_key').apiKeyPrefix = 'Bearer'; final api = HolzleitnerApi().getAdminApi(); final String date = date_example; // String | Ziel-Tourdatum YYYY-MM-DD (Default: heute) try { final response = api.importErp(date); print(response); } catch on DioException (e) { print('Exception when calling AdminApi->importErp: $e\n'); } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **date** | **String**| Ziel-Tourdatum YYYY-MM-DD (Default: heute) | [optional] ### Return type [**ImportSummary**](ImportSummary.md) ### Authorization [admin_api_key](../README.md#admin_api_key) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **listReviews** > BuiltList listReviews() Listet alle geänderten Lieferscheine, die noch auf eine manuelle Bestätigung (Vier-Augen) warten — Entfernungen und/oder Geld-Gutschriften. ### Example ```dart import 'package:holzleitner_api/api.dart'; // TODO Configure API key authorization: admin_api_key //defaultApiClient.getAuthentication('admin_api_key').apiKey = 'YOUR_API_KEY'; // uncomment below to setup prefix (e.g. Bearer) for API key, if needed //defaultApiClient.getAuthentication('admin_api_key').apiKeyPrefix = 'Bearer'; final api = HolzleitnerApi().getAdminApi(); try { final response = api.listReviews(); print(response); } catch on DioException (e) { print('Exception when calling AdminApi->listReviews: $e\n'); } ``` ### Parameters This endpoint does not need any parameter. ### Return type [**BuiltList<PendingReviewResponse>**](PendingReviewResponse.md) ### Authorization [admin_api_key](../README.md#admin_api_key) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **markMailSent** > MarkMailSentResponse markMailSent(markMailSentRequest) Markiert die Liefermails der angegebenen Belegnummern als **versendet** (`mail_sent_at = now()`, nur wo noch offen). Vom Mailclient aufzurufen, NACHDEM ERPframe die Mails erfolgreich verschickt hat — danach erscheinen die Belege nicht mehr in `GET /admin/delivered-belegnummern`. ### Example ```dart import 'package:holzleitner_api/api.dart'; // TODO Configure API key authorization: admin_api_key //defaultApiClient.getAuthentication('admin_api_key').apiKey = 'YOUR_API_KEY'; // uncomment below to setup prefix (e.g. Bearer) for API key, if needed //defaultApiClient.getAuthentication('admin_api_key').apiKeyPrefix = 'Bearer'; final api = HolzleitnerApi().getAdminApi(); final MarkMailSentRequest markMailSentRequest = ; // MarkMailSentRequest | try { final response = api.markMailSent(markMailSentRequest); print(response); } catch on DioException (e) { print('Exception when calling AdminApi->markMailSent: $e\n'); } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **markMailSentRequest** | [**MarkMailSentRequest**](MarkMailSentRequest.md)| | ### Return type [**MarkMailSentResponse**](MarkMailSentResponse.md) ### Authorization [admin_api_key](../README.md#admin_api_key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **positionsModified** > PositionsModifiedResponse positionsModified(belegnummer) Liefert zu **einer** ERP-Belegnummer, ob an der Lieferung Positionen verändert wurden (Menge reduziert/Zeile entfernt oder Geld-Gutschrift) — unabhängig vom Zustand der Lieferung. `404`, wenn die Belegnummer unbekannt ist. Gibt es mehrere Lieferungen mit derselben Belegnummer, ist das Flag `true`, sobald **eine** davon verändert ist. ### Example ```dart import 'package:holzleitner_api/api.dart'; // TODO Configure API key authorization: admin_api_key //defaultApiClient.getAuthentication('admin_api_key').apiKey = 'YOUR_API_KEY'; // uncomment below to setup prefix (e.g. Bearer) for API key, if needed //defaultApiClient.getAuthentication('admin_api_key').apiKeyPrefix = 'Bearer'; final api = HolzleitnerApi().getAdminApi(); final String belegnummer = belegnummer_example; // String | ERP-Belegnummer, z. B. V-30690291 try { final response = api.positionsModified(belegnummer); print(response); } catch on DioException (e) { print('Exception when calling AdminApi->positionsModified: $e\n'); } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **belegnummer** | **String**| ERP-Belegnummer, z. B. V-30690291 | ### Return type [**PositionsModifiedResponse**](PositionsModifiedResponse.md) ### Authorization [admin_api_key](../README.md#admin_api_key) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **pushCompletion** > pushCompletion(deliveryId) Stößt das ERP-Rückschreiben eines bereits lokal abgeschlossenen Lieferabschlusses erneut an (idempotenter Retry, falls der automatische Push beim Abschluss fehlschlug). ### Example ```dart import 'package:holzleitner_api/api.dart'; // TODO Configure API key authorization: admin_api_key //defaultApiClient.getAuthentication('admin_api_key').apiKey = 'YOUR_API_KEY'; // uncomment below to setup prefix (e.g. Bearer) for API key, if needed //defaultApiClient.getAuthentication('admin_api_key').apiKeyPrefix = 'Bearer'; final api = HolzleitnerApi().getAdminApi(); final String deliveryId = deliveryId_example; // String | UUID der abgeschlossenen Lieferung try { api.pushCompletion(deliveryId); } catch on DioException (e) { print('Exception when calling AdminApi->pushCompletion: $e\n'); } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **deliveryId** | **String**| UUID der abgeschlossenen Lieferung | ### Return type void (empty response body) ### Authorization [admin_api_key](../README.md#admin_api_key) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: Not defined [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **resolveReview** > resolveReview(deliveryId, resolveReviewRequest) Bestätigt die Prüfung einer geänderten Lieferung (Vier-Augen) — die Lieferung verschwindet danach aus `GET /admin/reviews` (sofern nicht erneut geändert). ### Example ```dart import 'package:holzleitner_api/api.dart'; // TODO Configure API key authorization: admin_api_key //defaultApiClient.getAuthentication('admin_api_key').apiKey = 'YOUR_API_KEY'; // uncomment below to setup prefix (e.g. Bearer) for API key, if needed //defaultApiClient.getAuthentication('admin_api_key').apiKeyPrefix = 'Bearer'; final api = HolzleitnerApi().getAdminApi(); final String deliveryId = deliveryId_example; // String | UUID der Lieferung final ResolveReviewRequest resolveReviewRequest = ; // ResolveReviewRequest | try { api.resolveReview(deliveryId, resolveReviewRequest); } catch on DioException (e) { print('Exception when calling AdminApi->resolveReview: $e\n'); } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **deliveryId** | **String**| UUID der Lieferung | **resolveReviewRequest** | [**ResolveReviewRequest**](ResolveReviewRequest.md)| | ### Return type void (empty response body) ### Authorization [admin_api_key](../README.md#admin_api_key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: Not defined [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)