Archive
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 GetAssessmentsByID Method
Retrieves assessments (i.e., rent, insurance, fees, etc.) for a list of assessment ID numbers and the total amount due for each.
Parameters
| Name | DataType | Is Required |
|---|---|---|
| AssessIDs | Long | Required |
| Description | An array of the assessment’s ID numbers. | |
| SiteID | Long | Required |
| Description | The site’s ID number. This can be found using the GetSiteList method. | |
Returned Parameters
| Name | DataType |
|---|---|
| SOA_GET_ASSESSMENTS | SOA_GET_ASSESSMENTS |
| Description | Object containing the information returned for the method. |
| TotalDue | Decimal |
| Description | The total amount due for the assessments. |
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 GetAssessmentsByID request object and a GetAssessmentsByID response object.
// Create request and response objects
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.GetAssessmentsByID_Request request = new SWS.GetAssessmentsByID_Request();
SWS.GetAssessmentsByID_Response response;
Here’s my sample code of the Request object.
// GetAssessmentsByID Request
request.SiteID = 123456;
request.AssessIDs = new long[] { 213456, 456789 };
Finally we can call the method and pass across the login object and the request object to get our assessments by ID. 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.GetAssessmentsByID(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 GetAssessments Method
Retrieves assessments (i.e., rent, insurance, fees, etc.) for a specified account, or specified rentals within the account, for a specified set of rental cycles.
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. | |
| Cycles | Integer | Optional |
| Description | This is based on the number of rental periods that is requested. If no rental period is entered, a single rental period will be assessed. If a single integer is entered, all rental items will be assessed the same number of rental periods. If an array of integers is requested, they will be matched one-to-one with the array of rental ID numbers requested. If the rental period arrays do not match, an error will occur. The number of rental periods starts from the PTD. The number of rental periods to retrieve is limited, based on the ‘Allowed Number of Days Paid Ahead’ rule for the site. Any services, insurance or protection plans on the account will be assessed equalling the number of months that the rental is assessed. | |
| IsRetail | Boolean | Required |
| Description | Indicates if the payment is for rent only (“False”) or retail only (“True”). Payment cannot be submitted for both at the same time with this setting. | |
| IsRetailAndRental | Boolean | Required |
| Description | Indicates if the payment is for rent and retail (“True”) or if it is for rent only (“False”). Payment should include the entire balance due for this option. | |
| MoveOutDate | DateTime | Optional |
| Description | This is deprecated. See the GetMoveOutInfo SWS method to determine rental amount due prior to termination. | |
| RentalIDs | Long | Required* |
| Description | The rental item ID numbers. An array of rental ID’s from the account. If no ID’s are passed in all rentals on the account are assessed. You can pass in one or more rental ID’s to have the assessment limited to one or more specified rentals. All rentals must belong to the account. This is returned when using the MakeReservation method or can be searched for using the SearchBy method. *Note: This is only required if there is a reservation on the account otherwise it can be left blank. |
|
| SiteID | Long | Required |
| Description | The site’s ID number. This can be found using the GetSiteList method. | |
Returned Parameters
| Name | DataType |
|---|---|
| SOA_GET_ASSESSMENTS | SOA_GET_ASSESSMENTS |
| Description | Object containing all data returned for the method. |
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 GetAssessments request object and a GetAssessments response object.
// Create request and response Objects
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.GetAssessments_Request request = new SWS.GetAssessments_Request();
SWS.GetAssessments_Response response;
Here’s my sample code of the Request object.
// get assessment request for an account with 2 rentals for 1 months rent
request.SiteID = 123456;
request.AcctID = 123456;
request.RentalIDs = new long[] { 123456, 456789 };
request.Cycles = new int[] { 1, 1 };
request.IsRetail = false;
request.IsRetailAndRental = false;
Finally we can call the method and pass across the login object and the request object to get our assessments. 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.GetAssessments(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 