Adviser

Client Income

Income sources, payday plan and safe-to-spend.

Behind its own scope. Knowing what a client EARNS is a different disclosure from knowing what they spend, and a client who shared spending categories did not thereby agree to share their salary — so full_transactions does not imply it and grants predating migration 096 are excluded by construction.

Read-only: mirrors the arithmetic the client sees in the app so an adviser can never quote a different figure back to them.

get/api/adviser/clients/{user_id}/income

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}/income
  • Auth: HTTP bearer

Path parameters

user_idstring uuid required

Response

Successful Response

user_idstring required
client_labelstring required
monthly_incomenumber nullable required
detected_payday_dayinteger nullable required
next_paydaystring date nullable required
days_until_paydayinteger nullable required
monthly_income_from_sourcesnumber required
total_allocatednumber required
spent_so_far_this_monthnumber required
safe_to_spend_remainingnumber nullable required

Changes

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