Archive

Archive for the ‘Payments’ Category

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:

  • Rental
  • Retail
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

May 23, 2011 Leave a comment

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 GetWaiveVoidFeeStats Method

May 23, 2011 Leave a comment

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:

  • NO_LIMIT
  • NUM_WAIVES
  • AMT_WAIVES
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 GetTotalDue Method

May 23, 2011 Leave a comment

Retrieves the total amount due for specified rental items for an account and can expand the amount to cover future cycles. This will always include at least 1 rental period assessment. This will include all fees and services applicable to the requested time period.

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 for which to calculate the total. If no cycle is passed in, it is assumed only one cycle should be used. If a single integer is passed in, it is assumed that all account rentals will be included for the number of cycles indicated. If an array of integers is passed in, it is assumed they match one to one with the array of rental ID’s passed in. If the arrays are of different sizes, an error will occur. The number of cycles starts from the PTD for each 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 Required
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 Required
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 Optional
Description The rental item’s ID number. Use an array to choose which rentals will be included in the response. If no rental ID is indicated it will default to all rentals on the account. All rentals must belong to the account. 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
Details Decimal
Description The total amount due for the applied 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 GetTotalDue request object and a GetTotalDue 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.GetTotalDue_Response response;

Here’s my sample code of the Request object using a single rental from the account and requesting the oldest cycle’s total due.

// GetTotalDue 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 get our total due. 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.GetTotalDue(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.