Archive
SWS WaiveFee Method
Allows you to waive a fee that has been assess to an account, but that has not yet been paid. This will allow you to remove a fee even if it has gone through nightly processing, but it will count towards the waived count or amount set by the site admin in the site rules.
Parameters
| Name | DataType | Is Required |
|---|---|---|
| Amount | Decimal | Required |
| Description | The amount of the fee that will be waived. | |
| AssessmentID | Long | Required |
| Description | The assessment’s ID number. This can be retrieved using the GetAssessments method. It can also be retrieved using the GetRentalLedger method. | |
| OrgID | Long | Required |
| Description | The organization’s ID number. | |
| Reason | String | Optional |
| Description | The reason for waiving the fee. | |
| 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 fee waiver was successful (“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 service object, a WaiveFee request object and a WaiveFee response object. We can define and create those like this:
// Create a request and response objects
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.WaiveFee_Request request = new SWS.WaiveFee_Request();
SWS.WaiveFee_Response response;
Here’s my sample code of the Request object.
// WaiveFee Request
request.OrgID = 123456;
request.SiteID = 123546;
request.AssessmentID = 123456;
request.RentalID = 123456;
request.Amount = 55.26m;
request.Reason = "Was charged the fee because of a misunderstanding";
Finally we can call the method and pass across the login object and the request object to waive our 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.WaiveFee(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.
SWS VoidFee Method
Allows you to void a fee. A void can only be done before nightly processing has updated the transaction.
Parameters
| Name | DataType | Is Required |
|---|---|---|
| AssessmentID | Long | Required |
| Description | The assessment’s ID number. This can be retrieved using the GetAssessments method. | |
| 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 |
|---|---|
| Succeeded | Boolean |
| Description | Indicates if the void was successful (“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 VoidFee request object, and a VoidFee response object. We can define and create those like this:
// Create a request and response objects
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.VoidFee_Request request = new SWS.VoidFee_Request();
SWS.VoidFee_Response response;
Here is a sample code of the request object:
// VoidFee Request
request.OrgID = 123456;
request.SiteID = 123546;
request.AcctID = 123456;
request.AssessmentID = 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.VoidFee(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.
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:
|
| 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.
SWS GetScheduledFees Method
Retrieves a list of scheduled fees for the specified rental.
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 |
|---|---|
| BASE_FEE_TYPE | Integer |
| Description | The scheduled fee type’s numeric value. Available values:
|
| FEE_ACTIVE | Boolean |
| Description | Indicates if the scheduled fee is active (“True”) or not (“False”). |
| FEE_AMT | String |
| Description | The fee amount. |
| FEE_AMT_DESC | String |
| Description | The description of the fee amount. |
| FEE_DESC | String |
| Description | The site fee’s description. |
| FEE_OBJECT_ID | Decimal |
| Description | The site fee’s ID number. |
| ICON | String |
| Description | The URL for the site revenue class icon that displays in the Store application. |
| ORG_FEE_OBJECT_ID | Long |
| Description | The organization fee’s ID number. |
| REF_TYPE | Decimal |
| Description | A numeric value for the assessment type. |
| RENTAL_ID | Long |
| Description | The rental item’s ID number. |
| SITE_ID | Long |
| Description | The site’s ID number. |
| TAXABLE | Boolean |
| Description | Indicates if the fee is taxable (“True”) or not (“False”). If a tax exempt ID is used, the fee will not be taxed even if this returns “True”. |
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 GetScheduledFees request object and a ScheduledFee response collection. We can define and create those like this:
// Create a request and response objects
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.GetScheduledFees_Request request = new SWS.GetScheduledFees_Request();
SWS.ScheduledFee[] response;
Here’s my sample code of the Request object.
// GetScheduledFees 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 scheduled fees. 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.GetScheduledFees(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.
Yardi Store Developer eXchange 