Payday

Get Payday Status

Get detected payday info, days until next payday, and last payday date.

get/api/payday/status

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

Response

Successful Response

detected_paydayinteger required
next_paydaystring required
days_until_paydayinteger required
last_paydaystring nullable required
monthly_incomenumber required
is_payday_todayboolean required
pay_confirmedboolean
pay_cadencestring nullable
pay_amountnumber nullable
next_payday_knownboolean
cycle_startstring nullable
cycle_endstring nullable

Changes

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