@kreiseck/kasseneck-api 0.14.0 → 0.15.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (55) hide show
  1. package/CHANGELOG.md +28 -0
  2. package/README.md +65 -0
  3. package/dist/cjs/client/aufrufe.d.ts +1 -1
  4. package/dist/cjs/client/aufrufe.js +11 -0
  5. package/dist/cjs/rechnung/api.d.ts +43 -0
  6. package/dist/cjs/rechnung/api.js +35 -0
  7. package/dist/cjs/rechnung/auth.d.ts +21 -0
  8. package/dist/cjs/rechnung/auth.js +36 -0
  9. package/dist/cjs/rechnung/endpunkte.d.ts +48 -0
  10. package/dist/cjs/rechnung/endpunkte.js +129 -0
  11. package/dist/cjs/rechnung/fehler.d.ts +21 -0
  12. package/dist/cjs/rechnung/fehler.js +44 -0
  13. package/dist/cjs/rechnung/index.d.ts +18 -0
  14. package/dist/cjs/rechnung/index.js +52 -0
  15. package/dist/cjs/rechnung/typen.d.ts +224 -0
  16. package/dist/cjs/rechnung/typen.js +9 -0
  17. package/dist/cjs/rechnung/vertrag.d.ts +98 -0
  18. package/dist/cjs/rechnung/vertrag.js +191 -0
  19. package/dist/esm/client/aufrufe.d.ts +1 -1
  20. package/dist/esm/client/aufrufe.js +11 -0
  21. package/dist/esm/rechnung/api.d.ts +43 -0
  22. package/dist/esm/rechnung/api.js +32 -0
  23. package/dist/esm/rechnung/auth.d.ts +21 -0
  24. package/dist/esm/rechnung/auth.js +33 -0
  25. package/dist/esm/rechnung/endpunkte.d.ts +48 -0
  26. package/dist/esm/rechnung/endpunkte.js +116 -0
  27. package/dist/esm/rechnung/fehler.d.ts +21 -0
  28. package/dist/esm/rechnung/fehler.js +39 -0
  29. package/dist/esm/rechnung/index.d.ts +18 -0
  30. package/dist/esm/rechnung/index.js +17 -0
  31. package/dist/esm/rechnung/typen.d.ts +224 -0
  32. package/dist/esm/rechnung/typen.js +8 -0
  33. package/dist/esm/rechnung/vertrag.d.ts +98 -0
  34. package/dist/esm/rechnung/vertrag.js +188 -0
  35. package/fixtures/hobex-hps-codes.json +1 -1
  36. package/fixtures/kasse-texte.json +1 -1
  37. package/fixtures/oberflaeche.json +87 -1
  38. package/fixtures/rechnung-api-beispiele/credit-fehler-grund.json +24 -0
  39. package/fixtures/rechnung-api-beispiele/credit-ok.json +20 -0
  40. package/fixtures/rechnung-api-beispiele/customer-fehler-uid.json +25 -0
  41. package/fixtures/rechnung-api-beispiele/customer-get-fehler-beide.json +15 -0
  42. package/fixtures/rechnung-api-beispiele/customer-ok.json +20 -0
  43. package/fixtures/rechnung-api-beispiele/customer-search-fehler-leer.json +14 -0
  44. package/fixtures/rechnung-api-beispiele/issue-brutto-20.json +27 -0
  45. package/fixtures/rechnung-api-beispiele/issue-fehler-cent.json +26 -0
  46. package/fixtures/rechnung-api-beispiele/issue-fehler-menge.json +26 -0
  47. package/fixtures/rechnung-api-beispiele/issue-fehler-negativ.json +26 -0
  48. package/fixtures/rechnung-api-beispiele/issue-fehler-satz.json +26 -0
  49. package/fixtures/rechnung-api-beispiele/issue-fehler-unbekannt.json +27 -0
  50. package/fixtures/rechnung-api-beispiele/issue-gemischt.json +33 -0
  51. package/fixtures/rechnung-api-beispiele/issue-kleinunternehmer.json +27 -0
  52. package/fixtures/rechnung-api-beispiele/issue-netto-20.json +28 -0
  53. package/fixtures/rechnung-api-beispiele/issue-rabatt.json +28 -0
  54. package/fixtures/rechnung-api.schema.json +672 -0
  55. package/package.json +12 -1
@@ -0,0 +1,21 @@
1
+ /**
2
+ * Anmeldung fuer die Rechnungs-API: der `api_key` des Kontos als Bearer.
3
+ *
4
+ * Anders als `apiKeyAuth` **ohne** `cashregister-token` — eine Rechnung
5
+ * entsteht nicht an einer Kasse, sondern am Konto.
6
+ *
7
+ * **Der Schluessel gehoert auf einen Server.** Mit ihm entstehen festgeschriebene
8
+ * Rechnungen mit fortlaufender Nummer, die sich nur noch per Gutschrift
9
+ * korrigieren lassen.
10
+ *
11
+ * Geprueft wird nur, was ohne Netz sicher falsch ist: ein leerer Wert, ein
12
+ * Partner-Schluessel (`pk_…`) oder ein Kassen-Token (`cb_…`). Die Form des
13
+ * Kontoschluessels selbst bleibt offen, weil das Backend neben `kr_<env>_…`
14
+ * weiterhin aeltere Formen annimmt. Die Meldung nennt nie den Wert, nur seine Art.
15
+ */
16
+ import type { KasseneckAuth } from '../client/auth.js';
17
+ export interface RechnungKeyAuthOptions {
18
+ /** `api_key` des Kontos, z. B. `kr_live_…` oder `kr_test_…`. */
19
+ apiKey: string;
20
+ }
21
+ export declare function rechnungKeyAuth(options: RechnungKeyAuthOptions): KasseneckAuth;
@@ -0,0 +1,33 @@
1
+ /**
2
+ * Anmeldung fuer die Rechnungs-API: der `api_key` des Kontos als Bearer.
3
+ *
4
+ * Anders als `apiKeyAuth` **ohne** `cashregister-token` — eine Rechnung
5
+ * entsteht nicht an einer Kasse, sondern am Konto.
6
+ *
7
+ * **Der Schluessel gehoert auf einen Server.** Mit ihm entstehen festgeschriebene
8
+ * Rechnungen mit fortlaufender Nummer, die sich nur noch per Gutschrift
9
+ * korrigieren lassen.
10
+ *
11
+ * Geprueft wird nur, was ohne Netz sicher falsch ist: ein leerer Wert, ein
12
+ * Partner-Schluessel (`pk_…`) oder ein Kassen-Token (`cb_…`). Die Form des
13
+ * Kontoschluessels selbst bleibt offen, weil das Backend neben `kr_<env>_…`
14
+ * weiterhin aeltere Formen annimmt. Die Meldung nennt nie den Wert, nur seine Art.
15
+ */
16
+ import { KasseneckAuthError } from '../client/errors.js';
17
+ export function rechnungKeyAuth(options) {
18
+ const schluessel = typeof options?.apiKey === 'string' ? options.apiKey.trim() : '';
19
+ if (!schluessel) {
20
+ throw new KasseneckAuthError('rechnungKeyAuth: apiKey fehlt');
21
+ }
22
+ if (/^pk_(live|test)_/i.test(schluessel)) {
23
+ throw new KasseneckAuthError('rechnungKeyAuth: das ist ein Partner-Schluessel (pk_…) — die Rechnungs-API nimmt den api_key des Kontos (kr_…)');
24
+ }
25
+ if (/^cb_(live|test)_/i.test(schluessel)) {
26
+ throw new KasseneckAuthError('rechnungKeyAuth: das ist ein Kassen-Token (cb_…) — die Rechnungs-API nimmt den api_key des Kontos (kr_…)');
27
+ }
28
+ // Pro Aufruf ein frisches Objekt, wie bei den anderen Anmeldungen.
29
+ return () => ({
30
+ headers: { Authorization: `Bearer ${schluessel}` },
31
+ params: {},
32
+ });
33
+ }
@@ -0,0 +1,48 @@
1
+ /**
2
+ * Die Aufrufe der Rechnungs-API — Kunden, Rechnungen, Gutschriften, Dateien.
3
+ *
4
+ * Jede Funktion nimmt den Transport als ersten Parameter und ist einzeln
5
+ * importierbar; die Fassade [createRechnungApi] bindet ihn nur einmal.
6
+ *
7
+ * **Geprueft wird hier nichts Fachliches.** Die Anfrage geht unveraendert an
8
+ * das Backend, das sie gegen denselben Vertrag prueft (`vertrag.ts`) und einen
9
+ * Formfehler als `validation` mit `errors[]` zurueckgibt — zwei Pruefungen
10
+ * hiessen zwei Wahrheiten, von denen eine veraltet.
11
+ *
12
+ * **Nicht automatisch wiederholen.** Wer nach einem Zeitlimit erneut
13
+ * ausstellt, tut das mit **demselben** `idempotencyKey`: dann kommt die schon
14
+ * ausgestellte Rechnung zurueck (`replayed: true`) statt einer zweiten.
15
+ *
16
+ * Nach dem Senden wird nichts hart gecastet: fehlt ein zugesagtes Feld, wirft
17
+ * der Aufruf `KasseneckValidationError` mit `scope:'response'`.
18
+ */
19
+ import type { InternerBinaerTransport, InternerTransport } from '../client/aufrufe.js';
20
+ import type { EInvoiceFormat } from './vertrag.js';
21
+ import type { CancelInvoiceRequest, CancelResult, CreditNoteRequest, CreditNoteResult, Customer, CustomerInput, CustomerPage, CustomerSearch, InvoiceDetail, InvoiceListQuery, InvoicePage, IssueInvoiceRequest, IssueResult } from './typen.js';
22
+ export declare function createCustomer(rufen: InternerTransport, customer: CustomerInput, optionen?: {
23
+ idempotencyKey?: string;
24
+ }): Promise<Customer>;
25
+ export declare function getCustomer(rufen: InternerTransport, kennung: {
26
+ customerId: string;
27
+ } | {
28
+ externalId: string;
29
+ }): Promise<Customer>;
30
+ export declare function updateCustomer(rufen: InternerTransport, customerId: string, patch: Partial<CustomerInput>): Promise<Customer>;
31
+ export declare function searchCustomers(rufen: InternerTransport, suche: CustomerSearch): Promise<CustomerPage>;
32
+ export declare function issueInvoice(rufen: InternerTransport, anfrage: IssueInvoiceRequest): Promise<IssueResult>;
33
+ export declare function cancelInvoice(rufen: InternerTransport, anfrage: CancelInvoiceRequest): Promise<CancelResult>;
34
+ export declare function createCreditNote(rufen: InternerTransport, anfrage: CreditNoteRequest): Promise<CreditNoteResult>;
35
+ export declare function getInvoice(rufen: InternerTransport, kennung: {
36
+ invoiceId: string;
37
+ } | {
38
+ number: string;
39
+ }): Promise<InvoiceDetail>;
40
+ export declare function listInvoices(rufen: InternerTransport, abfrage?: InvoiceListQuery): Promise<InvoicePage>;
41
+ /** Das PDF der Rechnung (bei Gutschriften: der Gutschrift), mit eingebetteter Factur-X-Datei. */
42
+ export declare function getInvoicePdf(rufenBinaer: InternerBinaerTransport, invoiceId: string): Promise<Uint8Array>;
43
+ /**
44
+ * Die E-Rechnung als XML-Text. Sie kommt im gewohnten Umschlag (`data.xml`)
45
+ * und nicht als rohe Datei: so bleibt ein fachlicher Fehler
46
+ * (`einvoice_incomplete` mit `missing[]`) ein gewoehnlicher Fehler.
47
+ */
48
+ export declare function getInvoiceXml(rufen: InternerTransport, invoiceId: string, format?: EInvoiceFormat): Promise<string>;
@@ -0,0 +1,116 @@
1
+ /**
2
+ * Die Aufrufe der Rechnungs-API — Kunden, Rechnungen, Gutschriften, Dateien.
3
+ *
4
+ * Jede Funktion nimmt den Transport als ersten Parameter und ist einzeln
5
+ * importierbar; die Fassade [createRechnungApi] bindet ihn nur einmal.
6
+ *
7
+ * **Geprueft wird hier nichts Fachliches.** Die Anfrage geht unveraendert an
8
+ * das Backend, das sie gegen denselben Vertrag prueft (`vertrag.ts`) und einen
9
+ * Formfehler als `validation` mit `errors[]` zurueckgibt — zwei Pruefungen
10
+ * hiessen zwei Wahrheiten, von denen eine veraltet.
11
+ *
12
+ * **Nicht automatisch wiederholen.** Wer nach einem Zeitlimit erneut
13
+ * ausstellt, tut das mit **demselben** `idempotencyKey`: dann kommt die schon
14
+ * ausgestellte Rechnung zurueck (`replayed: true`) statt einer zweiten.
15
+ *
16
+ * Nach dem Senden wird nichts hart gecastet: fehlt ein zugesagtes Feld, wirft
17
+ * der Aufruf `KasseneckValidationError` mit `scope:'response'`.
18
+ */
19
+ import { KasseneckValidationError } from '../client/errors.js';
20
+ function objekt(wert) {
21
+ return wert !== null && typeof wert === 'object' && !Array.isArray(wert)
22
+ ? wert
23
+ : {};
24
+ }
25
+ /** Ein zugesagtes Objektfeld der Antwort — oder ein Antwortfehler. */
26
+ function pflichtObjekt(aufruf, daten, feld) {
27
+ const wert = objekt(daten)[feld];
28
+ if (wert === null || typeof wert !== 'object' || Array.isArray(wert)) {
29
+ throw new KasseneckValidationError(aufruf, `Antwort ohne ${feld}`, 'response');
30
+ }
31
+ return wert;
32
+ }
33
+ /** Eine zugesagte Liste samt Cursor — oder ein Antwortfehler. */
34
+ function seite(aufruf, daten, feld) {
35
+ const o = objekt(daten);
36
+ if (!Array.isArray(o[feld])) {
37
+ throw new KasseneckValidationError(aufruf, `Antwort ohne ${feld}`, 'response');
38
+ }
39
+ return { eintraege: o[feld], nextCursor: typeof o['nextCursor'] === 'string' ? o['nextCursor'] : null };
40
+ }
41
+ const zahl = (wert) => (typeof wert === 'number' && Number.isFinite(wert) ? wert : 0);
42
+ /** Anfrageobjekt als Nutzlast — flache Kopie, damit der Aufrufer sein Objekt behaelt. */
43
+ const nutzlast = (anfrage) => ({ ...anfrage });
44
+ // ---- Kunden -----------------------------------------------------------------
45
+ export async function createCustomer(rufen, customer, optionen = {}) {
46
+ const params = { customer };
47
+ if (optionen.idempotencyKey)
48
+ params['idempotencyKey'] = optionen.idempotencyKey;
49
+ const daten = await rufen('createCustomer', params);
50
+ return pflichtObjekt('createCustomer', daten, 'customer');
51
+ }
52
+ export async function getCustomer(rufen, kennung) {
53
+ const daten = await rufen('getCustomer', nutzlast(kennung));
54
+ return pflichtObjekt('getCustomer', daten, 'customer');
55
+ }
56
+ export async function updateCustomer(rufen, customerId, patch) {
57
+ const daten = await rufen('updateCustomer', { customerId, customer: patch });
58
+ return pflichtObjekt('updateCustomer', daten, 'customer');
59
+ }
60
+ export async function searchCustomers(rufen, suche) {
61
+ const daten = await rufen('searchCustomers', nutzlast(suche));
62
+ const { eintraege, nextCursor } = seite('searchCustomers', daten, 'customers');
63
+ return { customers: eintraege, nextCursor };
64
+ }
65
+ // ---- Rechnungen -------------------------------------------------------------
66
+ export async function issueInvoice(rufen, anfrage) {
67
+ const daten = await rufen('issueInvoice', nutzlast(anfrage));
68
+ return {
69
+ invoice: pflichtObjekt('issueInvoice', daten, 'invoice'),
70
+ replayed: objekt(daten)['replayed'] === true,
71
+ };
72
+ }
73
+ export async function cancelInvoice(rufen, anfrage) {
74
+ const daten = await rufen('cancelInvoice', nutzlast(anfrage));
75
+ return {
76
+ creditNote: pflichtObjekt('cancelInvoice', daten, 'creditNote'),
77
+ original: pflichtObjekt('cancelInvoice', daten, 'original'),
78
+ originalPaidCents: zahl(objekt(daten)['originalPaidCents']),
79
+ replayed: objekt(daten)['replayed'] === true,
80
+ };
81
+ }
82
+ export async function createCreditNote(rufen, anfrage) {
83
+ const daten = await rufen('createCreditNote', nutzlast(anfrage));
84
+ return {
85
+ creditNote: pflichtObjekt('createCreditNote', daten, 'creditNote'),
86
+ remainingCents: zahl(objekt(daten)['remainingCents']),
87
+ replayed: objekt(daten)['replayed'] === true,
88
+ };
89
+ }
90
+ export async function getInvoice(rufen, kennung) {
91
+ const daten = await rufen('getInvoice', nutzlast(kennung));
92
+ return pflichtObjekt('getInvoice', daten, 'invoice');
93
+ }
94
+ export async function listInvoices(rufen, abfrage = {}) {
95
+ const daten = await rufen('listInvoices', nutzlast(abfrage));
96
+ const { eintraege, nextCursor } = seite('listInvoices', daten, 'invoices');
97
+ return { invoices: eintraege, nextCursor };
98
+ }
99
+ // ---- Dateien ----------------------------------------------------------------
100
+ /** Das PDF der Rechnung (bei Gutschriften: der Gutschrift), mit eingebetteter Factur-X-Datei. */
101
+ export function getInvoicePdf(rufenBinaer, invoiceId) {
102
+ return rufenBinaer('getInvoicePdf', { invoiceId });
103
+ }
104
+ /**
105
+ * Die E-Rechnung als XML-Text. Sie kommt im gewohnten Umschlag (`data.xml`)
106
+ * und nicht als rohe Datei: so bleibt ein fachlicher Fehler
107
+ * (`einvoice_incomplete` mit `missing[]`) ein gewoehnlicher Fehler.
108
+ */
109
+ export async function getInvoiceXml(rufen, invoiceId, format = 'ubl') {
110
+ const daten = await rufen('getInvoiceXml', { invoiceId, format });
111
+ const xml = objekt(daten)['xml'];
112
+ if (typeof xml !== 'string' || !xml) {
113
+ throw new KasseneckValidationError('getInvoiceXml', 'Antwort ohne xml', 'response');
114
+ }
115
+ return xml;
116
+ }
@@ -0,0 +1,21 @@
1
+ /**
2
+ * Fehler der Rechnungs-API auswerten — am Code, nie am Text.
3
+ *
4
+ * Es zaehlen nur Codes aus dem Vertrag ([INVOICE_ERROR_CODES]). Ein fremder
5
+ * Code (z. B. aus einer vorgeschalteten Schicht) ist fuer diese Helfer kein
6
+ * Rechnungs-Fehler: wer darauf verzweigt, soll es bewusst ueber
7
+ * `KasseneckApiError.code` tun.
8
+ */
9
+ import { type InvoiceErrorCode } from './vertrag.js';
10
+ /** Der Fehlercode eines geworfenen Fehlers — `undefined`, wenn es keiner der Rechnungs-API ist. */
11
+ export declare function rechnungFehlerCode(error: unknown): InvoiceErrorCode | undefined;
12
+ /** Kurzform fuer `catch (e) { if (istRechnungFehler(e, 'customer_exists')) … }`. */
13
+ export declare function istRechnungFehler(error: unknown, code: InvoiceErrorCode): boolean;
14
+ /** Ein Feldfehler aus `data.errors[]` einer `validation`-Antwort. */
15
+ export interface RechnungFeldFehler {
16
+ /** Feldpfad in der gesendeten Anfrage, z. B. `items[2].vatRate` oder `customer.vatId`. */
17
+ field: string;
18
+ message: string;
19
+ }
20
+ /** Die Feldfehler einer `validation`-Antwort; leer, wenn es keine sind. */
21
+ export declare function rechnungFeldFehler(error: unknown): RechnungFeldFehler[];
@@ -0,0 +1,39 @@
1
+ /**
2
+ * Fehler der Rechnungs-API auswerten — am Code, nie am Text.
3
+ *
4
+ * Es zaehlen nur Codes aus dem Vertrag ([INVOICE_ERROR_CODES]). Ein fremder
5
+ * Code (z. B. aus einer vorgeschalteten Schicht) ist fuer diese Helfer kein
6
+ * Rechnungs-Fehler: wer darauf verzweigt, soll es bewusst ueber
7
+ * `KasseneckApiError.code` tun.
8
+ */
9
+ import { KasseneckApiError } from '../client/errors.js';
10
+ import { INVOICE_ERROR_CODES } from './vertrag.js';
11
+ const BEKANNT = new Set(INVOICE_ERROR_CODES);
12
+ /** Der Fehlercode eines geworfenen Fehlers — `undefined`, wenn es keiner der Rechnungs-API ist. */
13
+ export function rechnungFehlerCode(error) {
14
+ if (!(error instanceof KasseneckApiError))
15
+ return undefined;
16
+ const code = error.code;
17
+ return code !== undefined && BEKANNT.has(code) ? code : undefined;
18
+ }
19
+ /** Kurzform fuer `catch (e) { if (istRechnungFehler(e, 'customer_exists')) … }`. */
20
+ export function istRechnungFehler(error, code) {
21
+ return rechnungFehlerCode(error) === code;
22
+ }
23
+ /** Die Feldfehler einer `validation`-Antwort; leer, wenn es keine sind. */
24
+ export function rechnungFeldFehler(error) {
25
+ if (!(error instanceof KasseneckApiError))
26
+ return [];
27
+ const roh = error.details['errors'];
28
+ if (!Array.isArray(roh))
29
+ return [];
30
+ const raus = [];
31
+ for (const eintrag of roh) {
32
+ if (eintrag === null || typeof eintrag !== 'object')
33
+ continue;
34
+ const { field, message } = eintrag;
35
+ if (typeof field === 'string' && typeof message === 'string')
36
+ raus.push({ field, message });
37
+ }
38
+ return raus;
39
+ }
@@ -0,0 +1,18 @@
1
+ /**
2
+ * `@kreiseck/kasseneck-api/rechnung` — Rechnungen (§ 11 UStG, keine Belege)
3
+ * und Kunden ueber die Rechnungs-API.
4
+ *
5
+ * Ein eigener Unterpfad wie `partner`: der `api_key` eines Kontos, mit dem
6
+ * Rechnungen ausgestellt werden, gehoert auf einen **Server** und soll nicht
7
+ * versehentlich in ein Browser-Buendel der Kasse wandern.
8
+ *
9
+ * Die Beschreibung der Endpunkte steht in der Referenz des Backends
10
+ * (`docs/api/rechnungen.md`). Was hier steht, ist der Vertrag als Daten und die
11
+ * Benutzung des Clients.
12
+ */
13
+ export { createRechnungApi, type RechnungApi, type RechnungApiOptions } from './api.js';
14
+ export { rechnungKeyAuth, type RechnungKeyAuthOptions } from './auth.js';
15
+ export { istRechnungFehler, rechnungFehlerCode, rechnungFeldFehler, type RechnungFeldFehler, } from './fehler.js';
16
+ export { cancelInvoice, createCreditNote, createCustomer, getCustomer, getInvoice, getInvoicePdf, getInvoiceXml, issueInvoice, listInvoices, searchCustomers, updateCustomer, } from './endpunkte.js';
17
+ export type { CancelInvoiceRequest, CancelResult, CreditNoteRequest, CreditNoteResult, Customer, CustomerInput, CustomerPage, CustomerSearch, EInvoiceStatus, Invoice, InvoiceDetail, InvoiceItem, InvoiceItemInput, InvoiceListQuery, InvoicePage, InvoiceRecipient, InvoiceTotals, IssueInvoiceRequest, IssueResult, } from './typen.js';
18
+ export { RECHNUNG_VERTRAG_VERSION, RECHNUNG_AUFRUFE, INVOICE_ERROR_CODES, CREDIT_NOTE_REASONS, TAX_SCHEMES, PRICE_MODES, VAT_RATES, CUSTOMER_TYPES, INVOICE_LIST_STATUS, DOC_TYPES, EINVOICE_FORMATS, KUNDE_FELDER, POSITION_FELDER, RECHNUNG_ANFRAGEN, RECHNUNG_GENAU_EINS, RECHNUNG_MINDESTENS_EINS, type RechnungAufruf, type InvoiceErrorCode, type CreditNoteReason, type TaxScheme, type PriceMode, type VatRatePercent, type CustomerType, type InvoiceListStatus, type DocType, type EInvoiceFormat, type Format, type Feld, } from './vertrag.js';
@@ -0,0 +1,17 @@
1
+ /**
2
+ * `@kreiseck/kasseneck-api/rechnung` — Rechnungen (§ 11 UStG, keine Belege)
3
+ * und Kunden ueber die Rechnungs-API.
4
+ *
5
+ * Ein eigener Unterpfad wie `partner`: der `api_key` eines Kontos, mit dem
6
+ * Rechnungen ausgestellt werden, gehoert auf einen **Server** und soll nicht
7
+ * versehentlich in ein Browser-Buendel der Kasse wandern.
8
+ *
9
+ * Die Beschreibung der Endpunkte steht in der Referenz des Backends
10
+ * (`docs/api/rechnungen.md`). Was hier steht, ist der Vertrag als Daten und die
11
+ * Benutzung des Clients.
12
+ */
13
+ export { createRechnungApi } from './api.js';
14
+ export { rechnungKeyAuth } from './auth.js';
15
+ export { istRechnungFehler, rechnungFehlerCode, rechnungFeldFehler, } from './fehler.js';
16
+ export { cancelInvoice, createCreditNote, createCustomer, getCustomer, getInvoice, getInvoicePdf, getInvoiceXml, issueInvoice, listInvoices, searchCustomers, updateCustomer, } from './endpunkte.js';
17
+ export { RECHNUNG_VERTRAG_VERSION, RECHNUNG_AUFRUFE, INVOICE_ERROR_CODES, CREDIT_NOTE_REASONS, TAX_SCHEMES, PRICE_MODES, VAT_RATES, CUSTOMER_TYPES, INVOICE_LIST_STATUS, DOC_TYPES, EINVOICE_FORMATS, KUNDE_FELDER, POSITION_FELDER, RECHNUNG_ANFRAGEN, RECHNUNG_GENAU_EINS, RECHNUNG_MINDESTENS_EINS, } from './vertrag.js';
@@ -0,0 +1,224 @@
1
+ /**
2
+ * Typen der Rechnungs-API. Die Anfragen folgen `vertrag.ts` Feld fuer Feld;
3
+ * `test/rechnung-client.test.ts` schickt die Beispiele des Vertrags durch.
4
+ *
5
+ * Betraege sind ueberall ganze Cent. Datumsangaben sind `YYYY-MM-DD` nach
6
+ * Wiener Kalender.
7
+ */
8
+ import type { CreditNoteReason, CustomerType, DocType, InvoiceListStatus, PriceMode, TaxScheme, VatRatePercent } from './vertrag.js';
9
+ export interface CustomerInput {
10
+ type: CustomerType;
11
+ name: string;
12
+ legalForm?: string;
13
+ email?: string;
14
+ phone?: string;
15
+ street?: string;
16
+ houseNumber?: string;
17
+ zip?: string;
18
+ city?: string;
19
+ /** ISO-3166-Alpha-2, z. B. `AT`. */
20
+ country: string;
21
+ /** UID-Nummer, z. B. `ATU12345678`. */
22
+ vatId?: string;
23
+ /** Kuerzel fuer die Rechnungsnummer; einmal gesetzt unveraenderlich. */
24
+ shortCode?: string;
25
+ /** Behoerde (B2G) — die E-Rechnung verlangt dann Adresse und `orderReference`. */
26
+ isAuthority?: boolean;
27
+ note?: string;
28
+ /** Kennung im eigenen System; je Konto eindeutig. */
29
+ externalId?: string;
30
+ }
31
+ export interface Customer {
32
+ id: string;
33
+ type: CustomerType;
34
+ name: string;
35
+ legalForm: string | null;
36
+ email: string | null;
37
+ phone: string | null;
38
+ street: string | null;
39
+ houseNumber: string | null;
40
+ zip: string | null;
41
+ city: string | null;
42
+ country: string;
43
+ vatId: string | null;
44
+ shortCode: string | null;
45
+ isAuthority: boolean;
46
+ note: string | null;
47
+ externalId: string | null;
48
+ createdAt: string | null;
49
+ updatedAt: string | null;
50
+ }
51
+ export interface CustomerSearch {
52
+ externalId?: string;
53
+ vatId?: string;
54
+ email?: string;
55
+ /** Namensanfang, Gross-/Kleinschreibung und Akzente egal. */
56
+ name?: string;
57
+ limit?: number;
58
+ cursor?: string;
59
+ }
60
+ export interface CustomerPage {
61
+ customers: Customer[];
62
+ nextCursor: string | null;
63
+ }
64
+ export interface InvoiceItemInput {
65
+ description: string;
66
+ subtitle?: string;
67
+ /** Hoechstens drei Nachkommastellen. */
68
+ quantity: number;
69
+ unit?: string;
70
+ /** Einzelpreis in ganzen Cent, im `priceMode` der Rechnung (netto oder brutto). */
71
+ unitPriceCents: number;
72
+ vatRate: VatRatePercent;
73
+ /** Zeilenrabatt in Prozent, hoechstens zwei Nachkommastellen. */
74
+ discountPct?: number;
75
+ }
76
+ export interface IssueInvoiceRequest {
77
+ /** Pflicht: dieselbe Anfrage mit demselben Schluessel erzeugt nie eine zweite Rechnung. */
78
+ idempotencyKey: string;
79
+ /** Pflicht ueber 400 € brutto sowie bei Reverse Charge und ig. Lieferung. */
80
+ customerId?: string;
81
+ taxScheme: TaxScheme;
82
+ priceMode: PriceMode;
83
+ /** Leistungsdatum bzw. Beginn des Leistungszeitraums. */
84
+ serviceStart: string;
85
+ serviceEnd?: string;
86
+ paymentTermDays?: number;
87
+ orderReference?: string;
88
+ intro?: string;
89
+ note?: string;
90
+ /** Verwendungszweck fuer die Ueberweisung; leer = Rechnungsnummer. */
91
+ paymentReference?: string;
92
+ girocode?: boolean;
93
+ tracking?: boolean;
94
+ items: InvoiceItemInput[];
95
+ /** Eigene Merkmale (hoechstens 20), nie gedruckt. */
96
+ metadata?: Record<string, string>;
97
+ }
98
+ export interface CancelInvoiceRequest {
99
+ idempotencyKey: string;
100
+ invoiceId: string;
101
+ reason: CreditNoteReason;
102
+ note?: string;
103
+ }
104
+ export interface CreditNoteRequest extends CancelInvoiceRequest {
105
+ items: InvoiceItemInput[];
106
+ }
107
+ export interface InvoiceTotals {
108
+ netCents: number;
109
+ vatCents: number;
110
+ grossCents: number;
111
+ byRate: {
112
+ rate: number;
113
+ netCents: number;
114
+ vatCents: number;
115
+ }[];
116
+ }
117
+ export interface EInvoiceStatus {
118
+ level: string;
119
+ formats: string[];
120
+ missing: string[];
121
+ }
122
+ export interface Invoice {
123
+ id: string;
124
+ number: string;
125
+ docType: DocType;
126
+ status: string;
127
+ invoiceDate: string;
128
+ dueDate: string | null;
129
+ customerId: string | null;
130
+ totals: InvoiceTotals;
131
+ einvoice: EInvoiceStatus | null;
132
+ statusUrl: string | null;
133
+ statusPassword: string | null;
134
+ metadata: Record<string, string>;
135
+ }
136
+ export interface InvoiceRecipient {
137
+ name: string;
138
+ type: CustomerType;
139
+ street: string | null;
140
+ houseNumber: string | null;
141
+ zip: string | null;
142
+ city: string | null;
143
+ country: string;
144
+ vatId: string | null;
145
+ shortCode: string | null;
146
+ email: string | null;
147
+ isAuthority: boolean;
148
+ }
149
+ /** Eine gespeicherte Position — wie gesendet, fehlende Angaben mit ihrem Standardwert. */
150
+ export interface InvoiceItem {
151
+ description: string;
152
+ subtitle: string;
153
+ quantity: number;
154
+ unit: string;
155
+ unitPriceCents: number;
156
+ vatRate: number;
157
+ discountPct: number;
158
+ }
159
+ export interface InvoiceDetail extends Invoice {
160
+ items: InvoiceItem[];
161
+ customer: InvoiceRecipient | null;
162
+ taxScheme: TaxScheme;
163
+ priceMode: PriceMode;
164
+ serviceStart: string | null;
165
+ serviceEnd: string | null;
166
+ paymentTermDays: number | null;
167
+ orderReference: string | null;
168
+ payments: {
169
+ amountCents: number;
170
+ date: string;
171
+ method: string;
172
+ }[];
173
+ paidCents: number;
174
+ openCents: number;
175
+ overdue: boolean;
176
+ writtenOff: boolean;
177
+ writeOffReasonCode: string | null;
178
+ related: {
179
+ invoiceId: string;
180
+ number: string | null;
181
+ } | null;
182
+ creditNotes: {
183
+ id: string;
184
+ number: string;
185
+ grossCents: number;
186
+ }[];
187
+ source: string | null;
188
+ createdAt: string | null;
189
+ finalizedAt: string | null;
190
+ }
191
+ export interface InvoiceListQuery {
192
+ from?: string;
193
+ to?: string;
194
+ status?: InvoiceListStatus;
195
+ docType?: DocType;
196
+ customerId?: string;
197
+ limit?: number;
198
+ cursor?: string;
199
+ }
200
+ export interface InvoicePage {
201
+ invoices: Invoice[];
202
+ nextCursor: string | null;
203
+ }
204
+ export interface IssueResult {
205
+ invoice: Invoice;
206
+ /** `true`, wenn die Anfrage schon einmal ausgefuehrt wurde und die bestehende Rechnung zurueckkommt. */
207
+ replayed: boolean;
208
+ }
209
+ export interface CancelResult {
210
+ creditNote: Invoice;
211
+ original: {
212
+ id: string;
213
+ status: string;
214
+ };
215
+ /** Bereits auf das Original bezahlt — die Rueckerstattung ist Sache des Betriebs. */
216
+ originalPaidCents: number;
217
+ replayed: boolean;
218
+ }
219
+ export interface CreditNoteResult {
220
+ creditNote: Invoice;
221
+ /** Brutto, das nach dieser Gutschrift noch gutgeschrieben werden kann. */
222
+ remainingCents: number;
223
+ replayed: boolean;
224
+ }
@@ -0,0 +1,8 @@
1
+ /**
2
+ * Typen der Rechnungs-API. Die Anfragen folgen `vertrag.ts` Feld fuer Feld;
3
+ * `test/rechnung-client.test.ts` schickt die Beispiele des Vertrags durch.
4
+ *
5
+ * Betraege sind ueberall ganze Cent. Datumsangaben sind `YYYY-MM-DD` nach
6
+ * Wiener Kalender.
7
+ */
8
+ export {};
@@ -0,0 +1,98 @@
1
+ /**
2
+ * Der Vertrag der Rechnungs-API — als Daten, nicht als Prosa.
3
+ *
4
+ * Aus dieser Datei entstehen drei Dinge, damit sie nicht auseinanderlaufen
5
+ * koennen:
6
+ *
7
+ * 1. `fixtures/rechnung-api.schema.json` (`npm run fixtures:rechnung`) — das
8
+ * Backend liest es aus dem vendorierten Paket und vergleicht es in beide
9
+ * Richtungen mit seiner eigenen Pruefung; der Dart-Zwilling zieht es byteweise.
10
+ * 2. Die Listen unter `rechnung` in `fixtures/oberflaeche.json` (Codes, Gruende,
11
+ * Enums) — ueber denselben Namensraum-Scan wie der Partner-Teil.
12
+ * 3. Die TypeScript-Typen in `typen.ts`.
13
+ *
14
+ * Nach aussen spricht die Schnittstelle Englisch: Feldnamen, Codes, Gruende.
15
+ * Deutsch bleibt, was ein Mensch liest (`message`, der Aufdruck eines Grundes).
16
+ *
17
+ * Beschrieben wird die Anfrage. Was der Server daraus macht — Rechnungsdatum,
18
+ * Nummer, Summen — ist bewusst **nicht** setzbar.
19
+ */
20
+ export declare const RECHNUNG_VERTRAG_VERSION = 1;
21
+ export declare const RECHNUNG_AUFRUFE: readonly ["createCustomer", "getCustomer", "updateCustomer", "searchCustomers", "issueInvoice", "cancelInvoice", "createCreditNote", "getInvoice", "listInvoices", "getInvoicePdf", "getInvoiceXml"];
22
+ export type RechnungAufruf = (typeof RECHNUNG_AUFRUFE)[number];
23
+ /**
24
+ * Stabile Fehlercodes. Das Fremdsystem verzweigt am Code, der Text darf sich
25
+ * aendern. `validation` traegt zusaetzlich `errors: [{ field, message }]`.
26
+ */
27
+ 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"];
28
+ export type InvoiceErrorCode = (typeof INVOICE_ERROR_CODES)[number];
29
+ /** Gruende einer Gutschrift. Der Server druckt den deutschen Anzeigetext. */
30
+ export declare const CREDIT_NOTE_REASONS: readonly ["cancellation", "price_reduction", "return", "incorrect_invoice", "other"];
31
+ export type CreditNoteReason = (typeof CREDIT_NOTE_REASONS)[number];
32
+ export declare const TAX_SCHEMES: readonly ["normal", "smallBusiness", "reverseCharge", "igLieferung", "exportThirdCountry"];
33
+ export type TaxScheme = (typeof TAX_SCHEMES)[number];
34
+ export declare const PRICE_MODES: readonly ["net", "gross"];
35
+ export type PriceMode = (typeof PRICE_MODES)[number];
36
+ export declare const VAT_RATES: readonly [0, 10, 13, 20];
37
+ export type VatRatePercent = (typeof VAT_RATES)[number];
38
+ export declare const CUSTOMER_TYPES: readonly ["private", "company"];
39
+ export type CustomerType = (typeof CUSTOMER_TYPES)[number];
40
+ export declare const INVOICE_LIST_STATUS: readonly ["final", "paid", "cancelled", "open", "overdue"];
41
+ export type InvoiceListStatus = (typeof INVOICE_LIST_STATUS)[number];
42
+ export declare const DOC_TYPES: readonly ["RE", "GU"];
43
+ export type DocType = (typeof DOC_TYPES)[number];
44
+ export declare const EINVOICE_FORMATS: readonly ["ubl", "cii"];
45
+ export type EInvoiceFormat = (typeof EINVOICE_FORMATS)[number];
46
+ /** Formate, die der Server mit `@kreiseck/validator` bzw. einem Muster prueft. */
47
+ export type Format = 'email' | 'phone' | 'vatId' | 'country' | 'date' | 'shortCode';
48
+ export type Feld = {
49
+ typ: 'string';
50
+ pflicht: boolean;
51
+ min?: number;
52
+ max: number;
53
+ format?: Format;
54
+ } | {
55
+ typ: 'integer';
56
+ pflicht: boolean;
57
+ min: number;
58
+ max: number;
59
+ } | {
60
+ typ: 'number';
61
+ pflicht: boolean;
62
+ min: number;
63
+ max: number;
64
+ nachkomma: number;
65
+ exklusivMin?: boolean;
66
+ } | {
67
+ typ: 'boolean';
68
+ pflicht: boolean;
69
+ } | {
70
+ typ: 'enum';
71
+ pflicht: boolean;
72
+ werte: readonly (string | number)[];
73
+ } | {
74
+ typ: 'object';
75
+ pflicht: boolean;
76
+ felder: Readonly<Record<string, Feld>>;
77
+ } | {
78
+ typ: 'list';
79
+ pflicht: boolean;
80
+ min: number;
81
+ max: number;
82
+ eintrag: Feld;
83
+ } | {
84
+ typ: 'map';
85
+ pflicht: boolean;
86
+ maxSchluessel: number;
87
+ schluesselMuster: string;
88
+ wertMax: number;
89
+ };
90
+ /** Kunde, wie das Fremdsystem ihn schickt. `vatId` ist die UID-Nummer. */
91
+ export declare const KUNDE_FELDER: Readonly<Record<string, Feld>>;
92
+ /** Eine Rechnungs- oder Gutschriftsposition. Preise in ganzen Cent. */
93
+ export declare const POSITION_FELDER: Readonly<Record<string, Feld>>;
94
+ export declare const RECHNUNG_ANFRAGEN: Readonly<Record<RechnungAufruf, Readonly<Record<string, Feld>>>>;
95
+ /** Genau eines dieser Felder muss gesetzt sein (je Aufruf, je Gruppe). */
96
+ export declare const RECHNUNG_GENAU_EINS: Readonly<Partial<Record<RechnungAufruf, readonly (readonly string[])[]>>>;
97
+ /** Mindestens eines dieser Felder muss gesetzt sein (je Aufruf, je Gruppe). */
98
+ export declare const RECHNUNG_MINDESTENS_EINS: Readonly<Partial<Record<RechnungAufruf, readonly (readonly string[])[]>>>;