SWS VoidMoveIn Method
Allows you to void a new rental. A void can only be initiated the same day that the move-in occurred and must be done prior to nightly processing. Keep in mind that if the rental was initiated through a reservation, the reservation will not be reinstated.
Parameters
Name | DataType | Is Required |
---|---|---|
RentalID | Long | Required |
Description | The rental item’s ID number. This is returned when using the MakeReservation method or can be searched for using the SearchBy method. | |
SiteID | Long | Required |
Description | The site’s ID number. This can be found using the GetSiteList method. |
Returned Parameters
Name | DataType |
---|---|
Succeeded | Boolean |
Description | Indicates if the void was completed successfully (“True”) or not (“False”). |
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 VoidMoveIn request object, and a VoidMoveIn response object. We can define and create those like this:
//' Create a request and response objects
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.VoidMoveIn_Request request = new SWS.VoidMoveIn_Request();
SWS.VoidMoveIn_Response response;
Here is a sample code of the request object:
// VoidMoveIn Request
request.SiteID = 123546;
request.RentalID = 123456;
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.VoidMoveIn(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.
Updated Oct. 15, 2015: You will no longer be able to void same day move-in rentals if you have taken multiple payments on that unit. Instead the payments may be voided using VoidTransaction or terminated using EndRental.