Archive
AssessmentData Reference
Reference information for the AssessmentData object.
Parameters
Name | DataType | Is Required |
---|---|---|
AssessmentID | Long | Required |
Description | The system generated id for the assessment you are processing. | |
AmountPayingForAssessment | Decimal | Required |
Description | The amount of the assessment. |
SWS VoidTransaction Method
Allows you to void a payment for a rental and/or retail items. A void can only be done the same day as the original transaction and prior to nightly processing.
Parameters
Name | DataType | Is Required |
---|---|---|
AccountID | 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. | |
AccountName | String | Required |
Description | The name on the account. This may differ from the primary contact’s name in some instances, such as a business account or a guardianship account. | |
Amount | Decimal | Required |
Description | The amount of the payment to be voided. | |
Ledger | LedgerType | Optional |
Description | Indicates if the transaction was for rental or retail. Available values:
|
|
OrgID | Long | Required |
Description | The organization’s ID number. | |
SiteID | Long | Required |
Description | The site’s ID number. This can be found using the GetSiteList method. | |
TransactionDate | DateTime | Required |
Description | The date the transaction occurred. For a void transaction it must always have been done current day. | |
TransactionID | Long | Required |
Description | The transaction’s ID number. Transaction IDs are system generated for each payment transaction that occurs in the system. If there is no transaction ID the transaction failed. The transaction ID is returned when any MakePayment method is used. It can also be retrieved using the GetRentalLedger method. |
Returned Parameters
Name | DataType |
---|---|
Successful | Boolean |
Description | Indicates if the transaction was voided successfully (“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 VoidTransaction request object, and a VoidTransaction response object. We can define and create those like this:
// Create a request and response objects
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.VoidTransaction_Request request = new SWS.VoidTransaction_Request();
SWS.VoidTransaction_Response response;
Here is a sample code of the request object:
// VoidTransaction Request
request.OrgID = 123456;
request.SiteID = 123546;
request.AccountID = 123456;
request.AccountName = "Doe, John";
request.Amount = 55.26m;
request.TransactionID = 123546;
request.TransactionDate = new DateTime(2016, 2, 3);
request.Ledger = SWS.LedgerType.Rental;
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.VoidTransaction(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 GetTotalDuePastDue Method
Retrieves the total amount due and the past due amount for a rental item, including the number of cycles past due. It works the same as the GetTotalDue SWS method with the exception that it requires each rental ID that you wish to include in the total. This will include all fees and services for the applicable past due and future amounts.
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 | The number of rental periods used to calculate the amount. If no cycle is passed in, it is assumed only one cycle should be included. The number of cycles starts from the PTD of the rental. You are limited to the number of cycles you can retrieve based on the ‘Allowed Number of Days Paid Ahead’ rule for the site. The rule information can be retrieved using the GetSiteRules and GetSiteRulesValue methods. | |
IsRetail | Boolean | Optional |
Description | Indicates that the total retrieved should be for retail assessment only (“True”) or if it should be for the rental assessments only (“False”). | |
IsRetailAndRental | Boolean | Optional |
Description | Indicates that the total retrieved should be for both the retail and the rental assessments on the account (“True”) or only for the rental assessments (“False”). | |
MoveOutDate | DateTime | Ignored |
Description | (Deprecated) The date the customer has indicated they will be moving out. | |
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 |
---|---|
PastDueCycles | Decimal |
Description | The number of rental periods that must be paid to bring the account current. |
PastDueTotal | Decimal |
Description | The total amount due to bring the account current. |
RequestedTotalDue | Decimal |
Description | The total amount due for the requested number of rental periods. |
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 GetTotalDue request object and a GetTotalDuePastDue response object. We can define and create those like this:
// Create a request and response objects
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.GetTotalDue_Request request = new SWS.GetTotalDue_Request();
SWS.GetTotalDuePastDue_Response response;
Here’s my sample code of the Request object.
// GetTotalDuePastDue Request
request.SiteID = 123456;
request.AcctID = 123456;
request.RentalID = new long[] { 123456 };
request.Cycles = new int[] { 1 };
request.IsRetail = false;
request.IsRetailAndRental = false;
Finally we can call the method and pass across the login object and the request object to retrieve the data. 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.GetTotalDuePastDue(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 GetTransactionRentals Method
Retrieves information regarding rentals and retail related to a specified transaction.
Parameters
Name | DataType | Is Required |
---|---|---|
SiteID | Long | Required |
Description | The site’s ID number. This can be found using the GetSiteList method. | |
TranID | ArrayOfLong | Required |
Description | The transaction’s ID number. Transaction IDs are system generated for each monetary transaction that occurs in the system. If there is no transaction ID the transaction failed. The transaction ID is returned when any MakePayment method is used. |
Returned Parameters
Name | DataType |
---|---|
RENTAL_ID | Decimal |
Description | The rental item’s ID number. |
TNX_DATE | DateTime |
Description | The date the transaction occurred. |
TNX_ID | Long |
Description | The transaction’s ID number.Transaction IDs are system generated for each monetary transaction that occurs in the system. |
HasRetail | Boolean |
Description | Indicates if the transaction included retail assessments (“True”) or not (“False”). |
TranID | Long |
Description | The transaction’s ID number. Transaction IDs are system generated for each monetary transaction that occurs in the system. This reiterates the first transaction ID. |
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 GetTransactionRentals request object and a GetTransactionRentals response object. We can define and create those like this:
// Create a request and response objects
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.GetTransactionRentals_Request request = new SWS.GetTransactionRentals_Request();
SWS.GetTransactionRentals_Response response;
Here’s my sample code of the Request object.
// GetTransactionRentals Request
request.SiteID = 123456;
request.TranID = new long[] { 123456 };
Finally we can call the method and pass across the login object and the request object to get our transaction rentals. 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.GetTransactionRentals(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.