Archive
Payment and AutoPay Setup widget use
Yardi has two browser forms that can be inserted into a website iframe/div to handle payment processing and auto pay enrollment. You will need special access to use these forms so please speak to your account manager before attempting to use them. These are not located within the API since they contain a user interface though API access is required to gather the required data for calling them. Each widget has it’s own link. Links shown here are for our Sandbox testing environment. Links for production can be obtained from your account manager.
Payment Widget
Link:
https://estoresbx.centershift.com/payment/pay_form.aspx?accountID= <account_guid>&siteID=<site_id>&acctID=<acct_id>& rentalID=<rental_id>&totalDue=<total_due>&cycles=<cycles>
Parameters (all parameters are required)
| Name | DataType |
|---|---|
| accountID | GUID |
| Description | This is a GUID you will be assigned when your account for using these widgets is setup. |
| siteID | Long |
| Description | This is ID for the site that owns the account. |
| acctID | Long |
| Description | This is the ID for the account containing the rental to be paid. |
| rentalID | Long |
| Description | This is the ID for the rental to be paid. |
| totalDue | Decimal |
| Description | This is the amount that will be paid. This amount must match the total due for the number of cycles being paid. This information can be obtained from GetTotalDue or GetTotalDuePastDue. |
| cycles | Integer |
| Description | This is the number of cycles (months) to be paid. This information can be obtained from GetTotalDue or GetTotalDuePastDue. |
The following can cause errors either initially or after submitting a payment:
- A rental is in auction – If a rental is currently scheduled for auction it cannot be paid for with this widget. Contacting the site will be required.
- The total_due amount passed in does not match the total due for the number of cycles passed in.
- The total_due/cycles passed in does not bring the account current.
- Required data is missing or not of the correct type.
- Payment was attempted but declined by the processor.
- Payment was approved but not able to be posted to the account.
Auto Pay Enrollment Widget
This allows creating a new auto pay or canceling an existing auto pay record.
Link:
https://estoresbx.centershift.com/payment/autopay_form.aspx?accountID= <account_guid>&siteID=<site_id>&acctID=<acct_id>& rentalID=<rental_id>&autoPaymentID=<auto_pay_id>
Parameters
| Name | DataType |
|---|---|
| accountID | GUID |
| Description | This is a GUID you will be assigned when your account for using these widgets is setup. |
| siteID | Long |
| Description | This is ID for the site that owns the account. |
| acctID | Long |
| Description | This is the ID for the account containing the rental to be paid. |
| rentalID | Long |
| Description | This is the ID for the rental to be paid. |
| autoPaymentID Optional | Long |
| Description | This is the ID for the current auto pay record. This should be passed if there is a current record to be cancelled. Otherwise the parameter should be left off the query string entirely. To obtain this ID you can call GetAutoPaySettings |
The following can cause errors either initially or after submitting the request:
- A rental is past due and an auto pay record is to be created. A rental must be current to set up auto pay.
- Required data is missing or not of the correct type.
- An update to the data failed.
SWS2 GetDataView Method – quote_reconciliation_v
This view, quote_reconciliation_v, pulls quotes created and includes information on when and who create the quote.
Returned Parameters
| Name | Data Type |
|---|---|
| QUOTE_ID | Long |
| Description | The quote’s ID number. |
| ORG_ID | Long |
| Description | The organization’s ID number. |
| CREATED_BY | Long |
| Description | The user’s ID that originally created the quote/reservation. |
| USER_NAME | String |
| Description | The username of the person that originally created the quote/reservation. |
| QUOTE_TYPE | Integer |
| Description | The numeric value for the type of quote/reservation. |
| QUOTE_TYPE_VAL | String |
| Description | The textual value for the type of quote/reservation. |
| STATUS | Integer |
| Description | The numeric value for the status of the quote/reservation. |
| QUOTE_STATUS_VAL | String |
| Description | The textual value for the status of the quote/reservation. |
| QUOTE_SOURCE | String |
| Description | The application through which the quote/reservation was created. |
| QUOTE_START_DATE | DateTime |
| Description | The date the quote/reservation was originally created. |
| EXPIRATION | DateTime |
| Description | The date the quote/reservation is no longer available to the customer. |
| SITE_ID | Long |
| Description | The site’s ID number. This can be found using the GetSiteList method. |
| SITE_NAME | String |
| Description | The name of the site as it appears in the Store application. |
| ACCT_NAME | String |
| 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. |
| FIRST_NAME | String |
| Description | The primary contact’s first name. |
| LAST_NAME | String |
| Description | The primary contact’s last name. |
| CONTACT_ADDRESS | String |
| Description | The address for the primary contact. This will include all address lines combined. |
| PHONE | String |
| Description | The primary contact’s primary phone number. |
| String | |
| Description | The primary contact’s email. This also acts as their username if eStore/eCommerce are supported. |
| UNIT_NUMBER | String |
| Description | The site assigned number applicable to the unit. This is not the unit ID. |
| UNIT_STATUS_VAL | String |
| Description | The textual value of the unit’s rental status. |
| UNIT_DIMENSIONS | String |
| Description | The width and depth dimensions combined in a string. |
| ATTRIBUTE01 | Integer |
| Description | The numeric value for the “Attribute01” custom look up as defined by the site. See eUnitAttr01 for the available values. |
| ATTRIBUTE01_VAL | String |
| Description | The textual value for the “Attribute01” custom lookup as defined by the site. See eUnitAttr01 for the available values. |
| QUOTED_RATE | Decimal |
| Description | The amount for which the quote/reservation was confirmed. This will take into account any adjusted rate and discounts. |
| DISCOUNT_AMOUNT_OFFERED | Decimal |
| Description | The dollar amount of any discount applicable to the quote/reservation. |
| MARKET_CODE_VAL | Integer |
| Description | The numeric indicator as to where the customer heard about the site. This is available to only specific sites. |
| MARKET_SOURCE_VAL | String |
| Description | The textual indicator as to where the customer heard about the site. This is available to only specific sites. |
| INQUIRY_SOURCE | String |
| Description | Indicates how the customer heard about the business. This is not required by all sites so may be null. |
| CREATED | DateTime |
| Description | The date that the quote reservation was originally created. |
Example
We’ll assume you’ve got a web reference, let’s name it Store, in your Visual Studio project. At this point we need to reference our objects. We’ll need the standard service object, a GetDataView_Request request object and a ParameterValues object. You will also need to pass in credentials. We can define and create those like this:
// Create a request and response objects
StoreServiceClient client = new StoreServiceClient();
GetDataView_Request request = new GetDataView_Request();
ParameterValues parms = new Store.ParameterValues();
As with every method we need to pass in credentials. We also set up the parameters for our request.
//get data view setup
client.ChannelFactory.Credentials.UserName.UserName = "user";
client.ChannelFactory.Credentials.UserName.Password = "pass";
client.ChannelFactory.Credentials.SupportInteractive = true;
parms.FilterType = 3;
parms.ParameterName = "created";
parms.ParameterValue = "01-MAR-2017";
request.OrgID = 123456;
request.SiteID = 123456;
request.ViewName = "quote_reconciliation_v";
request.Parameters = new ParameterValues[] { parms };
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.
try
{
// Call the method that will load the response object
object resp;
resp = client.GetDataView(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 SWS2 Methods.
SWS GetInsCancelWarningLetterInfo Method
This method allows insurance providers to access insurance cancellation warning letter data including when and where the letter was sent.
Parameters
| Name | DataType | Is Required |
|---|---|---|
| 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. | |
| 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. | |
Returned Parameters
| Name | DataType |
|---|---|
| LetterName | String |
| Description | The name of the letter that was sent. |
| UnitNum | String |
| Description | The unit’s number as assigned by the organization. This is not the UnitID. |
| RentalID | Long |
| Description | The rental’s ID number. |
| CustomerAccountName | String |
| 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. |
| CustomerFirstName | String |
| Description | The contact’s first name. |
| CustomerLastName | String |
| Description | The customer’s last name. |
| CustomerAddressLine1 | String |
| Description | Line one of the contact’s address. |
| CustomerAddressLine2 | String |
| Description | Line two of the contact’s address. |
| CustomerCity | String |
| Description | The city of the contact’s address. |
| CustomerState | String |
| Description | The state/province for the contact’s address. |
| CustomerPostalCode | String |
| Description | The postal code from the customer’s address. |
| SiteID | Long |
| Description | The site’s ID number. |
| SiteName | String |
| Description | The name of the site where the rental is located. |
| OperatorNumber | Long |
| Description | The user’s id that created the letter. |
| DaysInsuranceIsCancelled | Long |
| Description | The number of days before insurance will be cancelled from the date the letter was sent. |
| DaysLetterSent | Long |
| Description | The number of days since the letter was sent. |
| DateLetterCreated | DateTime |
| Description | The date the letter was created. |
| ProjectedInsuranceCancellationDate | DateTime |
| Description | The expected date of cancellation. |
| CancellationDate | DateTime |
| Description | If cancellation has occurred, the date insurance was cancelled. |
| InsuranceEffectiveEndDate | DateTime |
| Description | The last date of coverage. |
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, an GetInsCancelWarningLetterInfo request object and an GetInsCancelWarningLetterInfo response object. We can define and create those like this:
// Create a request and response objects
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.GetInsCancelWarningLetterInfo_Request request = new SWS.GetInsCancelWarningLetterInfo_Request();
SWS.GetInsCancelWarningLetterInfo_Response response;
Now we set up the parameters for our request.
// get letter data request
request.OrgID = 123456;
request.SiteID = 123456;
request.RentalID = 123546;
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.
try
{
// Call the method that will load the response object
response = service.GetInsCancelWarningLetterInfo(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 GetSiteTasksV2 Method
This method provides a wider range of task sources and types that previously were not available in the original method. Both the type and the source have been changed to integer types which will allow the method to grow as well.
Parameters
| Name | Data Type | Required |
|---|---|---|
| TaskId | Long | Optional |
| Description | Filters the results to a specific task. | |
| Type | Integer | Optional* |
| Description | The task category to retrieve. Most common values:
* Required if providing a source. |
|
| Source | Integer | Optional* |
| Description | The source of where the task was created. Most common values:
* Required if providing a type. |
|
| SiteID | Long | Required |
| Description | The site’s ID number. This can be found using the GetSiteList method. | |
| TaskDate | DateTime | Optional |
| Description | Filters the results to tasks due on a specific day. | |
Returned Parameters
| Name | Data Type |
|---|---|
| SOA_GET_SITE_TASKS | SOA_GET_SITE_TASKS |
| Description | The object containing the response. |
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 GetSiteTasksV2 request object and a GetSiteTasks response object. We can define and create those like this:
// Create a request and response objects
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.GetSiteTasksV2_Request request = new SWS.GetSiteTasksV2_Request();
SWS.GetSiteTasks_Response response;
Here’s my sample code of the Request object by type and source. Other optional parameters exists to change or narrow results.
// GetSiteTasks Request
request.SiteID = 123456;
request.Type = 1;
request.Source = 5;
Finally we can call the method and pass across the login object and the request object to get our site tasks. 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.GetSiteTasksV2(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 