Payday

Get Payday Preview

Get a payday preview with detected payday date, timeline, and smart suggestions based on the user's spending analysis.

get/api/payday/preview/{user_id}

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/payday/preview/{user_id}
  • Auth: HTTP bearer

Path parameters

user_idstring uuid required

Response

Successful Response

detected_paydayinteger required
next_paydaystring required
days_until_paydayinteger required
monthly_incomenumber nullable required
total_allocatednumber required
remaining_after_rulesnumber required
has_databoolean required
salary_detection_statusstring
income_staleboolean
one_off_income_this_cyclenumber
incoming_this_cyclenumber

Changes

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