Get Summary
Summarizes recurring income and expenses for a calendar month supplied as YYYY-MM. Returns expected expenses and income, plus expenses paid and income received, as positive magnitudes in the household's reporting currency.
Expected totals follow each series' schedule and active date window. Paid and received totals use matched transactions, so they can differ from expected amounts. This endpoint does not initiate payments.
Authorization
PersonalApiToken Use your personal API token (penny_pat_…) as the bearer credential. Enter the token only; the client adds the Bearer prefix. Read-only tokens permit read requests. Read/write tokens remain limited by your current household membership and role. See https://penny.finance/docs/api#authentication for setup.
In: header
Path Parameters
Query Parameters
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/households/string/recurring-transactions/summary?month=string"{ "total_recurring_expense": { "amount": "68.42", "currency": "USD" }, "total_recurring_income": { "amount": "68.42", "currency": "USD" }, "paid_expense": { "amount": "68.42", "currency": "USD" }, "received_income": { "amount": "68.42", "currency": "USD" }}Create Recurring Transaction POST
Creates a recurring income or expense series for a household merchant. This defines an expected schedule; it does not initiate payments or create financial…
Get Occurrences GET
Lists expected recurring income and expense occurrences within an inclusive date range, with their status and any matched transaction details. Occurrences…