Adviser

Client Annual Review

Last twelve months against the previous twelve, with commentary.

Generated on demand and never stored: a pack is a view of the data at a moment, and a cached one would quietly disagree with the client's own app the first time a transaction was recategorised.

get/api/adviser/clients/{user_id}/annual-review

Request

  • Base URL: https://api.earmarkiq.app (the document declares no server; this is the origin it was published from)
  • URL: https://api.earmarkiq.app/api/adviser/clients/{user_id}/annual-review
  • Auth: HTTP bearer

Path parameters

user_idstring uuid required

Query parameters

as_ofstring date nullable

Produce the pack as at this date. Defaults to today. The window is the twelve COMPLETE calendar months before it, so a pack prepared for a meeting held last month still covers that meeting's year.

Response

Successful Response

user_idstring required
client_labelstring required
firm_namestring required
generated_atstring date-time required
as_ofstring date required
comparison_availableboolean required
comparison_notestring required
history_startsstring date nullable required
scopesstring[] required
disclaimerstring required

Changes

No recorded changes to this operation across all 2 revisions of this API.