Get transactions by entity

1 import { OpenLedgerClientClient } from "openledger"; 2 3 const client = new OpenLedgerClientClient({ token: "YOUR_TOKEN" }); 4 await client.transactions.getTransactionsByEntity({ 5 entityId: "entityId" 6 });

1 { 2 "transactions": [ 3 { 4 "id": "id", 5 "entityId": "entityId", 6 "timestamp": "timestamp", 7 "amount": 0, 8 "currency": "currency", 9 "description": "description", 10 "debitAccountId": "debitAccountId", 11 "creditAccountId": "creditAccountId", 12 "status": "PENDING", 13 "metadata": {}, 14 "date": "date", 15 "transaction_date": "transaction_date", 16 "accountType": "accountType", 17 "financialType": "financialType", 18 "category": "category", 19 "category_id": null, 20 "debitAccount": { 21 "id": "id", 22 "name": "name", 23 "type": "type", 24 "financialType": "financialType", 25 "code": "code", 26 "subTypeCode": "subTypeCode", 27 "isCategory": false 28 }, 29 "creditAccount": { 30 "id": "id", 31 "name": "name", 32 "type": "type", 33 "financialType": "financialType", 34 "code": "code", 35 "subTypeCode": "subTypeCode", 36 "isCategory": false 37 }, 38 "plaid_account": { 39 "id": "id", 40 "name": "name", 41 "type": "type", 42 "subtype": "subtype", 43 "mask": "mask", 44 "institution_id": "institution_id" 45 } 46 } 47 ], 48 "nextCursor": null, 49 "hasMore": false 50 }

Retrieves all transactions for a specific entity with pagination

Query parameters

entityIdstringRequired

The ID of the entity to get transactions for

cursorstringOptional

Cursor for pagination

pageSizeintegerOptionalDefaults to 50

Number of transactions per page

Response

Transactions retrieved successfully

transactionslist of objects or null

nextCursorstring or null or null

hasMoreboolean or null

Headers

Query parameters

Response

Errors