{"openapi":"3.1.0","info":{"title":"Bexio (BYOK) API","version":"0.1.0","description":"Bexio (BYOK) lets an AI assistant read your own Bexio data through the Bexio API with a key you supply (Bexio personal access token). Read-only: 11 tools (list_articles, get_article, list_stock_locations, list_stock_areas, list_orders, list_deliveries, list_invoices, list_purchase_orders, get_purchase_order, list_bills, list_units). The BYOK key travels with each request, is used for that one...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-bexio.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-bexio/docs"},"termsOfService":"https://connectorbay.com/byok-bexio/terms"},"servers":[{"url":"https://byok-bexio.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-bexio/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/list_articles":{"post":{"operationId":"list_articles","summary":"List articles (products) with codes, prices and stock figures: on hand, minimum, reserved, available and on order. Use f","description":"List articles (products) with codes, prices and stock figures: on hand, minimum, reserved, available and on order. Use for \"Which Bexio articles are below their minimum stock\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"order_by":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":"id","description":"Sort field: id or intern_name; append _desc for descending.","title":"Order By"},"limit":{"anyOf":[{"maximum":2000,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"How many records to return (1 to 2000; the service default is 500; this connector shows at most 50 per answer).","title":"Limit"},"offset":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Skip this many records, for paging.","title":"Offset"}},"title":"list_articlesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_article":{"post":{"operationId":"get_article","summary":"Get one article by ID with codes, prices, stock figures, dimensions and remarks. Use for \"Show Bexio article 5\".","description":"Get one article by ID with codes, prices, stock figures, dimensions and remarks. Use for \"Show Bexio article 5\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"article_id":{"description":"Numeric article ID.","minimum":1,"title":"Article Id","type":"integer"}},"required":["article_id"],"title":"get_articleArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_stock_locations":{"post":{"operationId":"list_stock_locations","summary":"List stock locations (warehouses) with ID and name. Use for \"What stock locations exist in Bexio\".","description":"List stock locations (warehouses) with ID and name. Use for \"What stock locations exist in Bexio\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"order_by":{"anyOf":[{"maxLength":20,"type":"string"},{"type":"null"}],"default":"id","description":"Sort field: id or name.","title":"Order By"},"limit":{"anyOf":[{"maximum":2000,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"How many records to return (1 to 2000; the service default is 500; this connector shows at most 50 per answer).","title":"Limit"},"offset":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Skip this many records, for paging.","title":"Offset"}},"title":"list_stock_locationsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_stock_areas":{"post":{"operationId":"list_stock_areas","summary":"List stock areas (places within a location) with ID and name. Use for \"What stock areas are in Bexio\".","description":"List stock areas (places within a location) with ID and name. Use for \"What stock areas are in Bexio\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"order_by":{"anyOf":[{"maxLength":20,"type":"string"},{"type":"null"}],"default":"id","description":"Sort field: id or name.","title":"Order By"},"limit":{"anyOf":[{"maximum":2000,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"How many records to return (1 to 2000; the service default is 500; this connector shows at most 50 per answer).","title":"Limit"},"offset":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Skip this many records, for paging.","title":"Offset"}},"title":"list_stock_areasArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_orders":{"post":{"operationId":"list_orders","summary":"List sales orders with document number, title, customer contact ID, status, totals and last update. Use for \"Which Bexio","description":"List sales orders with document number, title, customer contact ID, status, totals and last update. Use for \"Which Bexio sales orders were updated recently\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"order_by":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":"id","description":"Sort field: id, total, total_net, total_gross or updated_at; append _desc for descending.","title":"Order By"},"limit":{"anyOf":[{"maximum":2000,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"How many records to return (1 to 2000; the service default is 500; this connector shows at most 50 per answer).","title":"Limit"},"offset":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Skip this many records, for paging.","title":"Offset"}},"title":"list_ordersArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_deliveries":{"post":{"operationId":"list_deliveries","summary":"List delivery notes with document number, title, contact ID, status and totals. Use for \"Which Bexio deliveries have bee","description":"List delivery notes with document number, title, contact ID, status and totals. Use for \"Which Bexio deliveries have been issued\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"order_by":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":"id","description":"Sort field: id, total, total_net, total_gross or updated_at; append _desc for descending.","title":"Order By"},"limit":{"anyOf":[{"maximum":2000,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"How many records to return (1 to 2000; the service default is 500; this connector shows at most 50 per answer).","title":"Limit"},"offset":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Skip this many records, for paging.","title":"Offset"}},"title":"list_deliveriesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_invoices":{"post":{"operationId":"list_invoices","summary":"List invoices with document number, title, contact ID, status, totals, received payments and remaining amount. Use for \"","description":"List invoices with document number, title, contact ID, status, totals, received payments and remaining amount. Use for \"Which Bexio invoices still have an open balance\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"order_by":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":"id","description":"Sort field: id, total, total_net, total_gross or updated_at; append _desc for descending.","title":"Order By"},"limit":{"anyOf":[{"maximum":2000,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"How many records to return (1 to 2000; the service default is 500; this connector shows at most 50 per answer).","title":"Limit"},"offset":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Skip this many records, for paging.","title":"Offset"}},"title":"list_invoicesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_purchase_orders":{"post":{"operationId":"list_purchase_orders","summary":"List purchase orders (article orders to suppliers) with document number, title, contact, status and dates. Use for \"Whic","description":"List purchase orders (article orders to suppliers) with document number, title, contact, status and dates. Use for \"Which Bexio purchase orders are open\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"order_by":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":"id","description":"Sort field: id, total, total_net, total_gross or updated_at; append _desc for descending.","title":"Order By"},"limit":{"anyOf":[{"maximum":2000,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"How many records to return (1 to 2000; the service default is 500; this connector shows at most 50 per answer).","title":"Limit"},"offset":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Skip this many records, for paging.","title":"Offset"}},"title":"list_purchase_ordersArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_purchase_order":{"post":{"operationId":"get_purchase_order","summary":"Get one purchase order by ID. Use for \"Show Bexio purchase order 12\".","description":"Get one purchase order by ID. Use for \"Show Bexio purchase order 12\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"purchase_order_id":{"description":"Numeric purchase order ID.","minimum":1,"title":"Purchase Order Id","type":"integer"}},"required":["purchase_order_id"],"title":"get_purchase_orderArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_bills":{"post":{"operationId":"list_bills","summary":"List supplier bills (purchase invoices) with vendor, status, amounts, bill and due dates; filter by status, dates and ve","description":"List supplier bills (purchase invoices) with vendor, status, amounts, bill and due dates; filter by status, dates and vendor. Use for \"Which Bexio supplier bills are overdue\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"status":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"Bill status filter: DRAFTS, PAID or OVERDUE (upper case).","title":"Status"},"vendor":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Vendor name, text contained in the vendor's name.","title":"Vendor"},"document_no":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Document number, text contained in it.","title":"Document No"},"bill_date_start":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"Earliest bill date, YYYY-MM-DD.","title":"Bill Date Start"},"bill_date_end":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"Latest bill date, YYYY-MM-DD.","title":"Bill Date End"},"due_date_start":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"Earliest due date, YYYY-MM-DD.","title":"Due Date Start"},"due_date_end":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"Latest due date, YYYY-MM-DD.","title":"Due Date End"},"sort":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Field to sort by, for example document_no.","title":"Sort"},"order":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":null,"description":"Sort order.","title":"Order"},"limit":{"anyOf":[{"maximum":500,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"Bills per page (1 to 500).","title":"Limit"},"page":{"anyOf":[{"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"}},"title":"list_billsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_units":{"post":{"operationId":"list_units","summary":"List units of measure (name and ID) used on articles. Use for \"What units can Bexio articles use\".","description":"List units of measure (name and ID) used on articles. Use for \"What units can Bexio articles use\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"limit":{"anyOf":[{"maximum":2000,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"How many records to return (1 to 2000; the service default is 500; this connector shows at most 50 per answer).","title":"Limit"},"offset":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Skip this many records, for paging.","title":"Offset"}},"title":"list_unitsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}