{"openapi":"3.1.0","info":{"title":"Fakturownia (BYOK) API","version":"0.1.0","description":"Fakturownia (BYOK) lets an AI assistant read your own Fakturownia data through the Fakturownia API with a key you supply (Fakturownia API authorization code). Read-only: 9 tools (list_invoices, get_invoice, list_clients, get_client, list_products, get_product, list_payments, list_categories, list_warehouses). The BYOK key travels with each request, is used for that one call only and is never...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-fakturownia.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-fakturownia/docs"},"termsOfService":"https://connectorbay.com/byok-fakturownia/terms"},"servers":[{"url":"https://byok-fakturownia.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-fakturownia/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_invoices":{"post":{"operationId":"list_invoices","summary":"List invoices, receipts, proformas and other sales documents for a period with number, dates, buyer, totals, status and ","description":"List invoices, receipts, proformas and other sales documents for a period with number, dates, buyer, totals, status and view link. Use income=no for expense documents. Use for \"Which Fakturownia invoices were issued this month\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"account":{"description":"Your Fakturownia account subdomain: the part before .fakturownia.pl in your account address, for example 'mycompany'.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Account","type":"string"},"period":{"anyOf":[{"enum":["last_12_months","this_month","last_30_days","last_month","this_year","last_year","all","more"],"type":"string"},{"type":"null"}],"default":"this_month","description":"Period: last_12_months, this_month, last_30_days, last_month, this_year, last_year, all or more (then give date_from and date_to).","title":"Period"},"date_from":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"Start date YYYY-MM-DD, used with period=more.","title":"Date From"},"date_to":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"End date YYYY-MM-DD, used with period=more.","title":"Date To"},"client_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"description":"Only documents of this client id.","title":"Client Id"},"kind":{"anyOf":[{"maxLength":30,"type":"string"},{"type":"null"}],"default":null,"description":"Only one document kind, for example vat, proforma, bill, receipt, advance, correction, estimate.","title":"Kind"},"income":{"anyOf":[{"enum":["yes","no"],"type":"string"},{"type":"null"}],"default":null,"description":"Use 'no' to list cost (expense) documents instead of sales documents.","title":"Income"},"order":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Sort field such as number, updated_at, price_gross, issue_date, payment_to; add .desc for descending, for example issue_date.desc.","title":"Order"},"page":{"anyOf":[{"maximum":100000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"per_page":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"Records per page (1 to 100; the account default applies when omitted).","title":"Per Page"}},"required":["account"],"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/get_invoice":{"post":{"operationId":"get_invoice","summary":"Get one invoice by id with number, dates, buyer, totals, payment status and line positions. Use for \"Show Fakturownia in","description":"Get one invoice by id with number, dates, buyer, totals, payment status and line positions. Use for \"Show Fakturownia invoice 100\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"account":{"description":"Your Fakturownia account subdomain: the part before .fakturownia.pl in your account address, for example 'mycompany'.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Account","type":"string"},"invoice_id":{"description":"Invoice id from list_invoices.","title":"Invoice Id","type":"integer"}},"required":["account","invoice_id"],"title":"get_invoiceArguments","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_clients":{"post":{"operationId":"list_clients","summary":"List clients with name, tax number, city, country and kind. Optionally search by name, tax number, email or short name. ","description":"List clients with name, tax number, city, country and kind. Optionally search by name, tax number, email or short name. Use for \"Find the Fakturownia client with tax number 5252445767\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"account":{"description":"Your Fakturownia account subdomain: the part before .fakturownia.pl in your account address, for example 'mycompany'.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Account","type":"string"},"name":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Search by client name.","title":"Name"},"tax_no":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Search by tax identification number.","title":"Tax No"},"shortcut":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Search by the client's short name.","title":"Shortcut"},"page":{"anyOf":[{"maximum":100000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"per_page":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"Records per page (1 to 100; the account default applies when omitted).","title":"Per Page"}},"required":["account"],"title":"list_clientsArguments","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_client":{"post":{"operationId":"get_client","summary":"Get one client by id with name, tax number, address city and country. Use for \"Show Fakturownia client 1\".","description":"Get one client by id with name, tax number, address city and country. Use for \"Show Fakturownia client 1\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"account":{"description":"Your Fakturownia account subdomain: the part before .fakturownia.pl in your account address, for example 'mycompany'.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Account","type":"string"},"client_id":{"description":"Client id from list_clients.","title":"Client Id","type":"integer"}},"required":["account","client_id"],"title":"get_clientArguments","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_products":{"post":{"operationId":"list_products","summary":"List products and services with code, net and gross price, VAT rate and currency. With a warehouse id the stock level is","description":"List products and services with code, net and gross price, VAT rate and currency. With a warehouse id the stock level is included by the API. Use for \"What products do I sell in Fakturownia and at what price\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"account":{"description":"Your Fakturownia account subdomain: the part before .fakturownia.pl in your account address, for example 'mycompany'.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Account","type":"string"},"warehouse_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"description":"Warehouse id to include stock levels for.","title":"Warehouse Id"},"date_from":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"Only products added or changed after this date, YYYY-MM-DD.","title":"Date From"},"page":{"anyOf":[{"maximum":100000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"per_page":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"Records per page (1 to 100; the account default applies when omitted).","title":"Per Page"}},"required":["account"],"title":"list_productsArguments","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_product":{"post":{"operationId":"get_product","summary":"Get one product by id with code, price, VAT rate and currency. Use for \"Show Fakturownia product 1\".","description":"Get one product by id with code, price, VAT rate and currency. Use for \"Show Fakturownia product 1\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"account":{"description":"Your Fakturownia account subdomain: the part before .fakturownia.pl in your account address, for example 'mycompany'.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Account","type":"string"},"product_id":{"description":"Product id from list_products.","title":"Product Id","type":"integer"}},"required":["account","product_id"],"title":"get_productArguments","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_payments":{"post":{"operationId":"list_payments","summary":"List recorded payments (banking payments) with name, amount, paid flag and linked invoice id. Use for \"Which payments ar","description":"List recorded payments (banking payments) with name, amount, paid flag and linked invoice id. Use for \"Which payments are recorded in Fakturownia\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"account":{"description":"Your Fakturownia account subdomain: the part before .fakturownia.pl in your account address, for example 'mycompany'.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Account","type":"string"},"page":{"anyOf":[{"maximum":100000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"per_page":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"Records per page (1 to 100; the account default applies when omitted).","title":"Per Page"}},"required":["account"],"title":"list_paymentsArguments","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_categories":{"post":{"operationId":"list_categories","summary":"List the account's document and product categories with id and name. Use for \"What categories exist in my Fakturownia ac","description":"List the account's document and product categories with id and name. Use for \"What categories exist in my Fakturownia account\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"account":{"description":"Your Fakturownia account subdomain: the part before .fakturownia.pl in your account address, for example 'mycompany'.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Account","type":"string"}},"required":["account"],"title":"list_categoriesArguments","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_warehouses":{"post":{"operationId":"list_warehouses","summary":"List warehouses with id and name. Use for \"Which warehouses are set up in Fakturownia\".","description":"List warehouses with id and name. Use for \"Which warehouses are set up in Fakturownia\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"account":{"description":"Your Fakturownia account subdomain: the part before .fakturownia.pl in your account address, for example 'mycompany'.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Account","type":"string"}},"required":["account"],"title":"list_warehousesArguments","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}}}}