Changelog

Hinweis: Die Schnittstelle wird gemäß Web-API Design-Guidelines priviligierter Schnittstellen umgesetzt. In dieser Dokumentation werden ausschließlich Abweichungen beschrieben.

3.46.6.656 / Schleupen.CS HV26 2026-09-29 (September 2026 - KW40-Di)

  1. Folgende Endpunkte liefern momentan ausschließlich Ergebnisse für den Geschäftsbereich "Strom" zurück:
    • GET Zähler abfragen (ZaehlerID)
    • GET Mehrere Zähler abfragen
    • GET Zählwerke abfragen (ZaehlerId)
    • GET Messlokationen abfragen (ZaehlerID)
  2. Der Endpunkt “GET Zählwerke abfragen (ZaehlerId)” wurde um Zählwerk-Gültigkeiten, sprich die Felder  “gueltigAb” und “gueltigBis” erweitert.
  3. Das Objekt “zaehlwerke” wurde um die beiden Felder “gueltigAb” und “gueltigBis” innerhalb folgender Endpunkt erweitert:
    • GET Messlokation abfragen (MesslokationID)
    • GET Mehrere Messlokationen abfragen
    • GET Messlokationen abfragen (MarktlokationID)
  4. Folgende Endpunkten wurden um Zähler-Gültigkeiten, spich die Felder “gueltigAb” und “gueltigBis”, ergänzt:
    • GET Zähler abfragen (ZaehlerID)
    • GET Mehrere Zähler abfragen
    • GET Zähler abfragen (MesslokationId)
  5. Der Endpunkt “GET Messlokationen abfragen (ZaehlerID)” wurde wie folgt erweitert: 
    • Das Objekt “zaehler” wurde um die beiden Felder “gueltigAb” und “gueltigBis” ergänzt.
    • Das Objekt “zaehlwerke” wurde um die beiden Felder “gueltigAb” und “gueltigBis” ergänzt.
    • Es wurde das Objekt “sperrzeitraeume” hinzugefügt. 

3.46.6.548 / Schleupen.CS HV26 2026-09-08 (September 2026 - KW37-Di)

  1. Erweiterung des Endpunktes „POST Vertragsbeendigung anfragen“ um das neue optionale Flag „istKuendigungspruefungErfolgt“. Mit diesem Flag kann die Kündigungsfristenprüfung bei Vertragsbeendigungen deaktiviert werden, so dass die automatisierte Verarbeitung von Umzugs- oder vergleichbaren Geschäftsprozessen ohne Prozessunterbrechungen erfolgen kann.
  2. Beschreibung zum Parameter Vertriebskanal im Endpunkt "GET Tarifvariante suchen" wurde um folgenden Hinweis ergänzt: "Wenn an einer Tarifvariante kein expliziter Vertriebskanal hinterlegt wurde, dann sind alle Vertriebskanäle zulässig. Diese Tarifvarianten werden auch bei einem gesetzten Filter immer mit ausgegeben."
  3. Die Version 3.0 des Endpunktes "POST Vertragsanlage starten" wurde abgekündigt.

3.46.6.531 / Schleupen.CS SV26 2026-07-28 (Juli 2026 - KW31-Di)

  1. Neuer Webhook „KonfigurierbareAttributeGeaendertEvent“:
    • Event-Typ: Updated
  2. Ergänzung des neuen optionalen Objektes "configurableAttributes" innerhalb folgender Abfragen: 
    • GET Vertrag abfragen (VertragId)
    • GET Vertraege abfragen
    • GET Vertraege abfragen (RechnungseinheitskontoId)
  3. Neue Version der Abfrage POST Vertragsanlage starten:
    • POST /api/vertraege/v3.1/
    • Entfernung des Pflichtfeldes "documentId" innerhalb des optionalen Objektes "externeDokumente"; Die DocumentID wird nun automatisch erzeugt.

3.46.5.511 / Schleupen.CS SV26 2026-07-14 (Juli 2026 - KW29-Di)

  1. Erweiterung des Objektes "vertragsauftraege" im Endpunkt POST Vertragsanlage starten:
    • Neues optionales Feld "vertragId" ergänzt. Durch dieses Feld wird eine Übergabe einer konkreten GUID von außen ermöglicht. Der Vertrag wird dann mit dieser VertragId angelegt. Bitte beachten: Die VertragsId muss eindeutig sein. Sie kann also nicht mehrfach verwendet werden.
    • Neue optionales Unterobjekt "configurableAttributes". Durch dieses Objekt können Ausprägungen an einem Vertrag zu einem zuvor konfigurierten Attribut (Die Struktur eines konfigurierten Attributs muss zuvor über Powershell eingespielt werden) mitgeben werden.

3.46.3.492 / Schleupen.CS SV26 2026-07-06 (Juli 2026 - KW28)

  1. Die Response folgender Vertrag-Abfrage-Endpunkte wurden um die optionalen Felder "naechsterAbrechnungsstichtag" und "sonderkuendigungsdatum" ergänzt:
    • GET Vertrag abfragen (VertragId)
    • GET Vertraege abfragen
    • GET Vertraege abfragen (RechnungseinheitskontoId)
  2. Erweiterung des Request des Endpunktes "POST Vertragsanlage starten" um das optionale Objekt "externeDokumente":
    • cabinetFileInfoId (Pflichtfeld) = existierende GUID aus der Dateiablage
    • documentId (Pflichtfeld) = freiwählbare GUID die in die Dokumentenablage geschrieben wird
    • documentName (Pflichtfeld) = Dokumentenname der in die Dokumentenablage geschrieben wird; Bitte mit Datenformatsendung angeben.
  3. Anpassung der Schema-Beschreibung zum Nutzungszeitpunkt beim Endpunkt "POST Messwert erfassen". Sie erhält nun einen Link, der zu einer genauen Erläuterung der Generierungslogik führt:
GeschäftsbereichsartAblesegrundRegelBeispiel
GasZwischenablesung,
Turnusablesung,
Geräteausbau,
Vertragswechsel + Endzählerstand		Es wird immer der nächste Tag 06:00 als Nutzungszeitpunkt gewählt01.01.2026 00:00 <= Ablesezeitpunkt < 02.01.2026 00:00 => Nutzungszeitpunkt = 02.01.2026 06:00
GasGeräteeinbau,
Gerätewechsel,
Vertragswechsel + Anfangszählerstand		Es wird immer derselbe Tag 06:00 als Nutzungszeitpunkt gewählt01.01.2026 00:00 <= Ablesezeitpunkt < 02.01.2026 00:00 =>Nutzungszeitpunkt = 01.01.2026 06:00
Strom, Wärme, WasserZwischenablesung,
Turnusablesung,
Geräteausbau,
Vertragswechsel + Endzählerstand		Es wird immer der nächste Tag 00:00 als Nutzungszeitpunkt gewählt01.01.2026 00:00 <= Ablesezeitpunkt < 02.01.2026 00:00 => Nutzungszeitpunkt = 02.01.2026 00:00
Strom, Wärme, WasserGeräteeinbau,
Gerätewechsel,
Vertragswechsel + Anfangszählerstand		Es wird immer derselbe Tag 00:00 als Nutzungszeitpunkt gewählt01.01.2026 00:00 <= Ablesezeitpunkt < 02.01.2026 00:00 => Nutzungszeitpunkt = 01.01.2026 00:00

3.46.2.469 / Schleupen.CS SV26 2026-06-15 (Juni 2026 - KW25)

  1. Neuer Endpunkt "/api/vertraege/{vertragId}/rueckabwicklung/v3.0" hinzugefügt:
    • Im Request:
      • istWiderruf (optional)
      • transaktionsgrund (optional)
      • istBilateraleKlaerungErfolgt (optional)
      • bilanzierungsendedatum (optional)
      • dokumentErzeugen (optional)
      • widerrufAkzeptieren(optional)
      • bemerkung (optional)

3.46.1.433 / Schleupen.CS SV26 2026-06-02 (Juni 2026 - KW23-Di)

  1. Neue Schnittstellenversion v3.1 des Endpunktes "POST Messwert erfassen":
    • In der Response wurde die Enum-Liste des Feldes "ablesegrund" gekürzt. Folgende Enum-Werte wurden entfernt:
      • Bilanzierungsgebietswechsel
      • Entsperrung
      • Geraeteparameteraenderung
      • Sperrung
      • ZaehlerstandFuerAbgrenzung
  2. Die Response folgender Messlokations-Abfrage-Endpunkte wurden um das optionale Objekt "sperrzeitraeume" ergänzt:
    • GET Messlokation abfragen (MesslokationId)
    • GET Mehrere Messlokationen abfragen
    • GET Messlokation abfragen (MarktlokationId)

3.45.1.421 / Schleupen.CS FV26 2026-05-26 (Mai 2026 - KW22-Di)

  1. Der Rufnummer-RegEx war inkonsistent zwischen CS.Schleupen und CRM-Konnektor. Die Validierung der Rufnummer im CRM-Konnektor wurde nun an die Validierung in CS.Schleupen angeglichen. Es gilt nun folgende Regel '^[\\+(]?[0-9/.() \\-]+$'." .
    Folgende Endpunkte wurden entsprechend angepasst:
    • POST Vertragsanlage starten
    • POST Vertragspartner ändern
    • POST Rechnungsempfänger ändern
    • POST Bankverbindung ändern
    • POST Person anlegen
    • GET Person abfragen
    • GET Personen abfragen

3.45.1.417 / Schleupen.CS FV26 2026-05-14 (Mai 2026 - KW20-Do)

  1. Neue Schnittstellenversion v3.1 des Endpunktes "GET Traifvarianten abfragen (Tarifid)":
    • Erweiterung in der Response:
      • vertragsTarifoptionen.vertragslaufzeit.laufzeiten erweitert: vertragslaufzeitBeginn
      • vertragstarifoptionen.preisbindung.preisbindungsbeginn erweitert: neuer enum-Wert: AbAnmeldebestaetigungNN
  2. Neue Schnittstellenversion v3.1 des Endpunktes "GET Tarifvariante abfragen (TarifvarianteId)":
    • Erweiterung in der Response:
      • vertragsTarifoptionen.vertragslaufzeit.laufzeiten erweitert: vertragslaufzeitBeginn
      • vertragstarifoptionen.preisbindung.preisbindungsbeginn erweitert: neuer enum-Wert: AbAnmeldebestaetigungNN
  3. Neue Schnittstellenversion v3.1 des Endpunktes "GET Tarifvarianten suchen":
    • Erweiterung in der Response:
      • vertragsTarifoptionen.vertragslaufzeit.laufzeiten erweitert: vertragslaufzeitBeginn
      • vertragstarifoptionen.preisbindung.preisbindungsbeginn erweitert: neuer enum-Wert: AbAnmeldebestaetigungNN
  4. Erweiterung der Response des Endpunktes "GET Tarifvarianten abfragen (VertragId)":
    • vertragsTarifoptionen.vertragslaufzeit erweitert: vertragslaufzeitBeginn
    • vertragspreisSpezifikationen erweitert: preisbindungBis (optional)
  5. Erweiterung der Response des Endpunktes "GET Verträge abfragen (RechnungseinheitskontoId)":
    • vertragslaufzeit erweitert: vertragslaufzeitBeginn, bezugsdatum
    • vertragsverlaengerung erweitert: bezugsdatum
    • kuendigungsfrist erweitert: bezugsdatum
    • vertragspreisSpezifikationen erweitert: preisbindungBis (optional)
  6. Erweiterung der Response des Endpunktes "GET Verträge abfragen":
    • vertragslaufzeit erweitert: vertragslaufzeitBeginn, bezugsdatum
    • vertragsverlaengerung erweitert: bezugsdatum
    • kuendigungsfrist erweitert: bezugsdatum
    • vertragspreisSpezifikationen erweitert: preisbindungBis (optional)
  7. Erweiterung der Response des Endpunktes "GET Vertrag abfargen (VertragId)":
    • vertragslaufzeit erweitert: vertragslaufzeitBeginn, bezugsdatum
    • vertragsverlaengerung erweitert: bezugsdatum
    • kuendigungsfrist erweitert: bezugsdatum
    • vertragspreisSpezifikationen erweitert: preisbindungBis (optional)
  8. Erweiterung des Request des Endpunktes "POST Tarifwechsel anfragen (VertragId)":
    • Hinzufügen des Flags "istRueckwirkenderTarifwechselErforderlich" (optional)

3.45.1.397 / Schleupen.CS FV26 2026-05-05 (Mai 2026 - KW19-Di)

  1. Der Endpunkte "POST Versandweg ändern (RechnungseinheitskontoID)" wurde um das optionale Feld "ruecklaeuferschreibenerzeugen" erweitert.

3.44.2.370 / Schleupen.CS FV26 2026-04-24 (April 2026 - KW17-Fr)

  1. Der Endpunkte "GET Rechnungseinheitskonto abfragen (RechnungseinheitskontoID)" wurde um das optionale Feld "stornodokumentErzeugen" erweitert.
  2. Endpunkte "GET Mehrere Rechnungseinheitskonten abfragen" wurde um das optionale Feld "stornodokumentErzeugen" erweitert.

3.44.1.362 / Schleupen.CS FV26 2026-04-23 (April 2026 - KW17-Do)

  1. Anpassung des Endpunktes "POST Abrechnungssperre setzen":
    • Innerhalb des Objektes "Abrechnungssperre" wurde das Feld "rechnungseinheitId" durch das Feld "rechnungseinheitskontoId" ersetzt.
  2. Anpassung des Endpunktes "GET Mehrere Rechnungseinheitskonten abfragen":
    • Am Objekt "abrechnungssperre" wurde das Feld "rechnungseinheitId" entfernt
  3. Anpassung des Endpunktes "GET Rechnungseinheitskonto abfragen (RechnungseinheitskontoID)":
    • Am Objekt "abrechnungssperre" wurde das Feld "rechnungseinheitId" entfernt

3.43.2.313 / Schleupen.CS FV26 2026-04-02 (April 2026 - KW14-Do)

  1. Der Endpunkte "POST Tarifwechsel anfragen" wurde um das optionale Feld "abschlagsplanNeuGenerieren" erweitert.
    Das Flag ist das relevante Kennzeichen für die Anlage eines Abschlagsplans. Für die korrekte Anlage muss das Flag und ein Abschlagsbetrag mitgeben werden.

3.43.2.298 / Schleupen.CS FV26 2026-03-26 (März 2026 - KW13-Do)

  1. Folgende Endpunkte wurden um das optionale Feld "kundenkommunikationBezeichnung" erweitert:
    • GET Tarifvarianten (TarifID)
    • GET Tarifvariante (TarifvariantenID)
    • GET Tarifvariante (VertragID)
    • GET Tarifvarianten suchen
  2. Der Request des Endpunktes "GET Tarifvarianten suchen" wurde zudem um den Parameter "kundenkommunikationBezeichung" ergänzt.
  3. Logikanpassung innerhalb Endpunkt "POST Messwerte erfassen"; Es wurde die Logik bezüglich der Ermittlung des Nutzungszeitpunktes für Messwerte in Schleupen.CS geändert.
    • Aus diesem Grund sind nur noch folgende Ablesegründe nutzbar:
      • Vertragswechsel
      • Gerätewechsel
      • Geräteausbau
      • Geräteeinbau
      • Turnusablesung
      • Zwischenablesung
    • Aus diesem Grund sind nur noch folgende Ableseerfassungshinweise nutzbar:
      • Anfangszählerstand
      • Endzählerstand
      • Zählerstand
    • HINWEIS: Die obsoleten Enum-Werte wurden noch nicht entfernt.Dies erfolgt zu einem späteren Zeitpunkt.

3.43.1.278 / Schleupen.CS FV26 2026-03-17 (März 2026 - KW12-Di)

  1. Die Response des Endpunktes "GET Messwerte abfragen" wurden wie folgt angepasst:
    • Die MesswertId wurde von einer Pflichtangabe zu einer optionalen Angabe geändert.

3.42.2.274 / Schleupen.CS FV26 2026-03-10 (März 2026 - KW11-Di)

  1. Folgende Endpunkte wurden um das optionale Objekt "abrechnungssperre" erweitert:
    • GET Rechnungseinheitskonto abfragen
    • GET Rechnungseinheitskonten abfragen

3.42.1.254 / Schleupen.CS WV25 2026-01-22/Rheinenergie (Januar 2026 - KW4-Do)

  1. Neue Endpunkte im Bereich "Gründe für Sperren" hinzugefügt:
    • GET Gründe für Abrechnungssperre abfragen
    • GET Abrechnungssperregrund abfragen (AbrechnungssperreGrundID)
  2. Neue Endpunkte im Bereich "Rechnungseinheitskonten" hinzugefügt:
    • POST Abrechnungssperre setzen (RechnungseinheitskontoID)
    • POST Abrechnungssperren setzen
    • DELETE Abrechnungssperre entfernen (RechnungseinheitskontoID)
    • DELETE Abrechnungssperren entfernen
  3. Events:
    • Allgemeines Objekt Meta.EventType um AbrechnungssperrgrundEvent erweitert.

3.1.12.1 / Schleupen.CS WV25 2026-01-12 (Januar 2026 - KW3)

  1. Erweiterung der Endpunkte "GET Marktlokation abfragen (VertragID)", "GET Marktlokation abfragen (MarktlokationID)" und "GET Marktlokationen abfragen" um das Objekt "Bilanzierungsdaten"

3.1.12.0 / Schleupen.CS HV25 2025-11-11 (November 2025 - KW46-Di)

  1. Erweiterung des Endpunktes "POST Tarifwechsel anfragen (VertragID)" innerhalb des Objektes "Vertragspreisspezifikationen" um das optionale Merkmal "einheitZeitbezugUndAbgrenzung"
  2. Neue Version des Endpunktes "POST Vertragsbeendigung anfragen (VertragID)" mit der Erweiterung folgender optionaler Felder:
    • istBilateraleKlaerungErfolgt
    • bilanzierungsendedatum

3.1.11.3 / Schleupen.CS HV25 2025-10-27(Oktober 2025 - KW44-Mo)

  1. Erweiterung des Endpunktes "POST Vertragsanlage starten (VertragID)" innerhalb des Objektes "Vertragspreisspezifikationen"um das optionale Merkmal "einheitZeitbezugUndAbgrenzung"

3.1.11.2 / Schleupen.CS HV25 2025-10-06(Oktober 2025 - KW41-Mo)

  1. Erweiterung des Endpunktes "POST Tarifwechsel anfragen (VertragID)":
    • Objekt "Vertragspreisspezifikationen"
    • Merkmal "vertriebskanalId"
    • Merkmal "messsystem"
    • Merkmal "abschlagsbetrag"
  2. Erweiterung der Endpunkte "GET Vertrag abfragen (VertragID)", "GET Verträge abfragen" und "GET Vertrag abfragen (RechnungseinheitskontoID)" wurden um das optionale Objekt "StatusZusatzinformation" erweitert:
    • Beschreibung
    • EbdCode
    • PruefschrittCode
    • Datum

3.1.11.1 / Schleupen.CS FV25 2025-06-24 (Juni 2025 - KW26-Di)

  1. Erweiterung folgender Endpunkte um die Felder "gueltigAb" und "gueltigBis" innerhalb des Objektes "zaehler":
    • GET Messlokation(MesslokationId)
    • GET Mehrere Messlokationen(MesslokationId)
    • GET Messlokation(MarktlokationId)

3.1.11.0 / Schleupen.CS FV25 2025-05-14 (Mai 2025 - KW20-Mi)

  1. Anlage neuer Endpunkt-Versionen:
    • /api/prozessstatus/v3.1 - Ausprägungen des Feldes "prozessArt" erweitert um:
      • NetzentgeltReduzierung
      • Vertragsdeaktivierung
      • Vertragsaktivierung
      • AenderungJahresverbrauchsprognose
    • /api/prozessstatus/{correlationId}/v3.1/ - Ausprägungen des Feldes "prozessArt" erweitert um:
      • NetzentgeltReduzierung
      • Vertragsdeaktivierung
      • Vertragsaktivierung
      • AenderungJahresverbrauchsprognose
    • /api/rechnungseinheitskonten/{rechnungseinheitskontoId}/vertraege/v3.1/ - Ausprägungen des Feldes "vertragsStatus" erweitert um:
      • VertragsanlageBestaetigtWartendAufDaten
    • /api/vertraege/v3.1/ - Ausprägungen des Feldes "vertragsStatus" erweitert um:
      • VertragsanlageBestaetigtWartendAufDaten
    • /api/vertraege/{vertragId}/v3.1/ - Ausprägungen des Feldes "vertragsStatus" erweitert um:
      • VertragsanlageBestaetigtWartendAufDaten

3.1.10.6 / Schleupen.CS FV25 2025-04-03 (April 2025 - KW14-Do)

  1. NACHTRAG zum 23.04.2025: Neuer Endpunkt "GET Messlokationen (ZaehlerID)" hinzugefügt.
  2. Neuer Endpunkt "GET Kreditinstitut abfragen (KreditinstitutId)" hinzugefügt.
  3. Die Abfragen "GET Messlokation abfragen (MesslokationId)", "GET Messlokation abfragen (MarktlokationId)" und "GET Mehrere Messlokationen abfragen" wurden wie folgt erweitert:
    • Das Objekt "zaehler" wurde von optional in eine Pflichtangabe geändert.
    • Das Objekt "zaehler" wurde um folgende Felder erweitert:
    • messlokationId (Pflichtfeld)
    • zaehlernummer
    • Neues Unterobjekt "zaehlwerke" (Pflichtfeld)

3.1.10.5 / Schleupen.CS FV25 2025-03-17 (März 2025 - KW12-Mo)

  1. GET (Mehrere) Prozessstatus abfragen:
    • Es wurde das Unterobjekt "vertragsProzessObjekte" hinzugefügt.

3.1.10.4 / Schleupen.CS WV24 2025-02-27 (Februar 2025 - KW9-Do)

  1. POST Vertragsanlage starten:
    • Das Unterobjekt "vertragsauftraege" wurden um das Enum "messsystem" erweitert.
  2. Die Ausprägungen des Feldes "Status" wurden bei folgenden Abfargen um den Wert "InAbschlusspruefung" ergänzt:
    • GET Prozessstatus abfragen
    • GET Mehrere Prozessstatus abfragen

3.1.10.3 / Schleupen.CS WV24 2025-02-14 (Februar 2025 - KW7-Fr/1)

  1. Die Vertragstarifoption "Vertragslaufzeit" unterhalb des Objektes "Vertragstarifoption" ist keine Pflichtangabe mehr. Die Angabe ist nun optional. Diese Anpassungen wurde für folgende Endpunkte vorgenommen:
    • POST Vertragsanlage starten
    • POST Tarifwechsel anfragen

3.1.10.2 / Schleupen.CS WV24 2025-01-31 (Januar 2025 - KW5-Fr)

  1. GET Tarifvarianten suchen:
    • Der Abfrageparameter "Hausnummer" wurden von dem Format Integer in das Format String umgewandelt.
    • Es können nun auch unvollständige Anschriften, z.B. nur PLZ, als Request versendet werden. Wenn die entsprechenden Voraussetzungen gegeben sind, wird ein Preis zurückgeliefert.
  2. POST Bankverbindung ändern:
    • Bei "alleZahlwegebeenden" wird nun auch die Uhrzeit und nicht nur das Tagesdatum berücksichtigt. So dass die Anlage und die Beendigung eines Zahlweges am indentischen Tag stattfinden kann.

3.1.10.1 / Schleupen.CS WV24 2024-12-16 (Dezember 2024 - KW51-Mo)

  1. POST Tarifwechsel anfragen:
    • Das Objekt Vertragstarifoptionen wurde hinzugefügt

3.1.10.0 / Schleupen.CS WV24 2024-12-06 (Dezember 2024 - KW49/3)

  1. Konkrete Rechnungseinheitstarifoptionen-Ausprägungen am Rechnungseinheitskonto ergänzt. Sie können mit folgenden GET-Abfragen abgerufen werden:
    • GET Rechnungseinheitskonto abfragen (unter Rechnungseinheitskonten)
    • GET Mehrere Rechnungseinheitskonten abfragen (unter Rechnungseinheitskonten)
    • GET Rechnungseinheitskonto abfragen (unter Personen)
  2. POST Gesamtkosten abfragen:Response:
    • Das Feld "umsatzsteuerbetrag" der Rechnungsposition wird in das Feld "umsatzsteuersatz" der Rechnungsposition abgeändert

3.1.9.0 / Schleupen.CS HV24 2024-11-27 (November 2024 - KW48)

  1. RechnungseinheitskontoEvent:
    • RechnungseinheitskontoEvent ausgelöst, wenn Änderungen an den Kontaktwegen des Vertragspartners oder des Rechnungsempfängers vorgenommen werden.
  2. POST Bankverbindung ändern:
    • Bestehender übergeordneter Array wird in das Unterobjekt "neueZahlwege" umgewandelt.
    • Das Feld "gueltigBis" wird entfernt.
    • Die restlichen Felder sind weiterhin Bestandteil des Arrays.
    • Die Felder "name" und "vorname":
      • Ergänzung der Beschreibung um folgenden Zusatz "Pflicht bei fehlender Angabe der PersonId."
    • Das Feld "alleZahlwegebeenden" wird außerhalb des Arrays "neueZahlwege" hinzugefügt.
  3. GET (Mehrere) Prozessstatus abfragen:
    • Das Feld "fehlertext" wurde ergänzt.

3.1.8.1 / Schleupen.CS HV24 2024-11-18 (November 2024 - KW47)

  1. Alle KreditinstitutEvents:
    • Der Lokationspfad wurde bei den Events in "/api/kreditinstitute/v3.0/" geändert. Da für den Endpunkt "GET Kreditinstitut abfragen" keine Parameter vorgesehen sind, kann keine passende LokationsId angeben werden.
  2. GET Tarifvarianten suchen:
    • Geschäftsbereich:
      • Validierung ergänzt. Die Verwendung ist aktuell auf die Geschäftsbereichsarten "Strom" und "Gas" beschränkt.
    • Jahresverbrauch / JahresverbrauchEinheit:
      • Validierung ergänzt. Bei den Geschäftsbereichsarten "Strom" und "Gas" ist die Angabe Pflicht.

3.1.8.0 / Schleupen.CS HV24 2024-10-17(Oktober 2024 - KW42/2)

  1. GET Tarifvarianten suchen:
    • Das Feld "preisherkunft" wurde von einem Pflichtfeld zu nullable geändert. Für den Fall, dass ein Bestandteil ohne Preis angezeigt wird, fehlt die Preisherkunft.
    • Der Vertriebskanal-QueryParameter ist nun listenfähig. Es können also mehrere Vertriebskanäle angegeben werden.
  2. GET Tarifvariante(-n) abfragen:
    • Energiequelle: Das Feld "istDefault" wurde entfernt. An den Energiequellen gibt es keinen Default, da es sich immer um einen Mix aus allen angegebenen Energiequellen handelt.
    • Tarifrestriktion: Das Objekt wurde um die Felder "vertriebskanal" und "vertriebskanalId" erweitert.
    • TarifoptionRegel: Das Objekt wurde um die Felder "vertriebskanal" und "vertriebskanalId" erweitert.
    • VertragsbonusTarifoption: Die Felder "bestandteilId" und "bestandteilIdentifikator" wurden hinzugefügt. Diese Felder verweisen auf einen Preisbestandteil, wenn dem Vertragsbonus einer zugeordnet ist.
  3. Folgende Services wurden um einen Idempotentency-Key erweitert:
    • Personenkonten.ZahlsperreEntfernen
    • Personenkonten.SperreSetzen (entspricht einer Mahnsperre)
    • Personenkonten.SperreEntfernen (entspricht einer Mahnsperre)

3.1.7.0 / Schleupen.CS HV24 2024-09-30(September 2024 - KW40)

  1. Neuer Endpunkt GET Tarifvarianten suchen hinzugefügt.
  2. Die Webhook-Informationen sind nun der Developer-Campus-Beschreibung zu entnehmen.
  3. Neuer Endpunkt GET Datei abfragen hinzugefügt.
  4. Events:
    • Allgemeines Objekt Meta.EventType um RechnungssimulationEvent erweitert.
    • Unter ResourceObjectRechnungssimulation den Typ entfernt
  5. Erweiterung der GET Tarifvarianten abfragen-Abfragen unter dem Bereich "Verträge" um konkrete Tarifoptionen am Vertrag mit Wertausprägungen
  6. Der Endpunkt Gesamtkosten ermitteln wurde von einer GET-Abfrage in eine POST-Abfrage umgewandelt. Die Parameter der Gesamtkostenabfrage wurden von der Query in den RequestBody verschoben und darüber hinaus um die Parameter Geschäftsbereichsart und Vertragspreisspezifikationen ergänzt.
  7. POST Vertragsanlage starten:
    • Objekt "Vertragsauftrag" erweitert um:
      • VertriebskanalId
      • ExterneVertragsnummer
      • Kundenart
  8. GET Vertrag abfragen:
    • Response erweitert um:
      • VertriebskanalId
      • ExterneVertragsnummer
  9. GET Prozesstatus abfragen und GET Mehrere Prozesstatus abfragen:
    • Status-Enum erweitert um folgende Ausprägungen:
      • InAufgabenbearbeitung
      • WartendAufVorgaenger
      • WartendAufNachfolger

3.1.6.1 / Schleupen.CS HV24 2024-09-17 (September 2024 - KW38/1)

  1. Erweiterung der Beschreibungen für die Felder Nutzungszeitpunkt,  Ablesegrund und Ableseerfassungshinweis innerhalb der Messwerterfassung um den Zusatz "Das Feld muss gefüllt sein, um den Clearingprozess erfolgreich zu durchlaufen."
  2. Erweiterung der GET Tarifvariante(n) abfragen-Abfragen unter dem Bereich "Tarife" um Regelwerke, die alle Tarifoptionen enthalten:
    • Vertragstarifoptionen:
      • Abrechnungsvorschrift
      • Abschlagsmodell
      • Energiequelle
      • KuendigungsFrist
      • Vertragslaufzeit
      • Vertragsverlaengerung
      • VertragsBonus
      • VertragsMalus
      • Preisbindung
    • Rechnungseinheitstarifoptionen:
      • Abrechnungsmodell
      • Ausgleichsmodell
      • Bankeinzugspflicht
      • Mahnmodell
      • Personenkontoart
      • Versandweg
      • Bonus
      • Malus
  3. Erweiterung der POST Vertraganlage starten-Abfrage um:
    • das optionale Objekt RechnungseinheitTarifoptionen
    • die optionalen VertragTarifoptionen unterhalb des Objektes "Vertragsauftraege"
  4. Erweiterung folgender Endpunkte, um das Merkmal "ExternalKey":
    • GET Person abfragen
    • GET Personen abfragen
  5. Request-Header Idempotency-Key zu folgenden Endpunkten hinzugefügt:
    • RechnungSimulieren
    • Personen
      • Person anlegen
      • Person ändern
    • Rechnungseinheitskonten
      • Bankverbindung ändern
      • Mahnsperre entfernen
      • Mahnsperre setzen
      • Rechnungsempfänger ändern
      • Versandweg ändern
      • Vertragspartner ändern
      • Zahlsperre setzen
    • Verträge:
      • Abschlagsänderung anfragen
      • Tarifwechsel anfragen
      • Vertragsanlage starten
      • Vertragsbeendigung anfragen
    • Zählerstand
      • Messwert erfassen

3.1.5.1 / Schleupen.CS SV24 2024-07-15 (Juli 2024 - KW29)

  1. Vorläufige Marktlokationen in GET-Abfragen:
    • Es wird die marktlokationId 00000000-0000-0000-0000-000000000000 ausgegeben.
  2. Erweiterung der Netznutzungsprofile- und Messlokationen-Objekte um die Felder gueltigVon und gueltigBis innerhalb folgender Abfragen:
    • GET Marktlokation (unter Verträge)Die Netznutzungsprofile und Messlokationen zu einem Vertrag sind auf diejenigen beschränkt, die während der Vertragslaufzeit (teil-)gültig sind.
    • GET Marktlokation (unter Marktlokationen)
    • GET Marktlokationen (unter Marktlokationen)

3.1.5.0 / Schleupen.CS SV24 2024-07-08 (Juli 2024 - KW28)

  1. Events für allgemeine Objekte:
    • Meta.EventType: Um TarifEvent und KreditinstitutEvent erweitert.

3.1.4.0 / Schleupen.CS SV24 2024-06-24 (Juni 2024 - KW26)

  1. Alle GET-Vertrag-Abfragen / POST-Vertrag-Abfragen / GET-Tarifvariante-Abfragen:
    • Mengeneinheit enum in TarifIndividuellerPreisBestandteil um Stueck erweitert
    • Mengeneinheit enum in Tarifrestriktion um Stueck erweitert
    • Mengeneinheit enum in VertragsauftragVertragspreisspezifikation um Stueck erweitert
    • Mengeneinheit enum in Vertragspreisspezifikation um Stueck erweitert

3.1.3.0

  1. NACHTRAG zum 04.07.2024: Das Feld "einheit" wurde von einem String in ein Enum geändert:
    • Folgende Ausprägungen können verwendet werden:
      • Kilowatt
      • Kilowattstunden
      • Wattsekunden
      • Megawattstunden
      • Gigawattstunden
      • Kilovoltamperereaktivstunde
      • Voltamperereaktiv
      • Kilovoltamperereaktiv
      • Kubikmeter
      • KilowattstundenProKubikmeter
    • Folgende Abfragen sind betroffen:
      • POST Messwert erfassen unter Zählerstand
      • GET Messwerte abfragen unter Zählerstand
      • GET Zählwerke abfragen unter Zähler
  2. Alle Vertrag-Abfragen:
    • Vertrags-Objekte um Vertragspreisspezifikationen erweitert.
  3. Vertrag anlegen:
    • Vertragsauftrag-Objekt um Vertragspreisspezifikationen erweitert.
    • Installationsobjekt:
      • Die Beschreibungen für Marktlokationbezeichnung, Zahlpunktbezeichnung und Zaehlernummer wurden angepasst, denn eins der drei Merkmale muss angegeben werden.
    • Transaktionsgrund:
      • Beschreibung um "Pflichtfeld bei Stromverträgen." ergänzt.
  4. Alle Tarifvarianten-Abfragen:
    • Tarifvarianten-Objekte um individuelle Preisbestandteile erweitert.
  5. Tarifvarianten-Abfrage im Bereich Verträge:
    • Feld IstGueltig hinzugefügt.
    • Vertragspreisspezifikationen hinzugefügt.
  6. Rechnungseinheitskonto:
    • Zahlsperre setzen:
      • Das Feld zahlsperreAb wurde entfernt. Es wird immer das aktuelle Tagesdatum verwendet. Zahlsperren mit Beginndatum in der Zukunft werden nicht unterstützt.
      • zahlsperreBis wurde von einem optionalen Feld in ein Pflichtfeld geändert.
    • Mahnsperre setzen:
      • Das Feld mahnsperreAb wurde entfernt. Es wird immer das aktuelle Tagesdatum verwendet. Mahnsperren mit Beginndatum in der Zukunft werden nicht unterstützt.
      • mahnsperreBis wurde von einem optionalen Feld in ein Pflichtfeld geändert.
  7. Alle E-Mail-Adressen:
    • RegEx zur Überprüfung der E-Mail-Adressen verbessert.
  8. Kommentare:
    • Rechtschreibfehler in Beschreibungen korrigiert. Teilweise konkretere Beschreibungen ergänzt.
  9. DateTimes:
    • Fehler behoben, durch den DateTimes ohne Zeitzonenzusatz ausgegeben wurden.
    • Verhalten angepasst, sodass DateTimes, die ohne Zeitzonenzusatz an die Schnittstelle übergeben werden, als lokale Zeiten des Servers (deutsche Zeit) behandelt werden.

3.1.2.0

  1. Messlokation(-en) abfragen:
    • MarktlokationId: Von Einzelwert auf Liste umgestellt. Hier gibt es eine n:m-Relation zwischen Marktlokation und Messlokation.
  2. Versandweg ändern:
    • EMail-Objekt:
      • Von Pflichtfeld zu optional geändert.
      • Beschreibung um "Pflichtfeld, wenn der Versandweg 'Onlineportal' ist." erweitert.
      • Feld GueltigBis entfernt.
  3. Tarifvariante(-n) abfragen:
    • Beschreibung um "Es werden nur freigegebene Tarifvarianten berücksichtigt." erweitert.
  4. Tarifvarianten abfragen (anhand einer Vertrag-ID):
    • Feld TarifvarianteAmVertragId hinzugefügt. Hierüber wird die spezifische Verknüpfung zwischen Tarifvariante und Vertrag eindeutig identifiziert, sodass bei Fällen, in denen eine Tarifvariante mehrmals an einem Vertrag gültig war, eine eindeutige Identifikation möglich ist.
  5. OIDC:
    • Berechtigungskonzept ergänzt.
  6. Alle Endpunkte:
    • Beschreibungen aller Endpunkte ergänzt.

3.1.1.1

  1. /api/personen/v3.0/:
    • Response-Code 202 (Accepted) entfernt. Beim Aufruf dieses Endpunkts wird immer 201 (Created) zurückgegeben, da die Anfrage immer synchron verarbeitet wird.

3.1.1.0

  1. Neue Get-Endpunkte für die Abfrage anhand mehrerer IDs:
    • /rechnungseinheitskonten/v3.0/
    • /vertraege/v3.0/
    • /marktlokationen/v3.0/
    • /messlokationen/v3.0/
    • /zaehler/v3.0/
    • /prozessstatus/v3.0/
  2. Erweiterte Get-Endpunkte für die Abfrage anhand mehrerer IDs:
    • /personen/v3.0/
  3. Route-Anpassungen:
    • Korrektur von /subscriptions/VertragsprozessCreatedEvent/ zu /subscriptions/VertragsprozessCompletedEvent/
  4. Erweiterung folgender Abfragen, um den Hinweis "Bitte beachten Sie, dass aktuell nur eine Abfrage für Stromzähler möglich ist.":
    • Zähler abfragen
    • Zählwerke abfragen
  5. Korrektur der String-Längen folgender Felder:
    • Zahlsperre-Bemerkung von 8.000 Zeichen auf 300 Zeichen geändert
    • Mahnsperre-Bemerkung von 300 Zeichen auf 255 Zeichen geändert
    • Mahnsperre-Bezeichnung von 255 Zeichen auf 120 Zeichen geändert

3.1.0.0

Initiale Version

Chatbot not allowed
Cookie Consent mit Real Cookie Banner