From aba97791613622497c1a6d94b4dea185b99b3440 Mon Sep 17 00:00:00 2001 From: seb Date: Sat, 1 Aug 2026 06:00:15 +0200 Subject: [PATCH] Update API documentation for POS price replacement to clarify pricing as gross and adjust example values. --- docs/api/openapi.json | 10 +++++----- docs/api/routes/article/set-prices.md | 8 ++++---- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/api/openapi.json b/docs/api/openapi.json index 9bacb6f..0a50bca 100644 --- a/docs/api/openapi.json +++ b/docs/api/openapi.json @@ -1283,7 +1283,7 @@ "Article" ], "summary": "Replace POS prices by SKU", - "description": "Replace-all prices for the company POS customer group.\nEach entry: `price` (net), `tax` (rate, ensured via tax.ensure), optional `minmultiplier` (default 1).\nEmpty `prices` clears all POS prices. Returns the same shape as GET by SKU.\n", + "description": "Replace-all prices for the company POS customer group.\nEach entry: `price` (gross), `tax` (rate %, ensured via tax.ensure), optional `minmultiplier` (default 1).\nStored as net = gross / (1 + tax/100). Empty `prices` clears all POS prices. Returns the same shape as GET by SKU.\n", "security": [ { "cookieAuth": [] @@ -1321,11 +1321,11 @@ "properties": { "price": { "type": "number", - "description": "Net price" + "description": "Gross price (Brutto)" }, "tax": { "type": "number", - "description": "Tax rate (e.g. 19)" + "description": "Tax rate percent (e.g. 19)" }, "minmultiplier": { "type": "number", @@ -1338,11 +1338,11 @@ "example": { "prices": [ { - "price": 10.5, + "price": 11.9, "tax": 19 }, { - "price": 9.9, + "price": 99, "tax": 19, "minmultiplier": 10 } diff --git a/docs/api/routes/article/set-prices.md b/docs/api/routes/article/set-prices.md index f10249b..fe34cb4 100644 --- a/docs/api/routes/article/set-prices.md +++ b/docs/api/routes/article/set-prices.md @@ -5,8 +5,8 @@ Protected. Requires a valid session cookie (`credentials: 'include'`). Replace POS prices by SKU Replace-all prices for the company POS customer group. -Each entry: `price` (net), `tax` (rate, ensured via tax.ensure), optional `minmultiplier` (default 1). -Empty `prices` clears all POS prices. Returns the same shape as GET by SKU. +Each entry: `price` (gross), `tax` (rate %, ensured via tax.ensure), optional `minmultiplier` (default 1). +Stored as net = gross / (1 + tax/100). Empty `prices` clears all POS prices. Returns the same shape as GET by SKU. ## Path parameters @@ -21,11 +21,11 @@ Empty `prices` clears all POS prices. Returns the same shape as GET by SKU. { "prices": [ { - "price": 10.5, + "price": 11.9, "tax": 19 }, { - "price": 9.9, + "price": 99, "tax": 19, "minmultiplier": 10 }