Skip to main content
GET
/
v2
/
analytics
/
bank-transactions
Get bank transaction metrics by allocation status
curl --request GET \
  --url https://api.example.com/v2/analytics/bank-transactions \
  --header 'Authorization: Bearer <token>'
{
  "potential_payments": {
    "count": 1,
    "total_amount": "<string>"
  },
  "needs_allocation": {
    "count": 1,
    "total_amount": "<string>"
  },
  "ready_to_post": {
    "count": 1,
    "total_amount": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
bank_account_id
string | null

Bank account ID to filter by

​
date
string<date> | null

Filter by specific date (YYYY-MM-DD)

Response

Successful Response

​
potential_payments
object
required

Deposit transactions where is_payment != False and no payments have been created.

​
needs_allocation
object
required

Deposit transactions with unapproved payments where allocated amount != transaction amount.

​
ready_to_post
object
required

Deposit transactions with unapproved payments where allocated amount == transaction amount.