@tillhub/schemas 6.268.0 → 6.269.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [6.269.0](https://github.com/tillhub/schemas/compare/v6.268.0...v6.269.0) (2023-10-24)
+
+
+### Features
+
+* **fiscalization:** Update schema with new configuration ([3a06905](https://github.com/tillhub/schemas/commit/3a06905))
+
 # [6.268.0](https://github.com/tillhub/schemas/compare/v6.267.0...v6.268.0) (2023-10-20)
 
 

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

@@ -133,7 +133,7 @@ module.exports = {
     ...oneOf({
       type: 'integer',
       example: 50000,
-      description: 'The amount of cash when the register was opened (e.g. 50.00€)'
+      description: 'The amount of cash when the register was opened (e.g. 50.00€) - before any adjustments -> thus must be equal to the previoius closing amount.'
     })
   },
   cash_revenue: {
@@ -169,14 +169,14 @@ module.exports = {
     ...oneOf({
       type: 'integer',
       example: 281000,
-      description: 'The calulated (should be) cash amount when closing the register, POS: cash_begin + cash_revenue + expenses_cash_total + tips_cash'
+      description: 'The calulated (expected) cash amount when closing the register, POS: cash_begin + cash_revenue + expenses_cash_total + tips_cash'
     })
   },
   cash_total_counted: {
     ...oneOf({
       type: 'integer',
       example: 280000,
-      description: 'The (is) cash amount - counted by a cashier - when closing the register, POS: user input'
+      description: 'The (actual) cash amount - counted by a cashier - when closing the register, POS: user input'
     })
   },
   cash_discrepancy: {

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

@@ -43,6 +43,7 @@ module.exports = {
           enum: [
             'fiskaltrust',
             'tse_fiskaly',
+            'at_fiskaly',
             'tse_epson',
             'fr_NF525',
             'it_epson'

package/lib/v1/registers/base.js

@@ -217,6 +217,7 @@ module.exports = {
               enum: [
                 'fiskaltrust',
                 'tse_fiskaly',
+                'at_fiskaly',
                 'tse_epson',
                 'fr_NF525',
                 'it_epson'

package/lib/v1/statuses/base.js

@@ -36,6 +36,7 @@ module.exports = {
     enum: [
       'fiskaltrust',
       'tse_fiskaly',
+      'at_fiskaly',
       'tse_epson',
       'fr_NF525'
     ],

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

@@ -21,7 +21,7 @@ module.exports = {
     ...oneOf({
       type: 'integer',
       example: 2000,
-      description: 'The given amount via this payment, 20.00 EUR or 2000 HUF respectively (represented as integer)'
+      description: 'The given amount via this payment, 20.00 EUR or 2000 HUF respectively (represented as integer) - tips are included, change money is not subtracted'
     })
   },
   currency_iso_code: {
@@ -103,7 +103,7 @@ module.exports = {
     ...oneOf({
       type: 'integer',
       example: 110,
-      description: 'The given tip via this payment, 1.10 EUR or 110 HUF respectively (represented as integer)'
+      description: 'The given tip via this payment, 1.10 EUR or 110 HUF respectively (represented as integer) - this is included in \'amount\''
     })
   },
   terminal_journal: {
@@ -260,10 +260,11 @@ module.exports = {
   }),
   _amount_total: oneOf({
     description: stripIndents`
-    The payed amount total. Excluding any change.
+    Manifesting Legacy: The given amount via this payment, 20.00 EUR or 20.00 HUF respectively (represented as Decimal) - tips are included, change money is not subtracted'
 
-    NOTE: usually cash payments will be grouped. Also, a cash payment will always carry any possible change money. Even though
-    a card payment might have caused it.
+    NOTE: The intention to use this without tip and change can not be realized as of 2023.
+
+    2023: Equal to \'_amount_given\' and \'_amount_requested\'.
 
     `,
     type: 'number',
@@ -284,6 +285,9 @@ module.exports = {
     be payed e.g. 49.98, but the customer has given 50,00. This
     is usually of interest in cash payments, or when when customers
     gave fewer amount than they ought to pay.
+
+    2023: Equal to \'_amount_total\' and \'_amount_requested\'.
+
     `,
     example: '50.00',
     type: 'number',
@@ -293,12 +297,12 @@ module.exports = {
   }),
   _amount_requested: oneOf({
     description: stripIndents`
-    The amount that was requested
-    by the POS e.g. 49.98, regardless
-    of what was given e.g. 50.00. Hence the rest is change or tip.
-    This is usually of interest in cash payments.
+    The amount that was requested to e.g. a card payment terminal - thus it includes the proposed tip amount.
+    See NOTE!
+
+    NOTE: The intention to use this without tip and change can not be realized as of 2023.
 
-    NOTE: this can be used in analytics to rebuild payment flows
+    2023: Equal to \'_amount_total\' and \'_amount_given\'.
     `,
     example: '49.98',
     type: 'number',
@@ -307,11 +311,11 @@ module.exports = {
     multipleOf: 0.01
   }),
   _amount_change: oneOf({
-    description: stripIndents`The cash amount that was handed back from the
-     cashier as change.
+    description: stripIndents` .
 
-     NOTE: that card payments can never have change, but need to cause a cash payment.
+     NOTE: usually NULL - as change is tx top level an should currently not be attributed to a single payment (of potentially many).
 
+     2023: Change can be set on a payment ONLY if top level change is agreed to be 0 .
      `,
     example: '49.98',
     type: 'number',

package/lib/v1/transactions/legacy/payments/response.js

@@ -41,6 +41,16 @@ module.exports = {
         type: 'number'
       })
     },
+    change: oneOf({
+      type: 'integer',
+      example: 800,
+      description: 'The change amount calculated by the API based on tx-top-level change value and attribution to one of the payments'
+    }),
+    amount_final: oneOf({
+      type: 'integer',
+      example: 1200,
+      description: 'The effectively payed amount calculated by the API, \'amount_final\' = \'amount\' - \'change\''
+    }),
     ...base
   }
 }

package/package.json

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