API Docs / Operations / Client - Books / Get Bookkeeping Health

Get Bookkeeping Health

GET /tenants/{tenant}/clients/{clientCode}/books/bookkeeping/health

Returns the provider's scoring of the client's books — health percentage, issue count and value at risk per time bucket, plus activity figures — quality and activity combined in one response so a bucket selector needs no further calls. The bucket names are the provider's own strings and the two lists' bucket sets differ; join by duration and expect gaps. Served through a short server-side cache — 'retrievedAt' says when the figures were actually fetched.

Parameters

NameTypeDescription
tenant* path string

The Tenant.Code

The Tenant.Code

clientCode* path string

Responses

400 Bad Request
401 Unauthorized – Invalid or missing API key
404 Not Found