Get recurring transaction templates | Open Ledger Documentation

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

{
  "success": true,
  "templates": [
    {
      "id": "string",
      "streamId": "string",
      "entityId": "string",
      "plaidTransactionId": "string",
      "discoveredAt": "2024-01-15T09:30:00Z",
      "isActive": true,
      "confidence": 1.1,
      "lastUpdate": "2024-01-15T09:30:00Z",
      "categorization": {
        "debitAccountId": "string",
        "creditAccountId": "string",
        "confidence": 1.1,
        "source": "string",
        "transactionType": "string",
        "createdAt": "2024-01-15T09:30:00Z"
      },
      "pattern": {
        "streamId": "string",
        "entityId": "string",
        "merchantPattern": "string",
        "averageAmount": 1.1
      },
      "stats": {
        "appliedCount": 1,
        "createdAt": "2024-01-15T09:30:00Z",
        "sourceTransactionId": "string"
      }
    }
  ],
  "summary": {
    "totalTemplates": 1,
    "activeTemplates": 1,
    "inactiveTemplates": 1,
    "totalApplications": 1,
    "averageConfidence": 1.1,
    "entityId": "string"
  }
}

Retrieve all recurring transaction templates for an entity, including categorization rules and usage statistics

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

entityIdstringRequired

The ID of the entity to get templates for

includeInactivebooleanOptionalDefaults to false

Whether to include inactive templates

streamIdstringOptional

Filter by specific stream ID

Response

Templates retrieved successfully

successboolean

templateslist of objects

summaryobject

Errors

400

Bad Request Error

500

Internal Server Error