PayoutsSummaryReport
Query the Payouts summary report in Stripe.
Table Specific Information
Used to query the Payouts Summary report in Stripe.
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 parameters are required:
- ParametersIntervalStart
- ParametersIntervalEnd
You can also include the following optional parameters:
- ParametersColumns
- ParametersCurrency
// This first creates the new Report and displays it. Report Creation takes time once it is created will display the report. SELECT * FROM PayoutsSummaryReport WHERE ParametersIntervalStart = '2020-12-27' AND ParametersIntervalEnd = '2020-12-28'
Select
You can run the following queries to retrieve report data:
SELECT * FROM PayoutsSummaryReport WHERE Id IN (SELECT Id FROM Reports WHERE report_type = 'payouts.summary.1')
SELECT * FROM PayoutsSummaryReport WHERE Id IN ('frr_1I54dkATXQzBWNrlnaavpHGe', 'frr_1I3I59ATXQzBWNrl9VcczrDY') // This will show multiple reports
SELECT * FROM PayoutsSummaryReport WHERE Id = 'frr_1I480mATXQzBWNrlYQRaLQ9x' // This will show a respective report
Columns
| Name | Type | References | Description |
| Reporting_Category | String | Reporting Category is a new categorization of balance transactions, meant to improve on the current type field. | |
| Currency | String | Three-letter ISO code for the currency in which gross, fee and net are defined. | |
| Count | Int | The number of transactions associated with the reporting_category. | |
| Gross | Decimal | Sum of the gross amounts of the transactions associated with the reporting_category. Expressed in major units of the currency (e.g. dollars for USD, yen for JPY). | |
| Fee | Decimal | Sum of the fees paid for the transactions associated with the reporting_category. Expressed in major units of the currency (e.g. dollars for USD, yen for JPY). | |
| Net | Decimal | Sum of the net amounts for the transactions associated with the reporting_category. Expressed in major units of the currency (e.g. dollars for USD, yen for JPY). | |
| Id | String |
Reports.Id | Unique identifier for the reports run object. |
| ParametersIntervalEnd | Datetime | Ending timestamp of data to be included in the report run (exclusive). | |
| ParametersIntervalStart | Datetime | Starting timestamp of data to be included in the report run. | |
| ParametersColumns | String | The set of output columns requested for inclusion in the report run. | |
| ParametersCurrency | String | Currency of objects to be included in the report run. |