Archive

Author Archive

How to enable the Transaction Details API for Authorize.NET

April 16, 2011 Leave a comment

If you use Authorize.NET to verify your Credit Card or ACH transactions for Store then you may need to enable the “Transaction Details API” if you want to get updates on your transactions. The “Transaction Details API” provided by Authorize.NET provides detailed reporting on past transactions which occurred through Authorize.NET. To enable the API you will need to login to your Authorize.NET portal. The portal address and login information will be provided by Authorize.NET.  Once logged in, click on the “Account” menu item on the top. Under the “Security Settings” section at the bottom you should see a link that says “Transaction Details API”. After clicking on the link, you should see a button on the page labeled “Enable Transaction Details API”.  Once enabled you are ready to go.

SWS UpdateRentalSettings Method

March 17, 2011 Leave a comment

Allows you to change the primary contact, secondary contact, tax exempt status, delinquency schedule, delinquency step and overlock status of the specified rental.

Parameters

Name DataType Is Required
DelExempt Boolean Optional
Description Sets the unit to exempt for the delinquency processing (“True”) or to be processed normally (“False”). Default is “False”.
DelScheduleID Long Optional
Description Changes the delinquency schedule that is assigned to the unit. You can get the ID, name and description using the GetDelinqSchedule method.
DelStep Integer Optional
Description Set the delinquency step number of the unit. This is the level of delinquency that applies to the unit’s delinquency status. This cannot be a negative number.
OverlockStatus OverlockStatus Optional
Description Sets the overlock status of the rental.
Available values:

  • NOT_OVERLOCKED
  • PENDING_OVERLOCK
  • OVERLOCKED
  • PENDING_LOCK_REMOVAL
PrimaryContact Long Optional
Description Assigns an existing contact as the primary rental contact to the rental via the contact ID.
PrimaryContactAddressID Long Optional
Description The address’s ID number for the address that should be assigned to the new primary contact. This is required if the PrimaryContact parameter is used.
PrimaryContactPhoneID Long Optional
Description The ID of the phone number you wish to add to the primary contact. This is required if the PrimaryContact parameter is used.
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.
SecondaryContact Long Optional
Description Assigns an existing contact as the secondary rental contact to the rental via the contact ID.
SecondaryContactAddressID Long Optional
Description The address’s ID number for the address that should be assigned to the secondary contact. This is required if the SecondaryContact parameter is used.
SecondaryContactPhoneID Long Optional
Description The ID of the phone number you wish to add to the secondary contact. This is required if the SecondaryContact parameter is used.
TaxExempt Boolean Optional
Description Indicates if the rental should not be charged taxes (“True”) of if taxes should apply normally (“False”). The default is “False”. This applies per rental so each rental that is tax exempt needs to be updated. This does not apply to retail that is handled separately.
TaxInfo String Optional
Description The tax id, if the rental should be tax exempt. This is required if you use the TaxExempt parameter.

Returned Parameters

Name DataType
AccountID Long
Description The account’s ID number.
DelExempt Boolean
Description Indicates that the unit is set to be exempt from delinquency processing (“True”) or if it will process normally (“False”). The default is “False”.
DelSchedule Long
Description The delinquency schedule’s ID number.
DelStep Integer
Description The current step number within the delinquency schedule that applies to the unit’s delinquency status. This cannot be a negative number.
EndDate DateTime
Description The date the rental was terminated and the customer moved out.
LTD DateTime
Description The date that the customer has leased
MoveOutDate DateTime
Description The date the customer vacated the rental.
OverlockStatus OverlockStatus
Description The current overlock status of the rental.
Available values:

  • NOT_OVERLOCKED
  • PENDING_OVERLOCK
  • OVERLOCKED
  • PENDING_LOCK_REMOVAL
PrimaryContactUpdated Boolean
Description Indicates if the primary contact was updated successfully (“True”) or not (“False”).
PTD DateTime
Description The date through which the customer has paid on their rental.
RentalID Long
Description The rental item’s ID number.
SecondaryContactUpdated Boolean
Description Indicates if the secondary contact was updated successfully (“True”) or not (“False”).
StartDate DateTime
Description The date the customer first moved into the unit.
TaxExempt Boolean
Description Indicates that the unit is set to be exempt from taxes (“True”) or if it will be taxed normally (“False”). The default is “False”.
TaxExemptInfo String
Description The tax ID number if the rental is tax exempt.

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, an UpdateRentalSettings request object, and an UpdateRentalSettings response object. We can define and create those like this:

' Create a request and response objects
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.UpdateRentalSettings_Request request = new SWS.UpdateRentalSettings_Request();
SWS.UpdateRentalSettings_Response response;

Here is a sample code of the request object:

// UpdateRentalSettings Request
request.RentalId = 123546;
request.PrimaryContact = 123456;
request.PrimaryContactAddressID = 123456;
request.PrimaryContactPhoneID = 123456;

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.UpdateRentalSettings(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 UpdateRefundStatus Method

March 17, 2011 Leave a comment

Provides the ability to approve or deny a list of refunds which are pending approval.

Parameters

Name DataType Is Required
Note String Optional
Description The notes regarding why a refund was denied or approved.
RefundID Long Required
Description The refund request’s ID number.
RefundStatus RefundStatus Required
Description The status to which you are changing the refund request.
Available values:

  • PendingApproval
  • Approved
  • Denied
  • Processed
  • ReSet
  • CreditFail
  • SystemRefund
  • Cancelled
SiteId Long Required
Description The site’s ID number. This can be found using the GetSiteList method.

Returned Parameters

Name DataType
RefundID Long
Description The refund request’s ID number that was updated.
Success Boolean
Description Indicates if the refund request was updated successfully (“True”) or if it failed (“False”).
Message String
Description The information describing what went wrong if the update failed.

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, an UpdateRefundStatus request object, and an UpdateRefundStatus response object. We can define and create those like this:

// Create a request and response objects
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.UpdateRefundStatus_Request request = new SWS.UpdateRefundStatus_Request();
SWS.UpdateRefundStatus_Response response;

Here is a sample code of the request object:

// UdpateRefundStatus Request
request.PhoneId = 123456;
request.Phone = "800-555-1212";

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.UpdateRefundStatus(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.

Categories: API General, Refunds, Services Tags: