SWS AssessFee Method
Adds a fee (i.e., 10% Late Fee, Org Admin Fee, Standard Dumpster Fee, etc.) to a rental item.
Parameters
| Name | DataType | Is Required |
|---|---|---|
| BaseFeeObj | ORG_FEE_SITE_ALL | Optional* |
| Description | The items required for assessing a base fee to the rental. See the GetBaseFees SWS method for available base fees. * Either BaseFeeObj or SchedFeeObj 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. | |
| SchedFeeObj | ORG_RENTAL_SCHEDULED_FEES | Optional* |
| Description | The items required for assessing a scheduled fee to the rental. See GetScheduledFees method for available scheduled fees. * Either BaseFeeObj or SchedFeeObj is required. |
|
| 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 fee was added successfully to the account (“True”) or not (“False”). |
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 fee object, an AssessFee request object and an AssessFee response object. We can define and create those like this:
// Create a request and response objects and grab a fee from GetBaseFees
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.AssessFee_Request request = new SWS.AssessFee_Request();
SWS.AssessFee_Response response;
SWS.GetBaseFees_Response base_fee = service.GetBaseFees(user_request, fee_request);
Here’s my sample code of the Request object.
// Create the Assess fee request
request.SiteID = 123456;
request.RentalID = 123456;
request.BaseFeeObj = base_fee.Details[0];
Finally we can call the method and pass across the login object and the request object to assessing a fee. 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.AssessFee(user_request, request);
}
catch (Exception ex)
{
MessageBox.Show(ex.Message);
}
Note that if something goes wrong the fee 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.
Yardi Store Developer eXchange 