--- schema_version: "1" id: aa61d0acb9ee0a8e8c529833b11e08f758c235ecd016efbf5df7d803f005c91b title: CustomerProperty collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/financial_services_cloud_object_reference/sforce_api_objects_customerproperty.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.financial_services_cloud_object_reference.meta/financial_services_cloud_object_reference/sforce_api_objects_customerproperty.htm source_site: developer.salesforce.com content_type: documentation content_hash: 07b1fc3a95b045bc077909d92f809747961088756a0bbb5ff8fac82b25faed9c description: Represents the insurable and insured properties of a customer. --- # CustomerProperty Represents the insurable and insured properties of a customer. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### Address - **Type**: address - **Properties**: Filter, Nillable - **Description**: The location of the property. This is a compound field of type Address and combines these fields: City, Country, GeocodeAccuracy, Latitude, Longitude, PostalCode, State, and Street. For more information, see [Address Compound Fields](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/compound_fields_address.htm). ### AnnualMileage - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The distance that the vehicle is expected to be driven in a year. ### AssetId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the asset associated with this customer property. ### BathroomCount - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The total number of bathrooms in the property. ### BedroomCount - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The total number of bedrooms in the property. ### BuiltUpArea - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The property's usable area, which is also known as the carpet area. ### CeilingType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The type of the ceiling the property has. For example, conventional, beam, shed, cove, tray, suspended. ### ConstructionClass - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The type of the property's construction. For example, framed, masonry non-combustible, modified, semi-resistive, or fire resistive. ### DaysDrivenTowork - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The number of days that the vehicle was used to drive to work. ### Description - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The description of the asset. ### DwellingType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The property's dwelling type on the policy creation date. For example, ranch, single family, or condo. ### EngineDisplacementVolume - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The engine capacity of the vehicle. ### FactoryPrice - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The price of the vehicle billed by the manufacturer. ### FairMarketValue - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The estimated market price of the vehicle on the policy creation date. ### FinancingType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The type of financing used to purchase the asset. ### FloorCount - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The number of stories in the property. ### FloorType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The type of the floor the property had on the policy creation date. For example, ceramic tile, porcelain tile, floating wood tile. ### FoundationType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The type of the property's foundation. For example, pier and beam, slab. ### FuelType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The fuel system of the vehicle. ### GarageSpaceCount - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The number of parking spaces available in the property. ### GarageType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The type of the garage the property has. ### GrossVehicleWeight - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Vehicle’s weight. ### IsBasementIncluded - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the property has a basement. - **Default value**: False ### IsChimneyIncluded - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the property has a chimney. - **Default value**: False ### IsPassedSmogCheck - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the vehicle has passed the smog check. - **Default value**: False ### IsSwimmingPoolIncluded - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the property has a swimming pool. - **Default value**: False ### KitchenCount - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The total number of kitchens in the property. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed 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. ### LeasePeriod - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The current lease period for the property. ### LienHolderName - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The bank or the financial firm that legally owns the asset. ### LoadCapacity - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Vehicle’s load-carrying capacity. ### LotArea - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The total area of the plot on which the property is constructed, including the construction area and the open area on all sides. ### Make - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The brand of the vehicle. ### MakeYear - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The year in which the vehicle was manufactured. ### MilesDrivenToWork - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The number of miles that the vehicle covered when it was used to drive to work. ### ModelName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The model name of the vehicle. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, Sort - **Description**: An auto-generated number assigned to this record. ### OdometerReading - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Vehicle's odometer reading on the policy creation date. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: ID of the record owner. ### PassengerSeatCapacity - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The legal seating capacity of the vehicle. ### PrimaryOwnerId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: ID of the primary owner of the asset. ### PrimaryUse - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: What the vehicle is primarily going to be used for. ### PurchaseDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date on which this property was purchased. ### PurchasePrice - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The amount of money paid by the owner to purchase this property. ### RegistrationNumber - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: Vehicle's license plate number. ### RegistrationType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Vehicle's registration type. For example, antique, combo, apportioned, commercial. ### RoofType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The type of the roof the property has. ### SourceSystem - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the source system this property record was obtained from. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of this property record in the source system. ### TransmissionType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The transmission type of the vehicle. ### Vin - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Vehicle’s identification number. ### YearBuilt - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The year in which the property was constructed. ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [CustomerPropertyChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.financial_services_cloud_object_reference.meta/financial_services_cloud_object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object in API version 62.0 and later. [CustomerPropertyFeed](https://developer.salesforce.com/docs/atlas.en-us.financial_services_cloud_object_reference.meta/financial_services_cloud_object_reference/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [CustomerPropertyHistory](https://developer.salesforce.com/docs/atlas.en-us.financial_services_cloud_object_reference.meta/financial_services_cloud_object_reference/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [CustomerPropertyOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.financial_services_cloud_object_reference.meta/financial_services_cloud_object_reference/sforce_api_associated_objects_ownersharingrule.htm "StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner.") Sharing rules are available for the object. [CustomerPropertyShare](https://developer.salesforce.com/docs/atlas.en-us.financial_services_cloud_object_reference.meta/financial_services_cloud_object_reference/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object.