Yardi Store Developer eXchange

Allows you to void a payment for a rental and/or retail items. A void can only be done the same day as the original transaction and prior to nightly processing.

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 us name it SWS, in your Visual Studio project. At this point we need to define our objects.  We will need the standard service object, a VoidTransaction request object, and a VoidTransaction response object. We can define and create those like this:

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

Here is a sample code of the request object:

// VoidTransaction Request
request.OrgID = 123456;
request.SiteID = 123546;
request.AccountID = 123456;
request.AccountName = "Doe, John";
request.Amount = 55.26m;
request.TransactionID = 123546;
request.TransactionDate = new DateTime(2016, 2, 3);
request.Ledger = SWS.LedgerType.Rental;

Finally we can call the method and pass across the login object and the request object to retrieve our requested information. 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.VoidTransaction(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 in the exception so it can be debugged.

For a full list of methods see SWS Methods.