Interseroh EntsorgerPortal

Mehrwert

Ein System, das den Service Interseroh EntsorgerPortal Bestellung-Leistung API konsumiert, kann automatisiert Bestellungen prüfen, beantworten und daraus Aufträge erzeugen. Nach Beendigung des Auftrages kann das System direkt die Leistungsmledung an Interseroh übermitteln.

Funktionalität

Der Service Interseroh EntsorgerPortal Bestellung-Leistung API kann über verschiedene Endpoints genutzt werden. Diese Endpoints sind durch Swagger dokumentiert ( Link zu Swagger).
Folgende Funktionalitäten werden bereitgestellt:

• Abruf einer Liste von Bestellungen
• Abruf einer einzelnen Bestellung
• Bestellung akzeptieren
• Bestellung zurückweisen
• Bestellung stornieren
• Fälligkeitsdatum einer Bestellung ändern
• Senden von Leistungsmeldungen in Form von Metadaten.
• Senden von optischen Belegen.

Bestellung

Der gesamte Bestellung-Service basiert auf dem Datenobjekt Bestellung. Das Objekt enthält Paramter und verweist auf weitere Objekte. Diese verfügen wiederum über eigene Parameter. Im folgenden werden die Objekte und Parameter erläutert:

Objekt	Parameter	Erläuterung
bestellung		Eine Bestellung ist eine Bedarfsäußerung verbunden mit dem Wunsch auf Leistungserbringung.
	bestellId	Ein eindeutiger, technischer Identifizierer der Bestellung und des gesamten Geschäftsvorganges.
	bestellnummer	Identifiziert eine einzelne Bestellung (fachlich).
	erstellungsdatum	Das Datum an dem eine Bestellung erstellt wurde.
	dokumentErforderlich	Der Vorgang kann erst fakturiert werden nachdem ein optischer Beleg eingereicht wurde. Ein optischer Beleg ist z.B.: eine PDF-Datei eines eingescannten Wiegescheins.
	turnusAuftrag	Gibt an, ob eine Bestellung, durch einen Turnusauftrag (TRUE) erzeugt wurde.
	info	Hier können zusätzliche Informationen hinterlegt werden. Ggf. auch direkt vom Kunden.
	status	Der Status des Bestellungskopfes (siehe Tabelle unten).
rahmenvertrag		Vertrag, der Grundlage der Bestellung ist
	nummer	Fachlicher Identifizierer eines Rahmenvertrags.
	beschreibung	Name des entsprechenden Individualvertrages.
betriebsstaette		Definiert die Betriebsstätte des Entsorgungspartners, an welche sich die Bestellung richtet.
	beschreibung	Eine Fachliche Beschreibung der Betriebsstätte
lieferant		Definiert den Lieferanten (=Entsorgungspartner), an welchen sich die Bestellung richtet.
	nummer	Fachlicher Identifizierer des Lieferanten
	name	Name des Lieferanten
leistungsadresse		Anschrift der Leitungserbringung für den Kunden; unabhängig von der Art der Leistung (Ware, Entsorgung, Dienstleistung)
	nummer	Fachlicher Identifizierer einer Leistungsadresse. Falls typ=ANFALLSTELLE handelt es sich um die Anfallstellennummer.
	name	Teil der Anschrift.
	beschreibung	Teil der Anschrift.
	strasse	Teil der Anschrift.
	plz	Teil der Anschrift.
	ort	Teil der Anschrift.
	info	Freitextfeld für weitere Informationen, das durch den Auftraggeber gefüllt werden kann (z.B. Informationen zur Zufahrt o.ä.).
	typ	Beschreibt den Typ der Leistungsadresse. Mögliche Werte: ANFALLSTELLE; LADESTELLE
positionen		Eine Anzahl von Positionen zu dieser Bestellung.
	posId	Ein eindeutiger, technischer Identifizierer der Position.
	hauptposition	Gibt an ob die jeweilige Position eine Hauptposition ist (true / false). Leistungsrückmeldungen dürfen sich nur auf Hauptpositionen beziegen.
	nummer	Jede Position einer Bestellung erhält eine eindeutige Nummer.
	menge	Beschreibt die bestellte Menge einer Position
	mengeneinheit	Beschreibt die Einheit, mit der die Position gemessen wird.
	faelligkeitsdatum	Datum bis zu dem die jeweilige Position geleistet werden muss.
	status	Positionsstatus (siehe Tabelle unten)
	typ	Mögliche Werte: BAG; CONTAINER; CONTAINER_LEER; FRACHTPAPIERE; FRACTION; FRACTION_2; FREIGHT; HANDLING; SHIP_ONLY_CONTAINER; SHIP_ONLY_FREIGHT; SHIP_ONLY_HANDLING; SHIP_ONLY_FRACTION; VERWERTUNG
artikel		Abrechnungsgrundlage, Abrechnungsposition, kann Material bzw. Dienstleistung sein.
	nummer	Fachlicher Identifizierer eines Artikels.
	beschreibung	Beschreibt den Artikel in Worten.
	avvnummer	Die AVV-Nummer des Stoffes, falls der Artikel einen Stoff beschreibt.

Status

Bestellungen (Kopfebene) und Bestellungspositionen können einen der folgenden Status annehmen. Die jeweils möglichen Aktionen sind abhängig vom Status:

Bestellung		Position
Status	Mögliche Aktionen	Status	Mögliche Aktionen
OFFEN	Akzeptieren, Zurückweisen	OFFEN
AKZEPTIERT	Stornierung anfragen	AKZEPTIERT	Leistung zurückmelden, Änderung des Fälligkeitsdatums anfragen
-		RUECKGEMELDET
ERFUELLT		ERFUELLT
GESPERRT		GESPERRT
ZURUECKGEWIESEN		ZURUECKGEWIESEN
AENDERUNGSWUNSCH_EINGEGANGEN		AENDERUNGSWUNSCH_EINGEGANGEN
STORNIERT		STORNIERT

Die Status sind fachlich wie folgt definiert:

• OFFEN: Bestellungen und Positionen in diesem Status sind neu beim Entsorger eingegangen und noch nicht geprüft worden (entsprechend noch nicht akzeptiert oder zurückgewiesen worden)
• AKZEPTIERT: Bestellungen und Positionen in diesem Status wurden vom Entsorgungspartner nach formalen Gesichtspunkten, ggf. automatisiert, geprüft und positiv beschieden
• RUECKGEMELDET: Für Positionen in diesem Status liegt eine Leistungsmeldung vor. Diese wurde allerdings noch nicht vollständig verarbeitet und muss ggf. noch geprüft werden.
• ERFUELLT: Für Positionen in diesem Status liegt eine vollständig verarbeitete Leistungsmeldung vor. Wenn alle Positionen einer Bestellung erfüllt wurden, wechselt der Status der Bestellung (Kopfstatus) auf ERFUELLT
• GESPERRT: Dieser Status zeigt eine interne Bearbeitung der Bestellung (von Seiten Interseroh).
• ZURUECKGEWIESEN: Bestellungen und Positionen in diesem Status wurden vom Entsorgungspartner nach formalen Gesichtspunkten, ggf. automatisiert geprüft und negativ beschieden
• AENDERUNGSWUNSCH_EINGEGANGEN: Sobald der Entsorgungspartner entweder eine Stornierung der gesamten Bestellung oder die Änderung eines Fälligkeitsdatums einer Position anfragt, wechselt die gesamte Bestellung in diesen Status.
• STORNIERT: Bestellungen uns Positionen in diesem Status wurden storniert. STORNIERT ist ein Endstatus, der nicht wieder verlassen werden kann.

Leistung

Der gesamte Leistung-Service basiert auf dem Datenobjekt Leistung. Das Objekt hat Paramter und verweist auf weitere Objekte. Diese verfügen wiederum über eigene Paramter. Im folgenden werden die Objekte und Parameter erklärt:

Objekt	Parameter	Erläuterung
leistung		Eine Leistungsrückmeldung auf eine konkrete Hauptposition.
	leistungsdatum	Datum der Ausführung der Leistung.
	lieferscheinnummer	Die identifizierende Nummer des Leistungsnachweises.
	menge	Beschreibt die erfasste Menge einer Position (kann bei Pauschalbestellungen beispielsweise auch „1 Stück“ sein).
	mengeneinheit	Beschreibt die Einheit, mit der die Position gemessen wird.
	verwogen	Gibt an, ob das Material verwogen wurde. Mögliche Werte: TRUE; FALSE
beleg		Falls notwendig, kann hier ein Scan bzw. Foto eines physischen Leistungsnachweises angefügt werden (ergibt sich aus dem Kennzeichen „dokumentErforderlich“ in der Bestellung).
	belegArten	Gibt die Belegart an. Kann entweder LIEFERSCHEIN, WIEGESCHEIN, ÜBERNAHMESCHEIN oder BELEGKOMBINATION sein.
	belegId	Ein eindeutiger, technischer Identifizierer des Belges.
	datei	Als String kodierte Datei (pdf oder Bilddatei).