Get Occurrences
Lists expected recurring income and expense occurrences within an inclusive date range, with their status and any matched transaction details.
Occurrences are calculated from stored schedules and transaction history; they are not new financial transactions. Cancelled series contribute only through their end date. Use this response to build a recurring calendar and distinguish expected activity from recorded 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
datedateResponse Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/households/string/recurring-transactions/occurrences?start_date=2019-08-24&end_date=2019-08-24"{ "occurrences": [ { "recurring_transaction_id": "Rt6wP4dM8xNc", "name": "Netflix", "expected_date": "2019-08-24", "expected_amount": { "amount": "68.42", "currency": "USD" }, "type": "income", "status": "paid", "transaction_id": "Tx3fJ9mS6vBa", "transaction_amount": { "amount": "68.42", "currency": "USD" }, "merchant": { "id": "Mr9dL3xT6bQa", "name": "Blue Bottle Coffee", "website": "https://www.bluebottlecoffee.com/", "image_url": "https://cdn.penny.finance/merchants/blue-bottle-coffee.png", "default_image_url": "https://cdn.penny.finance/merchants/default-coffee.png" } } ]}Get Summary GET
Summarizes recurring income and expenses for a calendar month supplied as YYYY-MM. Returns expected expenses and income, plus expenses paid and income…
Get Recurring Transaction Occurrences GET
Lists expected occurrences for one recurring series within an inclusive date range, including their status and matched transaction details. Matching is…