Guides
Reporting
Column provides the following reports: bank_account_transaction and bank_account_summary. All reports are available in CSV, JSON, and Parquet formats.
Bank Account Transaction Report
bank_account_transaction reports contain all transactions (e.g., book/ACH/wire transfers, loan payments/disbursements, etc.) that affected balances of bank accounts in given reporting periods, including available_balance, pending_balance, locked_balance and holding_balance. Each row is a transaction with its details.
effective_at2006-01-02T15:04:05Z)effective_at_utc2006-01-02T15:04:05Z)bank_account_idbank_account_typeaccount_number_identity_identity_nameentity_typetransaction_idtransaction_typecurrencyavailable_amountavailable_balance in cents (negative for debit)available_balanceavailable_balance in cents after this transactionpending_amountpending_balance in cents (negative for debit)pending_balancepending_balance in cents after this transactionlocked_amountlocked_balance in cents (negative for debit)locked_balancelocked_balance in cents after this transactionholding_amountholding_balance in cents (negative for debit)holding_balanceholding_balance in cents after this transactionBank Account Summary Report
bank_account_summary reports contain snapshots of all bank accounts (including bank accounts without any transaction) under your platform by the end of the reporting periods. Each row is a bank account summary. If a bank account has multiple account numbers, they will be aggregated and only one row will be shown in summary reports.
bank_account_idbank_account_typebank_account_statusentity_identity_nameentity_typetransaction_countcurrencyavailable_balance_openavailable_balance in cents at the beginning of the reporting periodavailable_balance_creditavailable_balance during the reporting periodavailable_balance_debitavailable_balance during the reporting periodavailable_balance_closeavailable_balance in cents at the end of the reporting periodpending_balance_openpending_balance in cents at the beginning of the reporting periodpending_balance_creditpending_balance during the reporting periodpending_balance_debitpending_balance during the reporting periodpending_balance_closepending_balance in cents at the end of the reporting periodlocked_balance_openlocked_balance in cents at the beginning of the reporting periodlocked_balance_creditlocked_balance during the reporting periodlocked_balance_debitlocked_balance during the reporting periodlocked_balance_closelocked_balance in cents at the end of the reporting periodholding_balance_openholding_balance in cents at the beginning of the reporting periodholding_balance_creditholding_balance during the reporting periodholding_balance_debitholding_balance during the reporting periodholding_balance_closeholding_balance in cents at the end of the reporting periodBank Account Summary History
Daily summary history of bank accounts is also available via the Bank Account Summary History API.
Prerequisite
To generate daily or on-demand bank_account_transaction or bank_account_summary settlement reports, you must configure the reporting time zone of your platform in Platform Settings on Dashboard. Column will use your reporting time zone to decide the day boundaries of your settlement reports.
For example, if your reporting time zone is UTC, daily settlement reports for 2022-04-12 will include all transactions between 2022-04-12 00:00:00 (inclusive) and 2022-04-13 00:00:00 (exclusive). However, if your reporting time zone is America/Los_Angeles, it will include all transactions between 2022-04-12 07:00:00 (inclusive) and 2022-04-13 07:00:00 (exclusive).
If you update the reporting time zone of your platform to a different value, it will be applied to new daily or on-demand settlement reports. History settlement reports will not be re-generated. You can use the Schedule Settlement Report API to re-generate history settlement reports using the new reporting time zone.
Daily Settlement Reports
If you have configured the reporting time zone of your platform, Column will automatically generate daily bank_account_transaction and bank_account_summary reports after the midnight of your reporting time zone every day.
On-demand Settlement Reports
You can use the Schedule Settlement Report API to submit requests to generate bank_account_transaction or bank_account_summary settlement reports of your preferred date ranges. Column will process your requests and generate reports once all data required by your reports are ready. For example, if you schedule a report from 2022-04-01 to 2022-04-30, it will not be generated until the beginning of 2022-05-01.
The earliest available date for settlement reports is 2022-01-01, and the maximum date range for on-demand settlement reports is 93 days. If a report with the same type, time zone, and date range has already been scheduled before, we will return the existing report instead of scheduling it again.
When you schedule an on-demand report for a date range, daily reports in the given date range will be automatically scheduled if they are missing.
Download Settlement Reports
You can use the Document API to get the download URL of a settlement report using the document ID of a report format.
Webhook Events
You will receive webhook events when settlement reports are scheduled, completed successfully, or failed to generate.
reporting.bank_account_summary.scheduledbank_account_summary reportreporting.bank_account_summary.completedbank_account_summary reportreporting.bank_account_summary.failedbank_account_summary reportreporting.bank_account_transaction.scheduledbank_account_transaction reportreporting.bank_account_transaction.completedbank_account_transaction reportreporting.bank_account_transaction.failedbank_account_transaction report