{ "openapi": "3.1.0", "info": { "title": "Bexio Access Gateway", "version": "1.0.0", "description": "Independent Bexio permission gateway. Deny by default. No deletion or lifecycle transitions. This is not a Bexio AG product." }, "servers": [ { "url": "/" } ], "components": { "securitySchemes": { "GatewayKey": { "type": "http", "scheme": "bearer", "bearerFormat": "bxg_\u2026" } } }, "paths": { "/bexio/2.0/kb_order": { "get": { "operationId": "get_kb_order", "summary": "orders.read", "security": [ { "GatewayKey": [] } ], "x-required-scope": "orders.read", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer" } }, { "name": "offset", "in": "query", "schema": { "type": "integer" } }, { "name": "order_by", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Bexio JSON response" }, "201": { "description": "Created" }, "400": { "description": "Invalid or disallowed payload" }, "401": { "description": "Invalid, expired or revoked key" }, "403": { "description": "Denied by gateway policy" }, "404": { "description": "Not accessible" }, "409": { "description": "Idempotency conflict or unconfirmed write" }, "429": { "description": "Key rate limit reached" }, "502": { "description": "Upstream unavailable; write may have an unconfirmed outcome" }, "503": { "description": "Storage or audit unavailable" } } }, "post": { "operationId": "post_kb_order", "summary": "orders.create", "security": [ { "GatewayKey": [] } ], "x-required-scope": "orders.create", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128 } } ], "responses": { "200": { "description": "Bexio JSON response" }, "201": { "description": "Created" }, "400": { "description": "Invalid or disallowed payload" }, "401": { "description": "Invalid, expired or revoked key" }, "403": { "description": "Denied by gateway policy" }, "404": { "description": "Not accessible" }, "409": { "description": "Idempotency conflict or unconfirmed write" }, "429": { "description": "Key rate limit reached" }, "502": { "description": "Upstream unavailable; write may have an unconfirmed outcome" }, "503": { "description": "Storage or audit unavailable" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "minProperties": 1, "properties": { "document_nr": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "contact_id": { "type": [ "integer", "null" ] }, "contact_sub_id": { "type": [ "integer", "null" ] }, "pr_project_id": { "type": [ "integer", "null" ] }, "language_id": { "type": [ "integer", "null" ] }, "bank_account_id": { "type": [ "integer", "null" ] }, "currency_id": { "type": [ "integer", "null" ] }, "payment_type_id": { "type": [ "integer", "null" ] }, "header": { "type": [ "string", "null" ] }, "footer": { "type": [ "string", "null" ] }, "mwst_type": { "type": [ "integer", "null" ] }, "mwst_is_net": { "type": "boolean" }, "show_position_taxes": { "type": "boolean" }, "is_valid_from": { "type": [ "string", "null" ] }, "contact_address_manual": { "type": [ "string", "null" ] }, "delivery_address_type": { "type": [ "integer", "null" ] }, "delivery_address_manual": { "type": [ "string", "null" ] }, "api_reference": { "type": [ "string", "null" ] }, "template_slug": { "type": [ "string", "null" ] }, "user_id": { "type": "integer", "description": "Optional. Must equal the authenticated Bexio user attached to the identity; injected when omitted." }, "positions": { "type": "array", "maxItems": 150, "items": { "oneOf": [ { "type": "object", "additionalProperties": false, "required": [ "type" ], "properties": { "amount": { "type": [ "string", "number" ] }, "article_id": { "type": [ "integer", "null" ] }, "unit_id": { "type": [ "integer", "null" ] }, "account_id": { "type": [ "integer", "null" ] }, "unit_price": { "type": [ "string", "number" ] }, "discount_in_percent": { "type": [ "string", "number" ] }, "tax_id": { "type": [ "integer", "null" ] }, "text": { "type": [ "string", "null" ] }, "is_optional": { "type": "boolean" }, "parent_id": { "type": [ "integer", "null" ] }, "type": { "const": "KbPositionArticle" } } }, { "type": "object", "additionalProperties": false, "required": [ "type" ], "properties": { "amount": { "type": [ "string", "number" ] }, "unit_id": { "type": [ "integer", "null" ] }, "account_id": { "type": [ "integer", "null" ] }, "unit_price": { "type": [ "string", "number" ] }, "discount_in_percent": { "type": [ "string", "number" ] }, "tax_id": { "type": [ "integer", "null" ] }, "text": { "type": [ "string", "null" ] }, "is_optional": { "type": "boolean" }, "parent_id": { "type": [ "integer", "null" ] }, "type": { "const": "KbPositionCustom" } } }, { "type": "object", "additionalProperties": false, "required": [ "type" ], "properties": { "text": { "type": [ "string", "null" ] }, "show_pos_nr": { "type": "boolean" }, "parent_id": { "type": [ "integer", "null" ] }, "type": { "const": "KbPositionText" } } }, { "type": "object", "additionalProperties": false, "required": [ "type" ], "properties": { "text": { "type": [ "string", "null" ] }, "type": { "const": "KbPositionSubtotal" } } }, { "type": "object", "additionalProperties": false, "required": [ "type" ], "properties": { "text": { "type": [ "string", "null" ] }, "value": { "type": [ "string", "number" ] }, "is_percentual": { "type": "boolean" }, "type": { "const": "KbPositionDiscount" } } }, { "type": "object", "additionalProperties": false, "required": [ "type" ], "properties": { "pagebreak": { "type": "boolean" }, "type": { "const": "KbPositionPagebreak" } } }, { "type": "object", "additionalProperties": false, "required": [ "type" ], "properties": { "text": { "type": [ "string", "null" ] }, "show_pos_nr": { "type": "boolean" }, "type": { "const": "KbPositionSubposition" } } } ] } } } }, "description": "Strict server-side field allowlist; see /api-guide. user_id is fixed by the selected identity on order creation." } } } } }, "/bexio/2.0/kb_order/search": { "post": { "operationId": "post_kb_order_search", "summary": "orders.read", "security": [ { "GatewayKey": [] } ], "x-required-scope": "orders.read", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer" } }, { "name": "offset", "in": "query", "schema": { "type": "integer" } }, { "name": "order_by", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Bexio JSON response" }, "201": { "description": "Created" }, "400": { "description": "Invalid or disallowed payload" }, "401": { "description": "Invalid, expired or revoked key" }, "403": { "description": "Denied by gateway policy" }, "404": { "description": "Not accessible" }, "409": { "description": "Idempotency conflict or unconfirmed write" }, "429": { "description": "Key rate limit reached" }, "502": { "description": "Upstream unavailable; write may have an unconfirmed outcome" }, "503": { "description": "Storage or audit unavailable" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "maxItems": 50, "items": { "type": "object", "additionalProperties": false, "properties": { "field": { "type": "string" }, "value": {}, "criteria": { "type": "string" } } } }, "description": "Strict server-side field allowlist; see /api-guide. user_id is fixed by the selected identity on order creation." } } } } }, "/bexio/2.0/kb_order/{order_id}": { "get": { "operationId": "get_kb_order_order_id", "summary": "orders.read", "security": [ { "GatewayKey": [] } ], "x-required-scope": "orders.read", "parameters": [ { "name": "order_id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "limit", "in": "query", "schema": { "type": "integer" } }, { "name": "offset", "in": "query", "schema": { "type": "integer" } }, { "name": "order_by", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Bexio JSON response" }, "201": { "description": "Created" }, "400": { "description": "Invalid or disallowed payload" }, "401": { "description": "Invalid, expired or revoked key" }, "403": { "description": "Denied by gateway policy" }, "404": { "description": "Not accessible" }, "409": { "description": "Idempotency conflict or unconfirmed write" }, "429": { "description": "Key rate limit reached" }, "502": { "description": "Upstream unavailable; write may have an unconfirmed outcome" }, "503": { "description": "Storage or audit unavailable" } } }, "post": { "operationId": "post_kb_order_order_id", "summary": "orders.update", "security": [ { "GatewayKey": [] } ], "x-required-scope": "orders.update", "parameters": [ { "name": "order_id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128 } } ], "responses": { "200": { "description": "Bexio JSON response" }, "201": { "description": "Created" }, "400": { "description": "Invalid or disallowed payload" }, "401": { "description": "Invalid, expired or revoked key" }, "403": { "description": "Denied by gateway policy" }, "404": { "description": "Not accessible" }, "409": { "description": "Idempotency conflict or unconfirmed write" }, "429": { "description": "Key rate limit reached" }, "502": { "description": "Upstream unavailable; write may have an unconfirmed outcome" }, "503": { "description": "Storage or audit unavailable" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "minProperties": 1, "properties": { "document_nr": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "contact_id": { "type": [ "integer", "null" ] }, "contact_sub_id": { "type": [ "integer", "null" ] }, "pr_project_id": { "type": [ "integer", "null" ] }, "language_id": { "type": [ "integer", "null" ] }, "bank_account_id": { "type": [ "integer", "null" ] }, "currency_id": { "type": [ "integer", "null" ] }, "payment_type_id": { "type": [ "integer", "null" ] }, "header": { "type": [ "string", "null" ] }, "footer": { "type": [ "string", "null" ] }, "mwst_type": { "type": [ "integer", "null" ] }, "mwst_is_net": { "type": "boolean" }, "show_position_taxes": { "type": "boolean" }, "is_valid_from": { "type": [ "string", "null" ] }, "contact_address_manual": { "type": [ "string", "null" ] }, "delivery_address_type": { "type": [ "integer", "null" ] }, "delivery_address_manual": { "type": [ "string", "null" ] }, "api_reference": { "type": [ "string", "null" ] }, "template_slug": { "type": [ "string", "null" ] } } }, "description": "Strict server-side field allowlist; see /api-guide. user_id is fixed by the selected identity on order creation." } } } } }, "/bexio/2.0/kb_order/{order_id}/pdf": { "get": { "operationId": "get_kb_order_order_id_pdf", "summary": "orders.read", "security": [ { "GatewayKey": [] } ], "x-required-scope": "orders.read", "parameters": [ { "name": "order_id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "limit", "in": "query", "schema": { "type": "integer" } }, { "name": "offset", "in": "query", "schema": { "type": "integer" } }, { "name": "order_by", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Bexio JSON response" }, "201": { "description": "Created" }, "400": { "description": "Invalid or disallowed payload" }, "401": { "description": "Invalid, expired or revoked key" }, "403": { "description": "Denied by gateway policy" }, "404": { "description": "Not accessible" }, "409": { "description": "Idempotency conflict or unconfirmed write" }, "429": { "description": "Key rate limit reached" }, "502": { "description": "Upstream unavailable; write may have an unconfirmed outcome" }, "503": { "description": "Storage or audit unavailable" } } } }, "/bexio/2.0/kb_order/{order_id}/kb_position_article": { "get": { "operationId": "get_kb_order_order_id_kb_position_article", "summary": "orders.read", "security": [ { "GatewayKey": [] } ], "x-required-scope": "orders.read", "parameters": [ { "name": "order_id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "limit", "in": "query", "schema": { "type": "integer" } }, { "name": "offset", "in": "query", "schema": { "type": "integer" } }, { "name": "order_by", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Bexio JSON response" }, "201": { "description": "Created" }, "400": { "description": "Invalid or disallowed payload" }, "401": { "description": "Invalid, expired or revoked key" }, "403": { "description": "Denied by gateway policy" }, "404": { "description": "Not accessible" }, "409": { "description": "Idempotency conflict or unconfirmed write" }, "429": { "description": "Key rate limit reached" }, "502": { "description": "Upstream unavailable; write may have an unconfirmed outcome" }, "503": { "description": "Storage or audit unavailable" } } }, "post": { "operationId": "post_kb_order_order_id_kb_position_article", "summary": "positions.create", "security": [ { "GatewayKey": [] } ], "x-required-scope": "positions.create", "parameters": [ { "name": "order_id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128 } } ], "responses": { "200": { "description": "Bexio JSON response" }, "201": { "description": "Created" }, "400": { "description": "Invalid or disallowed payload" }, "401": { "description": "Invalid, expired or revoked key" }, "403": { "description": "Denied by gateway policy" }, "404": { "description": "Not accessible" }, "409": { "description": "Idempotency conflict or unconfirmed write" }, "429": { "description": "Key rate limit reached" }, "502": { "description": "Upstream unavailable; write may have an unconfirmed outcome" }, "503": { "description": "Storage or audit unavailable" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "minProperties": 1, "properties": { "amount": { "type": [ "string", "number" ] }, "article_id": { "type": [ "integer", "null" ] }, "unit_id": { "type": [ "integer", "null" ] }, "account_id": { "type": [ "integer", "null" ] }, "unit_price": { "type": [ "string", "number" ] }, "discount_in_percent": { "type": [ "string", "number" ] }, "tax_id": { "type": [ "integer", "null" ] }, "text": { "type": [ "string", "null" ] }, "is_optional": { "type": "boolean" }, "parent_id": { "type": [ "integer", "null" ] } } }, "description": "Strict server-side field allowlist; see /api-guide. user_id is fixed by the selected identity on order creation." } } } } }, "/bexio/2.0/kb_order/{order_id}/kb_position_article/{position_id}": { "get": { "operationId": "get_kb_order_order_id_kb_position_article_position_id", "summary": "orders.read", "security": [ { "GatewayKey": [] } ], "x-required-scope": "orders.read", "parameters": [ { "name": "order_id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "position_id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "limit", "in": "query", "schema": { "type": "integer" } }, { "name": "offset", "in": "query", "schema": { "type": "integer" } }, { "name": "order_by", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Bexio JSON response" }, "201": { "description": "Created" }, "400": { "description": "Invalid or disallowed payload" }, "401": { "description": "Invalid, expired or revoked key" }, "403": { "description": "Denied by gateway policy" }, "404": { "description": "Not accessible" }, "409": { "description": "Idempotency conflict or unconfirmed write" }, "429": { "description": "Key rate limit reached" }, "502": { "description": "Upstream unavailable; write may have an unconfirmed outcome" }, "503": { "description": "Storage or audit unavailable" } } }, "post": { "operationId": "post_kb_order_order_id_kb_position_article_position_id", "summary": "positions.update", "security": [ { "GatewayKey": [] } ], "x-required-scope": "positions.update", "parameters": [ { "name": "order_id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "position_id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128 } } ], "responses": { "200": { "description": "Bexio JSON response" }, "201": { "description": "Created" }, "400": { "description": "Invalid or disallowed payload" }, "401": { "description": "Invalid, expired or revoked key" }, "403": { "description": "Denied by gateway policy" }, "404": { "description": "Not accessible" }, "409": { "description": "Idempotency conflict or unconfirmed write" }, "429": { "description": "Key rate limit reached" }, "502": { "description": "Upstream unavailable; write may have an unconfirmed outcome" }, "503": { "description": "Storage or audit unavailable" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "minProperties": 1, "properties": { "amount": { "type": [ "string", "number" ] }, "article_id": { "type": [ "integer", "null" ] }, "unit_id": { "type": [ "integer", "null" ] }, "account_id": { "type": [ "integer", "null" ] }, "unit_price": { "type": [ "string", "number" ] }, "discount_in_percent": { "type": [ "string", "number" ] }, "tax_id": { "type": [ "integer", "null" ] }, "text": { "type": [ "string", "null" ] }, "is_optional": { "type": "boolean" }, "parent_id": { "type": [ "integer", "null" ] } } }, "description": "Strict server-side field allowlist; see /api-guide. user_id is fixed by the selected identity on order creation." } } } } }, "/bexio/2.0/kb_order/{order_id}/kb_position_custom": { "get": { "operationId": "get_kb_order_order_id_kb_position_custom", "summary": "orders.read", "security": [ { "GatewayKey": [] } ], "x-required-scope": "orders.read", "parameters": [ { "name": "order_id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "limit", "in": "query", "schema": { "type": "integer" } }, { "name": "offset", "in": "query", "schema": { "type": "integer" } }, { "name": "order_by", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Bexio JSON response" }, "201": { "description": "Created" }, "400": { "description": "Invalid or disallowed payload" }, "401": { "description": "Invalid, expired or revoked key" }, "403": { "description": "Denied by gateway policy" }, "404": { "description": "Not accessible" }, "409": { "description": "Idempotency conflict or unconfirmed write" }, "429": { "description": "Key rate limit reached" }, "502": { "description": "Upstream unavailable; write may have an unconfirmed outcome" }, "503": { "description": "Storage or audit unavailable" } } }, "post": { "operationId": "post_kb_order_order_id_kb_position_custom", "summary": "positions.create", "security": [ { "GatewayKey": [] } ], "x-required-scope": "positions.create", "parameters": [ { "name": "order_id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128 } } ], "responses": { "200": { "description": "Bexio JSON response" }, "201": { "description": "Created" }, "400": { "description": "Invalid or disallowed payload" }, "401": { "description": "Invalid, expired or revoked key" }, "403": { "description": "Denied by gateway policy" }, "404": { "description": "Not accessible" }, "409": { "description": "Idempotency conflict or unconfirmed write" }, "429": { "description": "Key rate limit reached" }, "502": { "description": "Upstream unavailable; write may have an unconfirmed outcome" }, "503": { "description": "Storage or audit unavailable" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "minProperties": 1, "properties": { "amount": { "type": [ "string", "number" ] }, "unit_id": { "type": [ "integer", "null" ] }, "account_id": { "type": [ "integer", "null" ] }, "unit_price": { "type": [ "string", "number" ] }, "discount_in_percent": { "type": [ "string", "number" ] }, "tax_id": { "type": [ "integer", "null" ] }, "text": { "type": [ "string", "null" ] }, "is_optional": { "type": "boolean" }, "parent_id": { "type": [ "integer", "null" ] } } }, "description": "Strict server-side field allowlist; see /api-guide. user_id is fixed by the selected identity on order creation." } } } } }, "/bexio/2.0/kb_order/{order_id}/kb_position_custom/{position_id}": { "get": { "operationId": "get_kb_order_order_id_kb_position_custom_position_id", "summary": "orders.read", "security": [ { "GatewayKey": [] } ], "x-required-scope": "orders.read", "parameters": [ { "name": "order_id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "position_id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "limit", "in": "query", "schema": { "type": "integer" } }, { "name": "offset", "in": "query", "schema": { "type": "integer" } }, { "name": "order_by", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Bexio JSON response" }, "201": { "description": "Created" }, "400": { "description": "Invalid or disallowed payload" }, "401": { "description": "Invalid, expired or revoked key" }, "403": { "description": "Denied by gateway policy" }, "404": { "description": "Not accessible" }, "409": { "description": "Idempotency conflict or unconfirmed write" }, "429": { "description": "Key rate limit reached" }, "502": { "description": "Upstream unavailable; write may have an unconfirmed outcome" }, "503": { "description": "Storage or audit unavailable" } } }, "post": { "operationId": "post_kb_order_order_id_kb_position_custom_position_id", "summary": "positions.update", "security": [ { "GatewayKey": [] } ], "x-required-scope": "positions.update", "parameters": [ { "name": "order_id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "position_id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128 } } ], "responses": { "200": { "description": "Bexio JSON response" }, "201": { "description": "Created" }, "400": { "description": "Invalid or disallowed payload" }, "401": { "description": "Invalid, expired or revoked key" }, "403": { "description": "Denied by gateway policy" }, "404": { "description": "Not accessible" }, "409": { "description": "Idempotency conflict or unconfirmed write" }, "429": { "description": "Key rate limit reached" }, "502": { "description": "Upstream unavailable; write may have an unconfirmed outcome" }, "503": { "description": "Storage or audit unavailable" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "minProperties": 1, "properties": { "amount": { "type": [ "string", "number" ] }, "unit_id": { "type": [ "integer", "null" ] }, "account_id": { "type": [ "integer", "null" ] }, "unit_price": { "type": [ "string", "number" ] }, "discount_in_percent": { "type": [ "string", "number" ] }, "tax_id": { "type": [ "integer", "null" ] }, "text": { "type": [ "string", "null" ] }, "is_optional": { "type": "boolean" }, "parent_id": { "type": [ "integer", "null" ] } } }, "description": "Strict server-side field allowlist; see /api-guide. user_id is fixed by the selected identity on order creation." } } } } }, "/bexio/2.0/kb_order/{order_id}/kb_position_text": { "get": { "operationId": "get_kb_order_order_id_kb_position_text", "summary": "orders.read", "security": [ { "GatewayKey": [] } ], "x-required-scope": "orders.read", "parameters": [ { "name": "order_id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "limit", "in": "query", "schema": { "type": "integer" } }, { "name": "offset", "in": "query", "schema": { "type": "integer" } }, { "name": "order_by", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Bexio JSON response" }, "201": { "description": "Created" }, "400": { "description": "Invalid or disallowed payload" }, "401": { "description": "Invalid, expired or revoked key" }, "403": { "description": "Denied by gateway policy" }, "404": { "description": "Not accessible" }, "409": { "description": "Idempotency conflict or unconfirmed write" }, "429": { "description": "Key rate limit reached" }, "502": { "description": "Upstream unavailable; write may have an unconfirmed outcome" }, "503": { "description": "Storage or audit unavailable" } } }, "post": { "operationId": "post_kb_order_order_id_kb_position_text", "summary": "positions.create", "security": [ { "GatewayKey": [] } ], "x-required-scope": "positions.create", "parameters": [ { "name": "order_id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128 } } ], "responses": { "200": { "description": "Bexio JSON response" }, "201": { "description": "Created" }, "400": { "description": "Invalid or disallowed payload" }, "401": { "description": "Invalid, expired or revoked key" }, "403": { "description": "Denied by gateway policy" }, "404": { "description": "Not accessible" }, "409": { "description": "Idempotency conflict or unconfirmed write" }, "429": { "description": "Key rate limit reached" }, "502": { "description": "Upstream unavailable; write may have an unconfirmed outcome" }, "503": { "description": "Storage or audit unavailable" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "minProperties": 1, "properties": { "text": { "type": [ "string", "null" ] }, "show_pos_nr": { "type": "boolean" }, "parent_id": { "type": [ "integer", "null" ] } } }, "description": "Strict server-side field allowlist; see /api-guide. user_id is fixed by the selected identity on order creation." } } } } }, "/bexio/2.0/kb_order/{order_id}/kb_position_text/{position_id}": { "get": { "operationId": "get_kb_order_order_id_kb_position_text_position_id", "summary": "orders.read", "security": [ { "GatewayKey": [] } ], "x-required-scope": "orders.read", "parameters": [ { "name": "order_id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "position_id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "limit", "in": "query", "schema": { "type": "integer" } }, { "name": "offset", "in": "query", "schema": { "type": "integer" } }, { "name": "order_by", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Bexio JSON response" }, "201": { "description": "Created" }, "400": { "description": "Invalid or disallowed payload" }, "401": { "description": "Invalid, expired or revoked key" }, "403": { "description": "Denied by gateway policy" }, "404": { "description": "Not accessible" }, "409": { "description": "Idempotency conflict or unconfirmed write" }, "429": { "description": "Key rate limit reached" }, "502": { "description": "Upstream unavailable; write may have an unconfirmed outcome" }, "503": { "description": "Storage or audit unavailable" } } }, "post": { "operationId": "post_kb_order_order_id_kb_position_text_position_id", "summary": "positions.update", "security": [ { "GatewayKey": [] } ], "x-required-scope": "positions.update", "parameters": [ { "name": "order_id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "position_id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128 } } ], "responses": { "200": { "description": "Bexio JSON response" }, "201": { "description": "Created" }, "400": { "description": "Invalid or disallowed payload" }, "401": { "description": "Invalid, expired or revoked key" }, "403": { "description": "Denied by gateway policy" }, "404": { "description": "Not accessible" }, "409": { "description": "Idempotency conflict or unconfirmed write" }, "429": { "description": "Key rate limit reached" }, "502": { "description": "Upstream unavailable; write may have an unconfirmed outcome" }, "503": { "description": "Storage or audit unavailable" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "minProperties": 1, "properties": { "text": { "type": [ "string", "null" ] }, "show_pos_nr": { "type": "boolean" }, "parent_id": { "type": [ "integer", "null" ] } } }, "description": "Strict server-side field allowlist; see /api-guide. user_id is fixed by the selected identity on order creation." } } } } }, "/bexio/2.0/kb_order/{order_id}/kb_position_subtotal": { "get": { "operationId": "get_kb_order_order_id_kb_position_subtotal", "summary": "orders.read", "security": [ { "GatewayKey": [] } ], "x-required-scope": "orders.read", "parameters": [ { "name": "order_id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "limit", "in": "query", "schema": { "type": "integer" } }, { "name": "offset", "in": "query", "schema": { "type": "integer" } }, { "name": "order_by", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Bexio JSON response" }, "201": { "description": "Created" }, "400": { "description": "Invalid or disallowed payload" }, "401": { "description": "Invalid, expired or revoked key" }, "403": { "description": "Denied by gateway policy" }, "404": { "description": "Not accessible" }, "409": { "description": "Idempotency conflict or unconfirmed write" }, "429": { "description": "Key rate limit reached" }, "502": { "description": "Upstream unavailable; write may have an unconfirmed outcome" }, "503": { "description": "Storage or audit unavailable" } } }, "post": { "operationId": "post_kb_order_order_id_kb_position_subtotal", "summary": "positions.create", "security": [ { "GatewayKey": [] } ], "x-required-scope": "positions.create", "parameters": [ { "name": "order_id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128 } } ], "responses": { "200": { "description": "Bexio JSON response" }, "201": { "description": "Created" }, "400": { "description": "Invalid or disallowed payload" }, "401": { "description": "Invalid, expired or revoked key" }, "403": { "description": "Denied by gateway policy" }, "404": { "description": "Not accessible" }, "409": { "description": "Idempotency conflict or unconfirmed write" }, "429": { "description": "Key rate limit reached" }, "502": { "description": "Upstream unavailable; write may have an unconfirmed outcome" }, "503": { "description": "Storage or audit unavailable" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "minProperties": 1, "properties": { "text": { "type": [ "string", "null" ] } } }, "description": "Strict server-side field allowlist; see /api-guide. user_id is fixed by the selected identity on order creation." } } } } }, "/bexio/2.0/kb_order/{order_id}/kb_position_subtotal/{position_id}": { "get": { "operationId": "get_kb_order_order_id_kb_position_subtotal_position_id", "summary": "orders.read", "security": [ { "GatewayKey": [] } ], "x-required-scope": "orders.read", "parameters": [ { "name": "order_id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "position_id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "limit", "in": "query", "schema": { "type": "integer" } }, { "name": "offset", "in": "query", "schema": { "type": "integer" } }, { "name": "order_by", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Bexio JSON response" }, "201": { "description": "Created" }, "400": { "description": "Invalid or disallowed payload" }, "401": { "description": "Invalid, expired or revoked key" }, "403": { "description": "Denied by gateway policy" }, "404": { "description": "Not accessible" }, "409": { "description": "Idempotency conflict or unconfirmed write" }, "429": { "description": "Key rate limit reached" }, "502": { "description": "Upstream unavailable; write may have an unconfirmed outcome" }, "503": { "description": "Storage or audit unavailable" } } }, "post": { "operationId": "post_kb_order_order_id_kb_position_subtotal_position_id", "summary": "positions.update", "security": [ { "GatewayKey": [] } ], "x-required-scope": "positions.update", "parameters": [ { "name": "order_id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "position_id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128 } } ], "responses": { "200": { "description": "Bexio JSON response" }, "201": { "description": "Created" }, "400": { "description": "Invalid or disallowed payload" }, "401": { "description": "Invalid, expired or revoked key" }, "403": { "description": "Denied by gateway policy" }, "404": { "description": "Not accessible" }, "409": { "description": "Idempotency conflict or unconfirmed write" }, "429": { "description": "Key rate limit reached" }, "502": { "description": "Upstream unavailable; write may have an unconfirmed outcome" }, "503": { "description": "Storage or audit unavailable" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "minProperties": 1, "properties": { "text": { "type": [ "string", "null" ] } } }, "description": "Strict server-side field allowlist; see /api-guide. user_id is fixed by the selected identity on order creation." } } } } }, "/bexio/2.0/kb_order/{order_id}/kb_position_discount": { "get": { "operationId": "get_kb_order_order_id_kb_position_discount", "summary": "orders.read", "security": [ { "GatewayKey": [] } ], "x-required-scope": "orders.read", "parameters": [ { "name": "order_id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "limit", "in": "query", "schema": { "type": "integer" } }, { "name": "offset", "in": "query", "schema": { "type": "integer" } }, { "name": "order_by", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Bexio JSON response" }, "201": { "description": "Created" }, "400": { "description": "Invalid or disallowed payload" }, "401": { "description": "Invalid, expired or revoked key" }, "403": { "description": "Denied by gateway policy" }, "404": { "description": "Not accessible" }, "409": { "description": "Idempotency conflict or unconfirmed write" }, "429": { "description": "Key rate limit reached" }, "502": { "description": "Upstream unavailable; write may have an unconfirmed outcome" }, "503": { "description": "Storage or audit unavailable" } } }, "post": { "operationId": "post_kb_order_order_id_kb_position_discount", "summary": "positions.create", "security": [ { "GatewayKey": [] } ], "x-required-scope": "positions.create", "parameters": [ { "name": "order_id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128 } } ], "responses": { "200": { "description": "Bexio JSON response" }, "201": { "description": "Created" }, "400": { "description": "Invalid or disallowed payload" }, "401": { "description": "Invalid, expired or revoked key" }, "403": { "description": "Denied by gateway policy" }, "404": { "description": "Not accessible" }, "409": { "description": "Idempotency conflict or unconfirmed write" }, "429": { "description": "Key rate limit reached" }, "502": { "description": "Upstream unavailable; write may have an unconfirmed outcome" }, "503": { "description": "Storage or audit unavailable" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "minProperties": 1, "properties": { "text": { "type": [ "string", "null" ] }, "value": { "type": [ "string", "number" ] }, "is_percentual": { "type": "boolean" } } }, "description": "Strict server-side field allowlist; see /api-guide. user_id is fixed by the selected identity on order creation." } } } } }, "/bexio/2.0/kb_order/{order_id}/kb_position_discount/{position_id}": { "get": { "operationId": "get_kb_order_order_id_kb_position_discount_position_id", "summary": "orders.read", "security": [ { "GatewayKey": [] } ], "x-required-scope": "orders.read", "parameters": [ { "name": "order_id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "position_id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "limit", "in": "query", "schema": { "type": "integer" } }, { "name": "offset", "in": "query", "schema": { "type": "integer" } }, { "name": "order_by", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Bexio JSON response" }, "201": { "description": "Created" }, "400": { "description": "Invalid or disallowed payload" }, "401": { "description": "Invalid, expired or revoked key" }, "403": { "description": "Denied by gateway policy" }, "404": { "description": "Not accessible" }, "409": { "description": "Idempotency conflict or unconfirmed write" }, "429": { "description": "Key rate limit reached" }, "502": { "description": "Upstream unavailable; write may have an unconfirmed outcome" }, "503": { "description": "Storage or audit unavailable" } } }, "post": { "operationId": "post_kb_order_order_id_kb_position_discount_position_id", "summary": "positions.update", "security": [ { "GatewayKey": [] } ], "x-required-scope": "positions.update", "parameters": [ { "name": "order_id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "position_id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128 } } ], "responses": { "200": { "description": "Bexio JSON response" }, "201": { "description": "Created" }, "400": { "description": "Invalid or disallowed payload" }, "401": { "description": "Invalid, expired or revoked key" }, "403": { "description": "Denied by gateway policy" }, "404": { "description": "Not accessible" }, "409": { "description": "Idempotency conflict or unconfirmed write" }, "429": { "description": "Key rate limit reached" }, "502": { "description": "Upstream unavailable; write may have an unconfirmed outcome" }, "503": { "description": "Storage or audit unavailable" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "minProperties": 1, "properties": { "text": { "type": [ "string", "null" ] }, "value": { "type": [ "string", "number" ] }, "is_percentual": { "type": "boolean" } } }, "description": "Strict server-side field allowlist; see /api-guide. user_id is fixed by the selected identity on order creation." } } } } }, "/bexio/2.0/kb_order/{order_id}/kb_position_pagebreak": { "get": { "operationId": "get_kb_order_order_id_kb_position_pagebreak", "summary": "orders.read", "security": [ { "GatewayKey": [] } ], "x-required-scope": "orders.read", "parameters": [ { "name": "order_id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "limit", "in": "query", "schema": { "type": "integer" } }, { "name": "offset", "in": "query", "schema": { "type": "integer" } }, { "name": "order_by", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Bexio JSON response" }, "201": { "description": "Created" }, "400": { "description": "Invalid or disallowed payload" }, "401": { "description": "Invalid, expired or revoked key" }, "403": { "description": "Denied by gateway policy" }, "404": { "description": "Not accessible" }, "409": { "description": "Idempotency conflict or unconfirmed write" }, "429": { "description": "Key rate limit reached" }, "502": { "description": "Upstream unavailable; write may have an unconfirmed outcome" }, "503": { "description": "Storage or audit unavailable" } } }, "post": { "operationId": "post_kb_order_order_id_kb_position_pagebreak", "summary": "positions.create", "security": [ { "GatewayKey": [] } ], "x-required-scope": "positions.create", "parameters": [ { "name": "order_id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128 } } ], "responses": { "200": { "description": "Bexio JSON response" }, "201": { "description": "Created" }, "400": { "description": "Invalid or disallowed payload" }, "401": { "description": "Invalid, expired or revoked key" }, "403": { "description": "Denied by gateway policy" }, "404": { "description": "Not accessible" }, "409": { "description": "Idempotency conflict or unconfirmed write" }, "429": { "description": "Key rate limit reached" }, "502": { "description": "Upstream unavailable; write may have an unconfirmed outcome" }, "503": { "description": "Storage or audit unavailable" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "minProperties": 1, "properties": { "pagebreak": { "type": "boolean" } } }, "description": "Strict server-side field allowlist; see /api-guide. user_id is fixed by the selected identity on order creation." } } } } }, "/bexio/2.0/kb_order/{order_id}/kb_position_pagebreak/{position_id}": { "get": { "operationId": "get_kb_order_order_id_kb_position_pagebreak_position_id", "summary": "orders.read", "security": [ { "GatewayKey": [] } ], "x-required-scope": "orders.read", "parameters": [ { "name": "order_id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "position_id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "limit", "in": "query", "schema": { "type": "integer" } }, { "name": "offset", "in": "query", "schema": { "type": "integer" } }, { "name": "order_by", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Bexio JSON response" }, "201": { "description": "Created" }, "400": { "description": "Invalid or disallowed payload" }, "401": { "description": "Invalid, expired or revoked key" }, "403": { "description": "Denied by gateway policy" }, "404": { "description": "Not accessible" }, "409": { "description": "Idempotency conflict or unconfirmed write" }, "429": { "description": "Key rate limit reached" }, "502": { "description": "Upstream unavailable; write may have an unconfirmed outcome" }, "503": { "description": "Storage or audit unavailable" } } }, "post": { "operationId": "post_kb_order_order_id_kb_position_pagebreak_position_id", "summary": "positions.update", "security": [ { "GatewayKey": [] } ], "x-required-scope": "positions.update", "parameters": [ { "name": "order_id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "position_id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128 } } ], "responses": { "200": { "description": "Bexio JSON response" }, "201": { "description": "Created" }, "400": { "description": "Invalid or disallowed payload" }, "401": { "description": "Invalid, expired or revoked key" }, "403": { "description": "Denied by gateway policy" }, "404": { "description": "Not accessible" }, "409": { "description": "Idempotency conflict or unconfirmed write" }, "429": { "description": "Key rate limit reached" }, "502": { "description": "Upstream unavailable; write may have an unconfirmed outcome" }, "503": { "description": "Storage or audit unavailable" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "minProperties": 1, "properties": { "pagebreak": { "type": "boolean" } } }, "description": "Strict server-side field allowlist; see /api-guide. user_id is fixed by the selected identity on order creation." } } } } }, "/bexio/2.0/kb_order/{order_id}/kb_position_subposition": { "get": { "operationId": "get_kb_order_order_id_kb_position_subposition", "summary": "orders.read", "security": [ { "GatewayKey": [] } ], "x-required-scope": "orders.read", "parameters": [ { "name": "order_id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "limit", "in": "query", "schema": { "type": "integer" } }, { "name": "offset", "in": "query", "schema": { "type": "integer" } }, { "name": "order_by", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Bexio JSON response" }, "201": { "description": "Created" }, "400": { "description": "Invalid or disallowed payload" }, "401": { "description": "Invalid, expired or revoked key" }, "403": { "description": "Denied by gateway policy" }, "404": { "description": "Not accessible" }, "409": { "description": "Idempotency conflict or unconfirmed write" }, "429": { "description": "Key rate limit reached" }, "502": { "description": "Upstream unavailable; write may have an unconfirmed outcome" }, "503": { "description": "Storage or audit unavailable" } } }, "post": { "operationId": "post_kb_order_order_id_kb_position_subposition", "summary": "positions.create", "security": [ { "GatewayKey": [] } ], "x-required-scope": "positions.create", "parameters": [ { "name": "order_id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128 } } ], "responses": { "200": { "description": "Bexio JSON response" }, "201": { "description": "Created" }, "400": { "description": "Invalid or disallowed payload" }, "401": { "description": "Invalid, expired or revoked key" }, "403": { "description": "Denied by gateway policy" }, "404": { "description": "Not accessible" }, "409": { "description": "Idempotency conflict or unconfirmed write" }, "429": { "description": "Key rate limit reached" }, "502": { "description": "Upstream unavailable; write may have an unconfirmed outcome" }, "503": { "description": "Storage or audit unavailable" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "minProperties": 1, "properties": { "text": { "type": [ "string", "null" ] }, "show_pos_nr": { "type": "boolean" } } }, "description": "Strict server-side field allowlist; see /api-guide. user_id is fixed by the selected identity on order creation." } } } } }, "/bexio/2.0/kb_order/{order_id}/kb_position_subposition/{position_id}": { "get": { "operationId": "get_kb_order_order_id_kb_position_subposition_position_id", "summary": "orders.read", "security": [ { "GatewayKey": [] } ], "x-required-scope": "orders.read", "parameters": [ { "name": "order_id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "position_id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "limit", "in": "query", "schema": { "type": "integer" } }, { "name": "offset", "in": "query", "schema": { "type": "integer" } }, { "name": "order_by", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Bexio JSON response" }, "201": { "description": "Created" }, "400": { "description": "Invalid or disallowed payload" }, "401": { "description": "Invalid, expired or revoked key" }, "403": { "description": "Denied by gateway policy" }, "404": { "description": "Not accessible" }, "409": { "description": "Idempotency conflict or unconfirmed write" }, "429": { "description": "Key rate limit reached" }, "502": { "description": "Upstream unavailable; write may have an unconfirmed outcome" }, "503": { "description": "Storage or audit unavailable" } } }, "post": { "operationId": "post_kb_order_order_id_kb_position_subposition_position_id", "summary": "positions.update", "security": [ { "GatewayKey": [] } ], "x-required-scope": "positions.update", "parameters": [ { "name": "order_id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "position_id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128 } } ], "responses": { "200": { "description": "Bexio JSON response" }, "201": { "description": "Created" }, "400": { "description": "Invalid or disallowed payload" }, "401": { "description": "Invalid, expired or revoked key" }, "403": { "description": "Denied by gateway policy" }, "404": { "description": "Not accessible" }, "409": { "description": "Idempotency conflict or unconfirmed write" }, "429": { "description": "Key rate limit reached" }, "502": { "description": "Upstream unavailable; write may have an unconfirmed outcome" }, "503": { "description": "Storage or audit unavailable" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "minProperties": 1, "properties": { "text": { "type": [ "string", "null" ] }, "show_pos_nr": { "type": "boolean" } } }, "description": "Strict server-side field allowlist; see /api-guide. user_id is fixed by the selected identity on order creation." } } } } }, "/bexio/2.0/contact": { "get": { "operationId": "get_contact", "summary": "contacts.read", "security": [ { "GatewayKey": [] } ], "x-required-scope": "contacts.read", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer" } }, { "name": "offset", "in": "query", "schema": { "type": "integer" } }, { "name": "order_by", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Bexio JSON response" }, "201": { "description": "Created" }, "400": { "description": "Invalid or disallowed payload" }, "401": { "description": "Invalid, expired or revoked key" }, "403": { "description": "Denied by gateway policy" }, "404": { "description": "Not accessible" }, "409": { "description": "Idempotency conflict or unconfirmed write" }, "429": { "description": "Key rate limit reached" }, "502": { "description": "Upstream unavailable; write may have an unconfirmed outcome" }, "503": { "description": "Storage or audit unavailable" } } } }, "/bexio/2.0/contact/{id}": { "get": { "operationId": "get_contact_id", "summary": "contacts.read", "security": [ { "GatewayKey": [] } ], "x-required-scope": "contacts.read", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "limit", "in": "query", "schema": { "type": "integer" } }, { "name": "offset", "in": "query", "schema": { "type": "integer" } }, { "name": "order_by", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Bexio JSON response" }, "201": { "description": "Created" }, "400": { "description": "Invalid or disallowed payload" }, "401": { "description": "Invalid, expired or revoked key" }, "403": { "description": "Denied by gateway policy" }, "404": { "description": "Not accessible" }, "409": { "description": "Idempotency conflict or unconfirmed write" }, "429": { "description": "Key rate limit reached" }, "502": { "description": "Upstream unavailable; write may have an unconfirmed outcome" }, "503": { "description": "Storage or audit unavailable" } } } }, "/bexio/2.0/contact/search": { "post": { "operationId": "post_contact_search", "summary": "contacts.read", "security": [ { "GatewayKey": [] } ], "x-required-scope": "contacts.read", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer" } }, { "name": "offset", "in": "query", "schema": { "type": "integer" } }, { "name": "order_by", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Bexio JSON response" }, "201": { "description": "Created" }, "400": { "description": "Invalid or disallowed payload" }, "401": { "description": "Invalid, expired or revoked key" }, "403": { "description": "Denied by gateway policy" }, "404": { "description": "Not accessible" }, "409": { "description": "Idempotency conflict or unconfirmed write" }, "429": { "description": "Key rate limit reached" }, "502": { "description": "Upstream unavailable; write may have an unconfirmed outcome" }, "503": { "description": "Storage or audit unavailable" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "maxItems": 50, "items": { "type": "object", "additionalProperties": false, "properties": { "field": { "type": "string" }, "value": {}, "criteria": { "type": "string" } } } }, "description": "Strict server-side field allowlist; see /api-guide. user_id is fixed by the selected identity on order creation." } } } } }, "/bexio/2.0/article": { "get": { "operationId": "get_article", "summary": "articles.read", "security": [ { "GatewayKey": [] } ], "x-required-scope": "articles.read", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer" } }, { "name": "offset", "in": "query", "schema": { "type": "integer" } }, { "name": "order_by", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Bexio JSON response" }, "201": { "description": "Created" }, "400": { "description": "Invalid or disallowed payload" }, "401": { "description": "Invalid, expired or revoked key" }, "403": { "description": "Denied by gateway policy" }, "404": { "description": "Not accessible" }, "409": { "description": "Idempotency conflict or unconfirmed write" }, "429": { "description": "Key rate limit reached" }, "502": { "description": "Upstream unavailable; write may have an unconfirmed outcome" }, "503": { "description": "Storage or audit unavailable" } } } }, "/bexio/2.0/article/{id}": { "get": { "operationId": "get_article_id", "summary": "articles.read", "security": [ { "GatewayKey": [] } ], "x-required-scope": "articles.read", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "limit", "in": "query", "schema": { "type": "integer" } }, { "name": "offset", "in": "query", "schema": { "type": "integer" } }, { "name": "order_by", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Bexio JSON response" }, "201": { "description": "Created" }, "400": { "description": "Invalid or disallowed payload" }, "401": { "description": "Invalid, expired or revoked key" }, "403": { "description": "Denied by gateway policy" }, "404": { "description": "Not accessible" }, "409": { "description": "Idempotency conflict or unconfirmed write" }, "429": { "description": "Key rate limit reached" }, "502": { "description": "Upstream unavailable; write may have an unconfirmed outcome" }, "503": { "description": "Storage or audit unavailable" } } } }, "/bexio/2.0/article/search": { "post": { "operationId": "post_article_search", "summary": "articles.read", "security": [ { "GatewayKey": [] } ], "x-required-scope": "articles.read", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer" } }, { "name": "offset", "in": "query", "schema": { "type": "integer" } }, { "name": "order_by", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Bexio JSON response" }, "201": { "description": "Created" }, "400": { "description": "Invalid or disallowed payload" }, "401": { "description": "Invalid, expired or revoked key" }, "403": { "description": "Denied by gateway policy" }, "404": { "description": "Not accessible" }, "409": { "description": "Idempotency conflict or unconfirmed write" }, "429": { "description": "Key rate limit reached" }, "502": { "description": "Upstream unavailable; write may have an unconfirmed outcome" }, "503": { "description": "Storage or audit unavailable" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "maxItems": 50, "items": { "type": "object", "additionalProperties": false, "properties": { "field": { "type": "string" }, "value": {}, "criteria": { "type": "string" } } } }, "description": "Strict server-side field allowlist; see /api-guide. user_id is fixed by the selected identity on order creation." } } } } }, "/bexio/2.0/language": { "get": { "operationId": "get_language", "summary": "reference.read", "security": [ { "GatewayKey": [] } ], "x-required-scope": "reference.read", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer" } }, { "name": "offset", "in": "query", "schema": { "type": "integer" } }, { "name": "order_by", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Bexio JSON response" }, "201": { "description": "Created" }, "400": { "description": "Invalid or disallowed payload" }, "401": { "description": "Invalid, expired or revoked key" }, "403": { "description": "Denied by gateway policy" }, "404": { "description": "Not accessible" }, "409": { "description": "Idempotency conflict or unconfirmed write" }, "429": { "description": "Key rate limit reached" }, "502": { "description": "Upstream unavailable; write may have an unconfirmed outcome" }, "503": { "description": "Storage or audit unavailable" } } } }, "/bexio/2.0/country": { "get": { "operationId": "get_country", "summary": "reference.read", "security": [ { "GatewayKey": [] } ], "x-required-scope": "reference.read", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer" } }, { "name": "offset", "in": "query", "schema": { "type": "integer" } }, { "name": "order_by", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Bexio JSON response" }, "201": { "description": "Created" }, "400": { "description": "Invalid or disallowed payload" }, "401": { "description": "Invalid, expired or revoked key" }, "403": { "description": "Denied by gateway policy" }, "404": { "description": "Not accessible" }, "409": { "description": "Idempotency conflict or unconfirmed write" }, "429": { "description": "Key rate limit reached" }, "502": { "description": "Upstream unavailable; write may have an unconfirmed outcome" }, "503": { "description": "Storage or audit unavailable" } } } }, "/bexio/2.0/country/{id}": { "get": { "operationId": "get_country_id", "summary": "reference.read", "security": [ { "GatewayKey": [] } ], "x-required-scope": "reference.read", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "limit", "in": "query", "schema": { "type": "integer" } }, { "name": "offset", "in": "query", "schema": { "type": "integer" } }, { "name": "order_by", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Bexio JSON response" }, "201": { "description": "Created" }, "400": { "description": "Invalid or disallowed payload" }, "401": { "description": "Invalid, expired or revoked key" }, "403": { "description": "Denied by gateway policy" }, "404": { "description": "Not accessible" }, "409": { "description": "Idempotency conflict or unconfirmed write" }, "429": { "description": "Key rate limit reached" }, "502": { "description": "Upstream unavailable; write may have an unconfirmed outcome" }, "503": { "description": "Storage or audit unavailable" } } } }, "/bexio/2.0/unit": { "get": { "operationId": "get_unit", "summary": "reference.read", "security": [ { "GatewayKey": [] } ], "x-required-scope": "reference.read", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer" } }, { "name": "offset", "in": "query", "schema": { "type": "integer" } }, { "name": "order_by", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Bexio JSON response" }, "201": { "description": "Created" }, "400": { "description": "Invalid or disallowed payload" }, "401": { "description": "Invalid, expired or revoked key" }, "403": { "description": "Denied by gateway policy" }, "404": { "description": "Not accessible" }, "409": { "description": "Idempotency conflict or unconfirmed write" }, "429": { "description": "Key rate limit reached" }, "502": { "description": "Upstream unavailable; write may have an unconfirmed outcome" }, "503": { "description": "Storage or audit unavailable" } } } }, "/bexio/2.0/unit/{id}": { "get": { "operationId": "get_unit_id", "summary": "reference.read", "security": [ { "GatewayKey": [] } ], "x-required-scope": "reference.read", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "limit", "in": "query", "schema": { "type": "integer" } }, { "name": "offset", "in": "query", "schema": { "type": "integer" } }, { "name": "order_by", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Bexio JSON response" }, "201": { "description": "Created" }, "400": { "description": "Invalid or disallowed payload" }, "401": { "description": "Invalid, expired or revoked key" }, "403": { "description": "Denied by gateway policy" }, "404": { "description": "Not accessible" }, "409": { "description": "Idempotency conflict or unconfirmed write" }, "429": { "description": "Key rate limit reached" }, "502": { "description": "Upstream unavailable; write may have an unconfirmed outcome" }, "503": { "description": "Storage or audit unavailable" } } } }, "/bexio/2.0/payment_type": { "get": { "operationId": "get_payment_type", "summary": "reference.read", "security": [ { "GatewayKey": [] } ], "x-required-scope": "reference.read", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer" } }, { "name": "offset", "in": "query", "schema": { "type": "integer" } }, { "name": "order_by", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Bexio JSON response" }, "201": { "description": "Created" }, "400": { "description": "Invalid or disallowed payload" }, "401": { "description": "Invalid, expired or revoked key" }, "403": { "description": "Denied by gateway policy" }, "404": { "description": "Not accessible" }, "409": { "description": "Idempotency conflict or unconfirmed write" }, "429": { "description": "Key rate limit reached" }, "502": { "description": "Upstream unavailable; write may have an unconfirmed outcome" }, "503": { "description": "Storage or audit unavailable" } } } }, "/v1/me": { "get": { "operationId": "me", "summary": "Inspect the current key policy", "security": [ { "GatewayKey": [] } ], "responses": { "200": { "description": "Identity, scopes and limits" }, "401": { "description": "Invalid key" } } } }, "/bexio/3.0/users": { "get": { "operationId": "get_3_users", "summary": "reference.read", "security": [ { "GatewayKey": [] } ], "x-required-scope": "reference.read", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer" } }, { "name": "offset", "in": "query", "schema": { "type": "integer" } }, { "name": "order_by", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Bexio JSON response" }, "201": { "description": "Created" }, "400": { "description": "Invalid or disallowed payload" }, "401": { "description": "Invalid, expired or revoked key" }, "403": { "description": "Denied by gateway policy" }, "404": { "description": "Not accessible" }, "409": { "description": "Idempotency conflict or unconfirmed write" }, "429": { "description": "Key rate limit reached" }, "502": { "description": "Upstream unavailable; write may have an unconfirmed outcome" }, "503": { "description": "Storage or audit unavailable" } } } }, "/bexio/3.0/users/{id}": { "get": { "operationId": "get_3_users_id", "summary": "reference.read", "security": [ { "GatewayKey": [] } ], "x-required-scope": "reference.read", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "limit", "in": "query", "schema": { "type": "integer" } }, { "name": "offset", "in": "query", "schema": { "type": "integer" } }, { "name": "order_by", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Bexio JSON response" }, "201": { "description": "Created" }, "400": { "description": "Invalid or disallowed payload" }, "401": { "description": "Invalid, expired or revoked key" }, "403": { "description": "Denied by gateway policy" }, "404": { "description": "Not accessible" }, "409": { "description": "Idempotency conflict or unconfirmed write" }, "429": { "description": "Key rate limit reached" }, "502": { "description": "Upstream unavailable; write may have an unconfirmed outcome" }, "503": { "description": "Storage or audit unavailable" } } } }, "/bexio/3.0/currencies": { "get": { "operationId": "get_3_currencies", "summary": "reference.read", "security": [ { "GatewayKey": [] } ], "x-required-scope": "reference.read", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer" } }, { "name": "offset", "in": "query", "schema": { "type": "integer" } }, { "name": "order_by", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Bexio JSON response" }, "201": { "description": "Created" }, "400": { "description": "Invalid or disallowed payload" }, "401": { "description": "Invalid, expired or revoked key" }, "403": { "description": "Denied by gateway policy" }, "404": { "description": "Not accessible" }, "409": { "description": "Idempotency conflict or unconfirmed write" }, "429": { "description": "Key rate limit reached" }, "502": { "description": "Upstream unavailable; write may have an unconfirmed outcome" }, "503": { "description": "Storage or audit unavailable" } } } }, "/bexio/3.0/currencies/{id}": { "get": { "operationId": "get_3_currencies_id", "summary": "reference.read", "security": [ { "GatewayKey": [] } ], "x-required-scope": "reference.read", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "limit", "in": "query", "schema": { "type": "integer" } }, { "name": "offset", "in": "query", "schema": { "type": "integer" } }, { "name": "order_by", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Bexio JSON response" }, "201": { "description": "Created" }, "400": { "description": "Invalid or disallowed payload" }, "401": { "description": "Invalid, expired or revoked key" }, "403": { "description": "Denied by gateway policy" }, "404": { "description": "Not accessible" }, "409": { "description": "Idempotency conflict or unconfirmed write" }, "429": { "description": "Key rate limit reached" }, "502": { "description": "Upstream unavailable; write may have an unconfirmed outcome" }, "503": { "description": "Storage or audit unavailable" } } } }, "/bexio/3.0/taxes": { "get": { "operationId": "get_3_taxes", "summary": "reference.read", "security": [ { "GatewayKey": [] } ], "x-required-scope": "reference.read", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer" } }, { "name": "offset", "in": "query", "schema": { "type": "integer" } }, { "name": "order_by", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Bexio JSON response" }, "201": { "description": "Created" }, "400": { "description": "Invalid or disallowed payload" }, "401": { "description": "Invalid, expired or revoked key" }, "403": { "description": "Denied by gateway policy" }, "404": { "description": "Not accessible" }, "409": { "description": "Idempotency conflict or unconfirmed write" }, "429": { "description": "Key rate limit reached" }, "502": { "description": "Upstream unavailable; write may have an unconfirmed outcome" }, "503": { "description": "Storage or audit unavailable" } } } }, "/bexio/3.0/taxes/{id}": { "get": { "operationId": "get_3_taxes_id", "summary": "reference.read", "security": [ { "GatewayKey": [] } ], "x-required-scope": "reference.read", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "limit", "in": "query", "schema": { "type": "integer" } }, { "name": "offset", "in": "query", "schema": { "type": "integer" } }, { "name": "order_by", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Bexio JSON response" }, "201": { "description": "Created" }, "400": { "description": "Invalid or disallowed payload" }, "401": { "description": "Invalid, expired or revoked key" }, "403": { "description": "Denied by gateway policy" }, "404": { "description": "Not accessible" }, "409": { "description": "Idempotency conflict or unconfirmed write" }, "429": { "description": "Key rate limit reached" }, "502": { "description": "Upstream unavailable; write may have an unconfirmed outcome" }, "503": { "description": "Storage or audit unavailable" } } } }, "/bexio/3.0/users/me": { "get": { "operationId": "get_authenticated_bexio_user", "summary": "reference.read", "security": [ { "GatewayKey": [] } ], "x-required-scope": "reference.read", "responses": { "200": { "description": "Authenticated Bexio user" }, "401": { "description": "Unauthorized" } } } } } }