Skip to main content
GET
/
api
/
bills
/
patterns
List bill patterns
curl --request GET \
  --url https://api.ai2fin.com/api/bills/patterns \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "<string>",
    "name": "<string>",
    "baseAmount": 123,
    "frequency": "daily",
    "startDate": "2023-12-25",
    "endDate": "2023-12-25",
    "isActive": true,
    "categoryId": "<string>",
    "occurrences": [
      {}
    ]
  }
]

Authorizations

​
Authorization
string
header
required

JWT token obtained from /api/auth/login endpoint

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[]