#Recurring Transactions API

Once monetr has grouped your transactions into similar transaction clusters, it looks at each cluster and tries to work out whether it happens on a schedule. Your streaming service on the 12th every month, a paycheck every other Friday, car insurance once a year. When it finds a schedule that holds up, that's a recurring transaction.

A recurring transaction only ever goes one direction. Money going out and money coming in get looked at separately, so a cluster can have at most two of them, one for the charges and one for the refunds or deposits. Most only ever have one.

monetr wants at least three transactions before it'll call something recurring, and it has to be pretty sure about the schedule. Two charges a month apart is a coincidence as far as it's concerned.

Like the clusters, this all happens in a background job. It runs right after the clusters get recalculated, so a brand new transaction won't count toward anything until both jobs have gotten to it.

Each transaction has a transactionRecurringId pointing at the recurring transaction it's part of. That's how you'll find these for now, there's no endpoint to list them yet.

#The recurring transaction object

The ruleset keeps its DTSTART in UTC like every other ruleset in monetr, but the schedule is really in your account's timezone. If you want to pull dates out of it yourself, move DTSTART into your account's timezone first. Skip that and something like BYMONTHDAY=8 lands on the 9th for anyone east of UTC.

ended and deleted aren't the same thing. Something that ended still exists, it just isn't happening anymore. If a cluster stops recurring entirely, or the cluster itself goes away, the recurring transaction gets deleted. Its ID stops working and the transactions that were in it go back to a null transactionRecurringId.

#GET Get a recurring transaction

Returns one recurring transaction. You'll usually get the ID from a transaction's transactionRecurringId.

In the app: Nothing in the app calls this yet.

GET /api/bank_accounts/:bankAccountId/recurring/:transactionRecurringId

Auth: API key, subscription required.

#Path parameters

#Example

curl --request GET \
  --url "https://my.monetr.local/api/bank_accounts/bac_01gds6eqsq7h5mgevwtmw3cyxb/recurring/txrc_01j6b4n8w2kq5t9r3xm7vdc6ph" \
  --user "$MONETR_API_KEY_ID:$MONETR_API_KEY_SECRET"

{
  "transactionRecurringId": "txrc_01j6b4n8w2kq5t9r3xm7vdc6ph",
  "bankAccountId": "bac_01gds6eqsq7h5mgevwtmw3cyxb",
  "transactionClusterId": "tcl_01j6b4m3zr8yq2w6tnc5kxd9fe",
  "window": "monthly",
  "ruleset": "DTSTART:20240301T060000Z\nRRULE:FREQ=MONTHLY;INTERVAL=1;BYMONTHDAY=12",
  "first": "2024-03-12T05:00:00Z",
  "last": "2024-08-12T05:00:00Z",
  "next": "2024-09-12T05:00:00Z",
  "ended": false,
  "confidence": 0.94,
  "direction": "debit",
  "amounts": {
    "1399": 3,
    "1549": 3
  },
  "lastAmount": 1549,
  "createdAt": "2024-05-13T03:15:06.214Z",
  "updatedAt": "2024-08-30T03:15:05.902Z"
}

That one's a monthly charge on the 12th that went up from $13.99 to$15.49 partway through, which is why amounts has two entries.

#Errors