Archive

Archive for the ‘References’ Category

RentalContact Reference

March 8, 2017 Leave a comment

Reference for methods using the RentalContact object.

Name DateType Is Required
ContactId Long Required
Description The rental contact’s ID number. This is returned when using the CreateNewAccount or AddNewContact methods or you can search for it using the SearchBy method.
AddressId Long Required
Description The ID assigned to the address record when it was created.
PhoneId Long *Optional
Description The ID assigned to the phone record when it was created.
Note: While this is optional for the application, it’s best practice to always include a phone number for the site to contact the customer.
GateCode String Optional
Description Assigns a code to the gate system. This will be used to access the site and, possibly, their unit.
PrimaryFlag Boolean *Optional
Description Indicates if the contact is the primary for the quote record or not.
Note: While this is optional, if multiple contacts are being added to a rental, the first one will be set as primary if no other contact is flagged. It is best practice to always indicate which contact is the primary.
Categories: API General, References

ACCT_CONTACT_ADDRESSES Reference

November 10, 2016 Leave a comment

Reference for any method using the ACCT_CONTACT_ADDRESSES object. (This is different from the ContactAddress object.)

Name Data Type
ORG_ID Long
Description The organizations ID number.
ACCT_ID Long
Description The ID of the account to which the address is connected.
ACCT_TYPE Integer
Description The numeric value of the account type.
ACCT_TYPE_VAL String
Description The textual value of the account type.
ACCT_CLASS Integer
Description The numeric value of the account class.
ACCT_CLASS_VAL String
Description The textual value of the account class.
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.
CONTACT_ID Long
Description The contact’s ID number.
CONTACT_TYPE Integer
Description The numeric value of the contact type.
CONTACT_TYPE_VAL String
Description The textual value of the contact type.
ADDR_ID Long
Description The ID number of the primary contacts address.
ADDR_TYPE Integer
Description he numeric value for the address type.
Available values:

  • 1 – HOME
  • 2 – OFFICE
  • 3 – MAILING
  • 4 – SHIPPING
  • 5 – OTHER
ADDR_TYPE_VAL String
Description he numeric value for the address type.
Available values:

  • HOME – 1
  • OFFICE – 2
  • MAILING – 3
  • SHIPPING – 4
  • OTHER – 5
ADDRESS String
Description The primary contact’s address in full.
ADDR1 String
Description The first line of the street address.
ADDR2 String
Description The second line of the street address.
ADDR3 String
Description The third line of the street address.
CITY String
Description The city in which the address is located.
STATE String
Description The state/province in which the address is located.
POSTAL_CODE String
Description The postal/ZIP code for the address.
COUNTRY String
Description The country in which the address is located.
ACTIVE Boolean
Description Indicates if the contact is active (“True”) or not (“False”).
CREATED_BY Long
Description The ID number of the user that created the address record.
UPDATED_BY Long
Description  The ID of the last person to update the address record.
Categories: API General, References

ContactPhone Reference

November 10, 2016 Leave a comment

Reference for any method using the ContactPhone object. (This is different from ACCT_CONTACT_PHONES.)

Name Data Type
Active Boolean
Description “True” indicates and active phone number, “False” inactive.
ContactId Long
Description The system generated id number for the contact to which the phone is connected.
PhoneID Long
Description System generated ID of the phone record.
PhoneType PhoneType
Description The type of phone number.
Available values:

  • HOME
  • OFFICE
  • MOBILE
  • FAX
  • OTHER
Phone String
Description The phone number.
Categories: API General, References

AVAIL_SITE_RETAIL_ITEMS Reference

November 7, 2016 Leave a comment

Reference for calls using the AVAIL_SITE_RETAIL_ITEMS object.

Name DataType Is Required
ACTIVE Boolean Optional
Description “True” if the lookup is set as “Active”, “False” if not.
BARCODE String Optional
Description The barcode number of a retail item.
BUNDLED_ITEM Boolean Optional
Description “True” if retail item is part of a bundled item, “False” if not.
CATEGORY_ID Integer Optional
Description The selected category type ID number, if listed and applicable.
COLOR String Optional
Description The color of the retail item, if available.
COST_OF_GOODS Decimal Optional
Description The organization’s cost of goods price for a retail item.
DESCRIPTION String Optional
Description The description of the retail item, if available.
ITEM_TYPE Integer Optional
Description The item type of the retail item, depending upon whether it is sold alone or as part of a bundle.
MAX_PRICE Decimal Optional
Description The maximum retail item price allowed.
MIN_PRICE Decimal Optional
Description The minimum retail item price allowed.
PART_NUMBER String Optional
Description The part number of the retail item.
QTY Integer Optional
Description The total number of items available for sale at the site.
RETAIL_ID Long Optional
Description The retail item’s ID number at the organization level.
RETAIL_OBJECT_ID Long Required
Description The retail item’s ID number.
SITE_ID Long Optional
Description The site’s ID number.
SITE_PRICE Decimal Required
Description The retail item price defined by the site.
SKU String Optional
Description The stock keeping unit (SKU) number of the retail item.
SUGGESTED_PRICE Decimal Optional
Description The suggested retail item price defined by the site.
TAX_GROUP_ID Decimal Optional
Description The tax group’s ID number.
Categories: API General, References