Yardi Store Developer eXchange

Retrieves a collection of submitted refunds for specified site(s), for a given timeframe.

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 have a web reference, let’s name it SWS, in your Visual Studio project.  At this point we need to define the objects.  We’ll need the standard service object, a Refund request object, and a Refund response object.  We can define and create those like this:

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

Here’s a sample code of the Request object (including optional parameters):

// GetRefunds Request
request.OrgID = 123456;
request.SiteList = new long[] { 123456, 456789 };
request.StartDate = DateTime.Today.AddDays(-1);
request.RefundStatusFilter = new int[] { 1, 2 };

Finally we can call the method and pass across the login object and the request object to retrieve the specified refunds. 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.GetRefunds(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 capture the message returned in that exception so it can be debugged.

For a full list of methods see SWS Methods.