Home > Accounting, API General, Fees, Payments > SWS GetWaiveVoidFeeStats Method

SWS GetWaiveVoidFeeStats Method


Retrieves fee waive and void statistics for a rental item.

Parameters

Name DataType Is Required
OrgID Long Required
Description The organization’s ID number.
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
limitWaives waiveLimit
Description The “Fee Waive – Limit Definition” rule value set by the admin for the site.
Available values:

  • NO_LIMIT
  • NUM_WAIVES
  • AMT_WAIVES
maxWaives Integer
Description The “Fee Waive – Annual Limit” rule value set by the admin for the site. Indicates the maximum nuber of waivers allowed if set to NUM_WAIVES or the total dollar limit of waivers if set to AMT_WAIVES. If no limit is set it may still return a maximum value, but this value is ignored for the waivers.
reqWaiveReason Boolean
Description “True” if the sites “Fee Waive – Require Reason” rule is set to require the reason a fee is waived, “False” if not.
usedWaives String
Description If limitWaives is set to NUM_WAIVES this will be the number of waivers the customer has already received. If limitWaives is set to AMT_WAIVES this will be the total amount already waived for the customer.

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 a GetWaiveVoidFeeStats request object and a GetWaiveVoidFeeStats response object.  We can define and create those like this:

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

Here’s my sample code of the Request object.

//  GetWaiveVoidFeeStats Request
request.OrgID = 123456;
request.SiteID = 123456;
request.RentalID = 123456;

Finally we can call the method and pass across the login object and the request object to get our void fee stats. 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.GetWaiveVoidFeeStats(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.

  1. No comments yet.
  1. No trackbacks yet.

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out /  Change )

Google photo

You are commenting using your Google account. Log Out /  Change )

Twitter picture

You are commenting using your Twitter account. Log Out /  Change )

Facebook photo

You are commenting using your Facebook account. Log Out /  Change )

Connecting to %s

%d bloggers like this: