@kreiseck/kasseneck-api 0.17.0 → 0.19.0

package/dist/esm/rechnung/vertrag.js

@@ -32,6 +32,7 @@ export const RECHNUNG_AUFRUFE = [
     'getInvoiceXml',
     'getInvoiceSetupStatus',
     'listBrands',
+    'recordInvoicePayment',
 ];
 /**
  * Stabile Fehlercodes. Das Fremdsystem verzweigt am Code, der Text darf sich
@@ -57,6 +58,8 @@ export const INVOICE_ERROR_CODES = [
     'invoice_setup_incomplete',
     'language_not_allowed',
     'brand_not_found',
+    'not_payable',
+    'payment_exceeds_invoice',
 ];
 /** Gruende einer Gutschrift. Der Server druckt den deutschen Anzeigetext. */
 export const CREDIT_NOTE_REASONS = [
@@ -80,6 +83,18 @@ export const EINVOICE_FORMATS = ['ubl', 'cii'];
  * oesterreichisch formatiert.
  */
 export const INVOICE_LANGUAGES = ['de', 'en'];
+/**
+ * Wie eine Rechnung bezahlt wurde. Der Vermerk ist Buchhaltung, kein Beleg:
+ * `cash` wird gebucht, die Antwort traegt dann zusaetzlich den Hinweis
+ * `cash_receipt_required` — eine Barzahlung ist ein Barumsatz und braucht
+ * einen Beleg (§ 132a BAO), bei Registrierkassenpflicht ueber die Kasse.
+ */
+export const INVOICE_PAYMENT_METHODS = ['transfer', 'card', 'online', 'cash'];
+/**
+ * Hinweise, die eine erfolgreiche Antwort zusaetzlich tragen kann (`data.notice`).
+ * Sie sind keine Fehler: der Aufruf hat gewirkt, es gibt nur etwas zu wissen.
+ */
+export const INVOICE_NOTICE_CODES = ['cash_receipt_required'];
 /**
  * Einheiten einer Position. Die API nimmt nur diese Schluessel an; gedruckt
  * wird das Kuerzel in der Sprache der Rechnung (`RECHNUNG_TEXTE`,
@@ -261,6 +276,19 @@ export const POSITION_FELDER = Object.freeze({
     discountPct: { typ: 'number', pflicht: false, min: 0, max: 100, nachkomma: 2 },
 });
 const positionen = { typ: 'list', pflicht: true, min: 1, max: 500, eintrag: { typ: 'object', pflicht: true, felder: POSITION_FELDER } };
+/**
+ * Eine Zahlung zu einer Rechnung. Ohne `amountCents` gilt der volle
+ * Bruttobetrag, ohne `paidAt` der heutige Wiener Tag. `reference` ist die
+ * Zahlungskennung des Fremdsystems (z. B. `pi_3Q...`) — sie wird gespeichert,
+ * aber **nicht gedruckt**: die Rechnung wird aufbewahrt und vervielfaeltigt,
+ * und dem Empfaenger nuetzt sie nichts.
+ */
+export const PAYMENT_FELDER = Object.freeze({
+    method: { typ: 'enum', pflicht: true, werte: INVOICE_PAYMENT_METHODS },
+    amountCents: { typ: 'integer', pflicht: false, min: 1, max: 100_000_000 },
+    paidAt: datum(),
+    reference: text(100),
+});
 export const RECHNUNG_ANFRAGEN = Object.freeze({
     createCustomer: {
         customer: { typ: 'object', pflicht: true, felder: KUNDE_FELDER },
@@ -302,6 +330,12 @@ export const RECHNUNG_ANFRAGEN = Object.freeze({
         language: { typ: 'enum', pflicht: false, werte: INVOICE_LANGUAGES },
         /** Marke (Kennung aus `listBrands`); sonst die Standardmarke. */
         brandId: id,
+        /**
+         * Schon bezahlt: die Zahlung entsteht in **derselben** Transaktion wie das
+         * Festschreiben. Sonst gaebe es einen Moment, in dem die Rechnung offen ist
+         * und ein sofort geholtes PDF Zahlungsinformationen traegt.
+         */
+        payment: { typ: 'object', pflicht: false, felder: PAYMENT_FELDER },
     },
     cancelInvoice: {
         idempotencyKey: idempotencyKey(true),
@@ -340,6 +374,14 @@ export const RECHNUNG_ANFRAGEN = Object.freeze({
     },
     getInvoiceSetupStatus: {},
     listBrands: {},
+    recordInvoicePayment: {
+        idempotencyKey: idempotencyKey(true),
+        invoiceId: idPflicht,
+        method: { typ: 'enum', pflicht: true, werte: INVOICE_PAYMENT_METHODS },
+        amountCents: { typ: 'integer', pflicht: false, min: 1, max: 100_000_000 },
+        paidAt: datum(),
+        reference: text(100),
+    },
 });
 /** Genau eines dieser Felder muss gesetzt sein (je Aufruf, je Gruppe). */
 export const RECHNUNG_GENAU_EINS = Object.freeze({