@invowerk-dev/sdk 1.0.6 → 1.0.8

package/dist/index.d.ts

@@ -1,3 +1,3 @@
 export { client, type CreateClientConfig } from './client.gen.js';
 export { convertInvoice, explainCodes, generateInvoice, getMe, type Options, parseInvoice, renderInvoice, validateInvoice } from './sdk.gen.js';
-export type { BodyRenderInvoice, Buyer, ClientOptions, ContentClass, ConvertInvoiceData, ConvertInvoiceError, ConvertInvoiceErrors, ConvertInvoiceResponse, ConvertInvoiceResponses, ConvertResponse, ConvertSelfValidation, CreditsInfo, DocumentTotals, ERechnungDe, ErrorClasses, Evidence, ExplainCodesData, ExplainCodesError, ExplainCodesErrors, ExplainCodesResponse, ExplainCodesResponses, ExplainResponse, Finding, Flavor, GenerateInvoiceData, GenerateInvoiceError, GenerateInvoiceErrors, GenerateInvoiceResponse, GenerateInvoiceResponses, GenerateRequest, GenerateResponse, GetMeData, GetMeResponse, GetMeResponses, HintInfo, InvoiceLine, MeResponse, ParseDetection, ParseInvoiceData, ParseInvoiceResponse, ParseInvoiceResponses, ParseResponse, PostalAddress, Problem, RateLimitInfo, RenderInvoiceData, RenderInvoiceError, RenderInvoiceErrors, RenderInvoiceResponse, RenderInvoiceResponses, RenderResponse, RuleExplanation, ScenarioInfo, SelfValidation, Seller, Syntax, TaxBreakdown, ValidateInvoiceData, ValidateInvoiceError, ValidateInvoiceErrors, ValidateInvoiceResponse, ValidateInvoiceResponses, ValidationResponse, ValidatorVersions } from './types.gen.js';
+export type { BodyRenderInvoice, Buyer, ClientOptions, ContentClass, ConvertInvoiceData, ConvertInvoiceError, ConvertInvoiceErrors, ConvertInvoiceResponse, ConvertInvoiceResponses, ConvertResponse, ConvertSelfValidation, CreditsInfo, DocumentTotals, ERechnungDe, ErrorClasses, Evidence, ExplainCodesData, ExplainCodesError, ExplainCodesErrors, ExplainCodesResponse, ExplainCodesResponses, ExplainResponse, Finding, Flavor, GenerateInvoiceData, GenerateInvoiceError, GenerateInvoiceErrors, GenerateInvoiceResponse, GenerateInvoiceResponses, GenerateRequest, GenerateResponse, GetMeData, GetMeResponse, GetMeResponses, HintInfo, InvoiceLine, MeResponse, ParseDetection, ParseInvoiceData, ParseInvoiceResponse, ParseInvoiceResponses, ParseResponse, PostalAddress, PrecedingInvoice, Problem, RateLimitInfo, RenderInvoiceData, RenderInvoiceError, RenderInvoiceErrors, RenderInvoiceResponse, RenderInvoiceResponses, RenderResponse, RuleExplanation, ScenarioInfo, SelfValidation, Seller, Syntax, TaxBreakdown, ValidateInvoiceData, ValidateInvoiceError, ValidateInvoiceErrors, ValidateInvoiceResponse, ValidateInvoiceResponses, ValidationResponse, ValidatorVersions } from './types.gen.js';

package/dist/sdk.gen.d.ts

@@ -59,10 +59,11 @@ export declare const parseInvoice: <ThrowOnError extends boolean = false>(option
  * the flavor of the source is kept. invowerk checks the converted XML before
  * answering and never returns an invalid document. The answer is
  * `application/xml`; `?format=json` returns `{xml, syntax, flavor,
- * self_validation}`. Errors: 422 when the input cannot be read, with an error code
- * at the start of `detail`; 500 when the converted XML fails the check (the
- * credits are refunded); 413, 429 and 504 as for `POST /v1/parse`. Costs 3
- * credits.
+ * self_validation}`. Errors: 422 when the input cannot be read or cannot be
+ * written in the target form (e.g. XRechnung paid by direct debit: invowerk writes
+ * only SEPA credit transfer), with an error code at the start of `detail`; 500
+ * when the converted XML fails the check (the credits are refunded); 413, 429
+ * and 504 as for `POST /v1/parse`. Costs 3 credits.
  *
  * **Credits:** 3 per call.
  */
@@ -74,13 +75,15 @@ export declare const convertInvoice: <ThrowOnError extends boolean = false>(opti
  *
  * The JSON body is keyed on EN 16931 Business Terms (BT-*). `syntax` selects UBL
  * (default) or CII. `flavor` selects plain EN 16931 (default) or XRechnung, which
- * requires `buyer_reference` (BT-10, the Leitweg-ID). invowerk writes your
+ * 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; 500 when the generated XML fails the check (the credits are
- * refunded); 429 when every slot is busy (callers without an API key share
+ * 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.
  *
  * **Credits:** 5 per call.

package/dist/sdk.gen.js

@@ -60,10 +60,11 @@ export const parseInvoice = (options) => (options.client ?? client).post({
  * the flavor of the source is kept. invowerk checks the converted XML before
  * answering and never returns an invalid document. The answer is
  * `application/xml`; `?format=json` returns `{xml, syntax, flavor,
- * self_validation}`. Errors: 422 when the input cannot be read, with an error code
- * at the start of `detail`; 500 when the converted XML fails the check (the
- * credits are refunded); 413, 429 and 504 as for `POST /v1/parse`. Costs 3
- * credits.
+ * self_validation}`. Errors: 422 when the input cannot be read or cannot be
+ * written in the target form (e.g. XRechnung paid by direct debit: invowerk writes
+ * only SEPA credit transfer), with an error code at the start of `detail`; 500
+ * when the converted XML fails the check (the credits are refunded); 413, 429
+ * and 504 as for `POST /v1/parse`. Costs 3 credits.
  *
  * **Credits:** 3 per call.
  */
@@ -84,13 +85,15 @@ export const convertInvoice = (options) => (options.client ?? client).post({
  *
  * The JSON body is keyed on EN 16931 Business Terms (BT-*). `syntax` selects UBL
  * (default) or CII. `flavor` selects plain EN 16931 (default) or XRechnung, which
- * requires `buyer_reference` (BT-10, the Leitweg-ID). invowerk writes your
+ * 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; 500 when the generated XML fails the check (the credits are
- * refunded); 429 when every slot is busy (callers without an API key share
+ * 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.
  *
  * **Credits:** 5 per call.

package/dist/types.gen.d.ts

@@ -28,6 +28,12 @@ export type Buyer = {
      * Buyer postal address (BG-8).
      */
     address: PostalAddress;
+    /**
+     * Vat Id
+     *
+     * Buyer VAT ID, e.g. 'ATU12345678' (BT-48). Needed on lines with VAT category 'AE' (BR-AE-02) or 'K' (BR-IC-02).
+     */
+    vat_id?: string | null;
     /**
      * Electronic Address
      *
@@ -155,10 +161,16 @@ export type DocumentTotals = {
      * Invoice total with VAT (BT-112).
      */
     tax_inclusive: number | string;
+    /**
+     * Prepaid
+     *
+     * Amount already paid, e.g. the sum of earlier partial invoices on a final invoice (BT-113).
+     */
+    prepaid?: number | string | null;
     /**
      * Payable
      *
-     * Amount due for payment (BT-115). Defaults to the total with VAT.
+     * Amount due for payment (BT-115). Defaults to the total with VAT minus the paid amount (BT-112 − BT-113).
      */
     payable?: number | string | null;
 };
@@ -289,7 +301,9 @@ export type ExplainResponse = {
  * (``format``), in a rule of the applied rule set (``business_rules``) or in
  * the PDF around the invoice data (``carrier``). ``explain_url`` links the
  * explanation page for the code, in ``lang``. ``explain`` holds the explanation
- * itself when you call with ``?explain=true``.
+ * itself when you call with ``?explain=true``. ``printed_by`` names the
+ * browser or printer when a ``no_embedded_xml`` PDF was saved through a print
+ * function.
  */
 export type Finding = {
     /**
@@ -336,6 +350,12 @@ export type Finding = {
     explain?: {
         [key: string]: unknown;
     } | null;
+    /**
+     * Printed By
+     *
+     * Set only on 'no_embedded_xml': the browser or printer that saved the PDF through a print function, for example 'Firefox', 'Chrome' or 'Microsoft Print to PDF'. Printing drops the embedded invoice XML, so the original file may still be an e-invoice.
+     */
+    printed_by?: string | null;
 };
 /**
  * Flavor
@@ -383,7 +403,7 @@ export type GenerateRequest = {
     /**
      * Invoice Type Code
      *
-     * Invoice type code from UNTDID 1001; '380' is a commercial invoice (BT-3).
+     * Invoice type code from UNTDID 1001 (BT-3): '380' commercial invoice, '326' partial invoice, '381' credit note (syntax 'cii' only), '384' corrected invoice, '389' self-billed invoice, '875'/'876'/'877' partial, partial final and final construction invoice.
      */
     invoice_type_code?: string;
     /**
@@ -401,9 +421,49 @@ export type GenerateRequest = {
     /**
      * Payment Iban
      *
-     * IBAN of the payee account for a bank transfer (BT-84).
+     * IBAN of the payee account for a bank transfer (BT-84). Without it the invoice carries no payment instructions (BG-16). Required for flavor 'xrechnung' (BR-DE-1).
      */
     payment_iban?: string | null;
+    /**
+     * Payment Terms
+     *
+     * Payment terms as free text (BT-20).
+     */
+    payment_terms?: string | null;
+    /**
+     * Notes
+     *
+     * Free-text notes on the invoice as a whole, one entry per note (BT-22).
+     */
+    notes?: Array<string>;
+    /**
+     * Delivery Date
+     *
+     * Actual delivery date, 'YYYY-MM-DD' (BT-72). Defaults to the issue date unless a delivery period is given.
+     */
+    delivery_date?: string | null;
+    /**
+     * Delivery Period Start
+     *
+     * Start of the invoicing period, 'YYYY-MM-DD' (BT-73, BG-14), e.g. the period a service covers.
+     */
+    delivery_period_start?: string | null;
+    /**
+     * Delivery Period End
+     *
+     * End of the invoicing period, 'YYYY-MM-DD' (BT-74, BG-14). Not before the start (BR-29).
+     */
+    delivery_period_end?: string | null;
+    /**
+     * Deliver-to address (BG-15): where the goods go or the service is performed. Needed for VAT category 'K', intra-community supply (BT-80, BR-IC-12).
+     */
+    deliver_to?: PostalAddress | null;
+    /**
+     * Preceding Invoices
+     *
+     * Earlier invoices this invoice refers to (BG-3), e.g. the invoice a corrected invoice (384) replaces. Syntax 'cii' carries at most one.
+     */
+    preceding_invoices?: Array<PrecedingInvoice>;
     seller: Seller;
     buyer: Buyer;
     /**
@@ -620,12 +680,18 @@ export type ParseResponse = {
 /**
  * PostalAddress
  *
- * A postal address (BG-5 seller, BG-8 buyer).
+ * A postal address (BG-5 seller, BG-8 buyer, BG-15 deliver-to).
  *
  * EN 16931 requires only the country. XRechnung also requires city and post
  * code for the seller. invowerk does not check that the address exists.
  */
 export type PostalAddress = {
+    /**
+     * Line One
+     *
+     * Address line 1, usually street and house number (BT-35 seller, BT-50 buyer, BT-75 deliver-to).
+     */
+    line_one?: string | null;
     /**
      * City
      *
@@ -645,6 +711,26 @@ export type PostalAddress = {
      */
     country_code: string;
 };
+/**
+ * PrecedingInvoice
+ *
+ * A reference to an earlier invoice (BG-3), e.g. the invoice a corrected invoice
+ * (384) replaces, or a partial invoice a final invoice (877) settles.
+ */
+export type PrecedingInvoice = {
+    /**
+     * Number
+     *
+     * Number of the earlier invoice (BT-25).
+     */
+    number: string;
+    /**
+     * Issue Date
+     *
+     * Issue date of the earlier invoice, 'YYYY-MM-DD' (BT-26).
+     */
+    issue_date?: string | null;
+};
 /**
  * RateLimitInfo
  *
@@ -844,6 +930,36 @@ export type Seller = {
      * Seller VAT ID, e.g. 'DE123456789' (BT-31). Needed when a line has VAT category 'S' (BR-S-02).
      */
     vat_id?: string | null;
+    /**
+     * Tax Number
+     *
+     * Seller tax registration identifier, e.g. a German Steuernummer '123/456/78901' (BT-32). Written with scheme 'FC'.
+     */
+    tax_number?: string | null;
+    /**
+     * Identifier
+     *
+     * Seller identifier, e.g. a GLN or an ID the buyer knows the seller by (BT-29). An invoice needs BT-29, BT-30 or BT-31 (BR-CO-26).
+     */
+    identifier?: string | null;
+    /**
+     * Identifier Scheme
+     *
+     * Scheme of the seller identifier, an ISO/IEC 6523 ICD code, e.g. '0088' for a GLN (BT-29-1). Leave empty for an identifier without a scheme.
+     */
+    identifier_scheme?: string | null;
+    /**
+     * Legal Registration Id
+     *
+     * Seller legal registration identifier, e.g. a Handelsregisternummer 'HRB 12345' (BT-30). An invoice needs BT-29, BT-30 or BT-31 (BR-CO-26).
+     */
+    legal_registration_id?: string | null;
+    /**
+     * Legal Registration Scheme
+     *
+     * Scheme of the legal registration identifier, an ISO/IEC 6523 ICD code (BT-30-1). Leave empty for an identifier without a scheme.
+     */
+    legal_registration_scheme?: string | null;
     /**
      * Contact Name
      *
@@ -905,6 +1021,18 @@ export type TaxBreakdown = {
      * VAT rate of the category in percent (BT-119).
      */
     rate?: number | string;
+    /**
+     * Exemption Reason
+     *
+     * VAT exemption reason as text (BT-120). The rules require it or its code for categories such as 'E', 'AE', 'K', 'G' (e.g. BR-E-10).
+     */
+    exemption_reason?: string | null;
+    /**
+     * Exemption Reason Code
+     *
+     * VAT exemption reason code from the VATEX code list, e.g. 'VATEX-EU-AE' (BT-121).
+     */
+    exemption_reason_code?: string | null;
 };
 /**
  * ValidationResponse

package/package.json

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