commit aeaca65e39c0c55864ac77dd965fe8035304b4f8
parent b31c23b1247a5d43998483458b08ec8d93944852
Author: Christian Grothoff <christian@grothoff.org>
Date: Sun, 4 Jan 2026 16:20:52 +0100
bump protocol: define v25 feature set
Diffstat:
1 file changed, 17 insertions(+), 17 deletions(-)
diff --git a/core/api-merchant.rst b/core/api-merchant.rst
@@ -29,7 +29,7 @@ Merchant Backend RESTful API
Version History
---------------
-The current protocol version is **v24**.
+The current protocol version is **v25**.
Android PoS app is currently targeting **v20**.
@@ -39,12 +39,12 @@ Android PoS app is currently targeting **v20**.
* ``v22``: Added various defaults
* ``v23``: Added various defaults, fields and some new filters
* ``v24``: Make minor changes to refund semantics
+* ``v25``: adds features to group amounts internally (say to
+ separate tips, taxes and revenue in reporting) and endpoints
+ for periodic report generation
**Upcoming versions:**
-* ``vPOTS``: adds features to group amounts internally (say to
- separate tips, taxes and revenue in reporting)
-* ``vREPORTS``: adds features for periodic report generation
* ``vTAXES``: adds features to manage taxes
**Ideas for future version:**
@@ -239,7 +239,7 @@ such as the implemented version of the protocol and the currency used.
// Maps available report generator configuration section names
// to descriptions of the respective report generator.
- // Since **vREPORTS**.
+ // Since **v25**.
report_generators: { section_name : string};
// Array of exchanges trusted by the merchant.
@@ -2202,13 +2202,13 @@ Getting statistics
the report in various formats. Supported values for ``$NAME`` include:
* "transactions" (total revenue, total refunds, fees
- as well as number of transactions), since **vREPORTS**
- * "money-pots" (changes to totals in money pots), since **vPOTS**
+ as well as number of transactions), since **v25**
+ * "money-pots" (changes to totals in money pots), since **v25**
* "taxes" (amount of taxes withheld by tax class), since **vTAXES**,
* "sales-funnel" (number and volume of orders
created, claimed, paid, refunded and settled), since **vXXX**,
- The overall endpoint family exists since protocol **vREPORTS**.
+ The overall endpoint family exists since protocol **v25**.
**Required permission:** ``statistics-read``
@@ -3205,7 +3205,7 @@ Adding products to the inventory
// Money pot revenue on the product should be accounted in.
// 0 and missing both mean no money pot (revenue accounted
// in money pot of the overall order or not at all).
- // Since **vPOTS**.
+ // Since **v25**.
money_pot_id?: Integer;
}
@@ -3363,7 +3363,7 @@ Adding products to the inventory
// Money pot revenue on the product should be accounted in.
// 0 and missing both mean no money pot (revenue accounted
// in money pot of the overall order or not at all).
- // Since **vPOTS**.
+ // Since **v25**.
money_pot_id?: Integer;
}
@@ -3520,7 +3520,7 @@ Inspecting inventory
// Money pot revenue on the product should be accounted in.
// Missing means no money pot (revenue accounted
// in money pot of the overall order or not at all).
- // Since **vPOTS**.
+ // Since **v25**.
money_pot_id?: Integer;
}
@@ -4172,7 +4172,7 @@ Creating orders
// is not yet assigned to a pot via the ``ProductSold``.
// Not useful to wallets, only for
// merchant-internal accounting.
- // Since protocol **vPOTS**.
+ // Since protocol **v25**.
order_default_money_pot?: Integer;
}
@@ -4304,7 +4304,7 @@ Creating orders
// Money pot to use for this product, overrides value from
// the inventory if given.
- // Since **vPOTS**.
+ // Since **v25**.
product_money_pot?: Integer;
}
@@ -5888,7 +5888,7 @@ Reports are a backend feature that is used to send periodic
reports to the merchant. Reports are sent using notification
helper programs which must be configured for each merchant backend.
-Since protocol **vREPORTS**.
+Since protocol **v25**.
Generating reports
^^^^^^^^^^^^^^^^^^
@@ -6152,7 +6152,7 @@ Pots are a backend feature that is used for accounting. Transacted
amounts can be assigned into pots, for example to separate out
tips and taxes from revenue for reporting.
-Since protocol **vPOTS**.
+Since protocol **v25**.
Adding pots
^^^^^^^^^^^
@@ -6982,7 +6982,7 @@ The contract terms must have the following structure:
// products or taxes. Not useful to wallets, only for
// merchant-internal accounting. If not given, the remaining
// account is simply not accounted for in any money pot.
- // Since **vPOTS**.
+ // Since **v25**.
default_money_pot?: Integer;
}
@@ -7246,7 +7246,7 @@ It has the following structure:
// Money pot to use for this product, overrides value from
// the inventory if given. Not useful to wallets, only for
// merchant-internal accounting.
- // Since **vPOTS**.
+ // Since **v25**.
product_money_pot?: Integer;
}
