u
This commit is contained in:
seb
@@ -79,6 +79,10 @@
|
||||
{
|
||||
"name": "Posterminal",
|
||||
"description": "Company-scoped POS terminals"
|
||||
},
|
||||
{
|
||||
"name": "Ledger",
|
||||
"description": "Append-only ledger transactions"
|
||||
}
|
||||
],
|
||||
"paths": {
|
||||
@@ -2794,6 +2798,347 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"/ledger": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"Ledger"
|
||||
],
|
||||
"summary": "Add ledger entry",
|
||||
"description": "Appends a new entry to the append-only ledger table.\n`hash_version` is fixed to 1. `prev_hash` is cryptographically chained:\nfor the genesis row it defaults to `TODO_TSE_BASED_INITHASH`, and for subsequent rows\nit is the SHA-512 hex hash of the canonical JSON representation of the previous highest-id entry.\nRequires authentication and membership in the company owning the referenced manifest article.\n",
|
||||
"security": [
|
||||
{
|
||||
"cookieAuth": []
|
||||
}
|
||||
],
|
||||
"requestBody": {
|
||||
"required": true,
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/LedgerEntryInput"
|
||||
},
|
||||
"example": {
|
||||
"manifestarticle_id": 1,
|
||||
"transaction_type": "PAYMENT",
|
||||
"amount": 150,
|
||||
"transaction_text": "Payment received for invoice"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"201": {
|
||||
"description": "Ledger entry added successfully",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"ledger": {
|
||||
"$ref": "#/components/schemas/LedgerEntry"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"400": {
|
||||
"description": "Invalid ledger entry or no company selected",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/Error"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"401": {
|
||||
"description": "Unauthorized",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/Error"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"403": {
|
||||
"description": "Not authorized",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/Error"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"404": {
|
||||
"description": "Manifest article or company not found",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/Error"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"get": {
|
||||
"tags": [
|
||||
"Ledger"
|
||||
],
|
||||
"summary": "Query ledger by manifest article ID or SKU",
|
||||
"description": "Alternative query endpoint supporting `?manifestarticle_id=...` or `?sku=...`,\nwith optional `?transaction_type=...`.\n",
|
||||
"security": [
|
||||
{
|
||||
"cookieAuth": []
|
||||
}
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "query",
|
||||
"name": "manifestarticle_id",
|
||||
"schema": {
|
||||
"type": "integer"
|
||||
},
|
||||
"description": "Query entries for this manifest article line ID"
|
||||
},
|
||||
{
|
||||
"in": "query",
|
||||
"name": "sku",
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"description": "Query entries for this article SKU"
|
||||
},
|
||||
{
|
||||
"in": "query",
|
||||
"name": "transaction_type",
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"description": "Optional transaction type filter"
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "List of ledger entries",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"ledger": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/components/schemas/LedgerEntry"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"400": {
|
||||
"description": "Missing required query parameter or no company selected",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/Error"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/ledger/manifestarticle/{manifestarticleId}": {
|
||||
"get": {
|
||||
"tags": [
|
||||
"Ledger"
|
||||
],
|
||||
"summary": "Query ledger by manifest article ID",
|
||||
"description": "Lists ledger entries for a specific manifest article line, optionally filtered by transaction type.",
|
||||
"security": [
|
||||
{
|
||||
"cookieAuth": []
|
||||
}
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
"name": "manifestarticleId",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "integer"
|
||||
},
|
||||
"description": "Manifest article line ID"
|
||||
},
|
||||
{
|
||||
"in": "query",
|
||||
"name": "transaction_type",
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"description": "Optional transaction type filter"
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "List of ledger entries",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"ledger": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/components/schemas/LedgerEntry"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"400": {
|
||||
"description": "Invalid manifest article id or no company selected",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/Error"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"401": {
|
||||
"description": "Unauthorized",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/Error"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"403": {
|
||||
"description": "Not authorized",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/Error"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"404": {
|
||||
"description": "Manifest article or company not found",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/Error"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/ledger/sku/{sku}": {
|
||||
"get": {
|
||||
"tags": [
|
||||
"Ledger"
|
||||
],
|
||||
"summary": "Query ledger by article SKU",
|
||||
"description": "Lists ledger entries for an article SKU (joined from manifestarticle), optionally filtered by transaction type.",
|
||||
"security": [
|
||||
{
|
||||
"cookieAuth": []
|
||||
}
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
"name": "sku",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"description": "Article SKU"
|
||||
},
|
||||
{
|
||||
"in": "query",
|
||||
"name": "transaction_type",
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"description": "Optional transaction type filter"
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "List of ledger entries",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"ledger": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/components/schemas/LedgerEntry"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"400": {
|
||||
"description": "Invalid SKU or no company selected",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/Error"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"401": {
|
||||
"description": "Unauthorized",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/Error"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"403": {
|
||||
"description": "Not authorized",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/Error"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"404": {
|
||||
"description": "Company not found",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/Error"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/health": {
|
||||
"get": {
|
||||
"tags": [
|
||||
@@ -2848,7 +3193,7 @@
|
||||
"Events"
|
||||
],
|
||||
"summary": "Subscribe to update signals (SSE)",
|
||||
"description": "Opens a Server-Sent Events stream for the authenticated user's\n**selected company**. Clients receive named signals when another\nrequest successfully mutates shared data for that company\n(including the same browser's other tabs).\n\nUse `EventSource` with credentials so the session cookie is sent:\n\n```js\nconst es = new EventSource('https://…/api/events', { withCredentials: true });\nes.addEventListener('category', () => { refetchCategoryTree(); });\nes.addEventListener('articles', () => { refetchArticleIndex(); });\nes.addEventListener('article-42000045', () => { refetchArticle('42000045'); });\n```\n\nKeep-alive comments (`: keepalive`) are sent roughly every 25s.\nReconnect after changing the selected company (the stream is bound\nto the company at connect time).\n\n## Signals\n\n| Signal | Emitted after successful |\n|--------|--------------------------|\n| `category` | `POST /category`, `PATCH /category/{id}`, `PUT /category/order`, `DELETE /category/{id}`, `POST /category/{id}/image`, `DELETE /category/{id}/image` |\n| `articles` | `POST /article`, `PATCH /article/{sku}`, `DELETE /article/{sku}` |\n| `article-<sku>` | `PUT /article/{sku}/weight`, `PUT /article/{sku}/prices`, `PUT /article/{sku}/eans`, `PUT /article/{sku}/categories`, `PUT /article/{sku}/brand`, `PUT /article/{sku}/images/order`, `POST /article/{sku}/image`, `DELETE /article/{sku}/image/{fullHash}` |\n\nSignals are only sent when the mutation actually succeeds (2xx).\nFailed or no-op validation errors do not emit. The `article-<sku>`\nevent name uses the concrete SKU (e.g. `article-42000045`).\n",
|
||||
"description": "Opens a Server-Sent Events stream for the authenticated user's\n**selected company**. Clients receive named signals when another\nrequest successfully mutates shared data for that company\n(including the same browser's other tabs).\n\nUse `EventSource` with credentials so the session cookie is sent:\n\n```js\nconst es = new EventSource('https://…/api/events', { withCredentials: true });\nes.addEventListener('category', () => { refetchCategoryTree(); });\nes.addEventListener('articles', () => { refetchArticleIndex(); });\nes.addEventListener('article-42000045', () => { refetchArticle('42000045'); });\n```\n\nKeep-alive comments (`: heartbeat`) are sent roughly every 20s.\nReconnect after changing the selected company (the stream is bound\nto the company at connect time).\n\n## Signals\n\n| Signal | Emitted after successful |\n|--------|--------------------------|\n| `category` | `POST /category`, `PATCH /category/{id}`, `PUT /category/order`, `DELETE /category/{id}`, `POST /category/{id}/image`, `DELETE /category/{id}/image` |\n| `articles` | `POST /article`, `PATCH /article/{sku}`, `DELETE /article/{sku}` |\n| `article-<sku>` | `PUT /article/{sku}/weight`, `PUT /article/{sku}/prices`, `PUT /article/{sku}/eans`, `PUT /article/{sku}/categories`, `PUT /article/{sku}/brand`, `PUT /article/{sku}/images/order`, `POST /article/{sku}/image`, `DELETE /article/{sku}/image/{fullHash}` |\n\nSignals are only sent when the mutation actually succeeds (2xx).\nFailed or no-op validation errors do not emit. The `article-<sku>`\nevent name uses the concrete SKU (e.g. `article-42000045`).\n",
|
||||
"security": [
|
||||
{
|
||||
"cookieAuth": []
|
||||
@@ -10613,6 +10958,83 @@
|
||||
"description": "Base64 thumbhash of thumb preview"
|
||||
}
|
||||
}
|
||||
},
|
||||
"LedgerEntry": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"id",
|
||||
"manifestarticle_id",
|
||||
"transaction_type",
|
||||
"amount",
|
||||
"transaction_text",
|
||||
"hash_version"
|
||||
],
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "integer"
|
||||
},
|
||||
"manifestarticle_id": {
|
||||
"type": "integer",
|
||||
"description": "References manifestarticle.id"
|
||||
},
|
||||
"transaction_type": {
|
||||
"type": "string",
|
||||
"description": "Transaction identifier / type"
|
||||
},
|
||||
"amount": {
|
||||
"type": "number",
|
||||
"description": "Movement amount"
|
||||
},
|
||||
"transaction_text": {
|
||||
"type": "string",
|
||||
"description": "Transaction memo / details"
|
||||
},
|
||||
"hash_version": {
|
||||
"type": "integer",
|
||||
"description": "Algorithm version (1)"
|
||||
},
|
||||
"prev_hash": {
|
||||
"type": "string",
|
||||
"description": "Previous entry SHA-512 hex or initial seed hash"
|
||||
},
|
||||
"sku": {
|
||||
"type": "string",
|
||||
"nullable": true,
|
||||
"description": "SKU from referenced manifestarticle (present in query views)"
|
||||
},
|
||||
"created_at": {
|
||||
"type": "string",
|
||||
"format": "date-time",
|
||||
"description": "Timestamp when the row was created"
|
||||
}
|
||||
}
|
||||
},
|
||||
"LedgerEntryInput": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"manifestarticle_id",
|
||||
"transaction_type",
|
||||
"amount",
|
||||
"transaction_text"
|
||||
],
|
||||
"properties": {
|
||||
"manifestarticle_id": {
|
||||
"type": "integer",
|
||||
"description": "References manifestarticle.id"
|
||||
},
|
||||
"transaction_type": {
|
||||
"type": "string",
|
||||
"description": "Transaction identifier / type (max 100 chars)"
|
||||
},
|
||||
"amount": {
|
||||
"type": "number",
|
||||
"description": "Movement amount"
|
||||
},
|
||||
"transaction_text": {
|
||||
"type": "string",
|
||||
"description": "Transaction memo / details"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user