PayoutTransactions
Retrieves a list of all balance transactions ordered by processing time, with the most recent being first.
Table-Specific Information
Select
The provider uses the Shopify API to process search criteria that refer to the PayoutId column. The provider processes other filters client-side within the provider.The Shopify APIs requires the search criteria to contain PayoutId. For example, the following query is processed server-side.
SELECT * FROM PayoutTransactions WHERE PayoutId = '123'
When performing a query without a filter or a filter other then the PayoutId column, the provider will retrieve the entire list of transactions and perform the filters client-side.
The Shopify API requires that an PayoutId be specified when retrieving transactions. Therefore to retrieve all the transactions, the provider will first retrieve all the PayoutIds
from the Payouts table (essentially performing the query: SELECT Id FROM Payouts). Once the PayoutId values have been retrieved, the provider will issue individual requests to the
Shopify API to retrieve all the transactions for each PayoutId to build the result set.
SELECT * FROM PayoutTransactions
SELECT * FROM PayoutTransactions WHERE Test='true'
SELECT * FROM PayoutTransactions WHERE PayoutStatus='pending'
Columns
Name | Type | References | Description |
Id [KEY] | Long | The unique identifier of the transaction. | |
Type | String | The type of the balance transaction. | |
Test | Bool | If the transaction was created for a test mode Order or payment. | |
PayoutId | Long |
Payouts.Id | The id of the payout the transaction was paid out in. |
PayoutStatus | String | The status of the payout the transaction was paid out in, or pending if the transaction has not yet been included in a payout. | |
Currency | String | The ISO 4217 currency code of the transaction. | |
Amount | Decimal | The gross amount of the transaction, in a decimal formatted string. | |
Fee | Decimal | The total amount of fees deducted from the transaction amount. | |
Net | Decimal | The net amount of the transaction. | |
SourceId | Long | The id of the resource leading to the transaction. | |
SourceType | String | The type of the resource leading to the transaction. | |
SourceOrderTransactionId | String | The id of the Order Transaction that resulted in this balance transaction. | |
SourceOrderId | String | The id of the Order that this transaction ultimately originated from. | |
ProcessedAt | Datetime | The time the transaction was processed. |