SWS GetCashCredits Method
Retrieves the available cash credit/escrow for a selected AccountID or RentalID number.
Parameters
| Name | DataType | Is Required |
|---|---|---|
| AccountID | Long | Optional* |
| Description | The accounts ID number. This is returned when you use the CreateNewAccount method or can be retrieved with the SearchBy method. * Either AccountID or RentalID is required. |
|
| RentalID | Long | Optional* |
| Description | The rental item’s ID number. This is returned when using the MakeReservation method or can be searched for using the SearchBy method. * Either AccountID or RentalID is required. |
|
| SiteID | Long | Required |
| Description | The site’s ID number. This can be found using the GetSiteList method. | |
Returned Parameters
| Name | DataType |
|---|---|
| ACCT_ID | Long |
| Description | The account’s ID number. |
| AMT | Decimal |
| Description | The original amount of the cash credit/escrow. |
| BALANCE | Decimal |
| Description | The remaining amount of the cash credit/escrow if any portion of it has been used. |
| CREATED | DateTime |
| Description | The date and time the credit was created. |
| CREDIT_TYPE | Integer |
| Description | The numeric value for the credit type. |
| CREDIT_TYPE_VALUE | String |
| Description | The textual description of the CREDIT_TYPE value. |
| ESCROW_ID | Long |
| Description | The cash credit/escrow item’s ID number. |
| REF_ID | Long |
| Description | The cash credit/escrow’s reference ID number. |
| REF_TYPE | Integer |
| Description | The numeric value for the assessment type. |
| REF_TYPE_VAL | String |
| Description | The assessment type’s textual value. |
| SITE_ID | Long |
| Description | The site’s ID number. |
| TNX_ID | Long |
| Description | The transaction’s ID number. Transaction IDs are system generated for each payment transaction that occurs in the system. A null or “0” response indicates the transaction failed. |
| VERSION | Integer |
| Description | The unit’s version number which serves to prevent duplicate use of the unit. |
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 GetCashCredits request object and a CASH_CREDITS object. We can define and create those like this:
// Create a request and response objects
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.GetCashCredits_Request request = new SWS.GetCashCredits_Request();
SWS.CASH_CREDITS[] response;
Here’s my sample code of the Request object using the account ID.
// GetCashCredits Request
request.SiteID = 123456;
request.AccountID = 123456;
Finally we can call the method and pass across the login object and the request object to get our cash credit/escrow. 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.GetCashCredits(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 