Entity- und System-Zustände und -Modi

⚠️Warning

Sie sehen die Dokumentation für API-Version 2025-08-12. Die neueste Version ist 2026-06-01. Wesentliche Änderungen umfassen aktualisierte Terminologie (Asset → Organization, Entity → Taxpayer/Location).

Dieser Abschnitt gibt einen Überblick über den state und den mode, die den Lebenszyklus und das Betriebsverhalten der Ressourcen Entities und Systems definieren. Das nachfolgende Diagramm veranschaulicht die Übergänge zwischen diesen Zuständen und Modi und zeigt detailliert, wie sich die Ressource von der Erstellung bis zur Außerbetriebnahme entwickelt und wie sich ihre Betriebsmodi aufgrund interner Ereignisse oder externer API-Aufrufe anpassen.

Das Verständnis dieser Übergänge ist für ein effektives Ressourcenmanagement, einen reibungslosen Betrieb und die Lösung von Problemen wie ungültigen Anmeldeinformationen oder vorübergehenden Unterbrechungen unerlässlich.

Zustände

• Acquired: Anfangszustand der Ressource bei der Erstellung. In diesem Zustand können keine Operationen durchgeführt werden.
• Commissioned: Ressource ist bereit und voll funktionsfähig (vorausgesetzt, der Modus ist operativ).
• Decommissioned: Ressource ist nicht mehr betriebsbereit und kann keine Aufgaben ausführen.

Modi

• Inactive: Initialer Modus der Ressource bei der Erstellung. In diesem Modus können keine Operationen durchgeführt werden.
• Operative: Ressource ist voll funktionsfähig und funktioniert wie vorgesehen.
• Suspended: Die Ressource ist vorübergehend über einen API-Aufruf (PATCH) pausiert — z. B. um Fisconline-Zugangsdaten oder andere Ressourceninformationen zu aktualisieren. Nach Abschluss der Aktualisierung kann die Ressource wieder auf Operative gesetzt werden.
• Degraded (in dieser Version noch nicht in LIVE verfügbar): Die Ressource ist betriebsbereit, aber vorübergehend nicht verfügbar — z. B. aufgrund von Fisconline-Zugangsdatenfehlern. In der TEST-Umgebung kann dieser Modus manuell ausgelöst werden, indem der TRANSACTION-Record mit dem Header X-Taxpayer-Credentials-Expired: true gesendet wird, um Ihre Integration vor der Veröffentlichung in der Produktionsumgebung vorzubereiten. Mehr dazu im entsprechenden Artikel: Was ist der DEGRADED-Modus und wie kann man ihn beheben?

📘Note

Jeder Übergang wird entweder durch einen externen API-Aufruf ausgelöst oder erfolgt automatisch basierend auf interner Systemlogik:

• PATCH gibt an, dass ein externer API-Aufruf erforderlich ist, um den Übergang einzuleiten.
• INTERNAL gibt an, dass der Übergang automatisch innerhalb des Systems ausgelöst wird.

Bidirektionale Pfeile zeigen an, dass der Übergang in beide Richtungen erfolgen kann.

Zustandsübergänge

Alle state-Übergänge sind irreversibel.

• Acquired → Commissioned: Erfordert einen API-Aufruf (PATCH), um die Ressource zu aktivieren. Bei Erfolg wechselt der entsprechende Modus automatisch von Inactive zu Operative.
• Commissioned → Decommissioned: Erfordert einen API-Aufruf (PATCH), um die Ressource als nicht mehr in Verwendung zu markieren. Bei Erfolg wechselt der entsprechende Modus von Operative zu Inactive, was das Ende des Ressourcenlebenszyklus markiert.

⚠️Hinweis zur Abrechnung

Die Inbetriebnahme eines Systems in der LIVE-Umgebung markiert den Beginn der Abrechnung und löst die Übertragung offizieller Rechnungen an die Finanzbehörden aus. In der TEST-Umgebung finden keine Abrechnungen oder echten Übertragungen statt.

Modusübergänge

• Inactive → Operative: Wechselt automatisch, wenn der Zustand erfolgreich über einen API-Aufruf (PATCH) auf Commissioned aktualisiert wird.
• Operative → Suspended: Wird über einen API-Aufruf (PATCH) ausgelöst — z. B. um den Betrieb vorübergehend zu unterbrechen, während Fisconline-Zugangsdaten oder andere Ressourceninformationen aktualisiert werden.
• Operative → Degraded (in dieser Version noch nicht in LIVE verfügbar): Wechselt automatisch — z. B. aufgrund von dauerhaften Fisconline-Zugangsdatenfehlern. In der TEST-Umgebung kann dieser Übergang manuell ausgelöst werden, indem der TRANSACTION-Record mit dem Header X-Taxpayer-Credentials-Expired: true gesendet wird, um Ihre Integration vor der Veröffentlichung in der Produktionsumgebung vorzubereiten. Mehr dazu im entsprechenden Artikel: Was ist der DEGRADED-Modus und wie kann man ihn beheben?
• Degraded → Suspended (in dieser Version noch nicht in LIVE verfügbar): Muss manuell über einen API-Aufruf (PATCH) ausgelöst werden, um dauerhafte Fisconline-Zugangsdatenfehler zu beheben, bevor der Taxpayer in den Modus Operative zurückversetzt wird. Mehr dazu im entsprechenden Artikel: Was ist der DEGRADED-Modus und wie kann man ihn beheben?
• Suspended → Operative: Wird über einen API-Aufruf (PATCH) ausgelöst, sobald die erforderlichen Aktualisierungen abgeschlossen sind — z. B. Fisconline-Zugangsdaten oder andere Ressourceninformationen.