| Name | Description | Type | Additional information |
|---|---|---|---|
| CustomerSiteId |
Sedona internal autonumber for the Customer Site record |
integer |
None. |
| CustomerId |
Foreign key from AR_Customer table (required for POST and PUT, but cannot be changed on a PUT) |
integer |
Required |
| TaxGroupCode |
Value from AR_Taxing_Group table; set to N/A if not applicable; list of valid options can be retrieved from GET: api/taxinggroup |
string |
None. |
| BranchCode |
Value from AR_Branch table; list of valid options can be retrieved from GET: api/branch |
string |
Required String length: inclusive between 0 and 25 |
| IsCommercial |
True for Commercial account; false for Residential |
boolean |
Required |
| SiteName |
If a person, CustomerName should be passed in as "Last, First" |
string |
Required String length: inclusive between 0 and 60 |
| Address1 | string |
Required String length: inclusive between 0 and 60 |
|
| Address2 | string |
String length: inclusive between 0 and 60 |
|
| Address3 | string |
String length: inclusive between 0 and 60 |
|
| City |
City name; must exist in the GE_Table1 table |
string |
Required |
| State |
State 2 letter abbreviation; must exist in the GE_Table2 table |
string |
Required |
| Zip |
Zip code, not inclusive of extension (i.e. first 5 digits for U.S. zip); must exist in the GE_Table3 table |
string |
Required |
| County |
County name; must exist in the GE_Table4 table; defaults to N/A if not supplied |
string |
None. |
| ZipExt |
Last 4 of zip code |
string |
String length: inclusive between 0 and 10 |
| CountryAbbrev |
Country code; must exist in the SS_Country table (Abbrev column); defaults to "USA" if not supplied |
string |
None. |
| Phone1 | string |
String length: inclusive between 0 and 12 |
|
| Phone2 | string |
String length: inclusive between 0 and 25 |
|
| Fax | string |
String length: inclusive between 0 and 25 |
|
| string |
String length: inclusive between 0 and 50 |
||
| Comments | string |
String length: inclusive between 0 and 255 |
|
| MapCode |
Map Code (for directional purposes). This information will display on service tickets. |
string |
String length: inclusive between 0 and 15 |
| CrossStreet |
Cross street name for this site. This information will display on service tickets. |
string |
String length: inclusive between 0 and 50 |
| CustomerSince |
The installation date of this site; defaults to today if not supplied |
string |
None. |
| Inactive |
Set to true to make this site inactive |
boolean |
None. |
| ExternalLink |
defaults to empty string if not needed |
string |
String length: inclusive between 0 and 25 |
| ExternalSerialNumber |
defaults to empty string if not needed |
string |
String length: inclusive between 0 and 25 |
| ExternalVersionNumber |
defaults to empty string if not needed |
string |
String length: inclusive between 0 and 25 |
| CycleTaxGroupCode |
Value from AR_Taxing_Group table; Taxing Group that recurring invoices for this site will use; defaults to N/A if not supplied; list of valid options can be retrieved from GET: api/taxinggroup |
string |
None. |
| TaxExemptNum |
Applies only to tax exempt organizations (i.e. government/nonprofit) |
string |
String length: inclusive between 0 and 20 |
| GSTTaxExemptNum |
Applies only to tax exempt organizations in Canada (i.e. government/nonprofit) |
string |
String length: inclusive between 0 and 20 |
| SiteNumber | string |
String length: inclusive between 0 and 20 |
|
| CustomerBillId |
Foreign key from AR_Customer_Bill table; links this site to a billing address |
integer |
Required |
| BusinessName2 | string |
String length: inclusive between 0 and 60 |