The dext connector reads Dext's Data Health & Insights API: a snapshot of each client's bookkeeping health and how much work their books generate.
| Connector name | dext |
| Products | Records |
| Credentials | A personal Data Health API token |
| Access | Dext asks practices to contact them before using the API |
What it pulls
| Object | Contents |
|---|---|
client |
Name, practice code, organisation type, company number, health score, alert level, HMRC status, year end, VAT scheme, reporting cycle and current period, debtor balance, average debtor days, bank accounts and manual feeds |
client_activity |
One row each for the rolling year, the monthly average and the quarterly average: turnover, and counts of sales, bills, credits, manual journals and bank transactions, with the year on year changes |
Each record carries snapshot_at, the end of the run's window. The VAT number is never pulled. Client names become tokens.
Receipts and costs
Dext does not publish an API for receipts, costs or line items. To share those, export them from Dext Prepare as CSV on a schedule and point the CSV connector at the folder:
datayield connect csv --name dext-costs -o path=./dext-exports -o timestampColumn=<date column>Credentials
- In Dext, go to Practice settings → Data Health → API tokens.
- Enter a name and select Create.
- Copy the token. Dext shows it only once.
The token is personal. It reads the clients its creator can see. Deleting it in Dext stops it at once.
Connect
datayield connect dext -o token=env:DEXT_TOKENThe token is stored as a secret. See CLI reference.
Dext is not on the portal's Connect button. Paste the token into the SDK as above.
Options
| Option | Required | Meaning |
|---|---|---|
token |
yes | The Data Health API token. Stored as a secret. |
New records on each run
The API reports current values and has no change dates. Each run sends a fresh snapshot of every client, labeled with the run's period, so monthly runs build a history of how each client's books change.
Rate limits
Dext allows 60 requests a minute. The SDK makes three requests per client, and retries with a wait when Dext answers that the limit is reached.