Yardi Store Developer eXchange

Retrieves a sum total refund amount for multiple retail item types and quantities.

Parameters

Returned Parameters

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 GetRetailRefundAmount request object and a GetRetailRefundAmount response object.  You will also need a ReturnRetailItem(s) object to indicate which item you are returning. We can define and create those like this:

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

SWS.ReturnRetailItem item = new SWS.ReturnRetailItem();

Here’s my sample code of the Request object.

// GetRetailRefundAmount Request
item.RetailObjectID = 123456;
item.Quantity = 1;
item.ReturnReason = SWS.RetailReturnReasons.DEFECTIVE_DESTROY;

request.SiteID = 123456;
request.TransactionID = 123456;
request.ReturnRetailData = new SWS.ReturnRetailItem[] { item };

Finally we can call the method and pass across the login object and the request object to get our retail refund 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.GetRetailRefundAmount(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.