Skip to main content
POST
/
v5
/
banks
/
getTransactions
Get transactions
curl --request POST \
  --url https://sandbox.hurdlr.com/rest/v5/banks/getTransactions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: */*' \
  --data '
{
  "transactionFilters": {
    "bankAccountId": 123,
    "apiAccountId": "<string>",
    "entities": "EXPENSE",
    "statuses": [
      "ACTIVE"
    ],
    "reviewStatuses": [
      "PARTNER_REVIEW_REQUIRED"
    ],
    "cashFlowDirection": "IN",
    "bankDescription": "<string>",
    "description": "<string>",
    "minAmount": 123,
    "maxAmount": 123,
    "year": 123,
    "month": 123,
    "beginDate": "<string>",
    "endDate": "<string>",
    "includeTotal": true
  },
  "expenseFilters": {
    "id": 123,
    "types": "PENDING",
    "confidence": "LIKELY",
    "categoryIds": [
      123
    ],
    "personalCategoryIds": [
      123
    ],
    "vendorName": "<string>",
    "vendorIds": [
      123
    ],
    "businessIds": [
      123
    ],
    "clientIds": [
      123
    ]
  },
  "revenueFilters": {
    "id": 123,
    "types": [
      "PENDING"
    ],
    "businessIds": [
      123
    ],
    "clientIds": [
      123
    ]
  },
  "bankTransferFilters": {
    "id": 123,
    "types": [
      "PENDING"
    ]
  },
  "taxPaymentFilters": {
    "id": 123,
    "types": [
      "PENDING"
    ]
  },
  "invoicePaymentFilters": {
    "id": 123,
    "types": [
      "CONFIRMED"
    ]
  }
}
'
{
  "data": [
    {
      "entity": "EXPENSE",
      "entityId": 123,
      "status": "ACTIVE",
      "reviewStatus": "PARTNER_REVIEW_REQUIRED",
      "amount": 123,
      "date": "2023-11-07T05:31:56Z",
      "bankAccountId": 123,
      "description": "<string>",
      "bankDescription": "<string>",
      "apiTransactionId": "<string>",
      "apiAccountId": "<string>",
      "apiAccountNo": "<string>",
      "apiAccountName": "Citi Premier® Card",
      "apiInstitutionId": "<string>",
      "expenseFields": {
        "type": "BUSINESS",
        "vendorName": "<string>",
        "vendorId": 123,
        "businessName": "<string>",
        "businessId": 123,
        "clientId": 123,
        "categoryName": "<string>",
        "categoryId": 123,
        "personalCategoryName": "<string>",
        "personalCategoryId": 123,
        "expenseRuleId": 123,
        "bankTransferId": 123,
        "frequency": "ONE_TIME",
        "glAccountName": "<string>"
      },
      "revenueFields": {
        "type": "BUSINESS",
        "businessName": "<string>",
        "businessId": 123,
        "clientId": 123,
        "revenueAccountId": 123,
        "glAccountName": "<string>",
        "revenueRuleId": 123,
        "bankTransferId": 123,
        "invoiceId": 123
      },
      "bankTransferFields": {
        "type": "CONFIRMED",
        "transferType": "DEPOSIT",
        "creditAccountId": 123,
        "debitAccountId": 123,
        "isPayout": true,
        "glAccountName": "<string>"
      },
      "taxPaymentFields": {
        "type": "CONFIRMED",
        "glAccountName": "<string>"
      },
      "arPaymentFields": {
        "bankTransferId": 123
      },
      "customData": {},
      "apiName": "BENCH",
      "isClosed": true,
      "userAccess": "NONE",
      "accountantAccess": "NONE",
      "v6EntityId": "<string>"
    }
  ],
  "cursor": "<string>",
  "total": 123
}

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

cursor
string

Cursor from the previous paginated response

limit
integer<int32>

Page size, i.e. number of items to return per page

Body

*/*

Filter object

transactionFilters
object

Filters that pertain to all transactions

expenseFilters
object

Filters that pertain to all expense transactions

revenueFilters
object

Filters that pertain to all revenue transactions

bankTransferFilters
object

Filters that pertain to all bank transfer transactions

taxPaymentFilters
object

Filters that pertain to all tax payment transactions

invoicePaymentFilters
object

Filters that pertain to all invoice payment transactions

Response

200 - application/json

Successful operation

data
object[]

List of transactions

cursor
string

Cursor to be used in your subsequent paginated request. Only populated if there are more pages available.

total
integer<int32>

Total count of transactions in this query. Only populated if includeTotal is true in the request body transactionFilters.