Get transactions by entity | Open Ledger Documentation

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

{
  "transactions": [
    {
      "id": "string",
      "entityId": "string",
      "timestamp": "2024-01-15T09:30:00Z",
      "amount": 1.1,
      "currency": "string",
      "description": "string",
      "debitAccountId": "string",
      "creditAccountId": "string",
      "status": "PENDING",
      "metadata": {},
      "date": "2024-01-15T09:30:00Z",
      "transaction_date": "2024-01-15T09:30:00Z",
      "accountType": "string",
      "financialType": "string",
      "category": "string",
      "categoryId": "string",
      "categoryInfo": {
        "id": "string",
        "name": "string",
        "type": "ASSET",
        "financialType": "string",
        "code": 1
      },
      "bankAccountInfo": {
        "id": "string",
        "name": "string",
        "type": "ASSET",
        "role": "debit"
      },
      "counterpartyName": "string",
      "debitAccount": {
        "id": "string",
        "name": "string",
        "type": "string",
        "financialType": "string",
        "code": "string",
        "subTypeCode": "string",
        "isCategory": true
      },
      "creditAccount": {
        "id": "string",
        "name": "string",
        "type": "string",
        "financialType": "string",
        "code": "string",
        "subTypeCode": "string",
        "isCategory": true
      },
      "plaid_account": {
        "id": "string",
        "name": "string",
        "type": "string",
        "subtype": "string",
        "mask": "string",
        "institution_id": "string"
      }
    }
  ],
  "nextCursor": "string",
  "hasMore": true
}

Retrieves all transactions for a specific entity with pagination

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 transactions for

cursorstringOptional

Cursor for pagination

pageSizeintegerOptionalDefaults to 50

Number of transactions per page

Response

Transactions retrieved successfully

transactionslist of objects

nextCursorstring or null

hasMoreboolean

Errors

400

Bad Request Error

500

Internal Server Error