This type is the base response type of the getTransactionSummary method, and based on the filters that are used in the getTransactionSummary call URI, the response may include total count and amount of the seller's sales and credits, total count and amount of buyer refunds, and total count and amount of seller payment holds.
Types that use TransactionSummaryResponse
Not used by any types.
Call that uses TransactionSummaryResponse
Fields
balanceTransferAmount
The total balance transfer amount for given payee within the specified period.
balanceTransferBookingEntry
The credit debit sign indicator for the balance transfer.
balanceTransferCount
The total balance transfer count for given payee within the specified period.
creditAmount
This amount is the total dollar value of all the seller's sales and/or credits that match the input criteria.
Note: Unless the transactionType filter is used in the request to retrieve a specific type of monetary transaction, the creditCount and creditAmount fields account for both order sales and seller credits (the count and value is not distinguished between the two monetary transaction types).
If there are no sales/credits (creditCount=
Note: Unless the transactionType filter is used in the request to retrieve a specific type of monetary transaction, the creditCount and creditAmount fields account for both order sales and seller credits (the count and value is not distinguished between the two monetary transaction types).
If there are no sales/credits (creditCount=
0
), this container is not returned.creditBookingEntry
The enumeration value indicates whether the dollar amount in the creditAmount field is a charge (debit) to the seller or a credit. Typically, the enumeration value returned here will be
CREDIT
.creditCount
This integer value indicates the total number of the seller's sales and/or credits that match the input criteria.
Note: Unless the transactionType filter is used in the request to retrieve a specific type of monetary transaction (sale, buyer refund, or seller credit), the creditCount and creditAmount fields account for both order sales and seller credits (the count and value is not distinguished between the two monetary transaction types).
This field is generally returned, even if
Note: Unless the transactionType filter is used in the request to retrieve a specific type of monetary transaction (sale, buyer refund, or seller credit), the creditCount and creditAmount fields account for both order sales and seller credits (the count and value is not distinguished between the two monetary transaction types).
This field is generally returned, even if
0
, but it will not be returned if a transactionType filter is used, and its value is set to either REFUND
, DISPUTE
, or SHIPPING_LABEL
.disputeAmount
This amount is the total dollar value associated with any existing payment disputes that have been initiated by one or more buyers. Only the orders that match the input criteria are considered. The Payment Disputes methods in the Fulfillment API can be used by the seller to retrieve more information about any payment disputes.
If there are no payment disputes (disputeCount=
If there are no payment disputes (disputeCount=
0
), this container is not returned.disputeBookingEntry
The enumeration value indicates whether the dollar amount in the disputeAmount field is a charge (debit) to the seller or a credit. Typically, the enumeration value returned here will be
DEBIT
, but its possible that CREDIT
could be returned if the seller contested one or more payment disputes and won the dispute.disputeCount
This integer value indicates the total number of payment disputes that have been initiated by one or more buyers. Only the orders that match the input criteria are considered. The Payment Disputes methods in the Fulfillment API can be used by the seller to retrieve more information about any payment disputes.
This field is generally returned, even if
This field is generally returned, even if
0
, but it will not be returned if a transactionType filter is used, and its value is set to any value other than DISPUTE
.loanRepaymentAmount
The sum of all
For example, within a specified
The net amount of these three transactions is a DEBIT of 20.00 USD to the seller's account. Therefore, the value returned for
Note: For this example:
If there are no transactions that match the input criteria (i.e.,
LOAN_REPAYMENT
transactions (i.e., debit and credit,) that match the input criteria.For example, within a specified
transactionDate
range, three LOAN_REPAYMENT
transactions are identified:- DEBIT of 15.00 USD
- DEBIT of 10.00 USD
- CREDIT of 5.00 USD
The net amount of these three transactions is a DEBIT of 20.00 USD to the seller's account. Therefore, the value returned for
loanRepaymentAmount
will be 20.00 USD.Note: For this example:
- The value returned for
loanRepaymentCount
will be 3 - The
loanRepaymentBookingEntry
will be DEBIT
If there are no transactions that match the input criteria (i.e.,
loanRepaymentCount
=0,) this container is not returned.loanRepaymentBookingEntry
The enumeration value indicates whether the
For most
loanRepaymentAmount
is a DEBIT
against, or a CREDIT
to, the sellers's account.For most
loanRepaymentAmount
transactions, loanRepaymentBookingEntry
will be DEBIT. However, if a loan repayment transaction is reversed, that transaction will be shown as a CREDIT.loanRepaymentCount
This integer value indicates the total number of
This field is generally returned even if it equals 0. However it will not be returned if a
LOAN_REPAYMENT
transactions (i.e., DEBIT
and CREDIT
,) that match the input criteria.This field is generally returned even if it equals 0. However it will not be returned if a
transactionType
filter is used and its value has been set to any enumeration value other than LOAN_REPAYMENT
.nonSaleChargeAmount
The total non-sale charge amount for given payee within a specified period.
onHoldAmount
This amount is the total dollar value of order sales where the associated funds are on hold. Only the orders that match the input criteria are considered.
If there are no seller payment holds (onHoldCount=
If there are no seller payment holds (onHoldCount=
0
), this container is not returned.onHoldBookingEntry
The enumeration value indicates whether the dollar amount in the onHoldAmount field is a charge (debit) to the seller or a credit. Typically, the enumeration value returned here will be
CREDIT
, since on-hold funds should eventually be released as part of a payout to the seller once the hold is cleared.onHoldCount
This integer value indicates the total number of order sales where the associated funds are on hold. Only the orders that match the input criteria are considered.
This field is generally returned, even if
This field is generally returned, even if
0
, but it will not be returned if a transactionStatus filter is used, and its value is set to any value other than FUNDS_ON_HOLD
.purchaseAmount
Note: The
This amount is the total dollar value of all the purchases that have been initiated by a seller using spendable funds that match the input criteria.
If there are no transactions that match the input criteria (i.e.,
PURCHASE
transaction type is currently only applicable in the US marketplace.This amount is the total dollar value of all the purchases that have been initiated by a seller using spendable funds that match the input criteria.
If there are no transactions that match the input criteria (i.e.,
purchaseCount=0
), this container will not be returned.purchaseBookingEntry
Note: The
This enumeration value indicates whether the dollar amount in the purchase field is a charge (debit) to the seller or a credit.
PURCHASE
transaction type is currently only applicable in the US marketplace.This enumeration value indicates whether the dollar amount in the purchase field is a charge (debit) to the seller or a credit.
purchaseCount
Note: The
This integer value indicates the total number of purchases that have been initiated by a seller using spendable funds that match the input criteria.
This field is generally returned, even if it equals
PURCHASE
transaction type is currently only applicable in the US marketplace.This integer value indicates the total number of purchases that have been initiated by a seller using spendable funds that match the input criteria.
This field is generally returned, even if it equals
0
. However, it will not be returned if a transactionType
filter is used and its value has been set to any enumeration value other than PURCHASE
.refundAmount
This amount is the total dollar value of buyer refunds that match the input criteria.
If there are no refunds (refundCount=
If there are no refunds (refundCount=
0
), this container is not returned.refundBookingEntry
The enumeration value indicates whether the dollar amount in the refundAmount field is a charge (debit) to the seller or a credit. Typically, the enumeration value returned here will be
DEBIT
since this a refund from the seller to the buyer.refundCount
This integer value indicates the total number of buyer refunds that match the input criteria.
This field is generally returned, even if
This field is generally returned, even if
0
, but it will not be returned if a transactionType filter is used, and its value is set to any value other than REFUND
.shippingLabelAmount
This is the total dollar value of the eBay shipping labels purchased by the seller.
Note: eBay SHIPPING_LABEL transactions paid through PayPal are not currently supported by the Finances API, so those transactions will not be reflected in the amounts returned in this container.
Note: eBay SHIPPING_LABEL transactions paid through PayPal are not currently supported by the Finances API, so those transactions will not be reflected in the amounts returned in this container.
shippingLabelBookingEntry
The enumeration value indicates whether the dollar amount in the shippingLabelAmount field is a charge (debit) to the seller or a credit. Typically, the enumeration value returned here will be
Note: eBay SHIPPING_LABEL transactions paid through PayPal are not currently supported by the Finances API, so those transactions will not be reflected in this field.
DEBIT
, as eBay will charge the seller when eBay shipping labels are purchased, but it can be CREDIT
if the seller was refunded for a shipping label or was possibly overcharged for a shipping label. Note: eBay SHIPPING_LABEL transactions paid through PayPal are not currently supported by the Finances API, so those transactions will not be reflected in this field.
shippingLabelCount
This is the total number of eBay shipping labels purchased by the seller. The count returned here may depend on the specified input criteria.
Note: eBay SHIPPING_LABEL transactions paid through PayPal are not currently supported by the Finances API, so those transactions will not be reflected in the count returned in this container.
Note: eBay SHIPPING_LABEL transactions paid through PayPal are not currently supported by the Finances API, so those transactions will not be reflected in the count returned in this container.
transferAmount
This amount is the total dollar value of buyer refund transfers that match the input criteria.
If there are no transfers (refundCount=
If there are no transfers (refundCount=
0
), this container is not returned.transferBookingEntry
The enumeration value indicates whether the dollar amount in the transferAmount field is a charge (debit) to the seller or a credit. Typically, the enumeration value returned here will be
DEBIT
since this a seller reimbursement to eBay for buyer refunds.transferCount
This integer value indicates the total number of buyer refund transfers that match the input criteria.
This field is generally returned, even if
This field is generally returned, even if
0
, but it will not be returned if a transactionType filter is used, and its value is set to any value other than TRANSFER
.withdrawalAmount
This amount is the total dollar value of on-demand payouts (withdrawals) that match the input criteria.
If there are no withdrawals (withdrawalCount=
If there are no withdrawals (withdrawalCount=
0
), this container is not returned.withdrawalBookingEntry
The enumeration value indicates whether the dollar amount in the withdrawalAmount field is a charge (debit) to the seller or a credit. Typically, the enumeration value returned here will be
DEBIT
since this transaction involves a debit to the seller's available payout funds.withdrawalCount
This integer value indicates the total number of on-demand payouts (withdrawals) that match the input criteria.
This field is generally returned, even if
This field is generally returned, even if
0
, but it will not be returned if a transactionType filter is used, and its value is set to any value other than WITHDRAWAL
.