{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "#/components/schemas/TransactionSummaryResponse", "title": "TransactionSummaryResponse", "type": "object", "properties": { "adjustmentAmount": { "description": "Total adjustment amount for given payee within a specified period.", "$ref": "#/components/schemas/Amount" }, "adjustmentBookingEntry": { "type": "string", "description": "The credit debit sign indicator for adjustment. For implementation help, refer to eBay API documentation" }, "adjustmentCount": { "type": "integer", "description": "Total adjustment count for given payee within a specified period.", "format": "int32" }, "balanceTransferAmount": { "description": "The total balance transfer amount for given payee within the specified period.", "$ref": "#/components/schemas/Amount" }, "balanceTransferBookingEntry": { "type": "string", "description": "The credit debit sign indicator for the balance transfer. For implementation help, refer to eBay API documentation" }, "balanceTransferCount": { "type": "integer", "description": "The total balance transfer count for given payee within the specified period.", "format": "int32" }, "creditAmount": { "description": "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=0), this container is not returned.", "$ref": "#/components/schemas/Amount" }, "creditBookingEntry": { "type": "string", "description": "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. For implementation help, refer to eBay API documentation" }, "creditCount": { "type": "integer", "description": "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 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.", "format": "int32" }, "disputeAmount": { "description": "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=0), this container is not returned.", "$ref": "#/components/schemas/Amount" }, "disputeBookingEntry": { "type": "string", "description": "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. For implementation help, refer to eBay API documentation" }, "disputeCount": { "type": "integer", "description": "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 0, but it will not be returned if a transactionType filter is used, and its value is set to any value other than DISPUTE.", "format": "int32" }, "loanRepaymentAmount": { "description": "The sum of all 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:
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:
If there are no transactions that match the input criteria (i.e., loanRepaymentCount=0,) this container is not returned.", "$ref": "#/components/schemas/Amount" }, "loanRepaymentBookingEntry": { "type": "string", "description": "The enumeration value indicates whether the 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. For implementation help, refer to eBay API documentation" }, "loanRepaymentCount": { "type": "integer", "description": "This integer value indicates the total number of 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.", "format": "int32" }, "nonSaleChargeAmount": { "description": "The total non-sale charge amount for given payee within a specified period.", "$ref": "#/components/schemas/Amount" }, "nonSaleChargeBookingEntry": { "type": "string", "description": "The credit/debit sign indicator for the non-sale charge. For implementation help, refer to eBay API documentation" }, "nonSaleChargeCount": { "type": "integer", "description": "The total non-sale charge count for given payee within a specified period.", "format": "int32" }, "onHoldAmount": { "description": "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=0), this container is not returned.", "$ref": "#/components/schemas/Amount" }, "onHoldBookingEntry": { "type": "string", "description": "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. For implementation help, refer to eBay API documentation" }, "onHoldCount": { "type": "integer", "description": "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 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.", "format": "int32" }, "purchaseAmount": { "description": "Note: The 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.", "$ref": "#/components/schemas/Amount" }, "purchaseBookingEntry": { "type": "string", "description": "Note: The 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. For implementation help, refer to eBay API documentation" }, "purchaseCount": { "type": "integer", "description": "Note: The 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.", "format": "int32" }, "refundAmount": { "description": "This amount is the total dollar value of buyer refunds that match the input criteria.

If there are no refunds (refundCount=0), this container is not returned.", "$ref": "#/components/schemas/Amount" }, "refundBookingEntry": { "type": "string", "description": "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. For implementation help, refer to eBay API documentation" }, "refundCount": { "type": "integer", "description": "This integer value indicates the total number of buyer refunds that match the input criteria.

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.", "format": "int32" }, "shippingLabelAmount": { "description": "This is the total dollar value of the eBay shipping labels purchased by the seller.", "$ref": "#/components/schemas/Amount" }, "shippingLabelBookingEntry": { "type": "string", "description": "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 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. For implementation help, refer to eBay API documentation" }, "shippingLabelCount": { "type": "integer", "description": "This is the total number of eBay shipping labels purchased by the seller. The count returned here may depend on the specified input criteria.", "format": "int32" }, "transferAmount": { "description": "This amount is the total dollar value of buyer refund transfers that match the input criteria.

If there are no transfers (refundCount=0), this container is not returned.", "$ref": "#/components/schemas/Amount" }, "transferBookingEntry": { "type": "string", "description": "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. For implementation help, refer to eBay API documentation" }, "transferCount": { "type": "integer", "description": "This integer value indicates the total number of buyer refund transfers that match the input criteria.

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.", "format": "int32" }, "withdrawalAmount": { "description": "This amount is the total dollar value of on-demand payouts (withdrawals) that match the input criteria.

If there are no withdrawals (withdrawalCount=0), this container is not returned.", "$ref": "#/components/schemas/Amount" }, "withdrawalBookingEntry": { "type": "string", "description": "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. For implementation help, refer to eBay API documentation" }, "withdrawalCount": { "type": "integer", "description": "This integer value indicates the total number of on-demand payouts (withdrawals) that match the input criteria.

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.", "format": "int32" } }, "description": "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." }