ItemizedPayoutReconciliationReport
Query the Itemized payout reconciliation report in Stripe.
Table Specific Information
Used to query the Itemized Payout Reconciliation 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
- ParametersTimezone
- ParametersReportingCategory
// This first creates the new Report and displays it. Report Creation takes time once it is created will display the report. SELECT * FROM ItemizedPayoutReconciliationReport WHERE ParametersIntervalStart = '2020-12-27' AND ParametersIntervalEnd = '2020-12-28'
Select
You can run the following queries to retrieve report data:
SELECT * FROM ItemizedPayoutReconciliationReport WHERE Id IN (SELECT Id FROM Reports WHERE report_type = 'payout_reconciliation.itemized.4')
SELECT * FROM ItemizedPayoutReconciliationReport WHERE Id IN ('frr_1I54dkATXQzBWNrlnaavpHGe', 'frr_1I3I59ATXQzBWNrl9VcczrDY') // This will show multiple reports
SELECT * FROM ItemizedPayoutReconciliationReport WHERE Id = 'frr_1I480mATXQzBWNrlYQRaLQ9x' // This will show a respective report
Columns
| Name | Type | References | Description |
| Balance_Transaction_Id [KEY] | String | Unique identifier for the balance transaction. | |
| Created_UTC | Datetime | Time at which the balance transaction was created. Dates in UTC. | |
| Created | Datetime | Time at which the balance transaction was created. Dates in the requested timezone, or UTC if not provided. | |
| Available_On_UTC | Datetime | The date the balance transactions net funds will become available in the Stripe balance. Dates in UTC. | |
| Available_On | Datetime | The date the balance transactions net funds will become available in the Stripe balance. Dates in the requested timezone, or UTC if not provided. | |
| Currency | String | Three-letter ISO code for the currency in which gross, fee and net are defined. | |
| Gross | Decimal | Gross amount of the transaction. Expressed in major units of the currency (e.g. dollars for USD, yen for JPY). | |
| Fee | Decimal | Fees paid for this transaction. Expressed in major units of the currency (e.g. dollars for USD, yen for JPY). | |
| Net | Decimal | Net amount of the transaction. Expressed in major units of the currency (e.g. dollars for USD, yen for JPY). | |
| Reporting_Category | String | Reporting Category is a new categorization of balance transactions, meant to improve on the current type field. | |
| Source_Id | String | The Stripe object to which this transaction is related. | |
| Description | String | An arbitrary string attached to the balance transaction. Often useful for displaying to users. | |
| Customer_Facing_Amount | Decimal | For transactions associated with charges or refunds, the amount of the original charge or refund. | |
| Customer_Facing_Currency | String | For transactions associated with charges or refunds, the three-letter ISO code for the currency for customer_facing_amount. | |
| Automatic_Payout_Id | String | ID of the automatically created payout associated with this balance transaction (only set if your account is on an automatic payout schedule). | |
| Automatic_Payout_Effective_At_UTC | Datetime | The date we expect this automatic payout to arrive in your bank account, in UTC. This is also when the paid-out funds are deducted from your Stripe balance. | |
| Automatic_Payout_Effective_At | Datetime | The date we expect this automatic payout to arrive in your bank account, in the requested timezone, or UTC if not provided. This is also when the paid-out funds are deducted from your Stripe balance. | |
| Customer_Id | String | The unique ID of the related customer, if any. | |
| Customer_Email | String | Email address of the customer, if any, associated with this balance transaction. | |
| Customer_Name | String | Name of the customer, if any, associated with this balance transaction. | |
| Customer_Description | String | Description provided when creating the customer, often used to store the customer name. | |
| Shipping_Address_Line1 | String | First line of the shipping address associated with this charge, if any | |
| Shipping_Address_Line2 | String | Second line of the shipping address associated with this charge, if any | |
| Shipping_Address_City | String | City of the shipping address associated with this charge, if any | |
| Shipping_Address_State | String | State of the shipping address associated with this charge, if any | |
| Shipping_Address_Postal_Code | String | Postal code of the shipping address associated with this charge, if any | |
| Shipping_Address_Country | String | Country of the shipping address associated with this charge, if any | |
| Charge_Id | String | Unique identifier for the original charge associated with this balance transaction. Available for charges, refunds and disputes. | |
| Payment_Intent_Id | String | The unique ID of the related Payment Intent, if any. | |
| Charge_Created_UTC | Datetime | Creation time of the original charge associated with this balance transaction. Available for charges, refunds and disputes. For charges that were separately authorized and captured, this is the authorization time. Dates in UTC. | |
| Charge_Created | Datetime | Creation time of the original charge associated with this balance transaction. Available for charges, refunds and disputes. For charges that were separately authorized and captured, this is the authorization time. Dates in the requested timezone, or UTC if not provided. | |
| Invoice_Id | String | Unique ID for the invoice associated with this balance transaction. Available for charges, refunds, and disputes made in connection with a Stripe Billing invoice. | |
| Subscription_Id | String | Unique ID for the subscription associated with this balance transaction. Available for charges, refunds, and disputes made in connection with a Stripe Billing subscription. | |
| Payment_Method_Type | String | The type of payment method used in the related payment. | |
| Card_Brand | String | Card brand, if applicable. | |
| Card_Funding | String | Card funding type, if applicable. | |
| Card_Country | String | Two-letter ISO code representing the country of the card. | |
| Statement_Descriptor | String | The dynamic statement descriptor or suffix specified when the related charge was created. | |
| Dispute_Reason | String | Reason given by cardholder for dispute. | |
| Connected_Account_Id | String | For Stripe Connect activity related to a connected account, the unique ID for the account. | |
| Connected_Account_Name | String | For Stripe Connect activity related to a connected account, the name of the account. | |
| Connected_Account_Country | String | For Stripe Connect activity related to a connected account, the two-letter ISO code representing the country of the account. | |
| Regulatory_Tag | String | ??An identifier reflecting the classification of this transaction according to local regulations, if applicable. Accounts with automatic payouts enabled receive a separate payout for each regulatory tag. ??This column is only populated for Brazilian accounts. | |
| Payment_Metadata | String | Metadata associated with the related PaymentIntent, if any. If no PaymentIntent metadata exists, metadata from any related charge object will be returned. API requests including this column must specify a metadata key in brackets. This column can be specified multiple times to retrieve data from additional metadata keys. | |
| Refund_Metadata | String | Metadata associated with the related refund object, if any. API requests including this column must specify a metadata key in brackets. This column can be specified multiple times to retrieve data from additional metadata keys. | |
| Transfer_Metadata | String | Metadata associated with the related transfer object, if any. API requests including this column must specify a metadata key in brackets. This column can be specified multiple times to retrieve data from additional metadata keys. | |
| Id [KEY] | 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. | |
| ParametersReportingCategory | String | Category of balance transactions to be included in the report run. | |
| ParametersTimezone | String | Defaults to Etc/UTC. The output timezone for all timestamps in the report. |