Yardi Store Developer eXchange

Retrieves information about a payment being considered for reversal. Verifies that payment can be reversed and includes additional rentals and transactions that are affected.

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 ReversePayment request object and a GetPreReversePayDetails response object. You will also need one or more TranReversalInfo objects and one or more TransactionDate objects to provide transaction information for the payment(s) needing to be reversed. We can define and create those like this:

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

SWS.TransactionDate tranDates = new SWS.TransactionDate();
SWS.TranReversalInfo reverseDetails = new SWS.TranReversalInfo();

Here’s my sample code of the various objects required.

// GetPreReversePayDetails Request
tranDates.TranID = 123456;
tranDates.TranDate = DateTime.Today.AddDays(-5);

reverseDetails.AccountID = 123546;
reverseDetails.RentalID = 123456;
reverseDetails.TranDates = new SWS.TransactionDate[] { tranDates };

request.SiteID = 123456;
request.ReversalDetails =  new SWS.TranReversalInfo[] { reverseDetails };

Finally we can call the method and pass across the login object and the request object to get our filtered site unit data. 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.GetPreReversePayDetails(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.