API Docs / Schemas / BookkeepingHealthDto

BookkeepingHealthDto

Everything the bookkeeping-health provider reports about a client's books — quality and
activity, every time bucket the provider returned. The bucket selector in the UI switches
between buckets client-side; nothing here is windowed.

Properties

Name Type Description
organisationNamestring

The linked organisation's name.

The linked organisation's name.

retrievedAtstring

When the figures were fetched from the provider. Server-side caching means this can be up to
ten minutes ago — show it so nobody reads the numbers as live.

When the figures were fetched from the provider. Server-side caching means this can be up to
ten minutes ago — show it so nobody reads the numbers as live.

qualityarray of BookkeepingQualityPeriodDto

Quality scoring per time bucket, in the provider's order.

Quality scoring per time bucket, in the provider's order.

activityarray of BookkeepingActivityPeriodDto

Activity figures per time bucket, in the provider's order. Not the same bucket set as
SodiumHQ.DTOs.BookkeepingHealth.BookkeepingHealthDto.Quality — join by duration and expect gaps.

Activity figures per time bucket, in the provider's order. Not the same bucket set as
SodiumHQ.DTOs.BookkeepingHealth.BookkeepingHealthDto.Quality — join by duration and expect gaps.

JSON Example

{
  "organisationName": "string",
  "retrievedAt": "2024-01-01T00:00:00Z",
  "quality": [
    {
      "duration": "...",
      "healthIndicator": "...",
      "totalIssues": "...",
      "potentialErrors": "..."
    }
  ],
  "activity": [
    {
      "duration": "...",
      "turnover": "...",
      "transactionCount": "...",
      "invoices": "...",
      "bills": "..."
    }
  ]
}

Used By Operations