API Reference
Workspace Events
Read what changed in the workspace since the connecting user last checked: invoices paid, invoice payments that failed, bills added, and bank feed syncs that brought in new transactions.
Last updated 2026-11-14
Overview
GET /partners/workspace-events answers "what happened since I last checked?". COUNT remembers where each user last read up to, per partner app, so a plain call returns only the events after that point (oldest first) and moves the point forward.
Events carry ids and figures only — no names, memos, or descriptions. Read the record itself with the invoice, bill, or connection routes, passing `subjectUuid`.
Key concepts
The last-checked point
A plain call returns the events after the user's last check and remembers this check for next time. The very first check, or one after more than 30 days away, covers the last 7 days. The log keeps 30 days of events.
Reads that do not move the point
`since` (an ISO 8601 date-time, for "since Monday") and `eventTypes` read the log without moving the last-checked point. `readMarkerAdvanced` in the response says whether a call moved it.
Paging
When `hasMore` is true, call again with only `after` set to the returned `nextAfter`. The next page keeps the first page's `eventTypes` and whether it moves the point. A read with the same `after` always returns the same page.
Safe retries
Repeating a plain call within 2 minutes returns the same events again with `replayed: true`, so a retried call never loses any.
Workspace event
Attributes
eventIduuidEvent UUID.
eventTypeenumWhat happened.
One of: invoice.paid, invoice.payment_failed, bill.created, bank_feed.synced
occurredAtdatetimeWhen it happened (ISO 8601).
subjectTypeenumThe kind of record `subjectUuid` points at.
One of: invoice, bill, connection
subjectUuiduuidUUID of the invoice, bill, or bank connection.
documentNumberstringInvoice or bill number, when the event has one.
counterpartyobjectThe customer or vendor, when the event has one.
typeenumCounterparty kind.
One of: customer, vendor
uuiduuidCustomer or vendor UUID.
amountobjectThe amount, when the event has one.
decimalAmountstringAmount as a decimal string with two places.
currencystringISO currency code.
approvalStatusstringBill approval status on `bill.created`.
newTransactionCountintegerTransactions the sync brought in, on `bank_feed.synced`.
{
"eventId": "5b1e7c3a-9d2f-4a6b-8e1c-7f3d2a9b4c10",
"eventType": "invoice.paid",
"occurredAt": "2026-03-12T09:41:07.000Z",
"subjectType": "invoice",
"subjectUuid": "f6a7b8c9-d0e1-2345-fabc-456789012345",
"documentNumber": "INV-1042",
"counterparty": {
"type": "customer",
"uuid": "dfa3219e-6af8-4c53-997a-037534f63a35"
},
"amount": {
"decimalAmount": "1250.00",
"currency": "USD"
}
}Scope and permissions
Needs the `workspace:read` scope. The connecting user needs any one of `view_invoices`, `view_bills`, or `view_transactions`, and only the event types they may view are returned. The app's grant narrows it further: invoice events need `invoices:read`, `bill.created` needs `bills:read`, and `bank_feed.synced` needs `transactions:read`.MCP equivalent
COUNT_list_workspace_events.Related
Recent changes
Cash flow forecast, GST return and audit report, tax codes, workspace events, and 17 MCP tools
Documented the six partner routes the reference was missing. POST /partners/reports/cash-flow-forecast forecasts cash for the next 13 weeks, with an optional what-if scenario (customer payment delays, bill payment dates and one-off or repeating adjustments) returned as scenarioForecast. GET /partners/reports/gst-return calculates an NZ GST return without filing it, including the reconciliation that decides whether COUNT would let it file, and GET /partners/reports/gst-audit-report lists the transactions behind it, flags the ones with a GST issue, and pages 200 rows at a time. GET /partners/taxes lists the workspace tax codes and their UUIDs. GET /partners/workspace-events returns what changed since the user last checked: invoices paid, failed invoice payments, new bills and bank feed syncs. GET /partners/journal-entries/{uuid} returns one posting with every line. Taxes and workspace events are also reachable through the Practice Manager client-workspace routes. npm run check:parity now reports 186 documented routes against 186 backend routes. The MCP catalog adds COUNT_list_taxes, COUNT_list_workspace_events, COUNT_get_journal_entry, COUNT_generate_cash_flow_forecast, COUNT_get_gst_return, COUNT_get_gst_audit_report, COUNT_propose_transaction_categories, four position tools (COUNT_get_all_positions, COUNT_create_position, COUNT_update_position, COUNT_delete_position), and five firm tools for client status and client questionnaires. COUNT_delete_project is now COUNT_archive_project, and DELETE /partners/projects/{uuid} is documented as the archive it is, with its real response (result.success). Also, COUNT_get_bulk_task_status, which the server no longer registers, is removed.
