Yardi Store Developer eXchange

Retrieves detailed refund information and resets the refund status to indicate the records have been exported. Data is gathered 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 will assume you have a web reference, let’s name it SWS, in your Visual Studio project.  At this point we need to classify our objects.  We’ll need the standard service object, an ExportRefundDetail request object, and an ExportRefundDetail 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.RefundDetail_Response response;

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

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

 Finally we can call the method and pass across the login object and the request object to export 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.ExportRefundDetail(user_request, request);
}
catch (Exception ex)
{
  MessageBox.Show(ex.Message);
}

Note that if something goes wrong the service will respond with an exception. You will want to capture the message returned in that exception so it can be debugged.

For a full list of methods see SWS Methods.