Bank account activity report
Lists everything that moved through one bank account over a date range, with a running balance. One row is one cleared transaction: its date, who it was with, cash in or cash out, and the balance after it.
Authorization
AuthorizationstringrequiredPath parameters
bankAccountIdstringrequiredThe bank account to report on. A Snowflake id sent as a decimal string.
Query parameters
dateRange.startstring · dateFirst day of the period. Read in the company's timezone.
dateRange.endstring · dateLast day of the period, included in the range.
Response
200 · The account's activity for the period.
accountobjectThe bank account itself. Account and routing numbers are masked to their last four digits.
dateRangeobjectThe period actually reported on, after any defaulting.
startingBalancenumberThe account's balance immediately before the period.
netChangenumberHow much the balance moved over the period.
activitiesobject[]One row per transaction, in date order.
activitiesTotalobjectCash in and cash out added across every row.
401 · The access token is missing, expired, or not valid for this company.
404 · No bank account with that id exists in the caller's company.
Send both dateRange.start and dateRange.end and they are used as sent. Send only one and the other is filled in a month away from it. Send neither and the report covers the month up to now.
Each row is dated by when the transaction finalised, so a payment that has not settled yet is not in the report at all.