Archive

Archive for the ‘References’ Category

APPL_ACCT_CFLEX_DATA Reference

March 24, 2017 Leave a comment

Reference for any method using the APPL_ACCT_CFLEX_DATA object. These fields appear in the Store application at the account level. To view them click the account name and then click the green arrow on the right side of the account information.

Name Data Type
ACCT_ID Long
Description The account’s ID number. This is returned when you use the CreateNewAccount method or can be retrieved with the SearchBy method.
ORG_ID Long
Description The organization’s ID number.
EXT_COLUMN_NAME String
Description The name of the extended field in Store’s extended field definitions table.
LABEL STRING
Description The name of the field as it appears in the store application.
VALUE String
Description The option selected from the customized list of options.
LOOKUP_ID Long
Description The ID for the list of custom fields.
EXT_DATA_ID Long
Description The system’s ID for the data information.
CREATED_BY Long
Description The ID of the user that originally selected the item for the customer.
UPDATED_BY Long
Description The ID of the user that last updated the item for the customer.
Categories: API General, References

ACT_CONTACTS_DEC Reference

March 24, 2017 Leave a comment

Reference for all methods using the ACT_CONTACTS_DEC object.

Name Data Type
CONTACT_ID Long
Description The ID for the contact.
ACCT_ID Long
Description The account’s ID number. This is returned when you use the CreateNewAccount method or can be retrieved with the SearchBy method.
FIRST_NAME String
Description The first name of the contact.
LAST_NAME String
Description The last name or surname of the contact.
KNOWN_AS String
Description The name the customer prefers to go by.
CONTACT_TYPE Integer
Description The numeric value of the contact type.
Available values:

  • 1 – Account Manager
  • 2 – Account User
  • 3 – Account Contact Only
  • 4 – Business Contact Record
EMPLOYER String
Description The contact’s employer.
ACTIVE Boolean
Description Indicates if the contact is active or not.
EMAIL String
Description The email address for the contact.
DL_NUMBER String
Description The contact’s driver’s license number.
DL_STATE String
Description The state/province where the driver’s license was issued.
DOB String
Description The contact’s date of birth.
SSN String
Description The customer’s social security number.
SSN_DEC String
Description ┬áThe customer’s social security number.
ECOMM_CODE String
Description No longer returned.
CFLEX01 String
Description A custom field, set up by the organization, designed to hold additional contact information. This is not displayed in the Store application.
CFLEX02 String
Description A custom field, set up by the organization, designed to hold additional contact information. This is not displayed in the Store application.
CFLEX03 String
Description A custom field, set up by the organization, designed to hold additional contact information. This is not displayed in the Store application.
CFLEX04 String
Description A custom field, set up by the organization, designed to hold additional contact information. This is not displayed in the Store application.
CFLEX05 String
Description A custom field, set up by the organization, designed to hold additional contact information. This is not displayed in the Store application.
CREATED DateTime
Description The date the contact record was created.
UPDATED DateTime
Description The date the contact record was last updated.
CREATED_BY Long
Description The user’s ID that created the contact record.
UPDATED_BY Long
Description The users’s ID that last updated the contact record.
ACT_CONTACT_ADDRESSES ACCT_CONTACT_ADDRESSES
Description A collection of data for the contact’s address.
ACCT_CONTACT_PHONES ACCT_CONTACT_PHONES
Description A collection of data for the contact’s phone number.
Categories: API General, References

ReturnRetailItem Reference

March 20, 2017 Leave a comment

Reference for any method using the ReturnRetailItem object.

Name Data Type Required
RetailOjectID Long Required
Description The ID of the retail item being returned. Use the GetAvailableRetailItems method to find the ID.
ReturnReason RetailReturnReasons Required
Description The reason the retail item is being returned. Available values (Note: This list can be customized by the site, however, this method does not take advantage of the customization. Only the following reasons can be used.): RESTOCK_RESELL, DEFECTIVE_VENDOR_RETURN, DEFECTIVE_DESTROY.
Quantity Integer Required
Description The number of items being returned that match the RetailObjectID.
Categories: API General, References

MakeReservation_Request Reference

March 8, 2017 Leave a comment

Reference for any method using the MakeReservation_Request object.

Name Data Type Is Required
SiteID Long Required
Description The site’s ID number. This can be found using the GetSiteList method.
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.
UnitID Long Required
Description The unit’s ID number. This is returned when you use any of the GetSiteUnitData
calls and is maintained through rentals.
Version Decimal Required
Description The unit’s version number which serves to prevent duplicate use of the unit.
QuoteID Long Optional
Description The quote’s ID assigned to the quote when the initial reservation was created. Use this to update an existing quote to a different type of reservation/rental.
QuoteType Quote_Types Required
Description Tells the system what type of quote the reservation will be.
Available values:

  • QuoteOnly
  • SoftReservation
  • HardReservation

To make a rental use QuoteOnly but set RentNow to “true”, otherwise, set RentNow to “false”.

RentNow Boolean Required
Description Tells the system if it will be a rental or reservation. Set RentNow to “true” and QuoteType to “QuoteOnly” for a rental, otherwise set this as “false”.
Price Decimal Optional
Description Indicates the price at which the unit will be rented (the rent rate).
QuoteStartDate DateTime Optional
Description The date the quote record is created.
QuoteExpiration DateTime Optional
Description The date the quote record is no longer available.
InquirySource Integer Optional
Description The way the customer found out about the site/organization. This takes advantage of the custom LookUps in the Store application. You will need to get the list from the organization’s contact.
Contacts RentalContact Required
Description Object containing the information to add a contact.
Pcds TRAN_QUOTE_PCD_DETAIL Optional
Description Object containing all the information required to apply a discount or promotion.
OverrideReservationAmount Decimal Optional
Description This overrides the required deposit amount set by the site.
Categories: API General, References