Welcome to the Cybooks API
Welcome to the Cybooks API
The Cybooks Public API gives your own software access to a company's books in Cybooks: customers, vendors, invoices, bills, banking, the ledger, projects and more. Every operation is listed in the API Reference.
The base URL is https://api.cybooks.com.cy/v1.
Quick start
- In Cybooks, open the company the integration will access and go to Settings > API.
- Select Create API key, give it a name and choose only the permissions it needs. Copy the client ID and client secret.
- Request an access token with the scopes you need:
curl --request POST 'https://api.cybooks.com.cy/oauth/token' \
--user "${CYBOOKS_CLIENT_ID}:${CYBOOKS_CLIENT_SECRET}" \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'grant_type=client_credentials' \
--data-urlencode 'scope=customers:read'- Call the API with the token:
curl 'https://api.cybooks.com.cy/v1/customers?per_page=25' \
--header "Authorization: Bearer ${CYBOOKS_ACCESS_TOKEN}" \
--header 'Accept: application/json'Always send a scope when you request a token. A token without the scope an endpoint needs is refused with 403 Forbidden. The Authentication guide covers scopes, errors, rate limits, idempotent writes and key rotation.
Guides
- Authentication: API keys, access tokens, errors and rate limits.
- Webhooks: get notified when something changes, and verify the signature.
- Event types: every event Cybooks sends.
- Invoices: the income account on each invoice and credit-note line (
account_idoraccount_code) and what approval needs. - Invoice numbering: when invoices, credit notes and vendor credits get their number.
- Dividends: draft, declare and pay dividends, with SDC and GeSY withholding, by matching the bank line.
- Correcting approved bills: change an approved bill's supplier, accounts, tax rules or IP Box fields, and read the preview.
- Settling bills from bank lines: a transfer and its fee line, a small difference, or a line in another currency against one bill; one line over several bills or invoices.
- Owner's Money: book a director's or shareholder's private expense paid by the company to their personal account, move a line already categorized, and read the balances.
- Bills: the account on each bill, inbox and expense-claim line (
account_idoraccount_code;tax_rule_idon expense-claim lines), payable and expense-flow bills, matching a bill to its bank line, delete versus void, the day a void's reversal posts on and moving it once voided, and taking back a Pay bills "paid already" mark before a void. - Fixed assets: the asset register, a useful life in years, months or % a year, registering assets owned before the books started, and month-by-month catch-up depreciation.
- Invoice payments: record a customer payment on an invoice, preview the journal, and settle a short payment where the customer withheld tax at source (a withholding tax receivable).
- Employees: read employees, their contract and their pay; salary figures need
view_payroll. - Bank transactions: check a month against the statement, short answers to writes (
Prefer: return=minimal), categorize a bank line, change a line that is already booked (with the undo the 409 names), money back from a supplier or to a customer, and exclude, include or delete lines in bulk.
Build with AI
- Claude: the same operations power the Cybooks MCP server (in beta). Connect Claude from Integrations in Cybooks and ask about your numbers, or draft an invoice, in your own words.
- Your own agent: llms.txt lists every page of these docs in Markdown and links the OpenAPI definition. Add
.mdto any page URL to get its Markdown.
Help
Include the X-Request-Id from the response when you contact Cybooks support.
Updated 5 days ago
Did this page help you?
