{"openapi":"3.1.0","info":{"title":"Clockify Invoicing (BYOK) API","version":"0.1.0","description":"Clockify Invoicing (BYOK) lets an AI assistant read your own Clockify Invoicing data through the Clockify Invoicing API with a key you supply (API key). Read-only: 6 tools (list_invoices, get_invoice, list_invoice_payments, get_invoice_settings, list_expense_categories, list_custom_fields). 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-clockify-invoicing.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-clockify-invoicing/docs"},"termsOfService":"https://connectorbay.com/byok-clockify-invoicing/terms"},"servers":[{"url":"https://byok-clockify-invoicing.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-clockify-invoicing/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 with number, client, status, issue and due date, amount, paid and balance. Amounts are in the smallest cur","description":"List invoices with number, client, status, issue and due date, amount, paid and balance. Amounts are in the smallest currency unit (cents). Invoicing is a paid Clockify feature. Use for \"Which Clockify invoices are overdue\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"workspace_id":{"description":"Workspace id (from the Clockify connector's list_workspaces).","maxLength":200,"title":"Workspace Id","type":"string"},"statuses":{"anyOf":[{"enum":["UNSENT","SENT","PAID","PARTIALLY_PAID","VOID","OVERDUE"],"type":"string"},{"type":"null"}],"default":null,"description":"Only invoices with this status.","title":"Statuses"},"sort_column":{"anyOf":[{"enum":["ID","CLIENT","DUE_ON","ISSUE_DATE","AMOUNT","BALANCE"],"type":"string"},{"type":"null"}],"default":"ID","description":"Sort by ID, CLIENT, DUE_ON, ISSUE_DATE, AMOUNT or BALANCE.","title":"Sort Column"},"sort_order":{"anyOf":[{"enum":["ASCENDING","DESCENDING"],"type":"string"},{"type":"null"}],"default":"ASCENDING","description":"ASCENDING or DESCENDING.","title":"Sort Order"},"page_size":{"anyOf":[{"maximum":200,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"How many results per page (default 50).","title":"Page Size"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"}},"required":["workspace_id"],"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 with client, currency, status, dates, subtotal, tax, discount, amount, paid and balance. Amounts are in ","description":"Get one invoice with client, currency, status, dates, subtotal, tax, discount, amount, paid and balance. Amounts are in the smallest currency unit (cents). Invoicing is a paid Clockify feature. Use for \"Show Clockify invoice 5b715612b079875110794444\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"workspace_id":{"description":"Workspace id (from the Clockify connector's list_workspaces).","maxLength":200,"title":"Workspace Id","type":"string"},"invoice_id":{"description":"Invoice id (from list_invoices).","maxLength":200,"title":"Invoice Id","type":"string"}},"required":["workspace_id","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_invoice_payments":{"post":{"operationId":"list_invoice_payments","summary":"List the payments recorded on one invoice with amount and date. Amounts are in the smallest currency unit (cents). Invoi","description":"List the payments recorded on one invoice with amount and date. Amounts are in the smallest currency unit (cents). Invoicing is a paid Clockify feature. Use for \"What payments were made on Clockify invoice 5b715612b079875110794444\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"workspace_id":{"description":"Workspace id (from the Clockify connector's list_workspaces).","maxLength":200,"title":"Workspace Id","type":"string"},"invoice_id":{"description":"Invoice id (from list_invoices).","maxLength":200,"title":"Invoice Id","type":"string"},"page_size":{"anyOf":[{"maximum":200,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"How many results per page (default 50).","title":"Page Size"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"}},"required":["workspace_id","invoice_id"],"title":"list_invoice_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/get_invoice_settings":{"post":{"operationId":"get_invoice_settings","summary":"Show the workspace's invoice defaults: due days, tax rates and tax type, default subject and item type. Use for \"What ar","description":"Show the workspace's invoice defaults: due days, tax rates and tax type, default subject and item type. Use for \"What are our default Clockify invoice settings\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"workspace_id":{"description":"Workspace id (from the Clockify connector's list_workspaces).","maxLength":200,"title":"Workspace Id","type":"string"}},"required":["workspace_id"],"title":"get_invoice_settingsArguments","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_expense_categories":{"post":{"operationId":"list_expense_categories","summary":"List expense categories with unit, fixed price per unit (cents) and archived flag. Use for \"What expense categories exis","description":"List expense categories with unit, fixed price per unit (cents) and archived flag. Use for \"What expense categories exist in Clockify\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"workspace_id":{"description":"Workspace id (from the Clockify connector's list_workspaces).","maxLength":200,"title":"Workspace Id","type":"string"},"name":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only categories whose name contains this text.","title":"Name"},"archived":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"True for archived categories only, false for active ones; leave out for both.","title":"Archived"},"sort_order":{"anyOf":[{"enum":["ASCENDING","DESCENDING"],"type":"string"},{"type":"null"}],"default":"ASCENDING","description":"ASCENDING or DESCENDING by name.","title":"Sort Order"},"page_size":{"anyOf":[{"maximum":200,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"How many results per page (default 50).","title":"Page Size"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"}},"required":["workspace_id"],"title":"list_expense_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_custom_fields":{"post":{"operationId":"list_custom_fields","summary":"List custom fields defined in the workspace with name, type, entity (time entry, user or project), status and whether re","description":"List custom fields defined in the workspace with name, type, entity (time entry, user or project), status and whether required. Use for \"What custom fields are defined in Clockify\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"workspace_id":{"description":"Workspace id (from the Clockify connector's list_workspaces).","maxLength":200,"title":"Workspace Id","type":"string"},"name":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only fields whose name contains this text.","title":"Name"},"status":{"anyOf":[{"enum":["INACTIVE","VISIBLE","INVISIBLE"],"type":"string"},{"type":"null"}],"default":null,"description":"Only fields with this status.","title":"Status"},"entity_type":{"anyOf":[{"maxLength":30,"type":"string"},{"type":"null"}],"default":null,"description":"Only fields of this entity type, for example TIMEENTRY.","title":"Entity Type"}},"required":["workspace_id"],"title":"list_custom_fieldsArguments","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}}}}