@kreiseck/kasseneck-api 0.31.0 → 1.0.0-rc.2

package/dist/cjs/{rechnung → invoice}/vertrag.d.ts

@@ -4,10 +4,10 @@
  * Aus dieser Datei entstehen drei Dinge, damit sie nicht auseinanderlaufen
  * koennen:
  *
- * 1. `fixtures/rechnung-api.schema.json` (`npm run fixtures:rechnung`) — das
+ * 1. `fixtures/invoice-api.schema.json` (`npm run fixtures:rechnung`) — das
  *    Backend liest es aus dem vendorierten Paket und vergleicht es in beide
  *    Richtungen mit seiner eigenen Pruefung; der Dart-Zwilling zieht es byteweise.
- * 2. Die Listen unter `rechnung` in `fixtures/oberflaeche.json` (Codes, Gruende,
+ * 2. Die Listen unter `rechnung` in `fixtures/surface.json` (Codes, Gruende,
  *    Enums) — ueber denselben Namensraum-Scan wie der Partner-Teil.
  * 3. Die TypeScript-Typen in `typen.ts`.
  *
@@ -17,15 +17,25 @@
  * Beschrieben wird die Anfrage. Was der Server daraus macht — Rechnungsdatum,
  * Nummer, Summen — ist bewusst **nicht** setzbar.
  */
-export declare const RECHNUNG_VERTRAG_VERSION = 1;
-export declare const RECHNUNG_AUFRUFE: readonly ["createCustomer", "getCustomer", "updateCustomer", "searchCustomers", "issueInvoice", "cancelInvoice", "createCreditNote", "getInvoice", "listInvoices", "getInvoicePdf", "getInvoiceXml", "getInvoiceSetupStatus", "listBrands", "recordInvoicePayment"];
-export type RechnungAufruf = (typeof RECHNUNG_AUFRUFE)[number];
+export declare const INVOICE_CONTRACT_VERSION = 2;
+export declare const INVOICE_ENDPOINTS: readonly ["createCustomer", "getCustomer", "updateCustomer", "searchCustomers", "issueInvoice", "cancelInvoice", "createCreditNote", "getInvoice", "listInvoices", "getInvoicePdf", "getInvoiceXml", "getInvoiceSetupStatus", "listBrands", "recordInvoicePayment"];
+export type InvoiceEndpoint = (typeof INVOICE_ENDPOINTS)[number];
 /**
  * Stabile Fehlercodes. Das Fremdsystem verzweigt am Code, der Text darf sich
  * aendern. `validation` traegt zusaetzlich `errors: [{ field, message }]`.
  */
 export declare const INVOICE_ERROR_CODES: readonly ["validation", "idempotency_conflict", "module_inactive", "customer_not_found", "customer_exists", "short_code_taken", "short_code_immutable", "recipient_required", "invoice_requirements_missing", "invoice_not_found", "invoice_ambiguous", "not_cancellable", "partial_credit_exists", "credit_exceeds_invoice", "einvoice_incomplete", "invoice_api_not_enabled", "invoice_setup_incomplete", "language_not_allowed", "brand_not_found", "not_payable", "payment_exceeds_invoice", "tax_scheme_mismatch", "vat_rate_not_in_country", "reverse_charge_reason_required", "reverse_charge_threshold", "mixed_supply_not_allowed", "oss_not_enabled", "einvoice_unavailable", "amount_too_large"];
 export type InvoiceErrorCode = (typeof INVOICE_ERROR_CODES)[number];
+/**
+ * Codes, die Anmeldung und Rand auf jedem Rechnungsaufruf erzeugen koennen,
+ * soweit sie nicht schon in [INVOICE_ERROR_CODES] stehen: `errorCodes.auth`
+ * ohne die sieben des Partner-Zugangs, `errorCodes.edge` (sortiert) und
+ * zuletzt `route_missing` (Code des Pakets). [INVOICE_ERROR_CODES] bleibt
+ * genau der Katalog des Servers (das Backend vergleicht ihn mit dem Schema);
+ * die Helfer in `./invoice` erkennen beide Listen.
+ */
+export declare const INVOICE_REQUEST_ERROR_CODES: readonly ["account_not_found", "admin_required", "cashregister_not_assigned", "cashregister_not_found", "cashregister_token_invalid", "cashregister_token_missing", "dialect_mismatch", "internal_translation_error", "live_not_enabled", "method_not_allowed", "mfa_required", "not_found", "register_user_no_business", "register_user_not_allowed", "register_user_not_found", "response_translation_failed", "session_expired", "session_other_cashregister", "unauthorized", "user_disabled", "user_verification_failed", "route_missing"];
+export type InvoiceRequestErrorCode = (typeof INVOICE_REQUEST_ERROR_CODES)[number];
 /** Gruende einer Gutschrift. Der Server druckt den deutschen Anzeigetext. */
 export declare const CREDIT_NOTE_REASONS: readonly ["cancellation", "price_reduction", "return", "incorrect_invoice", "other"];
 export type CreditNoteReason = (typeof CREDIT_NOTE_REASONS)[number];
@@ -33,73 +43,74 @@ export type CreditNoteReason = (typeof CREDIT_NOTE_REASONS)[number];
  * Der Steuerfall einer Rechnung. Er wird vom Server **abgeleitet** (Kundenland,
  * Kundenart, UID, Ware oder Leistung); eine mitgeschickte Angabe muss dazu
  * passen, sonst `tax_scheme_mismatch`. Neue Faelle stehen hinten, damit
- * gespeicherte Reihenfolgen gueltig bleiben.
+ * gespeicherte Reihenfolgen gueltig bleiben. Unter `/v1` hiess `intraCommunitySupply` noch
+ * `igLieferung`; unter `/v3` weist der Server den alten Namen mit `validation` ab.
  *
  * - `normal`                oesterreichische Umsatzsteuer
  * - `smallBusiness`         Kleinunternehmer (§ 6 Abs. 1 Z 27 UStG)
  * - `reverseCharge`         Leistung an ein Unternehmen in der EU (Art. 196 MwSt-RL)
- * - `igLieferung`           Ware an ein Unternehmen in der EU (Art. 6 Abs. 1 UStG)
+ * - `intraCommunitySupply`  Ware an ein Unternehmen in der EU (Art. 6 Abs. 1 UStG)
  * - `exportThirdCountry`    Ware ins Drittland (§ 6 Abs. 1 Z 1 UStG)
  * - `domesticReverseCharge` Uebergang der Steuerschuld im Inland, Grund aus `REVERSE_CHARGE_REASONS`
  * - `oss`                   B2C in der EU ueber den One-Stop-Shop, Satz des Ziellandes
  * - `outsideScope`          Leistung an ein Drittlandsunternehmen — in Oesterreich nicht steuerbar
  */
-export declare const TAX_SCHEMES: readonly ["normal", "smallBusiness", "reverseCharge", "igLieferung", "exportThirdCountry", "domesticReverseCharge", "oss", "outsideScope"];
+export declare const TAX_SCHEMES: readonly ["normal", "smallBusiness", "reverseCharge", "intraCommunitySupply", "exportThirdCountry", "domesticReverseCharge", "oss", "outsideScope"];
 export type TaxScheme = (typeof TAX_SCHEMES)[number];
 /**
  * Gruende fuer den Uebergang der Steuerschuld **im Inland**. Ohne Grund gibt es
  * kein `domesticReverseCharge`: die Bedingungen sind je Fall verschieden, und
  * keine davon laesst sich aus Betrag und Land erraten.
  *
- * `schwelleCents` ist das Entgelt, ab dem der Fall greift — maßgeblich ist das
+ * `thresholdCents` ist das Entgelt, ab dem der Fall greift – maßgeblich ist das
  * **in der Rechnung ausgewiesene** Entgelt, nicht der Einzelpreis; ein
  * einheitlicher Liefervorgang darf dafuer nicht auf mehrere Rechnungen
  * aufgeteilt werden (UStR Rz 2605d).
  */
 export declare const REVERSE_CHARGE_REASONS: Readonly<{
     construction: {
-        stelle: string;
-        schwelleCents: null;
+        legalBasis: string;
+        thresholdCents: null;
     };
     scrap: {
-        stelle: string;
-        schwelleCents: null;
+        legalBasis: string;
+        thresholdCents: null;
     };
     mobile_devices: {
-        stelle: string;
-        schwelleCents: number;
+        legalBasis: string;
+        thresholdCents: number;
     };
     it_devices: {
-        stelle: string;
-        schwelleCents: number;
+        legalBasis: string;
+        thresholdCents: number;
     };
     metals: {
-        stelle: string;
-        schwelleCents: null;
+        legalBasis: string;
+        thresholdCents: null;
     };
     emission_certificates: {
-        stelle: string;
-        schwelleCents: null;
+        legalBasis: string;
+        thresholdCents: null;
     };
     gas_electricity: {
-        stelle: string;
-        schwelleCents: null;
+        legalBasis: string;
+        thresholdCents: null;
     };
     energy_certificates: {
-        stelle: string;
-        schwelleCents: null;
+        legalBasis: string;
+        thresholdCents: null;
     };
     investment_gold: {
-        stelle: string;
-        schwelleCents: null;
+        legalBasis: string;
+        thresholdCents: null;
     };
     security_transfer: {
-        stelle: string;
-        schwelleCents: null;
+        legalBasis: string;
+        thresholdCents: null;
     };
     foreign_supplier: {
-        stelle: string;
-        schwelleCents: null;
+        legalBasis: string;
+        thresholdCents: null;
     };
 }>;
 export type ReverseChargeReason = keyof typeof REVERSE_CHARGE_REASONS;
@@ -114,10 +125,25 @@ export declare const CUSTOMER_TYPES: readonly ["private", "company"];
 export type CustomerType = (typeof CUSTOMER_TYPES)[number];
 export declare const INVOICE_LIST_STATUS: readonly ["final", "paid", "cancelled", "open", "overdue"];
 export type InvoiceListStatus = (typeof INVOICE_LIST_STATUS)[number];
-export declare const DOC_TYPES: readonly ["RE", "GU"];
+/**
+ * Belegart: Rechnung oder Gutschrift (unter `/v1` `RE` bzw. `GU`). Das Vorzeichen
+ * steht in der Belegart, nie im Betrag.
+ */
+export declare const DOC_TYPES: readonly ["invoice", "credit_note"];
 export type DocType = (typeof DOC_TYPES)[number];
 export declare const EINVOICE_FORMATS: readonly ["ubl", "cii"];
 export type EInvoiceFormat = (typeof EINVOICE_FORMATS)[number];
+/**
+ * Was einer EN-16931-konformen E-Rechnung fehlt: `einvoice.missing` jeder
+ * Rechnungssicht und `data.missing` bei `einvoice_incomplete` bzw.
+ * `invoice_requirements_missing`. Unter `/v1` standen hier deutsche Woerter
+ * (`Straße`, `PLZ`, …).
+ */
+export declare const EINVOICE_MISSING_CODES: readonly ["name", "street", "zip", "city", "country", "vat_id", "order_reference", "order_reference_format"];
+export type EInvoiceMissingCode = (typeof EINVOICE_MISSING_CODES)[number];
+/** Warum eine Rechnung abgeschrieben wurde (`writeOffReasonCode` in `getInvoice`). */
+export declare const WRITE_OFF_REASON_CODES: readonly ["uncollectible", "time_barred", "waived", "disputed", "settled_externally", "other"];
+export type WriteOffReasonCode = (typeof WRITE_OFF_REASON_CODES)[number];
 /**
  * Sprachen einer Rechnung. Die Sprache wird beim Festschreiben eingefroren;
  * fehlt sie an Kunde oder Rechnung, gilt `de`. Behoerden bekommen immer `de`
@@ -145,9 +171,9 @@ export declare const INVOICE_NOTICE_CODES: readonly ["cash_receipt_required", "r
 export type InvoiceNoticeCode = (typeof INVOICE_NOTICE_CODES)[number];
 /**
  * Einheiten einer Position. Die API nimmt nur diese Schluessel an; gedruckt
- * wird das Kuerzel in der Sprache der Rechnung (`RECHNUNG_TEXTE`,
- * `einheit.<schluessel>`), die E-Rechnung fuehrt den UN/ECE-Code
- * (`RECHNUNG_EINHEITEN_CODES`). Ohne Angabe gilt `piece`.
+ * wird das Kuerzel in der Sprache der Rechnung (`INVOICE_TEXTS`,
+ * `unit_symbol.<schluessel>`), die E-Rechnung fuehrt den UN/ECE-Code
+ * (`INVOICE_UNIT_CODES`). Ohne Angabe gilt `piece`.
  */
 export declare const INVOICE_UNITS: readonly ["piece", "pair", "set", "dozen", "second", "minute", "hour", "day", "night", "week", "month", "quarter", "half_year", "year", "milligram", "gram", "kilogram", "tonne", "millimetre", "centimetre", "metre", "running_metre", "kilometre", "square_metre", "hectare", "millilitre", "litre", "cubic_metre", "kilowatt_hour", "megawatt_hour", "gigabyte", "terabyte", "flat_rate", "person", "licence", "user", "device", "session", "trip", "page", "sheet", "package", "box", "carton", "bottle", "can", "roll", "bag", "pallet"];
 export type InvoiceUnit = (typeof INVOICE_UNITS)[number];
@@ -157,7 +183,7 @@ export type InvoiceUnit = (typeof INVOICE_UNITS)[number];
  * Laufmeter; Lizenz, Benutzer, Geraet als Stueck). Die Validatoren der
  * E-Rechnung pruefen jeden Code im Backend (Beispiel `api-einheiten`).
  */
-export declare const RECHNUNG_EINHEITEN_CODES: Readonly<Record<InvoiceUnit, string>>;
+export declare const INVOICE_UNIT_CODES: Readonly<Record<InvoiceUnit, string>>;
 /**
  * Was erfuellt sein muss, bevor ueber die API ausgestellt werden darf — in
  * dieser Reihenfolge meldet `getInvoiceSetupStatus`, was fehlt, und dieselben
@@ -174,36 +200,36 @@ export declare const RECHNUNG_EINHEITEN_CODES: Readonly<Record<InvoiceUnit, stri
 export declare const INVOICE_SETUP_REQUIREMENTS: readonly ["module_active", "api_enabled", "live_enabled", "business_name", "address", "vat_id", "bank_account", "number_format"];
 export type InvoiceSetupRequirement = (typeof INVOICE_SETUP_REQUIREMENTS)[number];
 /** Formate, die der Server mit `@kreiseck/validator` bzw. einem Muster prueft. */
-export type Format = 'email' | 'phone' | 'vatId' | 'country' | 'date' | 'shortCode';
-export type Feld = {
-    typ: 'string';
-    pflicht: boolean;
+export type FieldFormat = 'email' | 'phone' | 'vatId' | 'country' | 'date' | 'shortCode';
+export type Field = {
+    type: 'string';
+    required: boolean;
     min?: number;
     max: number;
-    format?: Format;
+    format?: FieldFormat;
 } | {
-    typ: 'integer';
-    pflicht: boolean;
+    type: 'integer';
+    required: boolean;
     min: number;
     max: number;
 } | {
-    typ: 'number';
-    pflicht: boolean;
+    type: 'number';
+    required: boolean;
     min: number;
     max: number;
-    nachkomma: number;
-    exklusivMin?: boolean;
+    decimals: number;
+    exclusiveMin?: boolean;
 } | {
-    typ: 'boolean';
-    pflicht: boolean;
+    type: 'boolean';
+    required: boolean;
 } | {
-    typ: 'enum';
-    pflicht: boolean;
-    werte: readonly (string | number)[];
+    type: 'enum';
+    required: boolean;
+    values: readonly (string | number)[];
 } | {
-    typ: 'object';
-    pflicht: boolean;
-    felder: Readonly<Record<string, Feld>>;
+    type: 'object';
+    required: boolean;
+    fields: Readonly<Record<string, Field>>;
     /**
      * Feldgruppen, von denen GENAU EINE gesetzt sein muss (§ 9.1). Jede Gruppe
      * ist eine Liste von Feldnamen; im JSON Schema wird daraus
@@ -214,22 +240,22 @@ export type Feld = {
      * liesse sich das nicht ausdruecken, und als zwei optionale waere eine
      * Position ohne Preis gueltig.
      */
-    genauEins?: readonly (readonly string[])[];
+    exactlyOne?: readonly (readonly string[])[];
 } | {
-    typ: 'list';
-    pflicht: boolean;
+    type: 'list';
+    required: boolean;
     min: number;
     max: number;
-    eintrag: Feld;
+    item: Field;
 } | {
-    typ: 'map';
-    pflicht: boolean;
-    maxSchluessel: number;
-    schluesselMuster: string;
-    wertMax: number;
+    type: 'map';
+    required: boolean;
+    maxKeys: number;
+    keyPattern: string;
+    valueMax: number;
 };
 /** Kunde, wie das Fremdsystem ihn schickt. `vatId` ist die UID-Nummer. */
-export declare const KUNDE_FELDER: Readonly<Record<string, Feld>>;
+export declare const CUSTOMER_FIELDS: Readonly<Record<string, Field>>;
 /**
  * Eine Rechnungs- oder Gutschriftsposition.
  *
@@ -240,9 +266,9 @@ export declare const KUNDE_FELDER: Readonly<Record<string, Feld>>;
  * unterhalb eines Cents (Verbrauchsabrechnung, Stueckpreise im Zehntelcent),
  * die bisher gerundet eingereicht werden mussten.
  */
-export declare const POSITION_FELDER: Readonly<Record<string, Feld>>;
+export declare const ITEM_FIELDS: Readonly<Record<string, Field>>;
 /** Genau einer der beiden Preise je Position (§ 9.1). */
-export declare const POSITION_PREIS_GENAU_EINS: readonly (readonly string[])[];
+export declare const ITEM_PRICE_EXACTLY_ONE: readonly (readonly string[])[];
 /**
  * Eine Zahlung zu einer Rechnung. Ohne `amountCents` gilt der volle
  * Bruttobetrag, ohne `paidAt` der heutige Wiener Tag. `reference` ist die
@@ -250,9 +276,9 @@ export declare const POSITION_PREIS_GENAU_EINS: readonly (readonly string[])[];
  * aber **nicht gedruckt**: die Rechnung wird aufbewahrt und vervielfaeltigt,
  * und dem Empfaenger nuetzt sie nichts.
  */
-export declare const PAYMENT_FELDER: Readonly<Record<string, Feld>>;
-export declare const RECHNUNG_ANFRAGEN: Readonly<Record<RechnungAufruf, Readonly<Record<string, Feld>>>>;
+export declare const PAYMENT_FIELDS: Readonly<Record<string, Field>>;
+export declare const INVOICE_REQUESTS: Readonly<Record<InvoiceEndpoint, Readonly<Record<string, Field>>>>;
 /** Genau eines dieser Felder muss gesetzt sein (je Aufruf, je Gruppe). */
-export declare const RECHNUNG_GENAU_EINS: Readonly<Partial<Record<RechnungAufruf, readonly (readonly string[])[]>>>;
+export declare const INVOICE_EXACTLY_ONE: Readonly<Partial<Record<InvoiceEndpoint, readonly (readonly string[])[]>>>;
 /** Mindestens eines dieser Felder muss gesetzt sein (je Aufruf, je Gruppe). */
-export declare const RECHNUNG_MINDESTENS_EINS: Readonly<Partial<Record<RechnungAufruf, readonly (readonly string[])[]>>>;
+export declare const INVOICE_AT_LEAST_ONE: Readonly<Partial<Record<InvoiceEndpoint, readonly (readonly string[])[]>>>;