{"openapi":"3.1.0","info":{"title":"Buildium Accounting (BYOK) API","version":"0.1.0","description":"Buildium Accounting (BYOK) lets an AI assistant read your own Buildium Accounting data through the Buildium Accounting API with a key you supply (API key client ID). Read-only: 5 tools (list_gl_accounts, list_gl_account_balances, list_bank_accounts, list_credit_card_accounts, list_budgets). The BYOK key travels with each request, is used for that one call only and is never stored, logged or...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-buildium-accounting.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-buildium-accounting/docs"},"termsOfService":"https://connectorbay.com/byok-buildium-accounting/terms"},"servers":[{"url":"https://byok-buildium-accounting.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-buildium-accounting/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_gl_accounts":{"post":{"operationId":"list_gl_accounts","summary":"List general ledger accounts with number, name, type, sub type, bank-account flag, active flag and parent account. Use f","description":"List general ledger accounts with number, name, type, sub type, bank-account flag, active flag and parent account. Use for \"What is in my Buildium chart of accounts\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"account_type":{"anyOf":[{"enum":["Asset","Liability","Equity","Income","Expense"],"type":"string"},{"type":"null"}],"default":null,"description":"Only this type: Asset, Liability, Equity, Income or Expense.","title":"Account Type"},"limit":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"How many records to return (1 to 1000; the provider default is 50).","title":"Limit"},"offset":{"anyOf":[{"maximum":1000000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Zero-based position of the first record to return, for paging.","title":"Offset"}},"title":"list_gl_accountsArguments","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_gl_account_balances":{"post":{"operationId":"list_gl_account_balances","summary":"List general ledger account balances as of a date on a cash or accrual basis, optionally for one rental, association or ","description":"List general ledger account balances as of a date on a cash or accrual basis, optionally for one rental, association or owner entity. Use for \"What were my Buildium GL balances at the end of last month on a cash basis\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"accounting_basis":{"description":"Cash or Accrual.","enum":["Accrual","Cash"],"title":"Accounting Basis","type":"string"},"as_of_date":{"description":"Balances up to and including this date, YYYY-MM-DD.","maxLength":10,"title":"As Of Date","type":"string"},"entity_type":{"anyOf":[{"enum":["Rental","RentalOwner","Association"],"type":"string"},{"type":"null"}],"default":null,"description":"What entity_id refers to: Association, Rental or RentalOwner.","title":"Entity Type"},"entity_id":{"anyOf":[{"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"Only transactions of this entity id.","title":"Entity Id"},"limit":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"How many records to return (1 to 1000; the provider default is 50).","title":"Limit"},"offset":{"anyOf":[{"maximum":1000000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Zero-based position of the first record to return, for paging.","title":"Offset"}},"required":["accounting_basis","as_of_date"],"title":"list_gl_account_balancesArguments","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_bank_accounts":{"post":{"operationId":"list_bank_accounts","summary":"List bank accounts with name, type, active flag, balance and linked GL account (account and routing numbers are not retu","description":"List bank accounts with name, type, active flag, balance and linked GL account (account and routing numbers are not returned). Use for \"What bank accounts does my Buildium company have and what are their balances\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"status":{"anyOf":[{"enum":["Active","InActive"],"type":"string"},{"type":"null"}],"default":null,"description":"Active or InActive (default both).","title":"Status"},"bank_name":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Part of the bank account name.","title":"Bank Name"},"limit":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"How many records to return (1 to 1000; the provider default is 50).","title":"Limit"},"offset":{"anyOf":[{"maximum":1000000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Zero-based position of the first record to return, for paging.","title":"Offset"}},"title":"list_bank_accountsArguments","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_credit_card_accounts":{"post":{"operationId":"list_credit_card_accounts","summary":"List credit card accounts with name, payment due day, credit limit, active flag and balance. Use for \"Which credit card ","description":"List credit card accounts with name, payment due day, credit limit, active flag and balance. Use for \"Which credit card accounts are set up in Buildium\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"status":{"anyOf":[{"enum":["Active","InActive"],"type":"string"},{"type":"null"}],"default":null,"description":"Active or InActive (default both).","title":"Status"},"name":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Part of the account name.","title":"Name"}},"title":"list_credit_card_accountsArguments","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_budgets":{"post":{"operationId":"list_budgets","summary":"List budgets with name, start and end date and the rental or association they belong to (line items are left out). Use f","description":"List budgets with name, start and end date and the rental or association they belong to (line items are left out). Use for \"Which budgets exist in Buildium for fiscal year 2026\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"fiscal_year":{"anyOf":[{"maximum":2200,"minimum":1900,"type":"integer"},{"type":"null"}],"default":null,"description":"Only budgets that end in this fiscal year, for example 2026.","title":"Fiscal Year"},"name":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Part of the budget name.","title":"Name"},"property_id":{"anyOf":[{"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"Only budgets of this rental or association id.","title":"Property Id"},"limit":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"How many records to return (1 to 1000; the provider default is 50).","title":"Limit"},"offset":{"anyOf":[{"maximum":1000000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Zero-based position of the first record to return, for paging.","title":"Offset"}},"title":"list_budgetsArguments","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}}}}