@invowerk-dev/sdk 1.0.8 → 1.0.10

package/dist/sdk.gen.d.ts

@@ -78,13 +78,16 @@ export declare const convertInvoice: <ThrowOnError extends boolean = false>(opti
  * requires `buyer_reference` (BT-10, the Leitweg-ID) and `payment_iban` (BT-84).
  * A credit note (381) needs CII. The seller needs `identifier` (BT-29),
  * `legal_registration_id` (BT-30) or `vat_id` (BT-31). invowerk writes your
- * amounts as given. It does not compute or correct them. Before answering,
- * invowerk checks the generated XML and never returns an invalid document. The
- * answer is `application/xml`; `?format=json` returns
- * `{xml, syntax, flavor, self_validation}`. Errors: 422 for invalid input, with
- * details per field or the rule it breaks; 500 when the generated XML fails the
- * check (the credits are refunded); 429 when every slot is busy (callers without an API key share
- * one); 504 when it took longer than 20 s. Costs 5 credits.
+ * amounts as given, with 2 decimals. It does not compute or correct them.
+ * Input that breaks an EN 16931 or XRechnung rule is a 422 naming each rule,
+ * e.g. BT-112 = BT-109 + BT-110 (BR-CO-15). Dates are YYYY-MM-DD, amounts go
+ * up to 999,999,999.99. Before answering, invowerk checks
+ * the generated XML and never returns an invalid document. The answer is
+ * `application/xml`; `?format=json` returns `{xml, syntax, flavor,
+ * self_validation}`. Errors: 422 for invalid input, with details per field or
+ * the rule it breaks; 500 when the generated XML still fails the check (the
+ * credits are refunded); 429 when every slot is busy (callers without an API key
+ * share one); 504 when it took longer than 20 s. Costs 5 credits.
  *
  * **Credits:** 5 per call.
  */

package/dist/sdk.gen.js

@@ -88,13 +88,16 @@ export const convertInvoice = (options) => (options.client ?? client).post({
  * requires `buyer_reference` (BT-10, the Leitweg-ID) and `payment_iban` (BT-84).
  * A credit note (381) needs CII. The seller needs `identifier` (BT-29),
  * `legal_registration_id` (BT-30) or `vat_id` (BT-31). invowerk writes your
- * amounts as given. It does not compute or correct them. Before answering,
- * invowerk checks the generated XML and never returns an invalid document. The
- * answer is `application/xml`; `?format=json` returns
- * `{xml, syntax, flavor, self_validation}`. Errors: 422 for invalid input, with
- * details per field or the rule it breaks; 500 when the generated XML fails the
- * check (the credits are refunded); 429 when every slot is busy (callers without an API key share
- * one); 504 when it took longer than 20 s. Costs 5 credits.
+ * amounts as given, with 2 decimals. It does not compute or correct them.
+ * Input that breaks an EN 16931 or XRechnung rule is a 422 naming each rule,
+ * e.g. BT-112 = BT-109 + BT-110 (BR-CO-15). Dates are YYYY-MM-DD, amounts go
+ * up to 999,999,999.99. Before answering, invowerk checks
+ * the generated XML and never returns an invalid document. The answer is
+ * `application/xml`; `?format=json` returns `{xml, syntax, flavor,
+ * self_validation}`. Errors: 422 for invalid input, with details per field or
+ * the rule it breaks; 500 when the generated XML still fails the check (the
+ * credits are refunded); 429 when every slot is busy (callers without an API key
+ * share one); 504 when it took longer than 20 s. Costs 5 credits.
  *
  * **Credits:** 5 per call.
  */

package/dist/types.gen.d.ts

@@ -152,13 +152,13 @@ export type DocumentTotals = {
     /**
      * Tax Exclusive
      *
-     * Invoice total without VAT (BT-109).
+     * Invoice total without VAT (BT-109). invowerk writes no document-level allowances or charges, so to generate, it must equal the line total (BR-CO-13).
      */
     tax_exclusive: number | string;
     /**
      * Tax Inclusive
      *
-     * Invoice total with VAT (BT-112).
+     * Invoice total with VAT (BT-112): the total without VAT plus the sum of the VAT breakdown amounts (BR-CO-15).
      */
     tax_inclusive: number | string;
     /**
@@ -371,7 +371,9 @@ export type Flavor = 'en16931' | 'xrechnung';
  *
  * All amounts are your own figures. invowerk writes them into the XML and
  * checks the result against EN 16931 (and XRechnung, if selected). It does not
- * compute or correct them.
+ * compute or correct them. Input that breaks an EN 16931 or XRechnung rule is
+ * refused (HTTP 422), each rule named. Dates are YYYY-MM-DD, amounts go up to
+ * 999,999,999.99.
  */
 export type GenerateRequest = {
     /**
@@ -591,7 +593,7 @@ export type InvoiceLine = {
     /**
      * Tax Rate
      *
-     * VAT rate of the line in percent, e.g. 19.00 (BT-152).
+     * VAT rate of the line in percent, e.g. 19.00 (BT-152). Not written for category 'O', not subject to VAT (BR-O-05).
      */
     tax_rate?: number | string;
 };
@@ -1312,7 +1314,7 @@ export type GenerateInvoiceErrors = {
      */
     422: Problem;
     /**
-     * The generated XML failed invowerk's own check. No document is returned and the credits are refunded.
+     * The generated XML failed invowerk's own check. No document is returned and the credits are refunded. Input that breaks a rule is a 422, not a 500.
      */
     500: Problem;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@invowerk-dev/sdk",
-  "version": "1.0.8",
+  "version": "1.0.10",
   "description": "TypeScript client for the invowerk API: validate XRechnung, ZUGFeRD, Factur-X and Peppol BIS e-invoices from your code or CI.",
   "keywords": [
     "invowerk",