brandon14/ebay-sdk-php

View on GitHub
src/Sell/Finances/V1/docs/Model/TransactionSummaryResponse.md

Summary

Maintainability
Test Coverage
# # TransactionSummaryResponse

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**adjustment_amount** | [**\TNT\Ebay\Sell\Finances\V1\Model\Amount**](Amount.md) |  | [optional]
**adjustment_booking_entry** | **string** | The credit debit sign indicator for adjustment. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/finances/types/pay:BookingEntryEnum'>eBay API documentation</a> | [optional]
**adjustment_count** | **int** | Total adjustment count for given payee within a specified period. | [optional]
**balance_transfer_amount** | [**\TNT\Ebay\Sell\Finances\V1\Model\Amount**](Amount.md) |  | [optional]
**balance_transfer_booking_entry** | **string** | The credit debit sign indicator for the balance transfer. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/finances/types/pay:BookingEntryEnum'>eBay API documentation</a> | [optional]
**balance_transfer_count** | **int** | The total balance transfer count for given payee within the specified period. | [optional]
**credit_amount** | [**\TNT\Ebay\Sell\Finances\V1\Model\Amount**](Amount.md) |  | [optional]
**credit_booking_entry** | **string** | The enumeration value indicates whether the dollar amount in the <strong>creditAmount</strong> field is a charge (debit) to the seller or a credit. Typically, the enumeration value returned here will be <code>CREDIT</code>. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/finances/types/pay:BookingEntryEnum'>eBay API documentation</a> | [optional]
**credit_count** | **int** | This integer value indicates the total number of the seller's sales and/or credits that match the input criteria. <br/><br/><span class=\"tablenote\"><strong>Note:</strong> Unless the <b>transactionType</b> filter is used in the request to retrieve a specific type of monetary transaction (sale, buyer refund, or seller credit), the <b>creditCount</b> and <b>creditAmount</b> fields account for both order sales and seller credits (the count and value is not distinguished between the two monetary transaction types).</span><br><br>This field is generally returned, even if <code>0</code>, but it will not be returned if a <strong>transactionType</strong> filter is used, and its value is set to either <code>REFUND</code>, <code>DISPUTE</code>, or <code>SHIPPING_LABEL</code>. | [optional]
**dispute_amount** | [**\TNT\Ebay\Sell\Finances\V1\Model\Amount**](Amount.md) |  | [optional]
**dispute_booking_entry** | **string** | The enumeration value indicates whether the dollar amount in the <strong>disputeAmount</strong> field is a charge (debit) to the seller or a credit. Typically, the enumeration value returned here will be <code>DEBIT</code>, but its possible that <code>CREDIT</code> could be returned if the seller contested one or more payment disputes and won the dispute. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/finances/types/pay:BookingEntryEnum'>eBay API documentation</a> | [optional]
**dispute_count** | **int** | 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. <br><br>This field is generally returned, even if <code>0</code>, but it will not be returned if a <strong>transactionType</strong> filter is used, and its value is set to any value other than <code>DISPUTE</code>. | [optional]
**loan_repayment_amount** | [**\TNT\Ebay\Sell\Finances\V1\Model\Amount**](Amount.md) |  | [optional]
**loan_repayment_booking_entry** | **string** | The enumeration value indicates whether the <code>loanRepaymentAmount</code> is a <code>DEBIT</code> against, or a <code>CREDIT</code> to, the sellers's account.<br/><br/>For most <code>loanRepaymentAmount</code> transactions, <code>loanRepaymentBookingEntry</code> will be <b>DEBIT</b>. However, if a loan repayment transaction is reversed, that transaction will be shown as a <b>CREDIT</b>. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/finances/types/pay:BookingEntryEnum'>eBay API documentation</a> | [optional]
**loan_repayment_count** | **int** | This integer value indicates the total number of <code>LOAN_REPAYMENT</code> transactions (i.e., <code>DEBIT</code> and <code>CREDIT</code>,) that match the input criteria.<br/><br/>This field is generally returned even if it equals <b>0</b>. However it will not be returned if a <code>transactionType</code> filter is used and its value has been set to any enumeration value other than <code>LOAN_REPAYMENT</code>. | [optional]
**non_sale_charge_amount** | [**\TNT\Ebay\Sell\Finances\V1\Model\Amount**](Amount.md) |  | [optional]
**non_sale_charge_booking_entry** | **string** | The credit/debit sign indicator for the non-sale charge. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/finances/types/pay:BookingEntryEnum'>eBay API documentation</a> | [optional]
**non_sale_charge_count** | **int** | The total non-sale charge count for given payee within a specified period. | [optional]
**on_hold_amount** | [**\TNT\Ebay\Sell\Finances\V1\Model\Amount**](Amount.md) |  | [optional]
**on_hold_booking_entry** | **string** | The enumeration value indicates whether the dollar amount in the <strong>onHoldAmount</strong> field is a charge (debit) to the seller or a credit. Typically, the enumeration value returned here will be <code>CREDIT</code>, 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 <a href='https://developer.ebay.com/api-docs/sell/finances/types/pay:BookingEntryEnum'>eBay API documentation</a> | [optional]
**on_hold_count** | **int** | 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.<br><br>This field is generally returned, even if <code>0</code>, but it will not be returned if a <strong>transactionStatus</strong> filter is used, and its value is set to any value other than <code>FUNDS_ON_HOLD</code>. | [optional]
**refund_amount** | [**\TNT\Ebay\Sell\Finances\V1\Model\Amount**](Amount.md) |  | [optional]
**refund_booking_entry** | **string** | The enumeration value indicates whether the dollar amount in the <strong>refundAmount</strong> field is a charge (debit) to the seller or a credit. Typically, the enumeration value returned here will be <code>DEBIT</code> since this a refund from the seller to the buyer. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/finances/types/pay:BookingEntryEnum'>eBay API documentation</a> | [optional]
**refund_count** | **int** | This integer value indicates the total number of buyer refunds that match the input criteria. <br><br>This field is generally returned, even if <code>0</code>, but it will not be returned if a <strong>transactionType</strong> filter is used, and its value is set to any value other than <code>REFUND</code>. | [optional]
**shipping_label_amount** | [**\TNT\Ebay\Sell\Finances\V1\Model\Amount**](Amount.md) |  | [optional]
**shipping_label_booking_entry** | **string** | The enumeration value indicates whether the dollar amount in the <strong>shippingLabelAmount</strong> field is a charge (debit) to the seller or a credit. Typically, the enumeration value returned here will be <code>DEBIT</code>, as eBay will charge the seller when eBay shipping labels are purchased, but it can be <code>CREDIT</code> if the seller was refunded for a shipping label or was possibly overcharged for a shipping label. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/finances/types/pay:BookingEntryEnum'>eBay API documentation</a> | [optional]
**shipping_label_count** | **int** | This is the total number of eBay shipping labels purchased by the seller. The count returned here may depend on the specified input criteria. | [optional]
**transfer_amount** | [**\TNT\Ebay\Sell\Finances\V1\Model\Amount**](Amount.md) |  | [optional]
**transfer_booking_entry** | **string** | The enumeration value indicates whether the dollar amount in the <strong>transferAmount</strong> field is a charge (debit) to the seller or a credit. Typically, the enumeration value returned here will be <code>DEBIT</code> since this a seller reimbursement to eBay for buyer refunds. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/finances/types/pay:BookingEntryEnum'>eBay API documentation</a> | [optional]
**transfer_count** | **int** | This integer value indicates the total number of buyer refund transfers that match the input criteria. <br><br>This field is generally returned, even if <code>0</code>, but it will not be returned if a <strong>transactionType</strong> filter is used, and its value is set to any value other than <code>TRANSFER</code>. | [optional]
**withdrawal_amount** | [**\TNT\Ebay\Sell\Finances\V1\Model\Amount**](Amount.md) |  | [optional]
**withdrawal_booking_entry** | **string** | The enumeration value indicates whether the dollar amount in the <strong>withdrawalAmount</strong> field is a charge (debit) to the seller or a credit. Typically, the enumeration value returned here will be <code>DEBIT</code> since this transaction involves a debit to the seller's available payout funds. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/finances/types/pay:BookingEntryEnum'>eBay API documentation</a> | [optional]
**withdrawal_count** | **int** | This integer value indicates the total number of on-demand payouts (withdrawals) that match the input criteria. <br><br>This field is generally returned, even if <code>0</code>, but it will not be returned if a <strong>transactionType</strong> filter is used, and its value is set to any value other than <code>WITHDRAWAL</code>. | [optional]

[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)