Skip to content

GET /api/agent/daily-summary

Single-call narrative for 'how's the business going today?'. Composes cash position, last-7d activity (with top-5 inflows + outflows), AR aging snapshot, 13w forecast headline (ending cash, lowest point, break-even date), agent notes, AND a deterministic prose narrative. Sensitive-data gating: contact names in topInflows / topOutflows are rewritten to Sensitive contact for non-READ_SENSITIVE keys; totals are never masked. redactedItemCount is the aggregate count across both sub-collections.

Auth

  • Required scope: READ_SUMMARY
  • Header: Authorization: Bearer cr_live_<prefix>_<secret>

Responses

200 — Composite daily summary

Body: DailySummaryResponse

FieldTypeRequiredNotes
orgNamestringyes
generatedAtstring (date-time)yes
asOfDatestring (date)yes
cashTodayobjectyes
bankAccountsintegeryes
last7dobjectyes
arobjectyes
forecast13wobjectyes
narrativestringyesDeterministic LLM-ready 2-4 sentence prose summary. Threshold-driven phrasing for the 7-day net signal (net positive / net negative / roughly flat).
notesForAgentarray of AgentNoteno
redactedItemCountintegeryesSum of topInflows[] + topOutflows[] rows whose contactName was rewritten to "Sensitive contact". Always 0 when the key carries READ_SENSITIVE. Totals (net, in, out, AR bands, cashToday) are NEVER masked.
billingAlertBillingAlertno
xeroAlertXeroAlertno

401 — Unauthorized

Body: ErrorResponse

FieldTypeRequiredNotes
errorstringyes

403 — Key lacks the required scope

Body: ErrorResponse

FieldTypeRequiredNotes
errorstringyes

429 — Rate-limited or quota-exhausted

Body: ErrorResponse

FieldTypeRequiredNotes
errorstringyes

Response headers

Every successful response carries X-CashRunway-Subscription, X-CashRunway-Plan, X-CashRunway-Quota-Remaining, and X-CashRunway-Quota-Reset. Trialing subscriptions also include X-CashRunway-Trial-Days-Remaining. See the overview for details.

Released under a proprietary license.