Client - Books
A client's OWN accounting software: the organisation their record is bound to, and the invoices, contacts, bank accounts and profit and loss inside it. Distinct from the client's customer record in the practice's books, which is what the practice invoices them against. Organisations are always read live from the platform rather than a stored list, one client may be bound to one organisation and one organisation to one client, and platforms that offer no profit and loss report say so with a 400 rather than an empty report.
-
GET Get Books LinkReturns the organisation this client's record is bound to in their own accounting software, or 404 when they are not connected to any. The connection .../tenants/{tenant}/clients/{clientCode}/books/link
-
POST Link BooksBinds the client to one organisation reachable through an existing connection. The organisation is confirmed with the platform before the link is save.../tenants/{tenant}/clients/{clientCode}/books/link
-
DELETE Unlink BooksRemoves the client's binding. The underlying connection is left alone — other clients may reach their own organisations through the same one./tenants/{tenant}/clients/{clientCode}/books/link
-
GET List Available OrganisationsLists the organisations the practice's existing accounting connections can reach and that are free to link, asked of each platform live. Excludes the .../tenants/{tenant}/clients/{clientCode}/books/available-organisations
-
POST Connect Client BooksStarts a fresh authorisation aimed at this client's own accounting software and returns the connection, including the authorisation URL to send the br.../tenants/{tenant}/clients/{clientCode}/books/connect
-
GET List Books InvoicesLists the sales invoices in the client's own books, most recent first. Paged like any other list: pass 'offset' and 'limit' and you get exactly that w.../tenants/{tenant}/clients/{clientCode}/books/invoices
-
GET List Books ContactsLists the contacts in the client's own books. Paged like any other list — see the invoices endpoint for what 'totalCount' being null means./tenants/{tenant}/clients/{clientCode}/books/contacts
-
GET List Books Bank AccountsLists the bank accounts in the client's own books. A null balance means the platform does not report one on this endpoint — it is not a zero balance./tenants/{tenant}/clients/{clientCode}/books/bank-accounts
-
GET List Books Chart Of AccountsLists the client's chart of accounts — every nominal code, its name, and how the platform classifies it. Paged like any other list, and this one alway.../tenants/{tenant}/clients/{clientCode}/books/chart-of-accounts
-
GET Get Books Profit And LossRuns a profit and loss report over the client's own books for the period given. Name the period as a 'dateRange' (a PresetDateRange), as dateRange=Cus.../tenants/{tenant}/clients/{clientCode}/books/profit-and-loss
-
GET Get Books Trial BalanceRuns a trial balance over the client's own books — one signed balance per nominal account, positive for debit and negative for credit, in the platform.../tenants/{tenant}/clients/{clientCode}/books/trial-balance
-
GET Get Books Balance SheetRuns a balance sheet over the client's own books as at one date — 'asAt', defaulting to today. A statement of position, so unlike the profit and loss .../tenants/{tenant}/clients/{clientCode}/books/balance-sheet
-
GET Get Bookkeeping LinkReturns the organisation this client's record is bound to at the practice's bookkeeping health provider, or 404 when they are not linked. The connecti.../tenants/{tenant}/clients/{clientCode}/books/bookkeeping/link
-
POST Link BookkeepingBinds the client to one organisation at the practice's bookkeeping health provider. The organisation is confirmed with the provider before the link is.../tenants/{tenant}/clients/{clientCode}/books/bookkeeping/link
-
DELETE Unlink BookkeepingRemoves the client's binding. The underlying connection is left alone — other clients reach their own organisations through the same one./tenants/{tenant}/clients/{clientCode}/books/bookkeeping/link
-
GET List Available Bookkeeping OrganisationsLists the organisations the practice's bookkeeping health connection can score and that are free to link, asked of the provider live. Excludes any org.../tenants/{tenant}/clients/{clientCode}/books/bookkeeping/available-organisations
-
GET Get Bookkeeping HealthReturns the provider's scoring of the client's books — health percentage, issue count and value at risk per time bucket, plus activity figures — quali.../tenants/{tenant}/clients/{clientCode}/books/bookkeeping/health