@tillhub/schemas 6.235.0 → 6.236.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [6.236.0](https://github.com/tillhub/schemas/compare/v6.235.0...v6.236.0) (2023-07-25)
+
+
+### Features
+
+* **settings:** Add fiscalization configuration ([#831](https://github.com/tillhub/schemas/issues/831)) ([6fc4795](https://github.com/tillhub/schemas/commit/6fc4795))
+
 # [6.235.0](https://github.com/tillhub/schemas/compare/v6.234.0...v6.235.0) (2023-07-20)
 
 

package/lib/v1/configurations/items/settings.js

@@ -717,7 +717,30 @@ module.exports = {
             'voucher_systems' // new system with a single product per system and all nested prefixes and actions
           ],
           default: 'configurations' // starting from legacy
-        }
+        },
+        fiscally: oneOf({
+          type: 'object',
+          properties: {
+            austria: oneOf({
+              type: 'object',
+              additionalProperties: false,
+              properties: {
+                tid: oneOf({
+                  description: 'The "Teilnehmer-Identifikation" part of the FinanzOnline Cash Register Web Service User ("Registrierkassen-Webservice-Benutzer") credential triplet to be provided by the taxpayer',
+                  type: 'string'
+                }),
+                benid: oneOf({
+                  description: 'The "Benutzer-Identifikation" part of the FinanzOnline Cash Register Web Service User ("Registrierkassen-Webservice-Benutzer") credential triplet to be provided by the taxpayer.',
+                  type: 'string'
+                }),
+                pin: oneOf({
+                  description: 'The "PIN" part of the FinanzOnline Cash Register Web Service User ("Registrierkassen-Webservice-Benutzer") credential triplet to be provided by the taxpayer.',
+                  type: 'string'
+                })
+              }
+            })
+          }
+        })
       }
     }
   ]

package/lib/v1/transactions/legacy/base.js

@@ -695,14 +695,14 @@ module.exports = {
             properties: {
               bonus_points: oneOf({
                 type: 'integer',
-                description: 'Bonus Points to be booked - Free Points preferred, use 0 here.',
+                description: 'Bonus Points to be booked - Free Points preferred, use NULL here untill specified otherwise (2023-07).',
                 minimum: -12000,
                 maximum: 12000,
-                default: 0
+                default: null
               }),
               free_points: {
                 type: 'integer',
-                description: 'Free Points - preferrably used over Bonus Points.',
+                description: 'Free Points - preferrably used over Bonus Points. (Current points x campaign multiplier) - refund points',
                 minimum: -12000,
                 maximum: 12000,
                 default: 0
@@ -711,34 +711,38 @@ module.exports = {
                 type: 'string',
                 format: 'date-time',
                 example: '2018-01-29T14:55:05.000Z',
-                description: 'Date of the purchase'
+                description: 'Date of the purchase = transaction date'
               },
               timestamp_end: {
                 type: 'string',
                 format: 'date-time',
                 example: '2018-01-29T14:55:05.000Z',
-                description: 'Date of the purchase'
+                description: 'Date of the purchase = transaction date'
               },
               total_items: {
                 type: 'integer',
-                description: 'Number of cart items in the transaction.',
+                description: 'Number of cart items in the transaction that are not campaign products or vouchers.',
                 minimum: 0,
                 maximum: 99
               },
               employee_flag: {
                 type: 'boolean',
-                description: 'Marks a Coop employee, not yet relevant.',
+                description: 'Marks a Coop employee, not yet relevantm, send \'false\'.',
                 default: false
               },
               total_amount: {
                 type: 'integer',
-                description: 'Total value of the sale in Swiss Rappen including all purchased items.',
+                description: 'Total value of the sale in Swiss Rappen including ALL cart items, including refunds, excluding tips.',
                 minimum: -2400000,
                 maximum: 2400000
               },
               point_base_amount: {
                 type: 'integer',
-                description: 'Total value of the salethat qualifies for superpoints (certain items excluded).',
+                description: stripIndents`
+                'Total value of the sale that qualifies for superpoints (campaign items and vouchers excluded)
+
+                as long as net items are not supported this is identical to \'total_amount\'.
+                `,
                 minimum: -2400000,
                 maximum: 2400000
               },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tillhub/schemas",
-  "version": "6.235.0",
+  "version": "6.236.0",
   "private": false,
   "description": "All Tillhub API OpenAPI 3 compatible JSON Schemas.",
   "main": "./lib/index.js",