PartnerApi class

Constructors

PartnerApi({required String partnerKey, String? baseUrl, Client? httpClient, Duration? frist})
partnerKey ist der Partner-Schluessel pk_test_... / pk_live_....
PartnerApi.mitTransport(PartnerTransport _t)
Fuer Tests und fuer Aufrufer, die den Transport selbst bauen.

Properties

env → String
test oder live, aus dem Schluessel abgelesen -- ohne Netzaufruf.
no setter
hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

activateCashregister(String customerId, String cashregisterId) → Future<KassenInbetriebnahme>
Nimmt eine Kasse in Betrieb -- von Hand, wenn automatisch:false gilt oder ein Lauf abgebrochen ist.
checkPartnerCustomerEmail(String email) → Future<bool>
Ist diese E-Mail-Adresse als Kasseneck-Zugang noch frei?
createCustomerCashregister({required String customerId, bool? automatisch, String? signaturId}) → Future<NeueKasse>
Legt eine Kasse an.
createPartnerCustomer({required String appId, required Map<String, dynamic> betrieb, String? idempotencyKey, bool? einladen, PartnerEnv? env}) → Future<NeuerBetrieb>
Legt einen Betrieb an.
createPartnerWebhook({required String url, required List<String> events, String? beschreibung, bool? aktiv}) → Future<NeuerWebhook>
Legt einen Webhook-Endpunkt an. Hoechstens kWebhookLimit je Partner (webhook_limit).
deletePartnerWebhook(String webhookId) → Future<String>
Loescht einen Endpunkt. Danach kommt dort nichts mehr an.
fehlerRat(String code) → String?
Der Handlungssatz zu einem beliebigen Fehlercode der Partner-API. Gehoert in die eigene Fehlermeldung, damit ein Anwender nicht in der Doku nachschlagen muss.
getCustomerCredentials(String customerId) → Future<BetriebZugangsdaten>
Holt die Geheimnisse des Betriebs: seinen api_key und die Token seiner Kassen. Damit signiert eine App in seinem Namen Belege -- und ein Beleg ist nach RKSV nicht zuruecknehmbar.
getCustomerSignatureStatus(String customerId) → Future<SignaturStand>
Stand der Signatur eines Betriebs samt aller Antraege und des FON-Zugangs.
getPartnerCustomer(String customerId) → Future<Betrieb>
Ein Betrieb mit allem, was der Partner ueber ihn sehen darf -- nie Geheimnisse.
getPartnerInfo() → Future<PartnerInfo>
Wer bin ich, in welcher Umgebung, mit welchen Rechten -- und welche Apps gehoeren mir. apps[].id ist die appId fuer createPartnerCustomer.
listCustomerCashregisters(String customerId) → Future<KassenListe>
Die Kassen eines Betriebs samt Stand der Inbetriebnahme -- nie Token.
listPartnerCustomers({String? status, int? limit, String? cursor}) → Future<BetriebListe>
Betriebe dieses Partners, seitenweise. cursor aus der Antwort setzt fort; null heisst, es kommt nichts mehr.
listPartnerWebhookDeliveries({String? webhookId, int? limit}) → Future<List<WebhookZustellung>>
Die letzten Zustellversuche -- mit webhookId fuer einen Endpunkt, ohne ihn fuer alle. Die Stelle, an der sich "mein Server bekommt nichts" klaeren laesst, ohne bei Kasseneck nachzufragen.
listPartnerWebhooks() → Future<WebhookListe>
Die Webhook-Endpunkte dieses Partners samt Ereignis-Katalog.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
requestCustomerSignature(String customerId, {String? art, bool? weitere}) → Future<SignaturAntragErgebnis>
Beantragt die Signatureinheit. Kasseneck laesst die Karte beim Vertrauensdiensteanbieter auf diesen Betrieb ausstellen und meldet sie bei FinanzOnline an; einen Vorrat fertiger Karten gibt es nicht.
rotatePartnerWebhookSecret(String webhookId) → Future<NeuerWebhook>
Ein neues Secret fuer denselben Endpunkt.
Schickt dem Betrieb den Einrichtungs-Link fuer seinen FinanzOnline-Zugang. Ohne diesen Zugang gibt es live keine Signatureinheit (fon_missing).
sendPartnerWebhookTest(String webhookId, {String? event}) → Future<WebhookTestErgebnis>
Schickt eine Probe an genau diesen Endpunkt.
toString() → String
A string representation of this object.
inherited
updatePartnerWebhook(String webhookId, Map<String, dynamic> patch) → Future<PartnerWebhook>
Aendert einen Endpunkt. Nur die genannten Felder -- ein leeres patch lehnt das Backend ab (validation, Feld patch), statt stillschweigend nichts zu tun.

Operators

operator ==(Object other) → bool
The equality operator.
inherited