Account

PropertiesCopy Anchor Link

ObjectCopy Anchor Link

{
  "$id": "https://api.sb/routewise.dev/accounts/account_1",
  "$type": "Account",
  "class": "cash",
  "heldAt": "payments",
  "balance": {
    "amount": 25,
    "currency": "USD"
  },
  "pending": {
    "amount": 25,
    "currency": "USD"
  },
  "payoutSchedule": "daily"
}

RelationshipsCopy Anchor Link

• An Account has many Entries: each Entry posts to one Account, and an Account’s balance is the sum of its Entries. entries, inverse postsTo.

VerbsCopy Anchor Link

1. getReturns one Account by id.
   GET /{namespace}/accounts/{id}readNo Event
2. listReturns Accounts, newest first, one page at a time.
   GET /{namespace}/accountsreadNo Event
3. payoutPayout sends available cash from the payments balance to the owner’s bank and lists every Transaction the payout carries.
   POST /{namespace}/accounts/{account}/payoutdoAccount.paidOut
4. sweepSweep moves cash between two cash Accounts of the same owner, once or on a standing rule, within the Treasurer’s Limit.
   POST /{namespace}/accounts/{from}/sweepdoAccount.swept

An Account is kept forever and never edited: it has no update or delete.

PermissionsCopy Anchor Link

Which Access level may call each Verb. One-way Verbs wait their delay window.

StripeCopy Anchor Link

Treasury FinancialAccount (treasury.financial_account), for an Account whose heldAt is treasury. The source of truth is Stripe: db.sb mirrors it, written only from Stripe’s webhooks.

Call itCopy Anchor Link

Sweep my account.

ExampleCopy Anchor Link

A tutoring Startup keeps $3,000 of reserve cash in an Account of class cash held at treasury. Its balance is the sum of the Entries posted to it, and each week the Treasurer checks it against the figure Stripe reports.