money
cash_position_summary

Get my cash position summary subscription

Changed on

The signed-in member's own opt-in to the emailed cash-position summary for the business of their session. It is per member and off until the member turns it on; every recipient chooses for themselves. The summary goes to the member's address on file, at 5:30 PM Eastern on the due day: every day for daily, Mondays for weekly, the 1st of the month for monthly. Requires a signed-in business session and, on a business whose roles are enforced, the reports_read capability, because the summary states the business's balances; the send re-checks it, and a member who no longer holds it is not emailed. An API key is refused.

get/money/cash_position_summary/subscription

Request

  • Base URL
    https://api.stablesea.com (the document declares no server; this is the origin it was published from)
  • Auth
    none declared

Response

OK

cadencestring

How often the signed-in member is emailed their business's cash-position summary: daily, weekly, monthly, or off. A member who never chose is off.

delivery_enabledboolean

False in an environment that does not deliver the summary, where a choice is recorded but no email is sent.

emailstring

The address the summary goes to: the signed-in member's own address on file, never a value the request supplied. Empty when none is on file.

last_cadence'daily' | 'weekly' | 'monthly'

The newest cadence other than off the member ever chose: what switching back on restores. Absent when they never chose one.

Changes