Update API documentation for POS price replacement to clarify pricing as gross and adjust example values.

This commit is contained in:
seb
2026-08-01 06:00:15 +02:00
parent 8a94abf1c9
commit aba9779161
2 changed files with 9 additions and 9 deletions

View File

@@ -1283,7 +1283,7 @@
"Article" "Article"
], ],
"summary": "Replace POS prices by SKU", "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": [ "security": [
{ {
"cookieAuth": [] "cookieAuth": []
@@ -1321,11 +1321,11 @@
"properties": { "properties": {
"price": { "price": {
"type": "number", "type": "number",
"description": "Net price" "description": "Gross price (Brutto)"
}, },
"tax": { "tax": {
"type": "number", "type": "number",
"description": "Tax rate (e.g. 19)" "description": "Tax rate percent (e.g. 19)"
}, },
"minmultiplier": { "minmultiplier": {
"type": "number", "type": "number",
@@ -1338,11 +1338,11 @@
"example": { "example": {
"prices": [ "prices": [
{ {
"price": 10.5, "price": 11.9,
"tax": 19 "tax": 19
}, },
{ {
"price": 9.9, "price": 99,
"tax": 19, "tax": 19,
"minmultiplier": 10 "minmultiplier": 10
} }

View File

@@ -5,8 +5,8 @@ Protected. Requires a valid session cookie (`credentials: 'include'`).
Replace POS prices by SKU Replace POS prices by SKU
Replace-all prices for the company POS customer group. Replace-all prices for the company POS customer group.
Each entry: `price` (net), `tax` (rate, ensured via tax.ensure), optional `minmultiplier` (default 1). Each entry: `price` (gross), `tax` (rate %, ensured via tax.ensure), optional `minmultiplier` (default 1).
Empty `prices` clears all POS prices. Returns the same shape as GET by SKU. Stored as net = gross / (1 + tax/100). Empty `prices` clears all POS prices. Returns the same shape as GET by SKU.
## Path parameters ## Path parameters
@@ -21,11 +21,11 @@ Empty `prices` clears all POS prices. Returns the same shape as GET by SKU.
{ {
"prices": [ "prices": [
{ {
"price": 10.5, "price": 11.9,
"tax": 19 "tax": 19
}, },
{ {
"price": 9.9, "price": 99,
"tax": 19, "tax": 19,
"minmultiplier": 10 "minmultiplier": 10
} }