Skip to main content
GET
List bill patterns

Authorizations

Authorization
string
header
required

First-party access token for your own signed-in session, obtained from the /api/enterprise-auth/login endpoint. The REST API returns your own account data to you — it is a first-party consumer surface, not a third-party integration channel. Data from connected bank feeds (open-banking / CDR data) is your own data, returned only to you in your own authenticated session.

Query Parameters

includeInactive
boolean
default:false

Response

200 - application/json

Bill patterns retrieved

id
string
name
string
baseAmount
number
frequency
enum<string>
Available options:
daily,
weekly,
fortnightly,
monthly,
quarterly,
yearly
startDate
string<date>
endDate
string<date>
isActive
boolean
categoryId
string
occurrences
object[]