Get recurring transactions

1 curl -G https://api-staging.openledger.com/v1/transactions/recurring \ 2 -H "Authorization: Bearer <token>" \ 3 -d entityId=entityId

1 { 2 "inflow_streams": [ 3 { 4 "stream_id": "stream_id", 5 "account_id": "account_id", 6 "merchant_name": "merchant_name", 7 "description": "description", 8 "frequency": "WEEKLY", 9 "category": [ 10 "category" 11 ], 12 "last_amount": { 13 "amount": 0, 14 "currency": "currency" 15 }, 16 "average_amount": { 17 "amount": 0, 18 "currency": "currency" 19 }, 20 "is_active": false, 21 "last_date": "last_date", 22 "first_date": "first_date", 23 "confidence": 0, 24 "status": "ACTIVE", 25 "next_expected_date": "next_expected_date", 26 "transactions": [ 27 { 28 "id": "id", 29 "timestamp": "timestamp", 30 "amount": 0, 31 "currency": "currency", 32 "description": "description", 33 "status": "status", 34 "debit_account": { 35 "id": "id", 36 "name": "name", 37 "type": "type" 38 }, 39 "credit_account": { 40 "id": "id", 41 "name": "name", 42 "type": "type" 43 }, 44 "vendor": { 45 "id": "id", 46 "name": "name", 47 "category": "category" 48 }, 49 "plaid_account": { 50 "id": "id", 51 "account_name": "account_name", 52 "account_type": "account_type", 53 "account_mask": "account_mask" 54 }, 55 "metadata": {} 56 } 57 ] 58 } 59 ], 60 "outflow_streams": [ 61 null 62 ], 63 "total_inflow_streams": 0, 64 "total_outflow_streams": 0, 65 "summary": { 66 "total_transactions_analyzed": 0, 67 "analysis_period": { 68 "start_date": "start_date", 69 "end_date": "end_date", 70 "days_analyzed": 0 71 }, 72 "patterns_found": 0, 73 "confidence_threshold": 0, 74 "processing_time_ms": 0 75 } 76 }

Detect and retrieve recurring transaction patterns for an entity with detailed transaction history

Query parameters

entityIdstringRequired

The ID of the entity to analyze for recurring patterns

analysisWindowDaysintegerOptional<=365Defaults to 180

Number of days to look back for analysis

confidenceThresholddoubleOptional>=0<=1Defaults to 0.65

Minimum confidence score for pattern detection (0.0-1.0)

includeInactivebooleanOptionalDefaults to false

Whether to include inactive recurring streams

Response

Recurring transaction streams detected successfully

inflow_streamslist of objects or null

Detected recurring inflow patterns (income)

outflow_streamslist of any or null

Detected recurring outflow patterns (expenses/subscriptions)

total_inflow_streamsinteger or null

Count of detected inflow streams

total_outflow_streamsinteger or null

Count of detected outflow streams

summaryobject or null

Headers

Query parameters

Response

Errors