Finances API — client.sell.finances¶
Version v1.19.0 · base path /sell/finances/v1 · async twin: the same methods on
AsyncEbayClient, awaited.
Operations¶
Bases: BaseResource
get_order_earnings ¶
get_order_earnings(*, x_ebay_c_marketplace_id: str | None = None, filter: str | None = None, limit: int | str | None = None, offset: int | str | None = None, sort: str | None = None, raw_response: Literal[False] = False) -> sell_finances_models.OrderEarnings
get_order_earnings(*, x_ebay_c_marketplace_id: str | None = None, filter: str | None = None, limit: int | str | None = None, offset: int | str | None = None, sort: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_order_earnings(*, x_ebay_c_marketplace_id: str | None = None, filter: str | None = None, limit: int | str | None = None, offset: int | str | None = None, sort: str | None = None, raw_response: bool = False) -> sell_finances_models.OrderEarnings | httpx.Response
This method returns detailed order-level financial data for each order associated with a seller account. The returned order-level financial data includes order earnings, gross amount, expenses, and refunds. Order earnings includes earnings after deducting expenses and refunds from the gross amount. Note: Expenses include fees, shipping labels, and donations.
get_order_earnings_by_id ¶
get_order_earnings_by_id(order_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_finances_models.OrderEarning
get_order_earnings_by_id(order_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_order_earnings_by_id(order_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_finances_models.OrderEarning | httpx.Response
This method returns detailed order-level financial data including order earnings, gross amount, expenses, and refunds. Order earnings includes earnings after deducting expenses and refunds from the gross amount. Note: Expenses include fees, shipping labels, and donations. Refunds include gross refunds, gross claims, and gross payment disputes.
get_order_earnings_summary ¶
get_order_earnings_summary(*, x_ebay_c_marketplace_id: str | None = None, filter: str | None = None, raw_response: Literal[False] = False) -> sell_finances_models.OrderEarningsSummary
get_order_earnings_summary(*, x_ebay_c_marketplace_id: str | None = None, filter: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_order_earnings_summary(*, x_ebay_c_marketplace_id: str | None = None, filter: str | None = None, raw_response: bool = False) -> sell_finances_models.OrderEarningsSummary | httpx.Response
This method returns a summarized view of order earnings information for one or more orders associated with a seller account. The method retrieves aggregated data for order earnings after deducting expenses and refunds from the gross amount. You can use this method for high-level financial reporting workflows. Note: Expenses include fees, shipping labels, and donations.
get_payout ¶
get_payout(payout_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_finances_models.Payout
get_payout(payout_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_payout(payout_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_finances_models.Payout | httpx.Response
Important! Due to EU & UK Payments regulatory requirements, an additional security verification via Digital Signatures is required for certain API calls that are made on behalf of EU/UK sellers, including all Finances API methods. Please refer to Digital Signatures for APIs to learn more on the impacted APIs and the process to create signatures to be included in the HTTP payload.
get_payouts ¶
get_payouts(*, x_ebay_c_marketplace_id: str | None = None, filter: str | None = None, limit: int | str | None = None, offset: int | str | None = None, sort: str | None = None, raw_response: Literal[False] = False) -> sell_finances_models.Payouts
get_payouts(*, x_ebay_c_marketplace_id: str | None = None, filter: str | None = None, limit: int | str | None = None, offset: int | str | None = None, sort: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_payouts(*, x_ebay_c_marketplace_id: str | None = None, filter: str | None = None, limit: int | str | None = None, offset: int | str | None = None, sort: str | None = None, raw_response: bool = False) -> sell_finances_models.Payouts | httpx.Response
Important! Due to EU & UK Payments regulatory requirements, an additional security verification via Digital Signatures is required for certain API calls that are made on behalf of EU/UK sellers, including all Finances API methods. Please refer to Digital Signatures for APIs to learn more on the impacted APIs and the process to create signatures to be included in the HTTP payload.
get_payout_summary ¶
get_payout_summary(*, x_ebay_c_marketplace_id: str | None = None, filter: str | None = None, raw_response: Literal[False] = False) -> sell_finances_models.PayoutSummaryResponse
get_payout_summary(*, x_ebay_c_marketplace_id: str | None = None, filter: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_payout_summary(*, x_ebay_c_marketplace_id: str | None = None, filter: str | None = None, raw_response: bool = False) -> sell_finances_models.PayoutSummaryResponse | httpx.Response
Important! Due to EU & UK Payments regulatory requirements, an additional security verification via Digital Signatures is required for certain API calls that are made on behalf of EU/UK sellers, including all Finances API methods. Please refer to Digital Signatures for APIs to learn more on the impacted APIs and the process to create signatures to be included in the HTTP payload.
get_seller_funds_summary ¶
get_seller_funds_summary(*, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_finances_models.SellerFundsSummaryResponse
get_seller_funds_summary(*, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_seller_funds_summary(*, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_finances_models.SellerFundsSummaryResponse | httpx.Response
Important! Due to EU & UK Payments regulatory requirements, an additional security verification via Digital Signatures is required for certain API calls that are made on behalf of EU/UK sellers, including all Finances API methods. Please refer to Digital Signatures for APIs to learn more on the impacted APIs and the process to create signatures to be included in the HTTP payload.
get_transactions ¶
get_transactions(*, x_ebay_c_marketplace_id: str | None = None, filter: str | None = None, limit: int | str | None = None, offset: int | str | None = None, sort: str | None = None, raw_response: Literal[False] = False) -> sell_finances_models.Transactions
get_transactions(*, x_ebay_c_marketplace_id: str | None = None, filter: str | None = None, limit: int | str | None = None, offset: int | str | None = None, sort: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_transactions(*, x_ebay_c_marketplace_id: str | None = None, filter: str | None = None, limit: int | str | None = None, offset: int | str | None = None, sort: str | None = None, raw_response: bool = False) -> sell_finances_models.Transactions | httpx.Response
Important! Due to EU & UK Payments regulatory requirements, an additional security verification via Digital Signatures is required for certain API calls that are made on behalf of EU/UK sellers, including all Finances API methods. Please refer to Digital Signatures for APIs to learn more on the impacted APIs and the process to create signatures to be included in the HTTP payload.
get_transaction_summary ¶
get_transaction_summary(*, x_ebay_c_marketplace_id: str | None = None, filter: str | None = None, raw_response: Literal[False] = False) -> sell_finances_models.TransactionSummaryResponse
get_transaction_summary(*, x_ebay_c_marketplace_id: str | None = None, filter: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_transaction_summary(*, x_ebay_c_marketplace_id: str | None = None, filter: str | None = None, raw_response: bool = False) -> sell_finances_models.TransactionSummaryResponse | httpx.Response
Important! Due to EU & UK Payments regulatory requirements, an additional security verification via Digital Signatures is required for certain API calls that are made on behalf of EU/UK sellers, including all Finances API methods. Please refer to Digital Signatures for APIs to learn more on the impacted APIs and the process to create signatures to be included in the HTTP payload.
get_transfer ¶
get_transfer(transfer_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_finances_models.Transfer
get_transfer(transfer_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_transfer(transfer_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_finances_models.Transfer | httpx.Response
Important! Due to EU & UK Payments regulatory requirements, an additional security verification via Digital Signatures is required for certain API calls that are made on behalf of EU/UK sellers, including all Finances API methods. Please refer to Digital Signatures for APIs to learn more on the impacted APIs and the process to create signatures to be included in the HTTP payload.
get_billing_activities ¶
get_billing_activities(*, accept_language: str | None = None, filter: str | None = None, limit: int | str | None = None, offset: int | str | None = None, sort: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_finances_models.BillingActivityResponse
get_billing_activities(*, accept_language: str | None = None, filter: str | None = None, limit: int | str | None = None, offset: int | str | None = None, sort: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_billing_activities(*, accept_language: str | None = None, filter: str | None = None, limit: int | str | None = None, offset: int | str | None = None, sort: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_finances_models.BillingActivityResponse | httpx.Response
Important! Due to EU & UK Payments regulatory requirements, an additional security verification via Digital Signatures is required for certain API calls that are made on behalf of EU/UK sellers, including all Finances API methods. Please refer to Digital Signatures for APIs to learn more on the impacted APIs and the process to create signatures to be included in the HTTP payload.
Models¶
BookingEntryEnum ¶
Buyer ¶
Bases: EbayModel
username
class-attribute
instance-attribute
¶
username = Field(None, description="The eBay user ID of the order's buyer. Note: Effective September 26, 2025, select developers will no longer receive username data for U.S. users through this field. Instead, an immutable user ID will be returned in its place. For more information, please refer to Data Handling Compliance .")
BuyerWithId ¶
Bases: EbayModel
user_id
class-attribute
instance-attribute
¶
user_id = Field(None, alias='userId', description='The public user id of the buyer')
username
class-attribute
instance-attribute
¶
username = Field(None, description='The username of the buyer. Note: Effective September 26, 2025, select developers will no longer receive username data for U.S. users through this field. Instead, an immutable user ID will be returned in its place. For more information, please refer to Data Handling Compliance .')
CurrencyCodeEnum ¶
Bases: OpenStrEnum
ErrorParameter ¶
FeeTypeEnum ¶
Bases: OpenStrEnum
below_standard_shipping_fee
class-attribute
instance-attribute
¶
below_standard_shipping_fee = 'BELOW_STANDARD_SHIPPING_FEE'
final_value_fee_fixed_per_order
class-attribute
instance-attribute
¶
final_value_fee_fixed_per_order = 'FINAL_VALUE_FEE_FIXED_PER_ORDER'
high_item_not_as_described_fee
class-attribute
instance-attribute
¶
high_item_not_as_described_fee = 'HIGH_ITEM_NOT_AS_DESCRIBED_FEE'
high_item_not_as_described_shipping_fee
class-attribute
instance-attribute
¶
high_item_not_as_described_shipping_fee = 'HIGH_ITEM_NOT_AS_DESCRIBED_SHIPPING_FEE'
payment_processing_fee
class-attribute
instance-attribute
¶
payment_processing_fee = 'PAYMENT_PROCESSING_FEE'
final_value_shipping_fee
class-attribute
instance-attribute
¶
final_value_shipping_fee = 'FINAL_VALUE_SHIPPING_FEE'
category_featured_fee
class-attribute
instance-attribute
¶
category_featured_fee = 'CATEGORY_FEATURED_FEE'
featured_gallery_fee
class-attribute
instance-attribute
¶
featured_gallery_fee = 'FEATURED_GALLERY_FEE'
ebay_store_subscription_fee
class-attribute
instance-attribute
¶
ebay_store_subscription_fee = 'EBAY_STORE_SUBSCRIPTION_FEE'
international_listing_fee
class-attribute
instance-attribute
¶
international_listing_fee = 'INTERNATIONAL_LISTING_FEE'
pro_pack_bundle_fee
class-attribute
instance-attribute
¶
pro_pack_bundle_fee = 'PRO_PACK_BUNDLE_FEE'
marketplace_research_pro_subscription_fee
class-attribute
instance-attribute
¶
marketplace_research_pro_subscription_fee = 'MARKETPLACE_RESEARCH_PRO_SUBSCRIPTION_FEE'
vehicle_local_subscription_fee
class-attribute
instance-attribute
¶
vehicle_local_subscription_fee = 'VEHICLE_LOCAL_SUBSCRIPTION_FEE'
vehicle_local_insertion_fee
class-attribute
instance-attribute
¶
vehicle_local_insertion_fee = 'VEHICLE_LOCAL_INSERTION_FEE'
value_pack_bundle_fee
class-attribute
instance-attribute
¶
value_pack_bundle_fee = 'VALUE_PACK_BUNDLE_FEE'
pro_pack_plus_bundle_fee
class-attribute
instance-attribute
¶
pro_pack_plus_bundle_fee = 'PRO_PACK_PLUS_BUNDLE_FEE'
ebay_motors_pro_fee
class-attribute
instance-attribute
¶
ebay_motors_pro_fee = 'EBAY_MOTORS_PRO_FEE'
private_listing_fee
class-attribute
instance-attribute
¶
private_listing_fee = 'PRIVATE_LISTING_FEE'
auction_end_early_fee
class-attribute
instance-attribute
¶
auction_end_early_fee = 'AUCTION_END_EARLY_FEE'
store_subscription_early_termination_fee
class-attribute
instance-attribute
¶
store_subscription_early_termination_fee = 'STORE_SUBSCRIPTION_EARLY_TERMINATION_FEE'
ebay_plus_subscription_fee
class-attribute
instance-attribute
¶
ebay_plus_subscription_fee = 'EBAY_PLUS_SUBSCRIPTION_FEE'
vehicle_subscription_fee
class-attribute
instance-attribute
¶
vehicle_subscription_fee = 'VEHICLE_SUBSCRIPTION_FEE'
co_funding_coupon_fee
class-attribute
instance-attribute
¶
co_funding_coupon_fee = 'CO_FUNDING_COUPON_FEE'
payment_dispute_fee
class-attribute
instance-attribute
¶
payment_dispute_fee = 'PAYMENT_DISPUTE_FEE'
vehicles_basic_package_fee
class-attribute
instance-attribute
¶
vehicles_basic_package_fee = 'VEHICLES_BASIC_PACKAGE_FEE'
vehicles_plus_package_fee
class-attribute
instance-attribute
¶
vehicles_plus_package_fee = 'VEHICLES_PLUS_PACKAGE_FEE'
vehicles_premium_package_fee
class-attribute
instance-attribute
¶
vehicles_premium_package_fee = 'VEHICLES_PREMIUM_PACKAGE_FEE'
deposit_processing_fee
class-attribute
instance-attribute
¶
deposit_processing_fee = 'DEPOSIT_PROCESSING_FEE'
tax_deduction_at_source
class-attribute
instance-attribute
¶
tax_deduction_at_source = 'TAX_DEDUCTION_AT_SOURCE'
income_tax_withholding
class-attribute
instance-attribute
¶
income_tax_withholding = 'INCOME_TAX_WITHHOLDING'
regulatory_operating_fee
class-attribute
instance-attribute
¶
regulatory_operating_fee = 'REGULATORY_OPERATING_FEE'
FundingSource ¶
Bases: EbayModel
brand
class-attribute
instance-attribute
¶
brand = Field(None, description='The brand name of the credit card or the name of the financial institution that is the source of payment. This field may not be populated for other funding sources.')
memo
class-attribute
instance-attribute
¶
memo = Field(None, description="This field provides a note about the funding source. If the seller's credit card or bank account is the funding source, this field might contain the last four digits of the credit card or bank account. This field may also be returned as null.")
type
class-attribute
instance-attribute
¶
type = Field(None, description="The string value returned here indicates the funding source. Possible values include the following: AVAILABLE_FUNDS : transfer is funded with seller payout funds CREDIT_CARD : transfer is funded with seller's credit card BANK : transfer is funded with a direct debit to seller's bank account on file with eBay PAY_UPON_INVOICE : eBay will bill the seller for the transfer on the monthly invoice")
PayoutDetails ¶
Bases: EbayModel
payout_ids
class-attribute
instance-attribute
¶
payout_ids = Field(None, alias='payoutIds', description='This array indicates the list of true(actual) payout ids associated with a split payout. These values can be used as a path parameter for the getPayout method to retrieve details on the associated payouts.')
payout_reference
class-attribute
instance-attribute
¶
payout_reference = Field(None, alias='payoutReference', description='This field contains the unique identifier for the Payout Reference. In split-payout cases, this is the unique identifier reference (not true payout). This field is only returned and will show the associated true(actual) payout id(s) when sellers in Mainland China enable split payouts between a Payoneer account and/or a bank account.')
PayoutInstrument ¶
Bases: EbayModel
account_last_four_digits
class-attribute
instance-attribute
¶
account_last_four_digits = Field(None, alias='accountLastFourDigits', description='This value is the last four digits of the account that the seller uses to receive the payout. This may be the last four digits of a bank account, a debit card, or a payment processor account such as Payoneer.')
instrument_type
class-attribute
instance-attribute
¶
instrument_type = Field(None, alias='instrumentType', description="This value indicates the type of account that received the payout. The value returned in this field may be: BANK : indicates that the payout was made to a seller's bank account. CARD : indicates that the payout went to a seller's debit card The name of a digital wallet provider or payment processor (e.g., PAYONEER ) Note: Only Payoneer is currently supported for sellers in mainland China.")
nickname
class-attribute
instance-attribute
¶
nickname = Field(None, description='When instrumentType returns BANK , this value is the seller-provided nickname that the seller uses to represent the bank account that receives the payout. When instrumentType returns CARD , this value is the debit card network for the debit card that receives the payout.')
payout_percentage
class-attribute
instance-attribute
¶
payout_percentage = Field(None, alias='payoutPercentage', description='This value indicates the current payout percentage allocated to a payout instrument. For example, 50 indicates that 50% of the payout goes to the instrument. This field will be returned even when 100% of the payout funds are going to one payout instrument. This field is only returned to sellers in mainland China.')
PayoutStatusEnum ¶
Bases: OpenStrEnum
RangeValue ¶
ReferenceTypeEnum ¶
Bases: OpenStrEnum
payments_dispute_id
class-attribute
instance-attribute
¶
payments_dispute_id = 'PAYMENTS_DISPUTE_ID'
RegionTypeEnum ¶
SortField ¶
TransactionStatusEnum ¶
Bases: OpenStrEnum
funds_available_for_payout
class-attribute
instance-attribute
¶
funds_available_for_payout = 'FUNDS_AVAILABLE_FOR_PAYOUT'
TransactionTypeEnum ¶
Bases: OpenStrEnum
Amount ¶
Bases: EbayModel
converted_from_currency
class-attribute
instance-attribute
¶
converted_from_currency = Field(None, alias='convertedFromCurrency', description='The three-letter ISO 4217 code representing the currency of the amount in the convertedFromValue field. This value is the pre-conversion currency. This field is only returned if/when currency conversion was applied by eBay.')
converted_from_value
class-attribute
instance-attribute
¶
converted_from_value = Field(None, alias='convertedFromValue', description='The monetary amount before any conversion is performed, in the currency specified by the convertedFromCurrency field. This value is the pre-conversion amount. The value field contains the converted amount of this value, in the currency specified by the currency field. This field is only returned if/when currency conversion was applied by eBay.')
converted_to_currency
class-attribute
instance-attribute
¶
converted_to_currency = Field(None, alias='convertedToCurrency', description='Note: This field is only applicable for Mainland China sellers with an available CNY Bank payment instrument. This response can only have a value of CNY . The three-letter ISO 4217 code representing the currency of the amount in the convertedToValue field. This field is only returned for payouts to bank accounts when currency conversion was applied by eBay.')
converted_to_value
class-attribute
instance-attribute
¶
converted_to_value = Field(None, alias='convertedToValue', description='Note: This field is only applicable for Mainland China sellers with an available CNY Bank payment instrument. This response only returns value in CNY. The monetary value after any conversion is performed, in the currency specified by the convertedToCurrency field. This value is the converted amount.')
currency
class-attribute
instance-attribute
¶
currency = Field(None, description="A three-letter ISO 4217 code that indicates the currency of the amount in the value field. This field is always returned with any container using Amount type. Default : The currency of the authenticated user's country.")
exchange_rate
class-attribute
instance-attribute
¶
exchange_rate = Field(None, alias='exchangeRate', description='The exchange rate used for the monetary conversion. This field shows the exchange rate used to convert the dollar value in the value field from the dollar value in the convertedFromValue field. For sellers in mainland China, this field shows the exchange rate to convert the dollar value in the value field to the CNY value in the convertedToValue field.')
value
class-attribute
instance-attribute
¶
value = Field(None, description='The monetary amount, in the currency specified by the currency field. This field is always returned with any container using Amount type.')
BalanceAdjustment ¶
Bases: EbayModel
adjustment_amount
class-attribute
instance-attribute
¶
adjustment_amount = Field(None, alias='adjustmentAmount', description='The seller payout balance amount that will be applied toward the charges outlined in the charges array.')
adjustment_type
class-attribute
instance-attribute
¶
adjustment_type = Field(None, alias='adjustmentType', description='The enumeration value returned here indicates if the charge is a DEBIT or a CREDIT to the seller. Generally, all transfer transaction types are going to be DEBIT , since the money is being transferred from the seller to eBay.')
Charge ¶
Bases: EbayModel
cancellation_id
class-attribute
instance-attribute
¶
cancellation_id = Field(None, alias='cancellationId', description='The unique identifier of an order cancellation. This field is only applicable and returned if the charge is related to an order cancellation.')
case_id
class-attribute
instance-attribute
¶
case_id = Field(None, alias='caseId', description='The unique identifier of a case filed against an order. This field is only applicable and returned if the charge is related to a case filed against an order.')
charge_net_amount
class-attribute
instance-attribute
¶
charge_net_amount = Field(None, alias='chargeNetAmount', description='This container shows the net amount of the charge, which is the total amount of the charge minus the total amount of fees credited towards this refund as per eBay policy. It is possible for there to be multiple charges from multiple orders with one transfer. The net aggregate amount for all charges found in the charges array can be found in the transferDetail.totalChargeNetAmount container.')
inquiry_id
class-attribute
instance-attribute
¶
inquiry_id = Field(None, alias='inquiryId', description='The unique identifier of an Item Not Received (INR) inquiry filed against an order. This field is only applicable and returned if the charge is related to has an INR inquiry filed against the order.')
order_id
class-attribute
instance-attribute
¶
order_id = Field(None, alias='orderId', description='The unique identifier of the order that is associated with the charge.')
payment_dispute_id
class-attribute
instance-attribute
¶
payment_dispute_id = Field(None, alias='paymentDisputeId', description="The unique identifier of a third-party payment dispute filed against an order. This occurs when the buyer files a dispute against the order with their payment provider, and then the dispute comes into eBay's system. This field is only applicable and returned if the charge is related to a third-party payment dispute filed against an order.")
refund_id
class-attribute
instance-attribute
¶
refund_id = Field(None, alias='refundId', description='The unique identifier of a buyer refund associated with the charge.')
return_id
class-attribute
instance-attribute
¶
return_id = Field(None, alias='returnId', description='The unique identifier of an order return. This field is only applicable and returned if the charge is related to an order that was returned by the buyer.')
DiscountDetail ¶
Bases: EbayModel
amount
class-attribute
instance-attribute
¶
amount = Field(None, description='This container shows the amount of the promotion. The value and currency are always returned. If the buyer is in one country and purchases from an eBay marketplace that uses a different currency, the response also includes the converted-from and converted-to fields, and the exchange rate.')
offer_type
class-attribute
instance-attribute
¶
offer_type = Field(None, alias='offerType', description="The type of promotional discount applied through the activity's promotional offer amount . Examples include offer types such as ETRS (eBay Top Rated Seller) and PROMOTION .")
Error ¶
Bases: EbayModel
category
class-attribute
instance-attribute
¶
category = Field(None, description='Identifies the type of erro.')
domain
class-attribute
instance-attribute
¶
domain = Field(None, description='Name for the primary system where the error occurred. This is relevant for application errors.')
error_id
class-attribute
instance-attribute
¶
error_id = Field(None, alias='errorId', description='A unique number to identify the error.')
input_ref_ids
class-attribute
instance-attribute
¶
input_ref_ids = Field(None, alias='inputRefIds', description='An array of request elements most closely associated to the error.')
long_message
class-attribute
instance-attribute
¶
long_message = Field(None, alias='longMessage', description='A more detailed explanation of the error.')
message
class-attribute
instance-attribute
¶
message = Field(None, description="Information on how to correct the problem, in the end user's terms and language where applicable.")
output_ref_ids
class-attribute
instance-attribute
¶
output_ref_ids = Field(None, alias='outputRefIds', description='An array of request elements most closely associated to the error.')
parameters
class-attribute
instance-attribute
¶
parameters = Field(None, description='An array of name/value pairs that describe details the error condition. These are useful when multiple errors are returned.')
subdomain
class-attribute
instance-attribute
¶
subdomain = Field(None, description='Further helps indicate which subsystem the error is coming from. System subcategories include: Initialization, Serialization, Security, Monitoring, Rate Limiting, etc.')
FeeJurisdiction ¶
Bases: EbayModel
region_name
class-attribute
instance-attribute
¶
region_name = Field(None, alias='regionName', description='The name of the region to which the fee applies. The set of valid regionName values returned is determined by the corresponding regionType value. Note: Currently supported regionName values are standard two-character country or state codes. Typical examples include: MX (Mexico) IN (India) US (United States) CA (California) VT (Vermont) ME (Maine)')
region_type
class-attribute
instance-attribute
¶
region_type = Field(None, alias='regionType', description='This enumeration value indicates the type of region that the fee jurisdiction represents, such as a country or a state.')
FilterField ¶
OrderEarningFee ¶
OrderEarningsSummary ¶
Bases: EbayModel
expenses
class-attribute
instance-attribute
¶
expenses = Field(None, description="The aggregate amount of expenses for all orders included in the summary. Note: Expenses are always in the seller's payout currency. Conversion-related fields (such as exchangeRate ) in this container do not apply to the order_earnings resource.")
gross_amount
class-attribute
instance-attribute
¶
gross_amount = Field(None, alias='grossAmount', description="The aggregate gross amount for all orders included in the order earnings summary. This amount equals the item subtotal plus shipping and handling, and any seller-collected taxes paid by the buyer, minus any seller-offered discount. Note: Gross amount is always in the seller's payout currency.")
order_count
class-attribute
instance-attribute
¶
order_count = Field(None, alias='orderCount', description='The total number of orders included in the summary.')
order_earnings
class-attribute
instance-attribute
¶
order_earnings = Field(None, alias='orderEarnings', description="The aggregate earnings amount for all orders included in the summary, which includes the amount of order earnings after deducting expenses and any refunds from the gross amount. Note: Order earnings are always in the seller's payout currency. Conversion-related fields (such as exchangeRate ) in this container do not apply to the order_earnings resource.")
refunds
class-attribute
instance-attribute
¶
refunds = Field(None, description="The aggregate amount of all refunds issued for the orders included in the summary. Note: Refunds include gross refunds, gross claims, and gross payment disputes. Note: Refunds are always in the seller's payout currency. Conversion-related fields (such as exchangeRate ) in this container do not apply to the order_earnings resource.")
OrderSummary ¶
Bases: EbayModel
discounts
class-attribute
instance-attribute
¶
discounts = Field(None, description='The total amount of item-level promotions or discounts offered by the seller for a sale (order).')
item_subtotal
class-attribute
instance-attribute
¶
item_subtotal = Field(None, alias='itemSubtotal', description='The sum of the listing price(s) for all items in the order, before applying any seller discounts.')
seller_collected_taxes
class-attribute
instance-attribute
¶
seller_collected_taxes = Field(None, alias='sellerCollectedTaxes', description='The total amount of tax collected by the seller on all sold items for the order.')
shipping_and_handling_costs
class-attribute
instance-attribute
¶
shipping_and_handling_costs = Field(None, alias='shippingAndHandlingCosts', description='The total amount collected from the buyer to cover shipping and handling for all items in the order.')
PayoutSummaryResponse ¶
Bases: EbayModel
amount
class-attribute
instance-attribute
¶
amount = Field(None, description='This container shows the total value (and currency type used) of the seller payouts that match the input criteria. This field is not returned if there are no payouts that match the input criteria.')
payout_count
class-attribute
instance-attribute
¶
payout_count = Field(None, alias='payoutCount', description='This integer value indicates the total count of payouts to the seller that match the input criteria. This field is always returned, even if there are no payouts that match the input criteria (its value will show 0 ).')
transaction_count
class-attribute
instance-attribute
¶
transaction_count = Field(None, alias='transactionCount', description='This integer value indicates the total count of monetary transactions (order payments, buyer refunds, and seller credits) associated with the payouts that match the input criteria. This field is always returned, even if there are no payouts that match the input criteria (its value will show 0 ).')
Reference ¶
Bases: EbayModel
reference_id
class-attribute
instance-attribute
¶
reference_id = Field(None, alias='referenceId', description='The identifier of the transaction as specified by the referenceType . For example, with a referenceType of item_id , the referenceId refers to a unique item. This item may have several NON_SALE_CHARGE transactions.')
reference_type
class-attribute
instance-attribute
¶
reference_type = Field(None, alias='referenceType', description='An enumeration value that identifies the reference type associated with the referenceId .')
SellerFundsSummaryResponse ¶
Bases: EbayModel
available_funds
class-attribute
instance-attribute
¶
available_funds = Field(None, alias='availableFunds', description='This field represents the total amount of order funds that are available for a payout, but processing for a seller payout has not yet begun. If a seller wants to get more details on sales transactions that have yet to be processed, the seller can use the getTransactions method, and use the transactionStatus filter with its value set to FUNDS_AVAILABLE_FOR_PAYOUT .')
funds_on_hold
class-attribute
instance-attribute
¶
funds_on_hold = Field(None, alias='fundsOnHold', description='This field represents the total amount of order funds on hold. Seller payment holds can occur for different reasons. If a seller wants to get more details on sales transactions where funds are currently on hold, the seller can use the getTransactions method, and use the transactionStatus filter with its value set to FUNDS_ON_HOLD .')
processing_funds
class-attribute
instance-attribute
¶
processing_funds = Field(None, alias='processingFunds', description='This field represents the total amount of order funds being prepared and processed for a seller payout. If a seller wants to get more details on sales transactions that are being processed, the seller can use the getTransactions method, and use the transactionStatus filter with its value set to FUNDS_PROCESSING .')
total_funds
class-attribute
instance-attribute
¶
total_funds = Field(None, alias='totalFunds', description='This field represents the total amount of order funds still due to be distributed to the seller through a seller payout. This field should equal the sum of the amounts returned in the following fields: processingFunds availableFunds fundsOnHold If no payout funds are due to the seller, a 204 - No Content status code will be returned along with an empty payload.')
Tax ¶
TransactionSummaryResponse ¶
Bases: EbayModel
adjustment_amount
class-attribute
instance-attribute
¶
adjustment_amount = Field(None, alias='adjustmentAmount', description='Total adjustment amount for given payee within a specified period.')
adjustment_booking_entry
class-attribute
instance-attribute
¶
adjustment_booking_entry = Field(None, alias='adjustmentBookingEntry', description='The credit debit sign indicator for adjustment.')
adjustment_count
class-attribute
instance-attribute
¶
adjustment_count = Field(None, alias='adjustmentCount', description='Total adjustment count for given payee within a specified period.')
balance_transfer_amount
class-attribute
instance-attribute
¶
balance_transfer_amount = Field(None, alias='balanceTransferAmount', description='The total balance transfer amount for given payee within the specified period.')
balance_transfer_booking_entry
class-attribute
instance-attribute
¶
balance_transfer_booking_entry = Field(None, alias='balanceTransferBookingEntry', description='The credit debit sign indicator for the balance transfer.')
balance_transfer_count
class-attribute
instance-attribute
¶
balance_transfer_count = Field(None, alias='balanceTransferCount', description='The total balance transfer count for given payee within the specified period.')
credit_amount
class-attribute
instance-attribute
¶
credit_amount = Field(None, alias='creditAmount', description="This amount is the total dollar value of all the seller's sales and/or credits that match the input criteria.")
credit_booking_entry
class-attribute
instance-attribute
¶
credit_booking_entry = Field(None, alias='creditBookingEntry', 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 .')
credit_count
class-attribute
instance-attribute
¶
credit_count = Field(None, alias='creditCount', description="This integer value indicates the total number of the seller's sales and/or credits that match the input criteria.")
dispute_amount
class-attribute
instance-attribute
¶
dispute_amount = Field(None, alias='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.')
dispute_booking_entry
class-attribute
instance-attribute
¶
dispute_booking_entry = Field(None, alias='disputeBookingEntry', 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.')
dispute_count
class-attribute
instance-attribute
¶
dispute_count = Field(None, alias='disputeCount', 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.')
loan_repayment_amount
class-attribute
instance-attribute
¶
loan_repayment_amount = Field(None, alias='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: 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.")
loan_repayment_booking_entry
class-attribute
instance-attribute
¶
loan_repayment_booking_entry = Field(None, alias='loanRepaymentBookingEntry', 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 .")
loan_repayment_count
class-attribute
instance-attribute
¶
loan_repayment_count = Field(None, alias='loanRepaymentCount', 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 .')
non_sale_charge_amount
class-attribute
instance-attribute
¶
non_sale_charge_amount = Field(None, alias='nonSaleChargeAmount', description='The total non-sale charge amount for given payee within a specified period.')
non_sale_charge_booking_entry
class-attribute
instance-attribute
¶
non_sale_charge_booking_entry = Field(None, alias='nonSaleChargeBookingEntry', description='The credit/debit sign indicator for the non-sale charge.')
non_sale_charge_count
class-attribute
instance-attribute
¶
non_sale_charge_count = Field(None, alias='nonSaleChargeCount', description='The total non-sale charge count for given payee within a specified period.')
on_hold_amount
class-attribute
instance-attribute
¶
on_hold_amount = Field(None, alias='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.')
on_hold_booking_entry
class-attribute
instance-attribute
¶
on_hold_booking_entry = Field(None, alias='onHoldBookingEntry', 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.')
on_hold_count
class-attribute
instance-attribute
¶
on_hold_count = Field(None, alias='onHoldCount', 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 .')
purchase_amount
class-attribute
instance-attribute
¶
purchase_amount = Field(None, alias='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.')
purchase_booking_entry
class-attribute
instance-attribute
¶
purchase_booking_entry = Field(None, alias='purchaseBookingEntry', 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.')
purchase_count
class-attribute
instance-attribute
¶
purchase_count = Field(None, alias='purchaseCount', 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 .')
refund_amount
class-attribute
instance-attribute
¶
refund_amount = Field(None, alias='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.')
refund_booking_entry
class-attribute
instance-attribute
¶
refund_booking_entry = Field(None, alias='refundBookingEntry', 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.')
refund_count
class-attribute
instance-attribute
¶
refund_count = Field(None, alias='refundCount', 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 .')
shipping_label_amount
class-attribute
instance-attribute
¶
shipping_label_amount = Field(None, alias='shippingLabelAmount', description='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.')
shipping_label_booking_entry
class-attribute
instance-attribute
¶
shipping_label_booking_entry = Field(None, alias='shippingLabelBookingEntry', 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.')
shipping_label_count
class-attribute
instance-attribute
¶
shipping_label_count = Field(None, alias='shippingLabelCount', 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. 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.')
transfer_amount
class-attribute
instance-attribute
¶
transfer_amount = Field(None, alias='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.')
transfer_booking_entry
class-attribute
instance-attribute
¶
transfer_booking_entry = Field(None, alias='transferBookingEntry', 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.')
transfer_count
class-attribute
instance-attribute
¶
transfer_count = Field(None, alias='transferCount', 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 .')
withdrawal_amount
class-attribute
instance-attribute
¶
withdrawal_amount = Field(None, alias='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.')
withdrawal_booking_entry
class-attribute
instance-attribute
¶
withdrawal_booking_entry = Field(None, alias='withdrawalBookingEntry', 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.")
withdrawal_count
class-attribute
instance-attribute
¶
withdrawal_count = Field(None, alias='withdrawalCount', 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 .')
TransferDetail ¶
Bases: EbayModel
balance_adjustment
class-attribute
instance-attribute
¶
balance_adjustment = Field(None, alias='balanceAdjustment', description='This container shows the seller payout balance that will be applied toward the charges outlined in the charges array.')
charges
class-attribute
instance-attribute
¶
charges = Field(None, description='This container is an array of one or more charges related to the transfer. Charges can be related to an order cancellation, order return, case, payment dispute, etc.')
total_charge_net_amount
class-attribute
instance-attribute
¶
total_charge_net_amount = Field(None, alias='totalChargeNetAmount', description='This container shows the total amount that the seller owes for all of the charges outlined in the charges array.')
BillingActivityLineItem ¶
Bases: EbayModel
amount
class-attribute
instance-attribute
¶
amount = Field(None, description='This container shows the amount of the fee or credit. The value and currency are always returned. If the buyer is in one country and purchases from an eBay marketplace that uses a different currency, the response also includes the converted-from and converted-to fields, along with the exchange rate.')
billing_transaction_date
class-attribute
instance-attribute
¶
billing_transaction_date = Field(None, alias='billingTransactionDate', description='This timestamp indicates the date/time when eBay processed the transaction.')
billing_transaction_id
class-attribute
instance-attribute
¶
billing_transaction_id = Field(None, alias='billingTransactionId', description='This field provides a unique identifier of the billing transaction. If a seller wants to view details on a specific billing transaction, they can use the actvityId filter and pass in a specific billingTransactionId value.')
booking_entry
class-attribute
instance-attribute
¶
booking_entry = Field(None, alias='bookingEntry', description="The value returned in this field will indicate if the billing transaction is a debit against the seller's account, or a credit. A debit is much more prevalent than a credit, but sometimes a listing fee will get reversed and they will get a credit for this fee. Possible values: DEBIT CREDIT")
fee_type
class-attribute
instance-attribute
¶
fee_type = Field(None, alias='feeType', description='This field describes the type of fee associated with the transaction. An example value is FinalValueFeeFixedFeePerOrder .')
fee_type_description
class-attribute
instance-attribute
¶
fee_type_description = Field(None, alias='feeTypeDescription', description='This field contains the human-readable description of the fee type associated with the transaction. For example, Final Value Fee .')
listing_id
class-attribute
instance-attribute
¶
listing_id = Field(None, alias='listingId', description='The unique identifier of the eBay listing associated with the billing transaction. This field is returned if the fee is associated with a listing.')
order_id
class-attribute
instance-attribute
¶
order_id = Field(None, alias='orderId', description='The unique identifier of the eBay order associated with the billing transaction. This field is returned if the fee is associated with an order.')
promotional_offers
class-attribute
instance-attribute
¶
promotional_offers = Field(None, alias='promotionalOffers', description='A list of seller promotional offers applicable for the billing transaction.')
BillingActivityResponse ¶
Bases: EbayModel
billing_activities
class-attribute
instance-attribute
¶
billing_activities = Field(None, alias='billingActivities', description="A list of billing activity entries that meet the filter criteria. Billing activity will include fees, credits, and promotional offers applied to the seller's account.")
count
class-attribute
instance-attribute
¶
count = Field(None, description='An integer representing the number of billing activity items returned in this response page.')
limit
class-attribute
instance-attribute
¶
limit = Field(None, description='The value of the limit parameter. This is the maximum number of line items, as filtered, of billing transactions to return per page from the result set.')
next
class-attribute
instance-attribute
¶
next = Field(None, description='The URI for the next page of results starting with the resource name. This URI is returned if there is an additional page of results in the result set.')
offset
class-attribute
instance-attribute
¶
offset = Field(None, description='The value of the offset parameter. This field indicates how many results were skipped in the response. If an offset parameter was not included in the request, this value will default to 0 , returning the first page of results.')
prev
class-attribute
instance-attribute
¶
prev = Field(None, description='The URI for the previous page of results starting with the resource name. This URI is returned if there is a previous page of results in the result set.')
total
class-attribute
instance-attribute
¶
total = Field(None, description='The total number of billing transactions available that match the filter criteria. Note: When the total value exceeds the limit value, there are multiple pages of results.')
Expense ¶
Bases: EbayModel
currency
class-attribute
instance-attribute
¶
currency = Field(None, description='This field shows the three-letter currency code that represents the currency used for all of the order expenses')
donations
class-attribute
instance-attribute
¶
donations = Field(None, description='This array shows the amount(s) of one or more donations that are submitted to eBay charity organizations for one or more orders. Note: Donations are always tied to specific items. When an item is listed with a charity contribution (for example, 10%), the donation is calculated per item at the time of sale. Order earnings factor in only the items within the order that are eligible for donation.')
marketplace_fees
class-attribute
instance-attribute
¶
marketplace_fees = Field(None, alias='marketplaceFees', description='This array shows the type and amount(s) of marketplace fees that were charged against one or more orders.')
shipping_labels
class-attribute
instance-attribute
¶
shipping_labels = Field(None, alias='shippingLabels', description='This container shows the total amount paid by the seller for eBay shipping labels for one or more orders. Note: Charges and credits for shipping labels purchased with non-eBay payment methods (for example, PayPal) are excluded from the order earnings calculation.')
value
class-attribute
instance-attribute
¶
value = Field(None, description='This field shows the total expenses including charges and credits associated for one or more orders based on the order creation time period chosen.')
Fee ¶
Bases: EbayModel
amount
class-attribute
instance-attribute
¶
amount = Field(None, description='The monetary amount charged for the fee.')
fee_jurisdiction
class-attribute
instance-attribute
¶
fee_jurisdiction = Field(None, alias='feeJurisdiction', description='This type defines the jurisdiction associated with a fee. It identifies the geographic or regulatory context under which a specific fee is applied to an order.')
fee_memo
class-attribute
instance-attribute
¶
fee_memo = Field(None, alias='feeMemo', description='A descriptive message that provides additional context about the fee applied to the order.')
fee_type
class-attribute
instance-attribute
¶
fee_type = Field(None, alias='feeType', description='The enumeration value returned here indicates the type of fee that was deducted from the seller payout.')
OrderLineItem ¶
Bases: EbayModel
donations
class-attribute
instance-attribute
¶
donations = Field(None, description='The list of donations applied to the line item. Note: Currently, this array is only returned if the seller chooses to donate a percentage of the sales proceeds to a charitable organization registered with the eBay for Charity program.')
fee_basis_amount
class-attribute
instance-attribute
¶
fee_basis_amount = Field(None, alias='feeBasisAmount', description="This amount is the order's total amount and equals what the buyer has paid. This value includes transactions.amount , totalFeeAmount , eBayCollectedTaxAmount , and shipping charges (if any).")
line_item_id
class-attribute
instance-attribute
¶
line_item_id = Field(None, alias='lineItemId', description='The unique identifier of an order line item.')
marketplace_fees
class-attribute
instance-attribute
¶
marketplace_fees = Field(None, alias='marketplaceFees', description='An array of all fees accrued for the order line item and deducted from a seller payout.')
Payout ¶
Bases: EbayModel
amount
class-attribute
instance-attribute
¶
amount = Field(None, description='This is the total amount of the seller payout. The container shows the dollar amount of the payout and the currency used. The value of the payout is always shown, even if the payout has failed.')
bank_reference
class-attribute
instance-attribute
¶
bank_reference = Field(None, alias='bankReference', description="This field contains additional information provided by the bank and passed on by the payment processor; e.g., the manner in which the transaction will appear on the seller's bank statement. The field is returned only when provided by the bank and processor.")
last_attempted_payout_date
class-attribute
instance-attribute
¶
last_attempted_payout_date = Field(None, alias='lastAttemptedPayoutDate', description='This timestamp indicates the date/time when eBay last attempted to process a seller payout but it failed. This field is only returned if a seller payout fails, and the payoutStatus value shows RETRYABLE_FAILED or TERMINAL_FAILED . A seller can filter on the lastAttemptedPayoutDate in a getPayouts request.')
payout_date
class-attribute
instance-attribute
¶
payout_date = Field(None, alias='payoutDate', description='This timestamp indicates when the seller payout began processing. The following format is used: YYYY-MM-DDTHH:MM:SS.SSSZ . For example, 2015-08-04T19:09:02.768Z . This field is still returned even if the payout was pending but failed ( payoutStatus value shows RETRYABLE_FAILED or TERMINAL_FAILED ).')
payout_id
class-attribute
instance-attribute
¶
payout_id = Field(None, alias='payoutId', description="The unique identifier of the seller payout. This identifier is generated once eBay begins processing the payout to the seller's bank account.")
payout_instrument
class-attribute
instance-attribute
¶
payout_instrument = Field(None, alias='payoutInstrument', description="This container provides details about the seller's account that received (or is scheduled to receive) the payout. This container is still returned even if the payout failed.")
payout_memo
class-attribute
instance-attribute
¶
payout_memo = Field(None, alias='payoutMemo', description='This field contains information provided by upstream components, based on internal and external commitments. A typical message would contain the expected arrival time of the payout.')
payout_reference
class-attribute
instance-attribute
¶
payout_reference = Field(None, alias='payoutReference', description='This field contains the unique identifier for the Payout Reference. In split-payout cases, this is the unique identifier reference (not true payout). This field is only returned and will show the associated true(actual) payout id(s) when sellers in Mainland China enable split payouts between a Payoneer account and/or a bank account.')
payout_status
class-attribute
instance-attribute
¶
payout_status = Field(None, alias='payoutStatus', description='This enumeration value indicates the current status of the seller payout. For a successful payout, the value returned will be SUCCEEDED . See the PayoutStatusEnum type for more details on each payout status value.')
payout_status_description
class-attribute
instance-attribute
¶
payout_status_description = Field(None, alias='payoutStatusDescription', description='This field provides more details about the current status of payout. The description returned here will correspond with enumeration value returned in the payoutStatus field.')
total_amount
class-attribute
instance-attribute
¶
total_amount = Field(None, alias='totalAmount', description="This container indicates the sum of a seller's net payout amount plus the EXPRESS_PAYOUT_FEE charged by eBay. The is expressed as a numeric value and the currency used.")
total_fee
class-attribute
instance-attribute
¶
total_fee = Field(None, alias='totalFee', description='This container indicates the amount of the EXPRESS_PAYOUT_FEE charged by eBay when a seller requests payout to a debit card. The fee is expressed as a numeric value and the currency used.')
total_fee_details
class-attribute
instance-attribute
¶
total_fee_details = Field(None, alias='totalFeeDetails', description='This array indicates all payout fees associated with a payout, including the fee type, amount, value, and currency.')
transaction_count
class-attribute
instance-attribute
¶
transaction_count = Field(None, alias='transactionCount', description='This integer value indicates the number of monetary transactions (all orders, refunds, and credits, etc.) that have occurred with the corresponding payout. Its value should always be at least 1 , since there is at least one order per seller payout. For split payouts, each of the two sibling payouts would be considered its own transaction.')
Payouts ¶
Bases: EbayModel
href
class-attribute
instance-attribute
¶
href = Field(None, description='The URI of the getPayouts call request that produced the current page of the result set.')
limit
class-attribute
instance-attribute
¶
limit = Field(None, description='The maximum number of payouts that may be returned per page of the result set. The limit value can be passed in as a query parameter, or if omitted, its value defaults to 20 . Note: If this is the last or only page of the result set, the page may contain fewer payouts than the limit value.')
next
class-attribute
instance-attribute
¶
next = Field(None, description='The getPayouts call URI to use if you wish to view the next page of the result set. This field is only returned if there is a next page of results to view based on the current input criteria.')
offset
class-attribute
instance-attribute
¶
offset = Field(None, description='This integer value indicates the actual position that the first payout returned on the current page has in the results set. So, if you wanted to view the 11th payout of the result set, you would set the offset value in the request to 10 . In the request, you can use the offset parameter in conjunction with the limit parameter to control the pagination of the output.')
payouts
class-attribute
instance-attribute
¶
payouts = Field(None, description='An array of one or more payouts that match the input criteria. Details for each payout include the unique identifier of the payout, the status of the payout, the amount of the payout, and the number of monetary transactions associated with the payout.')
prev
class-attribute
instance-attribute
¶
prev = Field(None, description='The getPayouts call URI to use if you wish to view the previous page of the result set. This field is only returned if there is a previous page of results to view based on the current input criteria.')
total
class-attribute
instance-attribute
¶
total = Field(None, description='This integer value is the total number of payouts in the results set based on the current input criteria. Based on the total number of payouts that match the criteria, and on the limit and offset values, there may be additional pages in the results set.')
Transaction ¶
Bases: EbayModel
amount
class-attribute
instance-attribute
¶
amount = Field(None, description='This container shows the dollar value and currency type of the monetary transaction. This field is always returned even when eBay has yet to initiate a payout for the order.')
booking_entry
class-attribute
instance-attribute
¶
booking_entry = Field(None, alias='bookingEntry', description="The enumeration value returned in this field indicates if the monetary transaction amount is a ( CREDIT ) or a ( DEBIT ) to the seller's account. Typically, the SALE and CREDIT transaction types are credits to the seller's account, and the REFUND , DISPUTE , SHIPPING_LABEL , and TRANSFER transaction types are debits to the seller's account.")
buyer
class-attribute
instance-attribute
¶
buyer = Field(None, description='This is the unique eBay user ID for the buyer who purchased the order. This field is not returned for TRANSFER monetary transaction types.')
e_bay_collected_tax_amount
class-attribute
instance-attribute
¶
e_bay_collected_tax_amount = Field(None, alias='eBayCollectedTaxAmount', description='This is the amount of sales tax that has been collected by eBay for an order. Note: Sales tax applies only to SALE and REFUND transactions ( transactionType ).')
fee_jurisdiction
class-attribute
instance-attribute
¶
fee_jurisdiction = Field(None, alias='feeJurisdiction', description="This container stores information about region-specific fees that are charged to sellers. This is returned for fees (i.e., FeeTypeEnum values,) that are mandated by a seller's governing jurisdiction. For example: INCOME_TAX_WITHHOLDING TAX_DEDUCTION_AT_SOURCE VAT_WITHHOLDING")
fee_type
class-attribute
instance-attribute
¶
fee_type = Field(None, alias='feeType', description='The enumeration value returned in this field indicates the type of fee that was deducted from the seller payout.')
order_id
class-attribute
instance-attribute
¶
order_id = Field(None, alias='orderId', description='The unique identifier of the eBay order associated with the monetary transaction.')
order_line_items
class-attribute
instance-attribute
¶
order_line_items = Field(None, alias='orderLineItems', description='This array either shows the order line item transactional fees related to a SALE transaction and deducted from the payout associated with that order, or it shows the transactional fee credits going back to the seller in the case of a REFUND transaction.')
payments_entity
class-attribute
instance-attribute
¶
payments_entity = Field(None, alias='paymentsEntity', description='This string value indicates the entity that is processing the payment.')
payout_details
class-attribute
instance-attribute
¶
payout_details = Field(None, alias='payoutDetails', description='This container provides the payout details for a split-payout case. This container is only returned for split-payout use cases.')
payout_id
class-attribute
instance-attribute
¶
payout_id = Field(None, alias='payoutId', description='The unique identifier of the seller payout associated with the monetary transaction. This identifier is generated once eBay begins processing the payout for the corresponding order. This field will not be returned if eBay has not yet begun processing the payout for an order.')
references
class-attribute
instance-attribute
¶
references = Field(None, description='This field contains reference information for the transaction fee. This includes an ID and the type of ID provided (such as item ID).')
sales_record_reference
class-attribute
instance-attribute
¶
sales_record_reference = Field(None, alias='salesRecordReference', description='The Sales Record Number associated with a sales order. Sales Record Numbers are Selling Manager/Selling Manager Pro identifiers that are created at order checkout. Note: For all orders originating after February 1, 2020, a value of 0 will be returned in this field. The Sales Record Number field has also been removed from Seller Hub.')
taxes
class-attribute
instance-attribute
¶
taxes = Field(None, description='This array shows the tax type and amount applicable to the transaction. Note: Currently, this array is only returned for tax charged against a purchased eBay shipping label.')
total_fee_amount
class-attribute
instance-attribute
¶
total_fee_amount = Field(None, alias='totalFeeAmount', description='This amount is the total amount of selling fees paid for order. A breakdown of fees for each order line item can be found in the orderLineItems array. This field is even returned if it is 0.0 (no fees deducted from seller payout).')
total_fee_basis_amount
class-attribute
instance-attribute
¶
total_fee_basis_amount = Field(None, alias='totalFeeBasisAmount', description='This amount is the total amount for the order before selling fees are deducted from the seller payout associated with the order.')
transaction_date
class-attribute
instance-attribute
¶
transaction_date = Field(None, alias='transactionDate', description='This timestamp indicates when the monetary transaction (order purchase, buyer refund, seller credit) occurred. The following (UTC) format is used: YYYY-MM-DDTHH:MM:SS.SSSZ . For example, 2015-08-04T19:09:02.768Z .')
transaction_id
class-attribute
instance-attribute
¶
transaction_id = Field(None, alias='transactionId', description="This field, when combined with the transactionType field, provide a unique identifier of the monetary transaction. A monetary transaction can be a sales order, an order refund to the buyer, a credit to the seller's account, a debit to the seller for the purchase of a shipping label, or a transaction where eBay recouped money from the seller if the seller lost a buyer-initiated payment dispute.")
transaction_memo
class-attribute
instance-attribute
¶
transaction_memo = Field(None, alias='transactionMemo', description='This field applies to shipping label transactions, sales transactions where payout is on hold, and non-sale charge fees. The following are examples of how the field is used for each transaction type: Shipping label purchase : the transactionMemo field gives details about a purchase, a refund, or a price adjustment to the cost of the shipping label.')
transaction_status
class-attribute
instance-attribute
¶
transaction_status = Field(None, alias='transactionStatus', description='This enumeration value indicates the current status of the seller payout associated with the monetary transaction. See the TransactionStatusEnum type for more information on the different states.')
transaction_type
class-attribute
instance-attribute
¶
transaction_type = Field(None, alias='transactionType', description="This enumeration value indicates the type of monetary transaction. Examples of monetary transactions include a buyer's payment for an order, a refund to the buyer for a returned item or cancelled order, or a credit issued by eBay to the seller's account. For a complete list of monetary transaction types within the Finances API , see the TransactionTypeEnum type.")
Transactions ¶
Bases: EbayModel
href
class-attribute
instance-attribute
¶
href = Field(None, description='The URI of the getTransactions method request that produced the current page of the result set.')
limit
class-attribute
instance-attribute
¶
limit = Field(None, description='The maximum number of monetary transactions that may be returned per page of the result set. The limit value can be passed in as a query parameter, or if omitted, its value defaults to 20 . Note: If this is the last or only page of the result set, the page may contain fewer monetary transactions than the limit value.')
next
class-attribute
instance-attribute
¶
next = Field(None, description='The getTransactions method URI to use if you wish to view the next page of the result set. This field is only returned if there is a next page of results to view based on the current input criteria.')
offset
class-attribute
instance-attribute
¶
offset = Field(None, description='This integer value indicates the actual position that the first monetary transaction returned on the current page has in the results set. So, if you wanted to view the 11th monetary transaction of the result set, you would set the offset value in the request to 10 . In the request, you can use the offset parameter in conjunction with the limit parameter to control the pagination of the output.')
prev
class-attribute
instance-attribute
¶
prev = Field(None, description='The getTransactions method URI to use if you wish to view the previous page of the result set. This field is only returned if there is a previous page of results to view based on the current input criteria.')
total
class-attribute
instance-attribute
¶
total = Field(None, description='This integer value is the total amount of monetary transactions in the result set based on the current input criteria. Based on the total number of monetary transactions that match the criteria, and on the limit and offset values, there may be additional pages in the results set.')
transactions
class-attribute
instance-attribute
¶
transactions = Field(None, description="An array of one or more monetary transactions that match the input criteria. Details for each monetary transaction may include the unique identifier of the order associated with the monetary transaction, the status of the transaction, the amount of the order, the order's buyer, and the unique identifier of the payout (if a payout has been initiated/issued for the order).")
Transfer ¶
Bases: EbayModel
funding_source
class-attribute
instance-attribute
¶
funding_source = Field(None, alias='fundingSource', description="This container provides details about the seller's funding source to reimburse eBay for the transfer, such as a bank account, a credit card, or available seller payout funds.")
transaction_date
class-attribute
instance-attribute
¶
transaction_date = Field(None, alias='transactionDate', description='This timestamp indicates the date/time of the transfer. The following (UTC) format is used: YYYY-MM-DDTHH:MM:SS.SSSZ . For example, 2020-08-04T19:09:02.768Z')
transfer_amount
class-attribute
instance-attribute
¶
transfer_amount = Field(None, alias='transferAmount', description='The amount of the transfer being deducted from the funding source.')
transfer_detail
class-attribute
instance-attribute
¶
transfer_detail = Field(None, alias='transferDetail', description='This container provides more details about the transfer, including details on the charge(s) associated with the transfer. Multiple charges can be addressed with one transfer.')
transfer_id
class-attribute
instance-attribute
¶
transfer_id = Field(None, alias='transferId', description='The unique identifier of the TRANSFER transaction type. This is the same value that was passed into the end of the call URI.')
EarningsSummary ¶
Bases: EbayModel
expenses
class-attribute
instance-attribute
¶
expenses = Field(None, description="This container provides the total expenses associated with an order, including: Fees and fee credits (transaction fees, other fees, and ad fees) Shipping labels Donations It is used by both the getOrderEarnings and getOrderEarningsById methods. Note: Expenses are always in the seller's payout currency.")
gross_amount
class-attribute
instance-attribute
¶
gross_amount = Field(None, alias='grossAmount', description="This container shows the gross amount before any eBay deductions. This amount includes the item subtotal, buyer-paid shipping and handling, and seller-collected tax paid by the buyer. Note: This amount does not include any taxes or fees that eBay collects from the buyer. Note: Gross amount is always in the seller's payout currency.")
order_earnings
class-attribute
instance-attribute
¶
order_earnings = Field(None, alias='orderEarnings', description="This container shows your earnings after deducting expenses and any refunds from your gross amount. Note: Order earnings are always in the seller's payout currency. Conversion-related fields (such as exchangeRate or converted from/to fields) in this container do not apply to the order_earnings resource.")
refunds
class-attribute
instance-attribute
¶
refunds = Field(None, description="This container includes refunds for returns, cases, cancellations, requests, and disputes. It does not include fee credits. Note: Refunds are always in the seller's payout currency. Conversion-related fields (such as exchangeRate or converted from/to fields) in this container do not apply to the order_earnings resource.")
OrderEarning ¶
Bases: EbayModel
buyer
class-attribute
instance-attribute
¶
buyer = Field(None, description='Information about the buyer associated with the order. Includes buyer name and public user id.')
order_creation_date
class-attribute
instance-attribute
¶
order_creation_date = Field(None, alias='orderCreationDate', description='The date the order was created and payment was successful.')
order_earnings_summary
class-attribute
instance-attribute
¶
order_earnings_summary = Field(None, alias='orderEarningsSummary', description='This container defines a summarized view of earnings information derived from one order. It provides aggregated financial values for order earnings, gross amount, expenses, and refunds. Order earnings includes earnings after deducting expenses and refunds from the gross amount.')
order_id
class-attribute
instance-attribute
¶
order_id = Field(None, alias='orderId', description='The unique identifier of the order.')
order_last_modified_date
class-attribute
instance-attribute
¶
order_last_modified_date = Field(None, alias='orderLastModifiedDate', description='The date when the order was last modified.')
order_summary
class-attribute
instance-attribute
¶
order_summary = Field(None, alias='orderSummary', description='The container for order cost details, including line item subtotal, shipping and handling, seller-collected taxes, and any seller applied discounts. Always provided in the listing currency.')
OrderEarnings ¶
Bases: EbayModel
href
class-attribute
instance-attribute
¶
href = Field(None, description='The URI for the current page of results.')
limit
class-attribute
instance-attribute
¶
limit = Field(None, description='The maximum number of order earnings records returned in a single page of results.')
next
class-attribute
instance-attribute
¶
next = Field(None, description='The URI for the next page of results. This field is only returned if there is a next page of results to retrieve.')
offset
class-attribute
instance-attribute
¶
offset = Field(None, description='The number of order earnings records skipped before returning the current page of results.')
orders
class-attribute
instance-attribute
¶
orders = Field(None, description='The list of order earnings records returned in the current page of results. This array will be returned as empty if no orders match the request criteria.')
prev
class-attribute
instance-attribute
¶
prev = Field(None, description='The URI for the previous page of results. This field is only returned if there is a previous page of results to retrieve.')
total
class-attribute
instance-attribute
¶
total = Field(None, description='The total number of order earnings records that match the request criteria.')