BalanceSummaryReport
Returns the balance summary report in Stripe, including the net amount and currency for each balance category.
View-Specific Information
Note: This report requires a live-mode API key, which can be set using the LiveAPIKey connection property. This view is not accessible without specifying the LiveAPIKey.
Creating the Report
To create a report, the following columns are required:
- ParametersIntervalStart
- ParametersIntervalEnd
You can also include the following optional columns:
- Id
- ParametersColumns
- ParametersCurrency
- ParametersTimezone
// This first creates the new report and displays it. Report creation may take time before results are displayed.
SELECT * FROM BalanceSummaryReport WHERE ParametersIntervalStart = '2020-12-27' AND ParametersIntervalEnd = '2020-12-28'
SELECT
You can run the following queries to retrieve report data:
SELECT * FROM BalanceSummaryReport WHERE Id IN (SELECT Id FROM Reports WHERE report_type = 'balance.summary.1')
SELECT * FROM BalanceSummaryReport WHERE Id IN ('frr_1I54dkATXQzBWNrlnaavpHGe', 'frr_1I3I59ATXQzBWNrl9VcczrDY') // This will show multiple reports
SELECT * FROM BalanceSummaryReport WHERE Id = 'frr_1I480mATXQzBWNrlYQRaLQ9x' // This will show a respective report
Columns
| Name | Type | References | Description |
| Category | String | The balance category. One of starting_balance, ending_balance, activity or payouts. | |
| Description | String | One of Starting balance (YYYY-MM-DD) - the balance at the start of the period, Activity - the net amount of all transactions that affected your balance except for payouts, Less payouts - the amount of payouts to your bank account, or Ending balance (YYYY-MM-DD) - the balance left over at the end of the period after subtracting payouts from the Starting balance and Activity. | |
| Net_Amount | Decimal | The net amount for the transactions associated with the category, expressed in major units of the currency, such as dollars for USD or yen for JPY. | |
| Currency | String | The three-letter ISO code for the currency in which net_amount is defined. | |
| Id | String |
Reports.Id | The unique identifier for the report run object. |
| ParametersIntervalEnd | Datetime | The ending timestamp of the data to be included in the report run (exclusive). | |
| ParametersIntervalStart | Datetime | The starting timestamp of the data to be included in the report run. | |
| ParametersColumns | String | The set of output columns requested for inclusion in the report run. | |
| ParametersCurrency | String | The currency of objects to be included in the report run. | |
| ParametersTimezone | String | The output timezone for all timestamps in the report. Defaults to Etc/UTC. |