CustomerAddress

Customer Address Object

Customer Address is a Child object of Customer and Lead.  

End Point

/customeraddress

GET, POST, PUT, DELETE

GET and DELETE requests expect parameters customerId AND id of type Int32.

Properties

PropertyCaptionData TypeRequired
Id
Id
Int32Put only
CustomerRefCustomerEntityRefTrue (either Customer or Lead Ref)
Name
Name
String (50)
True
Addr1Name/CompanyString (50)False
Addr2StreetString (50)False
Addr3Floor/SuiteString (50)False
Addr4Care ofString (50)False
AltContactAlt. ContactString (50)False
AltPhoneAlt. PhoneString (50)False
CityCityString (50)False
ContactContactString (50)False
CountryCountryString (50)False
FaxFaxString (50)False
PhonePhoneString (50)False
StateState/Prov./Reg.String (50)False
WebsiteWebsiteString (50)False
ZipZip/Postal codeString (50)False
EmailEmailString (1023)False
ItemSalesTaxRefTax ItemEntityRefFalse
LocationRefLocationEntityRefFalse
SalesTaxCodeRefTax CodeEntityRefFalse
IsActiveActiveBooleanFalse
IsPrimaryIs PrimaryBooleanFalse

Json Sample

{
    "Id": 1,
    "CustomerRef": {
        "Id": 298,
        "Name": "Sky Rockets Inc."
    },
    "Website": "https://www.skyrocketsinc.com",
    "LocationRef": null,
    "ItemSalesTaxRef": null,
    "SalesTaxCodeRef": null,
    "Name": "Primary",
    "Addr1": "Sky Rockets Inc.",
    "Addr2": "140 Hauge Street",
    "Addr3": "Suite 404",
    "Addr4": "Accounting",
    "City": "Miami",
    "State": "FL",
    "Zip": "33303",
    "Country": "US",
    "Contact": "John Doe",
    "AltContact": "Jane Smith",
    "Phone": "972-544-3160",
    "AltPhone": "305-869-8942",
    "Fax": "305-869-8944",
    "Email": "jane.doe.@gmail.com",
    "IsPrimary": true,
    "IsActive": true,
    "CustomFields": [
        {
            "Name": "AddCust1",
            "Value": null,
            "Caption": "FFL"
        },
        {
            "Name": "AddCust2",
            "Value": null,
            "Caption": "Ship Time"
        }
    ]
}