Archive
SWS GetBaseFees Method
Retrieves a list of all fees at the site.
Parameters
| Name | DataType | Is Required |
|---|---|---|
| SiteID | Long | Required |
| Description | The site’s ID number. This can be found using the GetSiteList method. | |
Returned Parameters
| Name | DataType |
|---|---|
| ORG_FEE_SITE_ALL | ORG_FEE_SITE_ALL |
| Description | Object containing details off the organizations fees. |
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 GetBaseFees request object and a GetBaseFees response object. We can define and create those like this:
// Create a request and response objects
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.GetBaseFees_Request request = new SWS.GetBaseFees_Request();
SWS.GetBaseFees_Response response;
Here’s my sample code of the Request object.
// GetBaseFees Request
request.SiteID = 123456;
Finally we can call the method and pass across the login object and the request object to get our base 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.GetBaseFees(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 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.
SWS GetAccountAdjustments Method
Retrieves the processed non-sufficient fund (NSF) count and amount totals, fee waiver count and amount totals, and overrides for NSF and fee waivers on an account. Overrides are handled at the admin level.
Parameters
| Name | DataType | Is Required |
|---|---|---|
| AcctID | Long | Required |
| Description | The account’s ID number. This is returned when you use the CreateNewAccount method or can be retrieved with the SearchBy method. | |
| BeginDate | DateTime | Required |
| Description | The beginning date of the date range for which you are requesting the data. If “Null”, it defaults to today’s date. Dates begin at 12:00:01 A.M. | |
| EndDate | DateTime | Required |
| Description | The end date of the date range for which you are requesting the data. If ‘Null’, it defaults to today’s date. Dates end at 12:00 midnight. | |
| SiteID | Long | Required |
| Description | The site’s ID number. This can be found using the GetSiteList method. | |
Returned Parameters
| Name | DataType |
|---|---|
| AcctID | Long |
| Description | The account’s ID number. |
| FeeWaiveAmount | Decimal |
| Description | The total dollar amount of fees waived for the specified account. |
| FeeWaiveCount | Long |
| Description | The total number of fees waived for the specified account. |
| FeeWaiveOverrideAmount | Decimal |
| Description | The total dollar amount of fees waived that is beyond the limit defined by the site rule and approved by an admin. |
| FeeWaiveOverrideCount | Long |
| Description | The total number of additional fee waives allowed for this account that is beyond the limit defined by the site rule and approved by an admin. |
| NSFAmount | Decimal |
| Description | The total dollar amount of processed NSFs for the account. |
| NSFCount | Long |
| Description | The total number of processed NSFs for the account. |
| NSFOverrideCount | Long |
| Description | The total number of additional NSF’s allowed for this account that is beyond the limit defined by the site rule and approved by an admin. |
| SiteID | Long |
| Description | The site’s ID number. |
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 GetAccountAdjustments request object and a GetAccountAdjustments response object. We can define and create those like this:
// Create a request and response objects
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.GetAccountAdjustments_Request request = new SWS.GetAccountAdjustments_Request();
SWS.GetAccountAdjustments_Response response;
Here’s my sample code of the Request object.
// GetAccountAdjustments Request
request.SiteID = 123456;
request.AcctID = 123456;
request.DateRange.BeginDate = DateTime.Today.AddDays(-1);
request.DateRange.EndDate = DateTime.Today;
Finally we can call the method and pass across the login object and the request object to get our account adjustments. 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.GetAccountAdjustments(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 