Dext

App · 3 actions

Read your practice's clients from Dext's Data Health & Insights: health scores, alert levels, key metrics and activity.

Actions

ActionWhat it does
Get clientGet one client's details: its organisation, VAT details, health score, debtor metrics and bank reconciliation counts.
Get client activityGet a client's rolling annual totals and monthly and quarterly averages: turnover and counts of sales, bills, credits, journals and bank transactions, with their changes.
List clientsList every client your token can see, with its health score and alert level.

Get client

Get one client's details: its organisation, VAT details, health score, debtor metrics and bank reconciliation counts.

Inputs

Clientclient_idtextRequired
The client to read.

Outputs

dataobject
The response from Dext.
Example output
{
  "data": {
    "alertLevel": "example",
    "bankReconciliation": {
      "bankAccounts": 1,
      "manualFeeds": 1
    },
    "companyNumber": "example",
    "healthScore": 1,
    "hmrcStatus": "example",
    "id": "example",
    "metrics": {
      "avgDebtorDays": 1,
      "debtorBalance": 1,
      "oneDayImpact": 1
    },
    "name": "example",
    "organisationType": "example",
    "practiceCode": "example",
    "providerId": "example",
    "vatDetails": {
      "number": "example",
      "periodEnd": "example",
      "periodStart": "example",
      "reportingCycle": "example",
      "scheme": "example"
    },
    "yearEnd": "example"
  }
}

Get client activity

Get a client's rolling annual totals and monthly and quarterly averages: turnover and counts of sales, bills, credits, journals and bank transactions, with their changes.

Inputs

Clientclient_idtextRequired
The client to read.

Outputs

dataobject
The response from Dext.
Example output
{
  "data": {
    "annual": {
      "bankTransactionsChangeYoY": 1,
      "bankTransactionsCount": 1,
      "billsChangeYoY": 1,
      "billsCount": 1,
      "creditsChangeYoY": 1,
      "creditsCount": 1,
      "end": "example",
      "manualJournalsChangeYoY": 1,
      "manualJournalsCount": 1,
      "salesChangeYoY": 1,
      "salesCount": 1,
      "start": "example",
      "totalChangeYoY": 1,
      "totalCount": 1,
      "turnover": 1,
      "turnoverChangeYoY": 1
    },
    "monthlyAverage": {
      "bankTransactionsChangeYoY": 1,
      "bankTransactionsCount": 1,
      "billsChangeYoY": 1,
      "billsCount": 1,
      "creditsChangeYoY": 1,
      "creditsCount": 1,
      "end": "example",
      "manualJournalsChangeYoY": 1,
      "manualJournalsCount": 1,
      "salesChangeYoY": 1,
      "salesCount": 1,
      "start": "example",
      "totalChangeYoY": 1,
      "totalCount": 1,
      "turnover": 1,
      "turnoverChangeYoY": 1
    },
    "quarterlyAverage": {
      "bankTransactionsChangeMoM": 1,
      "bankTransactionsChangeYoY": 1,
      "bankTransactionsCount": 1,
      "billsChangeMoM": 1,
      "billsChangeYoY": 1,
      "billsCount": 1,
      "creditsChangeMoM": 1,
      "creditsChangeYoY": 1,
      "creditsCount": 1,
      "end": "example",
      "manualJournalsChangeMoM": 1,
      "manualJournalsChangeYoY": 1,
      "manualJournalsCount": 1,
      "salesChangeMoM": 1,
      "salesChangeYoY": 1,
      "salesCount": 1,
      "start": "example",
      "totalChangeMoM": 1,
      "totalChangeYoY": 1,
      "totalCount": 1,
      "turnover": 1,
      "turnoverChangeMoM": 1,
      "turnoverChangeYoY": 1
    }
  }
}

List clients

List every client your token can see, with its health score and alert level.

Inputs

None.

Outputs

datalist
The response from Dext.
Example output
{
  "data": [
    {
      "alertLevel": "example",
      "healthScore": 1,
      "id": "example",
      "name": "example",
      "practiceCode": "example",
      "providerId": "example"
    }
  ]
}

On this page