@kreiseck/kasseneck-api 0.14.0 → 0.16.0

package/fixtures/rechnung-api.schema.json

@@ -0,0 +1,681 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Kasseneck Rechnungs-API",
+  "version": 1,
+  "paket": "0.16.0",
+  "aufrufe": {
+    "createCustomer": {
+      "anfrage": {
+        "type": "object",
+        "properties": {
+          "customer": {
+            "type": "object",
+            "properties": {
+              "type": {
+                "enum": [
+                  "private",
+                  "company"
+                ]
+              },
+              "name": {
+                "type": "string",
+                "minLength": 1,
+                "maxLength": 200
+              },
+              "legalForm": {
+                "type": "string",
+                "maxLength": 40
+              },
+              "email": {
+                "type": "string",
+                "maxLength": 254,
+                "format": "email"
+              },
+              "phone": {
+                "type": "string",
+                "maxLength": 40,
+                "format": "phone"
+              },
+              "street": {
+                "type": "string",
+                "maxLength": 200
+              },
+              "houseNumber": {
+                "type": "string",
+                "maxLength": 20
+              },
+              "zip": {
+                "type": "string",
+                "maxLength": 10
+              },
+              "city": {
+                "type": "string",
+                "maxLength": 100
+              },
+              "country": {
+                "type": "string",
+                "minLength": 2,
+                "maxLength": 2,
+                "format": "country"
+              },
+              "vatId": {
+                "type": "string",
+                "maxLength": 20,
+                "format": "vatId"
+              },
+              "shortCode": {
+                "type": "string",
+                "maxLength": 8,
+                "format": "shortCode"
+              },
+              "isAuthority": {
+                "type": "boolean"
+              },
+              "note": {
+                "type": "string",
+                "maxLength": 1000
+              },
+              "externalId": {
+                "type": "string",
+                "minLength": 1,
+                "maxLength": 120
+              }
+            },
+            "required": [
+              "type",
+              "name",
+              "country"
+            ],
+            "additionalProperties": false
+          },
+          "idempotencyKey": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 120
+          }
+        },
+        "required": [
+          "customer"
+        ],
+        "additionalProperties": false
+      }
+    },
+    "getCustomer": {
+      "anfrage": {
+        "type": "object",
+        "properties": {
+          "customerId": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 128
+          },
+          "externalId": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 120
+          }
+        },
+        "additionalProperties": false
+      },
+      "genauEins": [
+        [
+          "customerId",
+          "externalId"
+        ]
+      ]
+    },
+    "updateCustomer": {
+      "anfrage": {
+        "type": "object",
+        "properties": {
+          "customerId": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 128
+          },
+          "customer": {
+            "type": "object",
+            "properties": {
+              "type": {
+                "enum": [
+                  "private",
+                  "company"
+                ]
+              },
+              "name": {
+                "type": "string",
+                "minLength": 1,
+                "maxLength": 200
+              },
+              "legalForm": {
+                "type": "string",
+                "maxLength": 40
+              },
+              "email": {
+                "type": "string",
+                "maxLength": 254,
+                "format": "email"
+              },
+              "phone": {
+                "type": "string",
+                "maxLength": 40,
+                "format": "phone"
+              },
+              "street": {
+                "type": "string",
+                "maxLength": 200
+              },
+              "houseNumber": {
+                "type": "string",
+                "maxLength": 20
+              },
+              "zip": {
+                "type": "string",
+                "maxLength": 10
+              },
+              "city": {
+                "type": "string",
+                "maxLength": 100
+              },
+              "country": {
+                "type": "string",
+                "minLength": 2,
+                "maxLength": 2,
+                "format": "country"
+              },
+              "vatId": {
+                "type": "string",
+                "maxLength": 20,
+                "format": "vatId"
+              },
+              "shortCode": {
+                "type": "string",
+                "maxLength": 8,
+                "format": "shortCode"
+              },
+              "isAuthority": {
+                "type": "boolean"
+              },
+              "note": {
+                "type": "string",
+                "maxLength": 1000
+              },
+              "externalId": {
+                "type": "string",
+                "minLength": 1,
+                "maxLength": 120
+              }
+            },
+            "additionalProperties": false
+          }
+        },
+        "required": [
+          "customerId",
+          "customer"
+        ],
+        "additionalProperties": false
+      }
+    },
+    "searchCustomers": {
+      "anfrage": {
+        "type": "object",
+        "properties": {
+          "externalId": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 120
+          },
+          "vatId": {
+            "type": "string",
+            "maxLength": 20
+          },
+          "email": {
+            "type": "string",
+            "maxLength": 254
+          },
+          "name": {
+            "type": "string",
+            "maxLength": 200
+          },
+          "limit": {
+            "type": "integer",
+            "minimum": 1,
+            "maximum": 100
+          },
+          "cursor": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 500
+          }
+        },
+        "additionalProperties": false
+      },
+      "mindestensEins": [
+        [
+          "externalId",
+          "vatId",
+          "email",
+          "name"
+        ]
+      ]
+    },
+    "issueInvoice": {
+      "anfrage": {
+        "type": "object",
+        "properties": {
+          "idempotencyKey": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 120
+          },
+          "customerId": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 128
+          },
+          "taxScheme": {
+            "enum": [
+              "normal",
+              "smallBusiness",
+              "reverseCharge",
+              "igLieferung",
+              "exportThirdCountry"
+            ]
+          },
+          "priceMode": {
+            "enum": [
+              "net",
+              "gross"
+            ]
+          },
+          "serviceStart": {
+            "type": "string",
+            "minLength": 10,
+            "maxLength": 10,
+            "format": "date"
+          },
+          "serviceEnd": {
+            "type": "string",
+            "minLength": 10,
+            "maxLength": 10,
+            "format": "date"
+          },
+          "paymentTermDays": {
+            "type": "integer",
+            "minimum": 0,
+            "maximum": 365
+          },
+          "orderReference": {
+            "type": "string",
+            "maxLength": 200
+          },
+          "intro": {
+            "type": "string",
+            "maxLength": 2000
+          },
+          "note": {
+            "type": "string",
+            "maxLength": 2000
+          },
+          "paymentReference": {
+            "type": "string",
+            "maxLength": 140
+          },
+          "girocode": {
+            "type": "boolean"
+          },
+          "tracking": {
+            "type": "boolean"
+          },
+          "items": {
+            "type": "array",
+            "minItems": 1,
+            "maxItems": 500,
+            "items": {
+              "type": "object",
+              "properties": {
+                "description": {
+                  "type": "string",
+                  "minLength": 1,
+                  "maxLength": 300
+                },
+                "subtitle": {
+                  "type": "string",
+                  "maxLength": 1000
+                },
+                "quantity": {
+                  "type": "number",
+                  "exclusiveMinimum": 0,
+                  "maximum": 1000000,
+                  "x-decimals": 3
+                },
+                "unit": {
+                  "type": "string",
+                  "maxLength": 20
+                },
+                "unitPriceCents": {
+                  "type": "integer",
+                  "minimum": 0,
+                  "maximum": 100000000
+                },
+                "vatRate": {
+                  "enum": [
+                    0,
+                    10,
+                    13,
+                    20
+                  ]
+                },
+                "discountPct": {
+                  "type": "number",
+                  "minimum": 0,
+                  "maximum": 100,
+                  "x-decimals": 2
+                }
+              },
+              "required": [
+                "description",
+                "quantity",
+                "unitPriceCents",
+                "vatRate"
+              ],
+              "additionalProperties": false
+            }
+          },
+          "metadata": {
+            "type": "object",
+            "maxProperties": 20,
+            "propertyNames": {
+              "pattern": "^[a-zA-Z0-9_]{1,40}$"
+            },
+            "additionalProperties": {
+              "type": "string",
+              "maxLength": 500
+            }
+          }
+        },
+        "required": [
+          "idempotencyKey",
+          "taxScheme",
+          "priceMode",
+          "serviceStart",
+          "items"
+        ],
+        "additionalProperties": false
+      }
+    },
+    "cancelInvoice": {
+      "anfrage": {
+        "type": "object",
+        "properties": {
+          "idempotencyKey": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 120
+          },
+          "invoiceId": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 128
+          },
+          "reason": {
+            "enum": [
+              "cancellation",
+              "price_reduction",
+              "return",
+              "incorrect_invoice",
+              "other"
+            ]
+          },
+          "note": {
+            "type": "string",
+            "maxLength": 2000
+          }
+        },
+        "required": [
+          "idempotencyKey",
+          "invoiceId",
+          "reason"
+        ],
+        "additionalProperties": false
+      }
+    },
+    "createCreditNote": {
+      "anfrage": {
+        "type": "object",
+        "properties": {
+          "idempotencyKey": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 120
+          },
+          "invoiceId": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 128
+          },
+          "reason": {
+            "enum": [
+              "cancellation",
+              "price_reduction",
+              "return",
+              "incorrect_invoice",
+              "other"
+            ]
+          },
+          "note": {
+            "type": "string",
+            "maxLength": 2000
+          },
+          "items": {
+            "type": "array",
+            "minItems": 1,
+            "maxItems": 500,
+            "items": {
+              "type": "object",
+              "properties": {
+                "description": {
+                  "type": "string",
+                  "minLength": 1,
+                  "maxLength": 300
+                },
+                "subtitle": {
+                  "type": "string",
+                  "maxLength": 1000
+                },
+                "quantity": {
+                  "type": "number",
+                  "exclusiveMinimum": 0,
+                  "maximum": 1000000,
+                  "x-decimals": 3
+                },
+                "unit": {
+                  "type": "string",
+                  "maxLength": 20
+                },
+                "unitPriceCents": {
+                  "type": "integer",
+                  "minimum": 0,
+                  "maximum": 100000000
+                },
+                "vatRate": {
+                  "enum": [
+                    0,
+                    10,
+                    13,
+                    20
+                  ]
+                },
+                "discountPct": {
+                  "type": "number",
+                  "minimum": 0,
+                  "maximum": 100,
+                  "x-decimals": 2
+                }
+              },
+              "required": [
+                "description",
+                "quantity",
+                "unitPriceCents",
+                "vatRate"
+              ],
+              "additionalProperties": false
+            }
+          }
+        },
+        "required": [
+          "idempotencyKey",
+          "invoiceId",
+          "reason",
+          "items"
+        ],
+        "additionalProperties": false
+      }
+    },
+    "getInvoice": {
+      "anfrage": {
+        "type": "object",
+        "properties": {
+          "invoiceId": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 128
+          },
+          "number": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 100
+          }
+        },
+        "additionalProperties": false
+      },
+      "genauEins": [
+        [
+          "invoiceId",
+          "number"
+        ]
+      ]
+    },
+    "listInvoices": {
+      "anfrage": {
+        "type": "object",
+        "properties": {
+          "from": {
+            "type": "string",
+            "minLength": 10,
+            "maxLength": 10,
+            "format": "date"
+          },
+          "to": {
+            "type": "string",
+            "minLength": 10,
+            "maxLength": 10,
+            "format": "date"
+          },
+          "status": {
+            "enum": [
+              "final",
+              "paid",
+              "cancelled",
+              "open",
+              "overdue"
+            ]
+          },
+          "docType": {
+            "enum": [
+              "RE",
+              "GU"
+            ]
+          },
+          "customerId": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 128
+          },
+          "limit": {
+            "type": "integer",
+            "minimum": 1,
+            "maximum": 100
+          },
+          "cursor": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 500
+          }
+        },
+        "additionalProperties": false
+      }
+    },
+    "getInvoicePdf": {
+      "anfrage": {
+        "type": "object",
+        "properties": {
+          "invoiceId": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 128
+          }
+        },
+        "required": [
+          "invoiceId"
+        ],
+        "additionalProperties": false
+      }
+    },
+    "getInvoiceXml": {
+      "anfrage": {
+        "type": "object",
+        "properties": {
+          "invoiceId": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 128
+          },
+          "format": {
+            "enum": [
+              "ubl",
+              "cii"
+            ]
+          }
+        },
+        "required": [
+          "invoiceId"
+        ],
+        "additionalProperties": false
+      }
+    },
+    "getInvoiceSetupStatus": {
+      "anfrage": {
+        "type": "object",
+        "properties": {},
+        "additionalProperties": false
+      }
+    }
+  },
+  "codes": [
+    "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"
+  ],
+  "gruende": [
+    "cancellation",
+    "price_reduction",
+    "return",
+    "incorrect_invoice",
+    "other"
+  ]
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kreiseck/kasseneck-api",
-  "version": "0.14.0",
+  "version": "0.16.0",
   "description": "RKSV-Registrierkasse fuer JavaScript und TypeScript: signierte Belege, Storno, Kartenzahlung, Bondruck. Austrian fiscal cash register (RKSV) API client.",
   "license": "Apache-2.0",
   "author": "Kreiseck",
@@ -119,6 +119,16 @@
         "default": "./dist/cjs/partner/index.js"
       }
     },
+    "./rechnung": {
+      "import": {
+        "types": "./dist/esm/rechnung/index.d.ts",
+        "default": "./dist/esm/rechnung/index.js"
+      },
+      "require": {
+        "types": "./dist/cjs/rechnung/index.d.ts",
+        "default": "./dist/cjs/rechnung/index.js"
+      }
+    },
     "./fixtures/*": "./fixtures/*"
   },
   "files": [
@@ -144,6 +154,7 @@
     "fixtures:erneuern": "npm run build && node scripts/belege-fixtures.mjs",
     "fixtures:kasse": "npm run build && node scripts/kasse-settings-fixture.mjs",
     "fixtures:oberflaeche": "npm run build && node scripts/oberflaeche.mjs",
+    "fixtures:rechnung": "npm run build && node scripts/rechnung-vertrag.mjs",
     "fixtures:hobex-hps-codes": "npm run build && node scripts/hobex-hps-codes.mjs",
     "fixtures:texte": "npm run build && node scripts/texte.mjs"
   },