com.ebay.sdk.call.GetSellerPaymentsCall Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of ebaysdkcore939 Show documentation
Show all versions of ebaysdkcore939 Show documentation
Repack of the eBay SDK version 939 for repository use
/*
Copyright (c) 2013 eBay, Inc.
This program is licensed under the terms of the eBay Common Development and
Distribution License (CDDL) Version 1.0 (the "License") and any subsequent version
thereof released by eBay. The then-current version of the License can be found
at http://www.opensource.org/licenses/cddl1.php and in the eBaySDKLicense file that
is under the eBay SDK ../docs directory.
*/
package com.ebay.sdk.call;
import java.lang.Boolean;
import java.lang.Integer;
import java.util.Calendar;
import com.ebay.sdk.*;
import com.ebay.soap.eBLBaseComponents.*;
/**
* Wrapper class of the GetSellerPayments call of eBay SOAP API.
*
* Title: SOAP API wrapper library.
* Description: Contains wrapper classes for eBay SOAP APIs.
* Copyright: Copyright (c) 2009
* Company: eBay Inc.
*
Input property: PaymentStatus - Filter to retrieve only items with the specified payment status (Paid or
* Pending). "Pending payments" are payments that Half.com has created but
* that have not yet been sent to the seller's financial institution. Pending
* payments are typically available once a buyer pays for an order. As
* Half.com processes payments by using periodic batch jobs, the
* GetSellerPayments response might not include an order line item's payment for
* up to 20 minutes after the buyer has paid. You can retrieve pending
* payments for the current pay period. Pending payments that have not been
* settled yet can also be retrieved for previous pay periods. "Paid
* payments" are payments that Half.com processed during previous pay
* periods. Paid payments might not appear in the seller's financial
* institution account balance until a certain number of days after the
* current pay period ends (see the Half.com online help for details). You
* can only retrieve paid payments for one previous pay period at a time.
*
Input property: PaymentTimeFrom - Time range filter that retrieves Half.com payments that were created within
* a single pay period. Sellers can refer to the Half.com site to determine
* their pay periods. PaymentTimeFrom is the earliest (oldest) time and
* PaymentTimeTo is the latest (most recent) time in the range. Half.com pay
* periods start and end at midnight Pacific time, but the time values are
* stored in the database in GMT (not Pacific time). See "Time Values" in the
* eBay Features Guide for information about converting between GMT and
* Pacific time.
*
* If you specify a PaymentStatus of Pending, add a buffer of one hour (or one
* day) to both ends of the time range to retrieve more data than you need, and
* then filter the results on the client side as needed. If any pending
* payments match the request, the response may include all payments since the
* beginning of the period.
*
* If you specify a PaymentStatus of Paid, the time range must contain one
* full pay period. That is, PaymentTimeFrom must be earlier or equal the
* start time of the pay period, and PaymentTimeTo must be later than or
* equal to the end time of the pay period. Otherwise, no paid payments are
* returned. For example, if the pay period starts on 2005-09-16 and ends on
* 2005-09-30, you could specify an earlier PaymentTimeFrom value of
* 2005-09-16T00:00:00.000Z and a later PaymentTimeTo value of
* 2005-10-01T12:00:00.000Z.
*
* If you specify a time range that covers two pay periods, only the payments
* from the most recent pay period are returned. The earliest time you can
* specify is 18 months ago.
*
Input property: PaymentTimeTo - Time range filter that retrieves Half.com payments for a single pay
* period. See the description of PaymentTimeTo for details about using this
* time range filter. For paid payments, this value should be equal to or
* later than the end of the last day of the pay period, where the time is
* converted to GMT. For example, if the period ends on 2005-09-30, you could
* specify 2005-10-01T09:00:00.000Z, which is later than the end of the last
* day.
*
Input property: Pagination - If many payments are available, you may need to call GetSellerPayments
* multiple times to retrieve all the data. Each result set is returned as a
* page of entries. Use this Pagination information to indicate the maximum
* number of entries to retrieve per page (i.e., per call), the page number
* to retrieve, and other data.
*
Output property: ReturnedPaginationResult - Contains information regarding the pagination of data (if pagination is used),
* including total number of pages and total number of entries.
*
Output property: ReturnedHasMorePayments - If true, there are more payments yet to be retrieved. Additional
* GetSellerPayments calls with higher page numbers or more entries per page
* must be made to retrieve these payments. If false, no more payments are
* available or no payments match the request (based on the payment status
* and time filter).
*
Output property: ReturnedSellerPayment - Information about a single payment that matches the criteria in the
* request. A payment is between Half.com and a seller. Each payment is for
* one transaction for one item in one order. An order can contain
* transactions for multiple items from multiple sellers, but this call only
* retrieves payments that are relevant to one seller. The financial value of
* a payment is typically based on an amount that a buyer paid to Half.com
* for a transaction, plus the shipping cost the buyer paid for the item,
* minus Half.com's commission. Payments can also describe refunds that the
* seller has issued. Multiple SellerPayment entries can be returned per page
* of results. Typically, they are returned in reverse chronological order
* (most recent PaidTime first). Only returned if payments exist that match
* the request.
*
Output property: ReturnedPaymentsPerPage - Indicates the number of payments that can be returned per page of data
* (i.e., per call). This is the same as the value specified in the
* Pagination.EntriesPerPage input (or the default value, if EntriesPerPage
* was not specified). This is not necessarily the actual number of payments
* returned per page (see ReturnedPaymentCountActual).
*
Output property: ReturnedPageNumber - Indicates which page of data holds the current result set. Will be the
* same as the value specified in the Pagination.PageNumber input. (If the
* input is higher than the total number of pages, the call fails with an
* error.) If no payments are returned, the value is 0. If payments are
* returned, the first page number is 1.
*
Output property: ReturnedReturnedPaymentCountActual - Indicates the total number of payments returned (i.e., the number of
* SellerPayment entries returned.
*
* @author Ron Murphy
* @version 1.0
*/
public class GetSellerPaymentsCall extends com.ebay.sdk.ApiCall
{
private RCSPaymentStatusCodeType paymentStatus = null;
private Calendar paymentTimeFrom = null;
private Calendar paymentTimeTo = null;
private PaginationType pagination = null;
private PaginationResultType returnedPaginationResult=null;
private Boolean returnedHasMorePayments=null;
private SellerPaymentType[] returnedSellerPayment=null;
private Integer returnedPaymentsPerPage=null;
private Integer returnedPageNumber=null;
private Integer returnedReturnedPaymentCountActual=null;
/**
* Constructor.
*/
public GetSellerPaymentsCall() {
}
/**
* Constructor.
* @param apiContext The ApiContext object to be used to make the call.
*/
public GetSellerPaymentsCall(ApiContext apiContext) {
super(apiContext);
}
/**
* Half.com only. Retrieves a summary of pending or paid payments that Half.com created for the
* seller identified by the authentication token in the request. Only retrieves
* payments that occurred within a particular pay period. Each payment is for one
* order line item in one order. An order can contain order line items for
* multiple items from multiple sellers, but this call only retrieves payments that
* are relevant to one seller. The financial value of a payment is typically based on
* an amount that a buyer paid to Half.com for an order line item, with adjustments for
* shipping costs and Half.com's commission. For most sellers, each month contains
* two pay periods: One from the 1st to the 15th of the month, and one from the 16th
* to the last day of the month. Sellers can refer to their account information on
* the Half.com site to determine their pay periods. (You cannot retrieve a seller's
* pay periods by using eBay API.) When a buyer makes a purchase and an
* order is created, Half.com creates a payment for the seller and marks it as
* Pending in the seller's Half.com account. Within a certain number of days after
* the pay period ends, Half.com settles payments for that period and marks each
* completed payment as Paid. See the Half.com Web site online help for more
* information about how payments are managed.
*
*
* @throws ApiException
* @throws SdkException
* @throws Exception
* @return The SellerPaymentType[] object.
*/
public SellerPaymentType[] getSellerPayments()
throws com.ebay.sdk.ApiException, com.ebay.sdk.SdkException, java.lang.Exception
{
GetSellerPaymentsRequestType req;
req = new GetSellerPaymentsRequestType();
if (this.paymentStatus != null)
req.setPaymentStatus(this.paymentStatus);
if (this.paymentTimeFrom != null)
req.setPaymentTimeFrom(this.paymentTimeFrom);
if (this.paymentTimeTo != null)
req.setPaymentTimeTo(this.paymentTimeTo);
if (this.pagination != null)
req.setPagination(this.pagination);
GetSellerPaymentsResponseType resp = (GetSellerPaymentsResponseType) execute(req);
this.returnedPaginationResult = resp.getPaginationResult();
this.returnedHasMorePayments = resp.isHasMorePayments();
this.returnedSellerPayment = resp.getSellerPayment();
this.returnedPaymentsPerPage = resp.getPaymentsPerPage();
this.returnedPageNumber = resp.getPageNumber();
this.returnedReturnedPaymentCountActual = resp.getReturnedPaymentCountActual();
return this.getReturnedSellerPayment();
}
/**
* Gets the GetSellerPaymentsRequestType.pagination.
* @return PaginationType
*/
public PaginationType getPagination()
{
return this.pagination;
}
/**
* Sets the GetSellerPaymentsRequestType.pagination.
* @param pagination PaginationType
*/
public void setPagination(PaginationType pagination)
{
this.pagination = pagination;
}
/**
* Gets the GetSellerPaymentsRequestType.paymentStatus.
* @return RCSPaymentStatusCodeType
*/
public RCSPaymentStatusCodeType getPaymentStatus()
{
return this.paymentStatus;
}
/**
* Sets the GetSellerPaymentsRequestType.paymentStatus.
* @param paymentStatus RCSPaymentStatusCodeType
*/
public void setPaymentStatus(RCSPaymentStatusCodeType paymentStatus)
{
this.paymentStatus = paymentStatus;
}
/**
* Gets the GetSellerPaymentsRequestType.paymentTimeFrom.
* @return Calendar
*/
public Calendar getPaymentTimeFrom()
{
return this.paymentTimeFrom;
}
/**
* Sets the GetSellerPaymentsRequestType.paymentTimeFrom.
* @param paymentTimeFrom Calendar
*/
public void setPaymentTimeFrom(Calendar paymentTimeFrom)
{
this.paymentTimeFrom = paymentTimeFrom;
}
/**
* Gets the GetSellerPaymentsRequestType.paymentTimeTo.
* @return Calendar
*/
public Calendar getPaymentTimeTo()
{
return this.paymentTimeTo;
}
/**
* Sets the GetSellerPaymentsRequestType.paymentTimeTo.
* @param paymentTimeTo Calendar
*/
public void setPaymentTimeTo(Calendar paymentTimeTo)
{
this.paymentTimeTo = paymentTimeTo;
}
/**
* Valid after executing the API.
* Gets the returned GetSellerPaymentsResponseType.returnedHasMorePayments.
*
* @return Boolean
*/
public Boolean getReturnedHasMorePayments()
{
return this.returnedHasMorePayments;
}
/**
* Valid after executing the API.
* Gets the returned GetSellerPaymentsResponseType.returnedPageNumber.
*
* @return Integer
*/
public Integer getReturnedPageNumber()
{
return this.returnedPageNumber;
}
/**
* Valid after executing the API.
* Gets the returned GetSellerPaymentsResponseType.returnedPaginationResult.
*
* @return PaginationResultType
*/
public PaginationResultType getReturnedPaginationResult()
{
return this.returnedPaginationResult;
}
/**
* Valid after executing the API.
* Gets the returned GetSellerPaymentsResponseType.returnedPaymentsPerPage.
*
* @return Integer
*/
public Integer getReturnedPaymentsPerPage()
{
return this.returnedPaymentsPerPage;
}
/**
* Valid after executing the API.
* Gets the returned GetSellerPaymentsResponseType.returnedReturnedPaymentCountActual.
*
* @return Integer
*/
public Integer getReturnedReturnedPaymentCountActual()
{
return this.returnedReturnedPaymentCountActual;
}
/**
* Valid after executing the API.
* Gets the returned GetSellerPaymentsResponseType.returnedSellerPayment.
*
* @return SellerPaymentType[]
*/
public SellerPaymentType[] getReturnedSellerPayment()
{
return this.returnedSellerPayment;
}
}