Home > API General, Auction, Tax > SWS GetAuctionTax Method

SWS GetAuctionTax Method


Returns the applicable tax of the amount for which the item was auctioned.

Parameters

Name DataType Required
SiteID Long Required
Description The site’s ID number. This can be found using the GetSiteList method.
Amount Decimal Required
Description The amount collected on the auctioned unit.

Returned Parameters

Name DataType
baseAmount Decimal
Description The amount collected on the auctioned unit.
taxAmount Decimal
Description The total of the taxes applicable to the baseAmount.

Example

As with every method we need to pass in credentials. We do this with the LookupUser request object.

We’ll assume you’ve got a web reference, let’s name it SWS, in your Visual Studio project.  At this point we need to our objects.  We’ll need the standard service object, a AuctionProceeds request object and a GetAuctionTax response object. We can define and create those like this:

// Create a request and response objects
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.AuctionProceeds request = new SWS.AuctionProceeds();
SWS.GetAuctionTax_Response response;

Here’s my sample code of the Request object.

// GetAuctionTax Request
request.SiteID = 123456;
request.AuctionProceedsAmount = new decimal[] { 326m };

We can call the method and pass across the login object and the request object to return our auction tax amount. It’s a good idea to do this in a Try Catch block.

// Call the method that will load the response object
try
{
  response = service.GetAuctionTax(user_request, request);
}
catch (Exception ex)
{
  MessageBox.Show(ex.Message);
}

Note that if something goes wrong the service will respond with an exception. You’ll want to take a look at that message returned in that exception so it can be debugged.

For a full list of methods see SWS Methods.

Categories: API General, Auction, Tax Tags: ,
  1. No comments yet.
  1. No trackbacks yet.

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out /  Change )

Google photo

You are commenting using your Google account. Log Out /  Change )

Twitter picture

You are commenting using your Twitter account. Log Out /  Change )

Facebook photo

You are commenting using your Facebook account. Log Out /  Change )

Connecting to %s

%d bloggers like this: