afv-library/skills/platform-data-and-tooling-api-context-get/assets/enterprise_api/ContactPointAddress.json

{
  "sections": [
    "title",
    "description",
    "fields",
    "associated_objects",
    "wsdl_segment",
    "field_reference"
  ],
  "title": "ContactPointAddress - Data API",
  "description": "Represents a contact’s billing or shipping address, which is associated with an individual or person account. This object is available in API version 49.0 and later.",
  "fields_columns": [
    "type",
    "properties",
    "description",
    "relationship_name",
    "relationship_type",
    "refers_to"
  ],
  "fields": {
    "ActiveFromDate": {
      "type": "date",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "The date when the contact’s address became active."
    },
    "ActiveToDate": {
      "type": "date",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "The date when the contact’s address is no longer active."
    },
    "Address": {
      "type": "address",
      "properties": "Filter, Nillable",
      "description": "The full address."
    },
    "AddressType": {
      "type": "picklist",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "Indicates the type of address. Possible values are: Billing Shipping"
    },
    "BestTimeToContactEndTime": {
      "type": "time",
      "properties": "Create, Filter, Nillable, Sort, Update",
      "description": "The latest time to contact the individual."
    },
    "BestTimeToContactStartTime": {
      "type": "time",
      "properties": "Create, Filter, Nillable, Sort, Update",
      "description": "The earliest time to contact the individual."
    },
    "BestTimeToContactTimezone": {
      "type": "picklist",
      "properties": "Create, Filter, Group, Nillable, Restricted picklist, Sort, Update",
      "description": "The time zone applied to the best time to contact the individual."
    },
    "City": {
      "type": "string",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "The address city."
    },
    "ContactPointPhoneId": {
      "type": "reference",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "Represents the primary phone number associated with this address. This is a relationship field.",
      "relationship_name": "ContactPointPhone",
      "relationship_type": "Lookup",
      "refers_to": "ContactPointPhone"
    },
    "Country": {
      "type": "string",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "The address country."
    },
    "GeocodeAccuracy": {
      "type": "picklist",
      "properties": "Create, Filter, Group, Nillable, Restricted picklist, Sort, Update",
      "description": "The level of accuracy of a location’s geographical coordinates compared with its physical address. A geocoding service typically provides this value based on the address’s latitude and longitude coordinates. Possible values are: Address Block City County ExtendedZip NearAddress Neighborhood State Street Unknown Zip"
    },
    "IsDefault": {
      "type": "boolean",
      "properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
      "description": "Indicates whether a contact’s address is the preferred method of communication (true) or not (false). The default value is false."
    },
    "IsPrimary": {
      "type": "boolean",
      "properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
      "description": "Indicates whether a contact’s address is their primary address (true) or not (false). The default value is false."
    },
    "IsThirdPartyAddress": {
      "type": "boolean",
      "properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
      "description": "Indicates whether the address is associated with a third party (true) or not (false). The default value is false. This field is available in API version 57.0 and later."
    },
    "LastReferencedDate": {
      "type": "dateTime",
      "properties": "Filter, Nillable, Sort",
      "description": "The timestamp for when the current user last referenced a record related to this record."
    },
    "LastViewedDate": {
      "type": "dateTime",
      "properties": "Filter, Nillable, Sort",
      "description": "The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed."
    },
    "Latitude": {
      "type": "double",
      "properties": "Create, Filter, Nillable, Sort, Update",
      "description": "Used with Longitude to specify the precise geolocation of the address. Acceptable values are numbers between –90 and 90 with up to 15 decimal places."
    },
    "Longitude": {
      "type": "double",
      "properties": "Create, Filter, Nillable, Sort, Update",
      "description": "Used with Latitude to specify the precise geolocation of the address. Acceptable values are numbers between –180 and 180 with up to 15 decimal places."
    },
    "Name": {
      "type": "string",
      "properties": "Create, Filter, Group, idLookup, Sort, Update",
      "description": "The name of the contact point address record.",
      "required": true
    },
    "OwnerId": {
      "type": "reference",
      "properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
      "description": "The ID of the account’s owner associated with this contact. This is a polymorphic relationship field.",
      "relationship_name": "Owner",
      "relationship_type": "Lookup",
      "refers_to": "Group, User"
    },
    "ParentId": {
      "type": "reference",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "The ID of the contact’s parent record. Only an individual or account can be a contact’s parent. Because this is a master-detail relationship, users must have Edit access to the parent record to create or modify a Contact Point Address. This is a polymorphic relationship field.",
      "relationship_name": "Parent",
      "relationship_type": "Master-detail",
      "refers_to": "Account, Individual"
    },
    "PostalCode": {
      "type": "string",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "The address postal code."
    },
    "PreferenceRank": {
      "type": "int",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "Preference rank when there are multiple contact point addresses."
    },
    "State": {
      "type": "string",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "The address state."
    },
    "Street": {
      "type": "textarea",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "The address street."
    },
    "UsageType": {
      "type": "picklist",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "Specify the usage type of this address. For instance, whether it’s a work address or a home address. Possible values are: Home Inactive Temporary Work"
    }
  },
  "associated_objects": "This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.\n\n- **ContactPointAddressChangeEvent**: Change events are available for the object.\n- **ContactPointAddressHistory**: History is available for tracked fields of the object.\n- **ContactPointAddressShare**: Sharing is available for the object.",
  "wsdl_segment": "```xml\n<complexType name=\"ContactPointAddress\">\n  <complexContent>\n    <extension base=\"ens:sObject\">\n      <sequence>\n        <element name=\"ActiveFromDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:date\"/>\n        <element name=\"ActiveToDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:date\"/>\n        <element name=\"Address\" nillable=\"true\" minOccurs=\"0\" type=\"tns:address\"/>\n        <element name=\"AddressType\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"ApprovalSubmissions\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"ApprovalWorkItems\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"BestTimeToContactEndTime\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:time\"/>\n        <element name=\"BestTimeToContactStartTime\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:time\"/>\n        <element name=\"BestTimeToContactTimezone\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"City\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"CommSubscriptionConsents\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"ContactPointConsents\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"ContactPointPhone\" nillable=\"true\" minOccurs=\"0\" type=\"ens:ContactPointPhone\"/>\n        <element name=\"ContactPointPhoneId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"Country\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"CreatedBy\" nillable=\"true\" minOccurs=\"0\" type=\"ens:User\"/>\n        <element name=\"CreatedById\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"CreatedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"FlowOrchestrationWorkItems\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"GeocodeAccuracy\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"Histories\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"IsDefault\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <element name=\"IsDeleted\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <element name=\"IsPrimary\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <element name=\"IsThirdPartyAddress\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <element name=\"LastModifiedBy\" nillable=\"true\" minOccurs=\"0\" type=\"ens:User\"/>\n        <element name=\"LastModifiedById\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"LastModifiedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"LastReferencedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"LastViewedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"Latitude\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:double\"/>\n        <element name=\"Longitude\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:double\"/>\n        <element name=\"Name\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"Owner\" nillable=\"true\" minOccurs=\"0\" type=\"ens:sObject\"/>\n        <element name=\"OwnerId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"Parent\" nillable=\"true\" minOccurs=\"0\" type=\"ens:sObject\"/>\n        <element name=\"ParentId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"PostalCode\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"PreferenceRank\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:int\"/>\n        <element name=\"ProcessInstances\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"
  "field_reference": {
    "ActiveFromDate": {
      "field_label": "Active from Date",
      "type": "date"
    },
    "ActiveToDate": {
      "field_label": "Active to Date",
      "type": "date"
    },
    "Address": {
      "field_label": "Address",
      "type": "address"
    },
    "AddressFirstName": {
      "field_label": "First Name",
      "type": "string",
      "length": "255"
    },
    "AddressLastName": {
      "field_label": "Last Name",
      "type": "string",
      "length": "255"
    },
    "AddressMiddleName": {
      "field_label": "Middle Name",
      "type": "string",
      "length": "255"
    },
    "AddressType": {
      "field_label": "Address Type",
      "type": "picklist",
      "length": "40"
    },
    "BestTimeToContactEndTime": {
      "field_label": "Best time to contact end time",
      "type": "time"
    },
    "BestTimeToContactStartTime": {
      "field_label": "Best time to contact start time",
      "type": "time"
    },
    "BestTimeToContactTimezone": {
      "field_label": "Best time to contact time zone",
      "type": "picklist",
      "length": "255"
    },
    "City": {
      "field_label": "City",
      "type": "string",
      "length": "40"
    },
    "CompanyName": {
      "field_label": "Company Name",
      "type": "string",
      "length": "255"
    },
    "ContactPointPhoneId": {
      "field_label": "Contact Point Phone ID",
      "type": "reference",
      "length": "18"
    },
    "Country": {
      "field_label": "Country",
      "type": "string",
      "length": "80"
    },
    "CreatedById": {
      "field_label": "Created By ID",
      "type": "reference",
      "length": "18"
    },
    "CreatedDate": {
      "field_label": "Created Date",
      "type": "datetime"
    },
    "GeocodeAccuracy": {
      "field_label": "Shipping Geocode Accuracy",
      "type": "picklist",
      "length": "40"
    },
    "Id": {
      "field_label": "Contact Point Address ID",
      "type": "id",
      "length": "18"
    },
    "IsDefault": {
      "field_label": "Is Default Address",
      "type": "boolean"
    },
    "IsDeleted": {
      "field_label": "Deleted",
      "type": "boolean"
    },
    "IsPrimary": {
      "field_label": "Is Primary",
      "type": "boolean"
    },
    "IsThirdPartyAddress": {
      "field_label": "Is Third-Party Address",
      "type": "boolean"
    },
    "LastModifiedById": {
      "field_label": "Last Modified By ID",
      "type": "reference",
      "length": "18"
    },
    "LastModifiedDate": {
      "field_label": "Last Modified Date",
      "type": "datetime"
    },
    "LastReferencedDate": {
      "field_label": "Last Referenced Date",
      "type": "datetime"
    },
    "LastViewedDate": {
      "field_label": "Last Viewed Date",
      "type": "datetime"
    },
    "Latitude": {
      "field_label": "Latitude",
      "type": "double",
      "precision": "18",
      "scale": "15"
    },
    "Longitude": {
      "field_label": "Longitude",
      "type": "double",
      "precision": "18",
      "scale": "15"
    },
    "Name": {
      "field_label": "Name",
      "type": "string",
      "length": "255"
    },
    "OwnerId": {
      "field_label": "Owner ID",
      "type": "reference",
      "length": "18"
    },
    "ParentId": {
      "field_label": "Parent ID",
      "type": "reference",
      "length": "18"
    },
    "PhoneNumber": {
      "field_label": "Phone",
      "type": "phone",
      "length": "40"
    },
    "PostalCode": {
      "field_label": "Zip/Postal Code",
      "type": "string",
      "length": "20"
    },
    "PreferenceRank": {
      "field_label": "Preference Rank",
      "type": "int",
      "digits": "9"
    },
    "State": {
      "field_label": "State/Province",
      "type": "string",
      "length": "80"
    },
    "Street": {
      "field_label": "Address",
      "type": "textarea",
      "length": "255"
    },
    "SystemModstamp": {
      "field_label": "System Modstamp",
      "type": "datetime"
    },
    "UsageType": {
      "field_label": "Usage Type",
      "type": "picklist",
      "length": "40"
    }
  },
  "field_reference_columns": [
    "field_label",
    "type",
    "length",
    "precision",
    "scale",
    "digits"
  ]
}