# legacydeveloper Automotive Cloud - Full Documentation # AccountAccountRelation Represents a relationship between accounts, such as a relationship between a dealer account and a household account. This object is available in API version 58.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules Automotive and Group Membership must be enabled. ## Fields ### AccountId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: ID of the account associated with this account account relationship. This field is a relationship field. - **Relationship Name**: Account - **Relationship Type**: Lookup - **Refers To**: Account ### EndDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date when the relationship ends. ### HierarchyType - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the hierarchy between accounts that are related. Possible values are: The default value is Parent. Child, Parent, or Peer. ### IsActive - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the account is actively involved with the related account (true) or not (false). The default value is false. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record, a record related to this record, or a list view. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Name of the account account relationship. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: ID of the owner of this object. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### PartyRoleRelationId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The relationship between two accounts. This field is a relationship field. - **Relationship Name**: PartyRoleRelation - **Relationship Type**: Lookup - **Refers To**: PartyRoleRelation ### RelatedAccountId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The related account in the relationship. This field is a relationship field. - **Relationship Name**: RelatedAccount - **Relationship Type**: Lookup - **Refers To**: Account ### RelatedInverseRecordId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The record that specifies the inverse relationship between the accounts. This field is a relationship field. - **Relationship Name**: RelatedInverseRecord - **Relationship Type**: Lookup - **Refers To**: AccountAccountRelation ### StartDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date when the relationship starts. ## 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. - [AccountAccountRelationChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_change_event.htm): Change events are available for the object. - [AccountAccountRelationFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_feed.htm): Feed tracking is available for the object. - [AccountAccountRelationHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_history.htm): History is available for tracked fields of the object. - [AccountAccountRelationOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_ownersharingrule.htm): Sharing rules are available for the object. - [AccountAccountRelationShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_share.htm): Sharing is available for the object. # Action Launcher in Automotive Cloud Add actions in the Action Launcher Lightning web component so that your users can search for and launch an action easily. The Action Launcher can be used on record pages like Vehicle, Asset, or Account, and in the Service Console for Automotive app. For more information about the developer resources of Action Launcher, see [Action Launcher](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/action_launcher.htm). # Action Plans in Automotive Cloud Use the Action Plans data model to capture commonly repeated tasks and metrics for partner visits. You can also use action plans for vehicles, asset milestones, and asset account and contact participants.
Available in: Enterprise, Unlimited, and Developer Editions.
For more information about the objects in the Action Plans data model, refer to these resources. - [ActionPlan](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_actionplan.htm) - [ActionPlanItem](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_actionplanitem.htm) - [ActionPlanTemplate](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_actionplantemplate.htm) - [ActionPlanTemplateItem](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_actionplantemplateitem.htm) - [ActionPlanTemplateItemValue](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_actionplantemplateitemvalue.htm) - [ActionPlanTemplateVersion](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_actionplantemplateversion.htm) # Action Response Output representation of the action response of an inbound event. ## Sample Response { "actionResponse": \[ { "actionName": "CreateUpdateAction", "actionOutput": { "objectName": "Account", "operationType": "Create", "recordId": "001xx000003gb9Naac" } }, { "actionName": "CreateUpdateAction", "actionOutput": { "objectName": "Account", "operationType": "Update", "recordId": "001xx000003gb9Naac" } } \] } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | action​Name | String | Action name of the inbound event. | Small, 60.0 | 60.0 | | action​Output | Map | Action output of the inbound event. | Small, 60.0 | 60.0 | # Actionable Segmentation in Automotive Cloud The Actionable Segmentation data model helps segment similar client profiles and curate them to design timely and personalized client outreach programs. Enable list creators to set up and assign actionable lists to sales agents or service agents. Help your sales or service agents get the most out of their prospect engagements with Outreach List in the split view. The agents can then engage with and build trusted relationships with the prospects. For more information about the developer resources, see [Actionable List Members](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/actionable_list_members.htm), [Actionable Segmentation](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/actionable_segmentation_objects.htm), and [Outreach List](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/outreach_list.htm). # ActionableEventOrchDef Represents the definition of an actionable event orchestration so that the records can be migrated from one org to another. ## Parent Type This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm "HTML (New Window)") metadata type and inherits its fullName field. ## File Suffix and Directory Location ActionableEventOrchDef components have the suffix .actionableEventOrchDef and are stored in the ActionableEventOrchDef folder. ## Version ActionableEventOrchDef components are available in API version 64.0 and later. ## Fields ### actionableEventUsageType - **Field Type**: string - **Description**: The usage type of the actionable event orchestration definition. - **Possible values**: - Automotive—1 - Manufacturing—2 - Standard—3 ### apiName - **Field Type**: string - **Description**: Required. The API name of the actionable event orchestration definition record. ### contextDefinitionDeveloperName - **Field Type**: string - **Description**: The developer name of a context definition that's associated with the actionable event orchestration definition. ### contextMappingTitle - **Field Type**: string - **Description**: The title of a context mapping that's associated with the actionable event orchestration definition. ### eventCategory - **Field Type**: string - **Description**: The category of an actionable event orchestration definition. ### eventSubtypeApiName - **Field Type**: string - **Description**: The API name of an actionable event orchestration definition subtype. ### eventTypeApiName - **Field Type**: string - **Description**: Required. The API name of an actionable event orchestration definition type. ### executionProcedureAPIName - **Field Type**: string - **Description**: The API name of the flow definition or the expression set template that executes the orchestration. ### executionProcedureType - **Field Type**: string - **Description**: Specifies the type of automated procedure that executes the orchestration. - **Possible values**: - ExpressionSetBasedOrchestration—1 - FlowBasedOrchestration—2 ### isActive - **Field Type**: boolean - **Description**: Required. Specifies if an actionable event orchestration definition record is active (true) or not (false). - **Default value**: false ### isTemplate - **Field Type**: boolean - **Description**: Required. Indicates whether the actionable event orchestration definition is a template (true) or not (false). - **Default value**: false ### label - **Field Type**: string - **Description**: Required. The label of the actionable event orchestration definition record. ## Declarative Metadata Sample Definition The following is an example of an ActionableEventOrchDef component. 1 Create\_Asset\_Registration AssetRegistrationCreateRecordDetails\_stdctx VehicleFaultEventDetailMapping Create\_Registration\_Records\_SubType Create\_Registration\_Records CreateAssetFlow 2 true Create Asset Registration The following is an example package.xml that references the previous definition. \* ActionableEventOrchDef 64.0 ## Wildcard Support in the Manifest File This metadata type supports the wildcard character \* (asterisk) in the package.xml manifest file. For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm "HTML (New Window)"). # ActionableEventOrchestration Represents the details of an actionable event and specifies how to orchestrate the processes. The record stores details such as the event type, subtype, and category, and the expression set and the context mappings related to an orchestration. This object is available in API version 63.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update(), upsert() ## Fields ### ApiName - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort - **Description**: The API name of an actionable event orchestration record. ### ContextDefinitionId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The context definition related to the expression set that processes an actionable event. This field is a relationship field. - **Relationship Name**: ContextDefinition - **Refers To**: ContextDefinition ### ContextDefinitionName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of a context definition that's associated with the actionable event orchestration. ### ContextMappingId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The context mapping that processes an actionable event. This field is a relationship field. - **Relationship Name**: ContextMapping - **Refers To**: ContextMapping ### ContextMappingName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of a context mapping in the context definition that's associated with the actionable event orchestration. ### DefinitionId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort, Update - **Description**: The unique identifier of the actionable event orchestration's definition. This field is a relationship field. - **Relationship Name**: Definition - **Refers To**: ActionableEventOrchDef ### EventCategory - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The category of an actionable event. ### EventSubtypeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The subtype of an actionable event. This field is a relationship field. - **Relationship Name**: EventSubtype - **Refers To**: ActionableEventSubtype ### EventTypeId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The type of an actionable event. This field is a relationship field. - **Relationship Name**: EventType - **Refers To**: ActionableEventType ### ExecutionProcedureId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The expression set or flow definition that executes the orchestration. This field is a relationship field. - **Relationship Name**: ExecutionProcedure - **Refers To**: ExpressionSet ### ExecutionProcedureName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the flow definition or the expression set template that executes the orchestration. ### ExecutionProcedureType - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the type of automated procedure that executes the orchestration. Possible values are: - Expression Set-Based - Flow-Based ### IsActive - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Specifies if an actionable event orchestration record is active (true) or not (false). The default value is false. ### IsInstalledTemplate - **Type**: boolean - **Properties**: Defaulted on create, Filter, Group, Sort - **Description**: Indicates whether the actionable event orchestration is an installed template that can't be modified (true) or not (false). The default value is false. ### IsTemplate - **Type**: boolean - **Properties**: Defaulted on create, Filter, Group, Sort - **Description**: Indicates whether the actionable event orchestration is a template (true) or not (false). The default value is false. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date the associated location was last modified. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date the associated location was last viewed. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of an actionable event orchestration record. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The owner ID of an actionable event orchestration record. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### UsageType - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: The usage type of the event orchestration. Possible values are: - Standard ## 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. - [ActionableEventOrchestrationChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_change_event.htm): Change events are available for the object. - [ActionableEventOrchestrationFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_feed.htm): Feed tracking is available for the object. - [ActionableEventOrchestrationHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_history.htm): History is available for tracked fields of the object. - [ActionableEventOrchestrationOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_ownersharingrule.htm): Sharing rules are available for the object. - [ActionableEventOrchestrationShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_share.htm): Sharing is available for the object. # ActionableEventSubtype Represents the subtype of an external or internal event that's processed by the Actionable Event Orchestration framework to trigger different types of actions. This object is available in API version 62.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### ActionableEventTypeId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The parent event type related to an actionable event subtype. This field is a relationship field. - **Relationship Name**: ActionableEventType - **Relationship Type**: Master-detail - **Refers To**: ActionableEventType (the master object) ### ApiName - **Type**: string - **Properties**: Create, Filter, Group, Sort - **Description**: The API name of an actionable event sub type. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date the associated location was last modified. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date the associated location was last viewed. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of an event subtype that represents a specific external or internal actionable event. ## 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. - [ActionableEventSubtypeChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_change_event.htm): Change events are available for the object. - [ActionableEventSubtypeFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_feed.htm): Feed tracking is available for the object. - [ActionableEventSubtypeHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_history.htm): History is available for tracked fields of the object. # ActionableEventType Represents the type of an external or internal event that's processed by the Actionable Event Orchestration framework to trigger different types of actions. This object is available in API version 62.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update(), upsert() ## Fields ### ApiName - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort - **Description**: The API name of an actionable event type. ### DefinitionId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort, Update - **Description**: The unique identifier of the actionable event type's definition. This field is a relationship field. - **Relationship Name**: Definition - **Refers To**: ActionableEventTypeDef ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date the associated location was last modified. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date the associated location was last viewed. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of an event type that represents a specific external or internal actionable event type. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The owner ID of an event type that represents a specific external or internal actionable event type. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ## 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. - [ActionableEventTypeChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_change_event.htm): Change events are available for the object. - [ActionableEventTypeFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_feed.htm): Feed tracking is available for the object. - [ActionableEventTypeHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_history.htm): History is available for tracked fields of the object. - [ActionableEventTypeOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_ownersharingrule.htm): Sharing rules are available for the object. - [ActionableEventTypeShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_share.htm): Sharing is available for the object. # ActionableEventTypeDef Represents the definition of an actionable event type so that the records can be migrated from one org to another. ## Parent Type This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm "HTML (New Window)") metadata type and inherits its fullName field. ## File Suffix and Directory Location ActionableEventTypeDef components have the suffix .ActionableEventTypeDef and are stored in the ActionableEventTypeDef folder. ## Version ActionableEventTypeDef components are available in API version 64.0 and later. ## Fields ### apiName - **Field Type**: string - **Description**: Required. The API name of an actionable event type definiton. ### eventSubtypes - **Field Type**: [EventSubtype\[\]](#auto_metadata_api_actionableeventtypedef_eventsubtype) - **Description**: The subtype of an actionable event. ### label - **Field Type**: string - **Description**: Required. Label of the actionable event type definition. ## EventSubtype Represents the subtype of an external or internal event that's processed by the Actionable Event Orchestration framework to trigger different types of actions. ### apiName - **Field Type**: string - **Description**: Required. The API name of an actionable event subtype. ### label - **Field Type**: string - **Description**: Required. Label of the event subtype that represents a specific kind of external or internal actionable event. ## Declarative Metadata Sample Definition The following is an example of an ActionableEventTypeDef component. Create\_Registration\_Records Create\_Registration\_Records\_SubType reate Registration Records Subtype Create Registration Records The following is an example package.xml that references the previous definition. \* ActionableEventTypeDef 64.0 ## Wildcard Support in the Manifest File This metadata type supports the wildcard character \* (asterisk) in the package.xml manifest file. For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm "HTML (New Window)"). # ActionableEventTypeDef Represents the definition of an actionable event type so that the records can be migrated from one org to another. This object is available in API version 62.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Fields ### DeveloperName - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The developer name of the actionable event type definition. ### FullName - **Type**: string - **Properties**: Group, Nillable - **Description**: The name of the actionable event type definition. Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance. ### Language - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The language in which this actionable event type definition is created. Possible values are: - af—Afrikaans - am—Amharic - ar—Arabic - ar\_AE—Arabic (United Arab Emirates) - ar\_BH—Arabic (Bahrain) - ar\_DZ—Arabic (Algeria) - ar\_EG—Arabic (Egypt) - ar\_IQ—Arabic (Iraq) - ar\_JO—Arabic (Jordan) - ar\_KW—Arabic (Kuwait) - ar\_LB—Arabic (Lebanon) - ar\_LY—Arabic (Libya) - ar\_MA—Arabic (Morocco) - ar\_OM—Arabic (Oman) - ar\_QA—Arabic (Qatar) - ar\_SA—Arabic (Saudi Arabia) - ar\_SD—Arabic (Sudan) - ar\_SY—Arabic (Syria) - ar\_TN—Arabic (Tunisia) - ar\_YE—Arabic (Yemen) - bg—Bulgarian - bn—Bengali - bs—Bosnian - ca—Catalan - cac—Chuj - cak—Kaqchikel - cs—Czech - cy—Welsh - da—Danish - de—German - de\_AT—German (Austria) - de\_BE—German (Belgium) - de\_CH—German (Switzerland) - de\_LU—German (Luxembourg) - el—Greek - el\_CY—Greek (Cyprus) - en\_AE—English (United Arab Emirates) - en\_AU—English (Australian) - en\_BE—English (Belgium) - en\_CA—English (Canadian) - en\_CY—English (Cyprus) - en\_DE—English (Germany) - en\_GB—English (UK) - en\_HK—English (Hong Kong) - en\_IE—English (Ireland) - en\_IL—English (Israel) - en\_IN—English (Indian) - en\_IT—English (Italy) - en\_MT—English (Malta) - en\_MY—English (Malaysian) - en\_NL—English (Netherlands) - en\_NZ—English (New Zealand) - en\_PH—English (Phillipines) - en\_SG—English (Singapore) - en\_US—English - en\_ZA—English (South Africa) - es—Spanish - es\_AR—Spanish (Argentina) - es\_BO—Spanish (Bolivia) - es\_CL—Spanish (Chile) - es\_CO—Spanish (Colombia) - es\_CR—Spanish (Costa Rica) - es\_DO—Spanish (Dominican Republic) - es\_EC—Spanish (Ecuador) - es\_GT—Spanish (Guatemala) - es\_HN—Spanish (Honduras) - es\_MX—Spanish (Mexico) - es\_NI—Spanish (Nicaragua) - es\_PA—Spanish (Panama) - es\_PE—Spanish (Peru) - es\_PR—Spanish (Puerto Rico) - es\_PY—Spanish (Paraguay) - es\_SV—Spanish (El Salvador) - es\_US—Spanish (United States) - es\_UY—Spanish (Uruguay) - es\_VE—Spanish (Venezuela) - et—Estonian - eu—Basque - fa—Farsi - fi—Finnish - fr—French - fr\_BE—French (Belgium) - fr\_CA—French (Canadian) - fr\_CH—French (Switzerland) - fr\_LU—French (Luxembourg) - fr\_MA—French (Morocco) - ga—Irish - gu—Gujarati - haw—Hawaiian - hi—Hindi - hmn—Hmong - hr—Croatian - ht—Haitian Creole - hu—Hungarian - hy—Armenian - in—Indonesian - is—Icelandic - it—Italian - it\_CH—Italian (Switzerland) - iw—Hebrew - ja—Japanese - ji—Yiddish - ka—Georgian - kk—Kazakh - kl—Greenlandic - km—Khmer - kn—Kannada - ko—Korean - lb—Luxembourgish - lt—Lithuanian - lv—Latvian - mi—Te reo - mk—Macedonian - ml—Malayalam - mr—Marathi - ms—Malay - mt—Maltese - my—Burmese - nl\_BE—Dutch (Belgium) - nl\_NL—Dutch - no—Norwegian - pa—Punjabi - pl—Polish - pt\_BR—Portuguese (Brazil) - pt\_PT—Portuguese (European) - quc—Kiche - rm—Romansh - ro—Romanian - ro\_MD—Romanian (Moldova) - ru—Russian - ru\_AM—Russian (Armenia) - ru\_BY—Russian (Belarus) - ru\_KG—Russian (Kyrgyzstan) - ru\_KZ—Russian (Kazakhstan) - ru\_LT—Russian (Lithuania) - ru\_MD—Russian (Moldova) - ru\_PL—Russian (Poland) - ru\_UA—Russian (Ukraine) - sh—Serbian (Latin) - sh\_ME—Montenegrin - sk—Slovak - sl—Slovene - sm—Samoan - sq—Albanian - sr—Serbian (Cyrillic) - sv—Swedish - sw—Swahili - ta—Tamil - te—Telugu - th—Thai - tl—Tagalog - tr—Turkish - uk—Ukrainian - ur—Urdu - vi—Vietnamese - xh—Xhosa - zh\_CN—Chinese (Simplified) - zh\_HK—Chinese (Hong Kong) - zh\_MY—Chinese (Malaysia) - zh\_SG—Chinese (Singapore) - zh\_TW—Chinese (Traditional) - zu—Zulu ### MasterLabel - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Label of the actionable event type definition. ### NamespacePrefix - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: The namespace prefix associated with this object. Each Developer Edition organization that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix\_\_componentName notation. The namespace prefix can have one of the following values: - In Developer Edition organizations, the namespace prefix is set to the namespace prefix of the organization for all objects that support it. There’s an exception if an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition organization of the package developer. - In organizations that aren’t Developer Edition organizations, NamespacePrefix is only set for objects that are part of an installed managed package. There’s no namespace prefix for all other objects. # ActionableOrchResponseEvent Represents information about an internal or external event after actions are taken by the orchestration process and the response is recorded. This object is available in API version 62.0 and later. ## Supported Calls describeSObjects() ## Fields ### ActionableOrchSourceEvent - **Type**: string - **Description**: The actionable source event related to the response event. ### ErrorInformation - **Type**: textarea - **Properties**: Nillable - **Description**: The error codes and error messages related to an actionable event that failed to be processed. ### EventUuid - **Type**: string - **Properties**: Nillable - **Description**: A universal unique identifier (UUID) that identifies a platform event message. This field is available in API version 62.0 and later. ### ExecutedAction - **Type**: textarea - **Properties**: Nillable - **Description**: The details about the action taken for an actionable event as executed by the actionable event orchestration framework. ### ProcessingStatus - **Type**: picklist - **Properties**: Restricted picklist - **Description**: Specifies the processing status of the actionable event for which the response is published. Possible values are: Failure, or Success. ### ReplayId - **Type**: string - **Properties**: Nillable - **Description**: Represents an ID value that is populated by the system and refers to the position of the event in the event stream. Replay ID values aren’t guaranteed to be contiguous for consecutive events. A subscriber can store a replay ID value and use it on resubscription to retrieve missed events that are within the retention window. ### SourceSystemIdentifier - **Type**: string - **Properties**: Nillable - **Description**: The unique identifier of the event in the source system where the actionable event originated. # ActionableOrchSourceEvent Represents information about an event on which actions are taken by the orchestration process. This object is available in API version 62.0 and later. ## Supported Calls create(), describeSObjects() ## Fields ### AdditionalCriteria - **Type**: textarea - **Properties**: Create, Nillable - **Description**: The additional criteria that customers want to share about an actionable event. ### Category - **Type**: string - **Properties**: Create, Nillable - **Description**: The category of the actionable event. ### EventData - **Type**: textarea - **Properties**: Create, Nillable - **Description**: The data about an actionable event, such as the faults, signals, or other input details. ### EventUuid - **Type**: string - **Properties**: Nillable - **Description**: A universal unique identifier (UUID) that identifies a platform event message. This field is available in API version 62.0 and later. ### ReplayId - **Type**: string - **Properties**: Nillable - **Description**: Represents an ID value that is populated by the system and refers to the position of the event in the event stream. Replay ID values aren’t guaranteed to be contiguous for consecutive events. A subscriber can store a replay ID value and use it on resubscription to retrieve missed events that are within the retention window. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Nillable - **Description**: The unique identifier of an event in the source system where the event originates. ### Subtype - **Type**: string - **Properties**: Create, Nillable - **Description**: The subtype of the actionable event. ### Type - **Type**: string - **Properties**: Create - **Description**: The type of the actionable event. # Additional Criteria Input Input representation of the additional event criteria generated during inbound events. ## JSON Example { "additionalEventCriteria": { "fieldList": \[ { "field": "priority\_\_c", "value": "high" } \] } } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | fieldList | [Field Match\[\]](connect_requests_field_list.htm "Input representation of a field match that contains the field name and value.") | List of field matches during incoming events. | Optional | 60.0 | # Advanced Orders for Telesales in Automotive Cloud Build and place telesales orders based on product assortments, the product catalog, and previously ordered products, with valid delivery dates and instant pricing for order line items. For more information about Advanced Orders for Telesales, see the [Advanced Orders for Telesales Developer Guide](https://developer.salesforce.com/docs/industries/advanced-orders-for-telesales/overview). # Appraisal Represents the appraisal for one or more items. This object is available in API version 63.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules Automotive and Appraisal Management must be enabled. ## Fields ### AppraisedById - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The contact or the user who performs an appraisal. This field is a polymorphic relationship field. - **Relationship Name**: AppraisedBy - **Refers To**: Contact, User ### Comment - **Type**: textarea - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The dealer or customer provides a comment for the appraisal, such as instructions or context. ### Fee - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The fee for the appraisal. ### FinalAppraisalValue - **Type**: currency - **Properties**: Filter, Nillable, Sort - **Description**: The final appraisal value that sums up the total item final value and the total adjustment value of an appraisal. This field is a calculated field. ### InitiatedById - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The account, contact, or user who initiates an appraisal. This field is a polymorphic relationship field. - **Relationship Name**: InitiatedBy - **Refers To**: Account, Contact, User ### IsActive - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the appraisal is active (true) or not (false). The default value is false. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The owner of the appraisal record. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### PurposeType - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the purpose of the appraisal, such as sales, trade-in, or valuation of an asset. Possible values are: Sale, or Trade-In. ### ReferenceRecordId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The record of an object, such as lead, account, opportunity, or application form product that serves as the context for the appraisal. This field is a polymorphic relationship field. - **Relationship Name**: ReferenceRecord - **Refers To**: Account, Case, Lead, Opportunity ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the status of the appraisal. ### TotalAdjustmentValue - **Type**: currency - **Properties**: Filter, Nillable, Sort - **Description**: The cumulative value based on all appraisal adjustments that refer to an appraisal. This field is a calculated field. ### TotalItemFinalValue - **Type**: currency - **Properties**: Filter, Nillable, Sort - **Description**: The cumulative value based on all the final values of all items related to the appraisal. This field is a calculated field. ### UsageType - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: The usage type of the appraisal. Possible values are: - Automotive ### ValidityEndDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date until which the appraisal is valid. ## 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. - [AppraisalChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_change_event.htm): Change events are available for the object. - [AppraisalHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_history.htm): History is available for tracked fields of the object. # AppraisalAdjustment Represents an adjustment for the appraisal or an appraisal item. This object is available in API version 63.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AdjustedById - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The contact or the user that performs the adjustment. This field is a polymorphic relationship field. - **Relationship Name**: AdjustedBy - **Refers To**: Contact, User ### AdjustmentValue - **Type**: currency - **Properties**: Create, Filter, Sort, Update - **Description**: The positive or negative value of the appraisal adjustment. ### AppraisalId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The appraisal record for which an adjustment is made. This field is a relationship field. - **Relationship Name**: Appraisal - **Relationship Type**: Master-detail - **Refers To**: Appraisal (the master object) ### AppraisalItemId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The appraisal item record for which an adjustment is made This field is a relationship field. - **Relationship Name**: AppraisalItem - **Refers To**: AppraisalItem ### Description - **Type**: textarea - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The description of the appraisal adjustment. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp indicating the last time the current user viewed a related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp indicating when the current user last viewed this record. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the appraisal adjustment. ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the status of the adjustment. Default values are: - Approved - InReview—Under Review - Rejected ### Type - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the type of the appraisal adjustment. Possible values are: Negative, or Positive. ## 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. - [AppraisalAdjustmentChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_change_event.htm): Change events are available for the object. # AppraisalItem Represents an item that is appraised, such as a vehicle or an asset. This object is available in API version 63.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### Address - **Type**: address - **Properties**: Filter, Nillable - **Description**: The address of the appraisal item. ### AppraisalId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The appraisal associated with the appraisal item. This field is a relationship field. - **Relationship Name**: Appraisal - **Relationship Type**: Master-detail - **Refers To**: Appraisal (the master object) ### AppraisedById - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The contact or the user that appraises the item. This field is a polymorphic relationship field. - **Relationship Name**: AppraisedBy - **Refers To**: Contact, User ### City - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the city where the item that is appraised. ### ConditionType - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the condition of the item that is appraised. Possible values are: Best, Better, or Good. ### Country - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specified the country where the item is appraised. ### CustomerAskingValue - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The value of the item proposed by the customer for the appraisal. ### ExteriorColor - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The exterior color of the item that is appraised. Possible values are: Black, or Blue. ### FinalValue - **Type**: currency - **Properties**: Filter, Nillable, Sort - **Description**: The final value of the appraisal item. This field is a calculated field. ### GeocodeAccuracy - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies how precise the location data is. Possible values are: - Address - Block - City - County - ExtendedZip—Extended Zip - NearAddress—Near Address - Neighborhood - State - Street - Unknown - Zip ### IdentificationNumber - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The identification number of the item that is appraised. ### InitialValue - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The preliminary value for the appraisal based on provider estimates. ### InstallDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date that the item is installed. ### IsAddOnIncluded - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the item includes an add on (true) or not (false). The default value is false. ### IsCustomized - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the item is customized (true) or not (false). The default value is false. ### IsHandoverComplete - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the handover is complete for the appraisal item (true) or not (false). The default value is false. ### 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. ### Latitude - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The latitude of the region where the item is appraised. ### LicensePlateNumber - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The license plate number of the vehicle that is appraised. ### Longitude - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The longitude of the region where the item is appraised. ### MakeName - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the make name of the item that is appraised. Possible values are: Make 1, Make 2, Make 3, or Maruti. ### ManufacturedDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date that the item is manufactured. ### ModelName - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the model of the item that is appraised. Possible values are: - Maruti Baleno - Model 1 - Model 2 - Model 3 - Model 4 - Model 5 ### ModelYear - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the year when the model of the item is first launched. Possible values are: 2023, 2024, or 2025. ### OwnershipType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the type of ownership of the item. Possible values are: Joint, or Primary. ### PostalCode - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the postal code where the item is appraised. ### PurchaseDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date that the item is purchased. ### ReferenceRecordId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The existing record of the item related to the appraisal as referenced in the application, such as an Asset or Vehicle record with a serial number or a vehicle identification number. This field is a polymorphic relationship field. - **Relationship Name**: ReferenceRecord - **Refers To**: Asset, Vehicle ### RegistrationState - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The state where the item that is appraised is registered. Possible values are: - Telangana ### RegistrationZipCode - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ZIP code of the item that is appraised. ### State - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The state of the item that is appraised. ### StateCode - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The state code of the item that is appraised. Possible values are: - TG—Telangana ### Street - **Type**: textarea - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The street of the item that is appraised. ### TotalAdjustmentValue - **Type**: currency - **Properties**: Filter, Nillable, Sort - **Description**: The cumulative value based on all appraisal adjustments that refer to this appraisal item. ### Trim - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The trim levels supported by the item that is appraised. Possible values are: - Baleno Alpha - Baleno Delta - Trim 1 - Trim 2 - Trim 3 - Trim 4 - Trim 5 - Trim 6 - Trim 7 - Trim 8 - Trim 9 ### Type - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the type of item that forms the basis for the appraisal. Possible values are: Asset, or Vehicle. ### Usage - **Type**: double - **Properties**: Create, Filter, Sort, Update - **Description**: The usage of the item that is appraised. ### UsageUnitOfMeasureId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unit of measure for the usage. This field is a relationship field. - **Relationship Name**: UsageUnitOfMeasure - **Refers To**: UnitOfMeasure ### WarrantyEndDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The end date of the warranty of the item that is appraised. ## 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. - [AppraisalItemChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_change_event.htm): Change events are available for the object. # AppraisalItemAddOn Represents an add-on product, such as an accessory, that enhances or complements the appraised item. This object is available in API version 63.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AppraisalItemId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The appraisal item that's associated with the appraisal item add-on. This field is a relationship field. - **Relationship Name**: AppraisalItem - **Relationship Type**: Master-detail - **Refers To**: AppraisalItem (the master object) ### 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. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the appraisal item add-on. ### Type - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the type of the appraisal item add-on. Possible values are: Advanced Dashboard, Infortainment, or Premium Leather. ### UnitPrice - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The unit price of the appraisal item add-on. ## 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. - [AppraisalItemAddOnChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_change_event.htm): Change events are available for the object. # AppraisalItemProviderVal Represents a valuation of the item that is appraised. This object is available in API version 63.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AppraisalItemId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The appraisal item that's associated with the appraisal source valuation. This field is a relationship field. - **Relationship Name**: AppraisalItem - **Relationship Type**: Master-detail - **Refers To**: AppraisalItem (the master object) ### AverageConditionValue - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The value of the item if it's average condition. ### CleanConditionValue - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The value of the item if it's in clean condition. ### 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. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The autopopulated name of Appraisal Item Provider Valuation record. ### ProviderName - **Type**: picklist - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The name of the provider that gives the valuation of the item. ### RoughConditionValue - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The value of the item if it's in rough condition. ### ValuationDateTime - **Type**: dateTime - **Properties**: Create, Filter, Sort, Update - **Description**: The date and time when the source gives the valuation of the item. ## 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. - [AppraisalItemProviderValChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_change_event.htm): Change events are available for the object. # AssessmentIndicatorDefinition Define parameters or metrics that act as markers of compliance for partner visit tasks. This object is available in Automotive Cloud in API version 56.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### DataType - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort - **Description**: Type of data the assessment indicator definition can hold. Possible values are: The default value is Number. - Boolean - DateTime—Date Time - Decimal - Number - Percentage - String—Text ### Description - **Type**: textarea - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Description of the assessment indicator definition. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user referenced this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user viewed this record. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the assessment indicator definition that indicates the metric used during a task. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: ID of the assessment indicator definition record owner. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ## 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. - [AssessmentIndicatorDefinitionFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_feed.htm): Feed tracking is available for the object. - [AssessmentIndicatorDefinitionHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_history.htm): History is available for tracked fields of the object. - [AssessmentIndicatorDefinitionOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_ownersharingrule.htm): Sharing rules are available for the object. - [AssessmentIndicatorDefinitionShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_share.htm): Sharing is available for the object. # AssetAccountParticipant Represents a junction between the Asset and Account objects describing the association between a participating account and an asset. This object is available in API version 56.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AccountId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The stakeholder account associated with the asset. This field is a relationship field. - **Relationship Name**: Account - **Relationship Type**: Lookup - **Refers To**: Account ### AssetId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The asset associated with the account. This field is a relationship field. - **Relationship Name**: Asset - **Relationship Type**: Lookup - **Refers To**: Asset ### EffectiveEndDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date when the association between the stakeholder and the vehicle ended. ### EffectiveStartDate - **Type**: date - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The date when the association between the stakeholder and the vehicle was initiated. ### IsActive - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the association between the stakeholder and the vehicle is active (true) or not (false). - **Default value**: false ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user referenced this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user viewed this record. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the asset account participant. ### RecordTypeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The record type associated with the asset account participant. This field is a relationship field. - **Relationship Name**: RecordType - **Relationship Type**: Lookup - **Refers To**: RecordType ### StakeholderRole - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the role of the associated account. Possible values are: - Customer-Preferred Dealer - Nominated Dealer - Closest Dealer - Sales Dealer - Service Dealer - Customer - Driver - Financier - Owner ### UsageType - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the usage type of the asset account participant. Possible values are: - Automotive - FieldServiceLightning—Field Service Lightning ### VehicleId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The vehicle that's marked as an asset. This field is a relationship field. - **Relationship Name**: Vehicle - **Relationship Type**: Lookup - **Refers To**: Vehicle ## 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. - [AssetAccountParticipantChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_change_event.htm): Change events are available for the object. - [AssetAccountParticipantFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_feed.htm): Feed tracking is available for the object. - [AssetAccountParticipantHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_history.htm): History is available for tracked fields of the object. # AssetContactParticipant Represents a junction between the Asset and Contact objects describing the association between a participating contact and an asset. This object is available in API version 56.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AssetId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The asset associated with the contact. This field is a relationship field. - **Relationship Name**: Asset - **Relationship Type**: Lookup - **Refers To**: Asset ### ContactId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The contact associated with the asset. This field is a relationship field. - **Relationship Name**: Contact - **Relationship Type**: Lookup - **Refers To**: Contact ### EffectiveEndDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date when the association between the stakeholder and the vehicle ended. ### EffectiveStartDate - **Type**: date - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The date when the association between the stakeholder and the vehicle was initiated. ### IsActive - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the association between the stakeholder and the vehicle is active (true) or not (false). - **Default value**: false ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user referenced this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user viewed this record. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the asset contact participant. ### StakeholderRole - **Type**: picklist - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Specifies the role of the associated contact. ### UsageType - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the usage type of the asset contact participant. Possible values are: - Automotive - FieldServiceLightning—Field Service Lightning ### VehicleId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The vehicle that's marked as an asset. This field is a relationship field. - **Relationship Name**: Vehicle - **Relationship Type**: Lookup - **Refers To**: Vehicle ## 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. - [AssetContactParticipantChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_change_event.htm): Change events are available for the object. - [AssetContactParticipantFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_feed.htm): Feed tracking is available for the object. - [AssetContactParticipantHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_history.htm): History is available for tracked fields of the object. # AssetLocation Represents a sighting or location update that records where an asset was last seen or detected. This object is available in API version 68.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### Address - **Type**: address - **Properties**: Create, Nillable, Update - **Description**: The street address where the asset was last seen or detected. ### AssetId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The asset being tracked for a specific sighting or location update. This field is a relationship field. - **Relationship Name**: Asset - **Relationship Type**: Lookup - **Refers To**: Asset ### CapturedLicensePlateNumber - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The license plate number captured during the sighting, used to confirm the asset's identity. ### Comments - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Additional notes or observations recorded for the sighting, such as the asset's surroundings and condition. ### ConfidenceScore - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: A score from 1 to 100 indicating the system's confidence that the sighted asset matches the target asset. ### GeoLocation - **Type**: location - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The latitude and longitude coordinates captured for the asset at the time of the sighting. ### LocationCategory - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The category of the location where the asset is located, such as a storage yard or a dealership. Possible values are: - Residence - Workplace - Storage Yard - Auction Yard - Dealership - Impound Lot - Public Street - Unknown ### LocationId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The location of the asset, such as a warehouse. This field is a relationship field. - **Relationship Name**: Location - **Relationship Type**: Lookup - **Refers To**: Location ### LocationStatus - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The status of the location associated with the asset. Possible values are: Current, Historical, or Pending Verification. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: An auto-generated unique identifier used to track a specific sighting or location update for the asset. ### RepossessionItemId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The repossession item associated with the asset location tracking record. This field is a relationship field. - **Relationship Name**: RepossessionItem - **Relationship Type**: Lookup - **Refers To**: RepossessionItem ### Source - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The origin of the location data, such as a license plate reader, a field agent, or a GPS ping. Possible values are: LPR (License Plate Reader), Field Sight, or Telematics. ### Timestamp - **Type**: dateTime - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The timestamp at which the sighting was recorded or the asset's location was updated. # AssetMilestone Represents the key events in the lifecycle of a vehicle asset, such as manufacturing, registration, or resale. This object is available in API version 56.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### Address - **Type**: address - **Properties**: Filter, Nillable - **Description**: The address associated with the milestone. ### AssetId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The asset record that's associated with the milestone. This field is a relationship field. - **Relationship Name**: Asset - **Relationship Type**: Lookup - **Refers To**: Asset ### City - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The city where the milestone occurred. ### Country - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The country where the milestone occurred. ### Description - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The description of the milestone. ### ExpiredDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The expiration date of the milestone. ### 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 milestone location’s latitude and longitude coordinates. Possible values are: - Address - Block - City - County - ExtendedZip - NearAddress - Neighborhood - State - Street - Unknown - Zip ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user referenced this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user viewed this record. ### Latitude - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Used with Longitude to specify the precise geolocation of the milestone location. Acceptable values are numbers between –90 and 90 with up to 15 decimal places. ### LocationId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The location associated with the milestone. This field is a relationship field. - **Relationship Name**: Location - **Relationship Type**: Lookup - **Refers To**: Location ### Longitude - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Used with Latitude to specify the precise geolocation of the milestone location. Acceptable values are numbers between –180 and 180 with up to 15 decimal places. ### MilestoneDate - **Type**: date - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The date on which the milestone occurred. ### MilestoneType - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the type of milestone. Possible values are: - 10 Years Service - Critical Recall - Delivered - Manufactured - Order Received - Sold ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the asset milestone. ### PostalCode - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The postal code of the location where the milestone occurred. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unique identifier of the milestone in the external system. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The external system from where the record was imported. ### Stage - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the stage of the milestone. Possible values are: Active, Expired, or Tentative. ### StageComment - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The comments about the stage of the milestone. For example, the reason for marking the milestone as tentative. ### State - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The state where the milestone occurred. ### Street - **Type**: textarea - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The street where the milestone occurred. ### UsageType - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the usage type of the asset milestone. Possible values are: - Automotive ### VehicleId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The vehicle asset that's associated with the milestone. This field is a relationship field. - **Relationship Name**: Vehicle - **Relationship Type**: Lookup - **Refers To**: Vehicle ## 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. - [AssetMilestoneChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_change_event.htm): Change events are available for the object. - [AssetMilestoneFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_feed.htm): Feed tracking is available for the object. - [AssetMilestoneHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_history.htm): History is available for tracked fields of the object. # AssetTitle Represents information that establishes the legal ownership of an asset or a vehicle. This object is available in API version 60.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AssetId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The Asset associated with the Asset Title record. This field is a relationship field. - **Relationship Name**: Asset - **Relationship Type**: Lookup - **Refers To**: Asset ### EffectiveEndDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date on which the validity of the title ends. ### EffectiveStartDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date on which the title is issued. ### FinancialAccountId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The active Financial Account associated with the asset or vehicle for the Asset Title record. This field is a relationship field. - **Relationship Name**: FinancialAccount - **Relationship Type**: Lookup - **Refers To**: FinancialAccount ### IsActive - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Identifies whether the title is active (true) or not (false). The default value is false. ### IssueFormat - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the format used to issue or transfer the asset title. Possible values are: Electronic, or Paper. ### IssuePlaceId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The place of issue for an asset title. This field is a relationship field. - **Relationship Name**: IssuePlace - **Relationship Type**: Lookup - **Refers To**: GeoState ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date when a user referenced this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date when a user viewed this record. ### LienStatus - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the lien status of the title. Possible values are: Active, None, Release Requested, or Released. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the Asset Title record. ### TitleNumber - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The unique identification number of the title. ### Type - **Type**: picklist - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Specifies the type of condition of the vehicle or asset associated with the title. Possible values are: Clean, Clear, Rebuilt, or Salvaged. ### VehicleId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The vehicle associated with the Asset Title record. This field is a relationship field. - **Relationship Name**: Vehicle - **Relationship Type**: Lookup - **Refers To**: Vehicle ### VehicleIdentificationNumber - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: The vehicle identification number of the vehicle associated with a title. ## 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. - [AssetTitleChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_change_event.htm): Change events are available for the object. - [AssetTitleFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_feed.htm): Feed tracking is available for the object. - [AssetTitleHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_history.htm): History is available for tracked fields of the object. # AssetTitleParty Represents the relationship between an account, a contact, or a user and an asset title. This object is available in API version 60.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### EffectiveEndDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date until when the party is associated with the asset title. ### EffectiveStartDate - **Type**: date - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The date from when the party is associated with the asset title. ### IsActive - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Identifies if the title and party relationship is active (true) or not (false). The default value is false. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date when a user referenced this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date when a user viewed this record. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The autopopulated name of the Asset Title Party record. ### PartyId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The party associated with the asset title. A party can be an account, a user, or a contact. This field is a polymorphic relationship field. - **Relationship Name**: Party - **Relationship Type**: Lookup - **Refers To**: Account, Contact, User ### PartyRole - **Type**: picklist - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Specifies the role of the party associated with the asset title. Possible values are: Co-Owner, Lien Holder, or Owner. ### TitleId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The asset title related to the asset title party. This field is a relationship field. - **Relationship Name**: Title - **Relationship Type**: Lookup - **Refers To**: AssetTitle ## 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. - [AssetTitlePartyChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_change_event.htm): Change events are available for the object. - [AssetTitlePartyFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_feed.htm): Feed tracking is available for the object. - [AssetTitlePartyHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_history.htm): History is available for tracked fields of the object. # AssetWarranty Defines the warranty terms applicable to an asset along with any exclusions and extensions. This object is available in API version 56.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules Automotive and Warranty Lifecycle Management must be enabled. ## Fields ### AssetId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The ID of the asset this asset warranty applies to. This field is a relationship field. - **Relationship Name**: Asset - **Relationship Type**: Lookup - **Refers To**: Asset ### AssetWarrantyNumber - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The identifier of the asset warranty record. ### EndDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date on which this asset warranty expires. ### ExchangeType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The type of exchange offered by this asset warranty. Possible values are: Advance Exchange, Loaner, or Return Exchange. ### Exclusions - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Description of any exclusions. ### ExpensesCovered - **Type**: percent - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The percentage of expenses covered. ### ExpensesCoveredEndDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date on which cover for expenses ends. ### IsTransferable - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the asset warranty can be transferred to a new owner (true) or not (false). The default value is false. ### LaborCovered - **Type**: percent - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The percentage of labor covered. ### LaborCoveredEndDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date on which cover for labor ends. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date when the asset warranty was last modified. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date when the asset warranty was last viewed. ### PartsCovered - **Type**: percent - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The percentage of parts covered. ### PartsCoveredEndDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date on which cover for parts ends. ### Pricebook2Id - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The price book item associated with this asset warranty term. This field is a relationship field. - **Relationship Name**: Pricebook2 - **Relationship Type**: Lookup - **Refers To**: Pricebook2 ### StartDate - **Type**: date - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The date on which cover under this asset warranty starts. ### WarrantyTermId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the warranty term this asset warranty term extends. This field is a relationship field. - **Relationship Name**: WarrantyTerm - **Relationship Type**: Lookup - **Refers To**: WarrantyTerm ### WarrantyType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The type of the asset warranty. Possible values are: Repair, Standard, or Supplier. ## 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. - [AssetWarrantyFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_feed.htm): Feed tracking is available for the object. - [AssetWarrantyHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_history.htm): History is available for tracked fields of the object. # Automotive Cloud Associated Objects This section provides a list of objects associated to standard objects and their standard fields. - **[StandardObjectNameChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/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. # Automotive Cloud Business APIs Automotive Cloud Business APIs are RESTful APIs that are sometimes available as Apex classes and methods.
Available in: Enterprise, Unlimited, and Developer Editions.
- **[REST Reference](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/auto_apis_rest_references.htm)** You can access Automotive Cloud Business APIs using REST endpoints. These REST APIs follow similar conventions as Connect REST APIs. # Automotive Cloud Fields on ApplicationForm Standard fields extend the ApplicationForm object for use in Automotive Cloud to represent high-level information of an application that's submitted for an automotive financial product. #### See Also - [_Object Reference for the Salesforce Platform_: ApplicationForm](https://developer.salesforce.com/docs/atlas.en-us.264.0.financial_services_cloud_object_reference.meta/financial_services_cloud_object_reference/sforce_api_objects_applicationform.htm) ## Fields ### IntakeChannelType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the type of channel through which the application form is received by the system. ### TierType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the tier type of an application form, based on which the offer terms are evaluated. Possible values are: Bronze, Gold, Platinum, or Silver. ### TotalDebtToIncomePercent - **Type**: percent - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The cumulative debt to income percentage for all applicants related to the application form. ### TotalIncomeToExpenseRatio - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The cumulative expense to income ratio for all applicants related to the application form. ### TotalLoanToValuePercent - **Type**: percent - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The cumulative loan to value percentage for all applicants related to the application form. # Automotive Cloud Fields on ApplicationFormProduct Standard fields extend the ApplicationFormProduct object for use in Automotive Cloud to represent the relationship between an application form product and a deviation. #### See Also - [_Object Reference for the Salesforce Platform_: ApplicationFormProduct](https://developer.salesforce.com/docs/atlas.en-us.264.0.financial_services_cloud_object_reference.meta/financial_services_cloud_object_reference/sforce_api_objects_applicationformproduct.htm) ## Fields ### DownPayment - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The downpayment amount an applicant wants to pay for the applicant form product. ### PartnerVisibleStatus - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the status of the application for a product that is submitted by the applicant as visible to a partner, such as a broker or a dealer. Possible values are: - Approved - Awaiting Signature - Contract Generation - Contract in review - Lender Approved - Lender Rejected - Loan Booked - Need More Info - Rejected - Signature Complete - Submitted for review ### RequestedMonthlyPayment - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The monthly payment amount an applicant wants to pay for the applicant form product. ### TotalBrandOwnedItemAmt - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The total value of brand-owned seller items requested for financing. ### TotalVendorOwnedItemAmt - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The total value of vendor-owned seller items requested for financing. # Automotive Cloud Fields on ApplicationFormProductProposal Standard fields extend the ApplicationFormProductProposal object for use in Automotive Cloud to represent the terms attached to a scheme to sanction an automotive loan or lease. #### See Also - [_Object Reference for the Salesforce Platform_: ApplicationFormProductProposal](https://developer.salesforce.com/docs/atlas.en-us.264.0.financial_services_cloud_object_reference.meta/financial_services_cloud_object_reference/sforce_api_objects_applicationformproductproposal.htm) ## Fields ### IsManualReviewRequired - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether manual review is required for the application form product proposal (true) or not (false). The default value is false. ### ProposalGenerationMethod - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the method in which the application form product proposal is generated, such as manual or automatic. Possible values are: Automatic, or Manual. # Automotive Cloud Fields on ApplicationFormSellerItem Standard fields extend the ApplicationFormSellerItem object for use in Automotive Cloud to represent a junction between an application form and an automotive seller product. #### See Also - [_Object Reference for the Salesforce Platform_: ApplicationFormSellerItem](https://developer.salesforce.com/docs/atlas.en-us.264.0.financial_services_cloud_object_reference.meta/financial_services_cloud_object_reference/sforce_api_objects_applicationformselleritem.htm) ## Fields ### AddlProductTermInMonths - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The duration of the term in months for a seller item that's marked as an additional product related to an application form. ### IntendedUse - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the intention or purpose of use for a seller item related to an application form. ### IsAdditionalProduct - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether a seller item related to an application product is an additional product (true), or not (false). The default value is false. ### ItemCondition - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the condition of a seller item related to an application form. # Automotive Cloud Fields on Asset Standard fields extend the Asset object for use in Automotive Cloud to represent information about each physical item that’s manufactured, installed, or sold, such as a vehicle, a part like a car engine, or an accessory like car seat covers. Use the VehicleId field on asset to represent an asset as a vehicle. #### See Also - [_Object Reference for the Salesforce Platform_: Asset](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_asset.htm) ## Fields ### VehicleId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The vehicle associated with the asset. This field is available in API version 56.0 and later. This field is a relationship field. - **Relationship Name**: Vehicle - **Relationship Type**: Lookup - **Refers To**: Vehicle # Automotive Cloud Fields on BusinessProfile Standard fields extend the BusinessProfile object for use in Automotive Cloud to represent information about partner account details. #### See Also - [_Object Reference for the Salesforce Platform_: BusinessProfile](https://developer.salesforce.com/docs/atlas.en-us.264.0.psc_api.meta/psc_api/sforce_api_objects_businessprofile.htm) ## Fields ### BusinessPartnerCode - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unique code that identifies the business partner. This field is available in API version 56.0 and later. ### BusinessPartnerRegisteredName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the business partner that’s registered as the legal name with the authorities. This field is available in API version 56.0 and later. ### BusinessPartnerType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the type of business partner and the role of the partner in relation to a vehicle. This field is available in API version 56.0 and later. Possible values are: - Original Equipment Manufacturer - Sales Dealer - Service Dealer - Customer - Distributor - Financier - Importer - Third-Party Body Shop ### ExternalReferenceNumber - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The ID of the business partner that’s maintained on its source system. This field is unique within your organization. This field is available in API version 56.0 and later. ### RegionName - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the name of the region where the business partner operates from. This field is available in API version 56.0 and later. Possible values are: California, Texas, or Washington. ### ServiceType - **Type**: multipicklist - **Properties**: Create, Filter, Nillable, Restricted picklist, Update - **Description**: Specifies the type of service provided by the business partner. This field is available in API version 56.0 and later. Possible values are: Spare Parts Sales, Sales, Repair & Maintenance, or Consultation. # Automotive Cloud Fields on InternalOrganizationUnit Standard fields extend the InternalOrganizationUnit object for use in Automotive Cloud to represent account structures or departments within a company. This object is available in Automotive Cloud in API version 56.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() #### See Also - [_Object Reference for the Salesforce Platform_: InternalOrganizationUnit](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_internalorganizationunit.htm) ## Fields ### AccountId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The account associated with this record. This field is a relationship field. - **Relationship Name**: Account - **Relationship Type**: Lookup - **Refers To**: Account # Automotive Cloud Fields on Lead Standard fields extend the Lead object for use in Automotive Cloud to represent information about the time frame during which a lead is interested in a transaction. #### See Also - [_Object Reference for the Salesforce Platform_: Lead](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_lead.htm) ## Fields ### EarliestInterestDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The earliest date from which the lead is interested in purchasing or selling the item. This field is available in API version 56.0 and later. ### LatestInterestDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The latest date by which the lead is interested in purchasing or selling the item. This field is available in API version 56.0 and later. # Automotive Cloud Fields on Product2 Standard fields extend the Product2 object for use in Automotive Cloud to represent information about vehicle models, parts, and accessories. #### See Also - [_Object Reference for the Salesforce Platform_: Product2](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_product2.htm?q=Product2) ## Fields ### AvailabilityDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date when the part is used in the vehicle or is made available for sale. This field is available in API version 56.0 and later. ### BusinessBrandId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The brand associated with this vehicle. This field is available in API version 56.0 and later. This field is a relationship field. - **Relationship Name**: BusinessBrand - **Relationship Type**: Lookup - **Refers To**: BusinessBrand ### DiscontinuedDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date from when the part can’t be used in the vehicle or sold. This field is available in API version 56.0 and later. ### HarmonizedSystemCode - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The harmonized system code that’s assigned to the vehicle or a part used in the vehicle. This field is available in API version 56.0 and later. ### HarmonizedTariffSchedCode - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The harmonized tariff schedule code that’s assigned to the vehicle or a part used in the vehicle. This field is available in API version 56.0 and later. ### IsCertified - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the part that’s installed as an accessory in the vehicle is certified (true) or not (false). This field is available in API version 56.0 and later. The default value is false. ### IsEnvrPrtcRegCompliant - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the product is compliant with the environment protection regulations or not. This field is available in API version 56.0 and later. The default value is false. ### MakeName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the make name of the product. This field is available in API version 56.0 and later. ### ManufacturerName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The manufacturer name for the part used in the vehicle. This field is available in API version 56.0 and later. ### ManufacturerPartNumber - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unique number assigned by the manufacturer to identify the part. This field is available in API version 56.0 and later. ### ModelName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the model name of the vehicle. This field is available in API version 56.0 and later. ### ModelYear - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The year when the model of the vehicle was first launched. This field is available in API version 56.0 and later. ### ModelYearVersion - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The specific iteration of a product introduced in a given model year. ### ProductCategoryCode - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The part category associated with the vehicle. This field is available in API version 56.0 and later. ### ProductLineCode - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The vehicle category associated with the part. This field is available in API version 56.0 and later. ### UniversalProductCode - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The universal product code used to track the part used in the vehicle. This field is available in API version 56.0 and later. ### VehicleTrimLevel - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The trim levels supported by the vehicle model. This field is available in API version 56.0 and later. ### VersionName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The version name associated with the vehicle model. This field is available in API version 56.0 and later. # Automotive Cloud Fields on Standard Objects Automotive Cloud adds standard fields to some standard Salesforce objects to represent information specific to vehicles and business partners. These fields are available only in orgs where Automotive Cloud is enabled.
Available in: Enterprise, Unlimited, and Developer Editions.
- **[Automotive Cloud Fields on ApplicationForm](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_applicationform.htm)** Standard fields extend the ApplicationForm object for use in Automotive Cloud to represent high-level information of an application that's submitted for an automotive financial product. - **[Automotive Cloud Fields on ApplicationFormProduct](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_applicationformproduct.htm)** Standard fields extend the ApplicationFormProduct object for use in Automotive Cloud to represent the relationship between an application form product and a deviation. - **[Automotive Cloud Fields on ApplicationFormProductProposal](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_applicationformproductproposal.htm)** Standard fields extend the ApplicationFormProductProposal object for use in Automotive Cloud to represent the terms attached to a scheme to sanction an automotive loan or lease. - **[Automotive Cloud Fields on ApplicationFormSellerItem](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_applicationformselleritem.htm)** Standard fields extend the ApplicationFormSellerItem object for use in Automotive Cloud to represent a junction between an application form and an automotive seller product. - **[Automotive Cloud Fields on Asset](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_asset.htm)** Standard fields extend the Asset object for use in Automotive Cloud to represent information about each physical item that’s manufactured, installed, or sold, such as a vehicle, a part like a car engine, or an accessory like car seat covers. Use the VehicleId field on asset to represent an asset as a vehicle. - **[Automotive Cloud Fields on BusinessProfile](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_businessprofile.htm)** Standard fields extend the BusinessProfile object for use in Automotive Cloud to represent information about partner account details. - **[Automotive Cloud Fields on InternalOrganizationUnit](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_internalorganizationunit.htm)** Standard fields extend the InternalOrganizationUnit object for use in Automotive Cloud to represent account structures or departments within a company. This object is available in Automotive Cloud in API version 56.0 and later. - **[Automotive Cloud Fields on Lead](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_lead.htm)** Standard fields extend the Lead object for use in Automotive Cloud to represent information about the time frame during which a lead is interested in a transaction. - **[Automotive Cloud Fields on Product2](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_product2.htm)** Standard fields extend the Product2 object for use in Automotive Cloud to represent information about vehicle models, parts, and accessories. # Automotive Cloud Metadata API Types Metadata API enables you to access some types and feature settings that you can customize in the user interface. For more information about Metadata API and to find a complete reference of existing metadata types, see **[Metadata API Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_intro.htm)**. - **[ActionableEventOrchDef](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/auto_metadata_api_actionableeventorchdef.htm)** Represents the definition of an actionable event orchestration so that the records can be migrated from one org to another. - **[ActionableEventTypeDef](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/auto_metadata_api_actionableeventtypedef.htm)** Represents the definition of an actionable event type so that the records can be migrated from one org to another. - **[Flow for Automotive Cloud](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/auto_flow_metadata_api.htm)** Represents the metadata associated with a flow. With Flow, you can create an application that navigates users through a series of screens to query and update records in the database. You can also execute logic and provide branching capability based on user input to build dynamic applications. - **[ObjectHierarchyRelationship](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/auto_metadata_api_objecthierarchyrelationship.htm)** Represents an organization’s field mappings for conversion of a lead’s related records to an opportunity’s related records. Fields can be mapped from LeadLineItem and LeadPreferredSeller to OpportunityLineItem and OpportunityPreferredSeller respectively. - **[TelemetryActionDefinition](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/auto_metadata_api_telemetryactiondefinition.htm)** Represents the action taken on a telemetry signal sent from a connected asset or vehicle, such as getting the current status of a vehicle or its component, or sending a request to perform a remote action on the vehicle or its component. - **[TelemetryActionDefStep](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/auto_metadata_api_telemetryactiondefstep.htm)** Represents a step in the action for a telemetry signal definition. - **[TelemetryActnDefStepAttr](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/auto_metadata_api_telemetryactndefstepattr.htm)** Represents the attributes of a telemetry action definition step. - **[TelemetryDefinition](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/auto_metadata_api_telemetrydefinition.htm)** Represents the definition of the structure of a telemetry signal sent from a connected asset or vehicle. - **[TelemetryDefinitionVersion](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/auto_metadata_api_telemetrydefinitionversion.htm)** Represents a version of the structure of a telemetry signal sent from a connected asset or vehicle. - **[Settings](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/auto_metadata_api_settings.htm)** Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type. For more information, see **[Settings](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm)**. # Automotive Cloud Standard Objects Automotive Cloud data model provides objects and fields to manage vehicles, customers, stakeholders, and financial relationships for your automotive company. Both dealer groups and original equipment manufacturers (OEMs) can use Automotive Cloud for varied requirements. Use the Automotive Cloud objects to manage vehicle definitions and vehicles, track stakeholders, manage leads, and report sales of vehicles and parts. Automotive Cloud is available in Lightning Experience.
Available in: Enterprise, Unlimited, and Developer Editions.
- **[AccountAccountRelation](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_accountaccountrelation.htm)** Represents a relationship between accounts, such as a relationship between a dealer account and a household account. This object is available in API version 58.0 and later. - **[ActionableEventOrchestration](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_actionableeventorchestration.htm)** Represents the details of an actionable event and specifies how to orchestrate the processes. The record stores details such as the event type, subtype, and category, and the expression set and the context mappings related to an orchestration. This object is available in API version 63.0 and later. - **[ActionableEventSubtype](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_actionableeventsubtype.htm)** Represents the subtype of an external or internal event that's processed by the Actionable Event Orchestration framework to trigger different types of actions. This object is available in API version 62.0 and later. - **[ActionableEventType](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_actionableeventtype.htm)** Represents the type of an external or internal event that's processed by the Actionable Event Orchestration framework to trigger different types of actions. This object is available in API version 62.0 and later. - **[ActionableEventTypeDef](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_actionableeventtypedef.htm)** Represents the definition of an actionable event type so that the records can be migrated from one org to another. This object is available in API version 62.0 and later. - **[ActionableOrchResponseEvent](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_actionableorchresponseevent.htm)** Represents information about an internal or external event after actions are taken by the orchestration process and the response is recorded. This object is available in API version 62.0 and later. - **[ActionableOrchSourceEvent](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_actionableorchsourceevent.htm)** Represents information about an event on which actions are taken by the orchestration process. This object is available in API version 62.0 and later. - **[Appraisal](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_appraisal.htm)** Represents the appraisal for one or more items. This object is available in API version 63.0 and later. - **[AppraisalAdjustment](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_appraisaladjustment.htm)** Represents an adjustment for the appraisal or an appraisal item. This object is available in API version 63.0 and later. - **[AppraisalItem](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_appraisalitem.htm)** Represents an item that is appraised, such as a vehicle or an asset. This object is available in API version 63.0 and later. - **[AppraisalItemAddOn](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_appraisalitemaddon.htm)** Represents an add-on product, such as an accessory, that enhances or complements the appraised item. This object is available in API version 63.0 and later. - **[AppraisalItemProviderVal](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_appraisalitemproviderval.htm)** Represents a valuation of the item that is appraised. This object is available in API version 63.0 and later. - **[AssessmentIndicatorDefinition](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_assessmentindicatordefinition.htm)** Define parameters or metrics that act as markers of compliance for partner visit tasks. This object is available in Automotive Cloud in API version 56.0 and later. - **[AssetAccountParticipant](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_assetaccountparticipant.htm)** Represents a junction between the Asset and Account objects describing the association between a participating account and an asset. This object is available in API version 56.0 and later. - **[AssetContactParticipant](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_assetcontactparticipant.htm)** Represents a junction between the Asset and Contact objects describing the association between a participating contact and an asset. This object is available in API version 56.0 and later. - **[AssetLocation](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_assetlocation.htm)** Represents a sighting or location update that records where an asset was last seen or detected. This object is available in API version 68.0 and later. - **[AssetMilestone](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_assetmilestone.htm)** Represents the key events in the lifecycle of a vehicle asset, such as manufacturing, registration, or resale. This object is available in API version 56.0 and later. - **[AssetTitle](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_assettitle.htm)** Represents information that establishes the legal ownership of an asset or a vehicle. This object is available in API version 60.0 and later. - **[AssetTitleParty](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_assettitleparty.htm)** Represents the relationship between an account, a contact, or a user and an asset title. This object is available in API version 60.0 and later. - **[AssetWarranty](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_assetwarranty.htm)** Defines the warranty terms applicable to an asset along with any exclusions and extensions. This object is available in API version 56.0 and later. - **[Claim](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_claim.htm)** Represents a warranty Claim submitted by a partner to a manufacturer, or a supplier recovery claim submitted by the manufacturer to a supplier. This object is available in API version 58.0 and later. - **[ClaimCoverage](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_claimcoverage.htm)** Represents a causal part in a defective asset that requires repair or replacement. This object is available in API version 58.0 and later. - **[ClaimCoveragePaymentDetail](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_claimcoveragepaymentdetail.htm)** Represents the claim coverage amount that must be paid to a claimant for a part replaced or replaced or a labor service performed to rectify a causal part in a defective asset. This object is available in API version 58.0 and later. - **[ClaimItem](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_claimitem.htm)** Represents a defective asset that requires repair or replacement. This object is available in API version 58.0 and later. - **[ClaimParticipant](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_claimparticipant.htm)** A junction object that associates the Claim object with the Account object. This object represents the participants of a claim. This object is available in API version 58.0 and later. - **[Codeset](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_codeset.htm)** Represents various industry defined codes in the context of their systems and versions of those systems. This object is available in API version 58.0 and later. - **[CodesetRelationship](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_codesetrelationship.htm)** Represents a relationship between a codeset and its related codeset. For example, a labor code associated with a fault code. This object is available in API version 58.0 and later. - **[CollectionPlanMilestone](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_collectionplanmilestone.htm)** Represents a milestone in a collection plan, such as a right-to-cure notice or a notice of intent to repossess. This object is available in API version 68.0 and later. - **[ContactContactRelation](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_contactcontactrelation.htm)** Represents a relationship between contacts, such as two members in a household. This object is available in API version 57.0 and later. - **[DealerVehDefSearchableField](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_dealervehdefsearchablefield.htm)** Represents information about dealerships selling and, or, servicing vehicles for location-based searches. Helps customers find nearby dealer locations for vehicle-related purchases and services. This object is available in API version 65.0 and later. - **[FinancialAccount](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_financialaccount.htm)** Represents a financing option, such as an automotive loan or lease related to a customer. This object is available in API version 60.0 and later. - **[FinancialAccountAddress](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_financialaccountaddress.htm)** Represents an address related to a financial account. This object is available in API version 60.0 and later. - **[FinancialAccountBalance](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_financialaccountbalance.htm)** Represents the details about a financial account balance. This object is available in API version 60.0 and later. - **[FinancialAccountFee](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_financialaccountfee.htm)** Represents the charges levied on a financial account This object is available in API version 60.0 and later. - **[FinancialAccountMilestone](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_financialaccountmilestone.htm)** Represents the events in the lifecycle of a financial account. This object is available in API version 60.0 and later. - **[FinancialAccountParty](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_financialaccountparty.htm)** Represents the relationship between an account or a contact and a financial account. This object is available in API version 60.0 and later. - **[FinancialAccountStatement](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_financialaccountstatement.htm)** Represents a periodic statement summary for a financial account. This object is available in API version 60.0 and later. - **[FinancialAccountTransaction](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_financialaccounttransaction.htm)** Represents a single transaction related to a loan or a lease. This object is available in API version 60.0 and later. - **[FinclAcctPtyFinclAsset](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_finclacctptyfinclasset.htm)** Represents the financial account associated with the financial asset for a specific account or contact. This object is available in API version 60.0 and later. - **[Fleet](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_fleet.htm)** Represents a group of assets or vehicles used in commercial or transport operations. This object is available in API version 59.0 and later. - **[FleetAsset](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_fleetasset.htm)** Represents the relationship between an asset or a vehicle and the fleet to which it belongs. This object is available in API version 59.0 and later. - **[FleetParticipant](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_fleetparticipant.htm)** Represents the relationship between a fleet and a participant, such as an account, a contact, or a user. This object is available in API version 59.0 and later. - **[GenericVisitTask](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_genericvisittask.htm)** Represents information about a task that can be performed during a visit. This object is available in Automotive Cloud in API version 56.0 and later. - **[GenericVisitTaskContext](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_genericvisittaskcontext.htm)** Represents the context or purpose for a generic visit task. This object is available in Automotive Cloud in API version 56.0 and later. - **[GnrcVstKeyPerformanceInd](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_gnrcvstkeyperformanceind.htm)** Represents the key performance indicators that can be recorded while performing a task during a visit. You can compare the expected and actual metric values with the key performance indicator records. This object is available in Automotive Cloud in API version 56.0 and later. - **[GnrcVstTaskContextRelation](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_gnrcvsttaskcontextrelation.htm)** Represents common attributes used for a visit task and a visit task context. This object is available in Automotive Cloud in API version 56.0 and later. - **[Holiday](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_holiday.htm)** Represents a period during which a service resource is unavailable for appointment scheduling. Recurring holidays are not supported in Automotive Cloud. This object is available in API version 58.0 and later. - **[LeadLineItem](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_leadlineitem.htm)** Represents items such as vehicles, accessories, and parts that a lead is interested in. This object is available in API version 56.0 and later. - **[LeadPreferredSeller](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_leadpreferredseller.htm)** Represents the relationship between a lead and the dealer account that the lead selects, or the relationship between a lead and the account that provides the lead. This object is available in API version 56.0 and later. - **[OpportunityPreferredSeller](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_opportunitypreferredseller.htm)** Represents the relationship between an opportunity and a dealer account, or the relationship between an opportunity and the account that provided the lead from which the opportunity was created. This object is available in API version 56.0 and later. - **[PartyCreditPrflFinclAcct](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_partycreditprflfinclacct.htm)** Represents information about financial accounts, such as a credit card, an auto loan, or a mortgage account, reported by a credit bureau. Helps lenders to review the details of a borrower's accounts, both active and inactive. This object is available in API version 65.0 and later. - **[PartyCreditProfileAlert](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_partycreditprofilealert.htm)** Represents the alerts and triggers raised against a borrower's credit activities, such as sudden score changes, new accounts, and payment defaults. Aids in detecting fraud, identifying borrower errors, and facilitating verification processes. This object is available in API version 65.0 and later. - **[PartyCreditProfileInquiry](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_partycreditprofileinquiry.htm)** Represents the details of inquiries made by external organizations to access a borrower's credit report. Can influence a lender's opinion of a borrower's risk profile based on the type of credit inquiries received. This object is available in API version 65.0 and later. - **[PartyFinancialAsset](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_partyfinancialasset.htm)** Represents the financial assets owned by an account or a contact. This object is available in API version 60.0 and later. - **[PartyFinclAssetAddlOwner](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_partyfinclassetaddlowner.htm)** Represents an additional owner of a financial asset. This object is available in API version 60.0 and later. - **[PartyRelationshipGroup](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_partyrelationshipgroup.htm)** Represents a group of people living together such as a household, or a group of people affiliated with each other. This object is available in Automotive Cloud in API version 56.0 and later. - **[PartyRoleRelation](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_partyrolerelation.htm)** Represents information about the type of relationship between the participants in a group or household. This object is available in API version 58.0 and later. - **[ProductFaultCode](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_productfaultcode.htm)** Represents a relationship between a product or product family and the fault code. This object is available in API version 58.0 and later. - **[ProductLaborCode](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_productlaborcode.htm)** Represents a junction between the labor code that's applicable to a product or product family and the required standard effort. This object is available in API version 58.0 and later. - **[ProductSvcCampaignDef](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_productsvccampaigndef.htm)** Represents information about the product or part that is impacted in a product service campaign. Stores the granular details related to product faults, facilitating efficient execution of the product service campaign. This object is available in API version 65.0 and later. - **[ProductSvcCmpnDefProdtBtch](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_productsvccmpndefprodtbtch.htm)** Represents the production batch details for a product campaign definition item. This object is available in API version 65.0 and later. - **[ProductWarrantyTerm](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_productwarrantyterm.htm)** Defines the relationship between a product or product family and a warranty term. This object is available in API version 56.0 and later. - **[PtyCrPrflFinclAcctActvty](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_ptycrprflfinclacctactvty.htm)** Represents information about the payments made by a borrower reported by a credit bureau. Reveals a borrower's payment behavior on past debts, indicating timely, delayed, or skipped payments. This object is available in API version 65.0 and later. - **[RebateClaim](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_rebateclaim.htm)** Represents proof of sale of a vehicle submitted by a dealer in the form of a retail delivery report. This report can also be used for rebate payout calculations. This object is available in Automotive Cloud in API version 56.0 and later. - **[Repossession](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_repossession.htm)** Represents a repossession case that tracks the recovery of an asset from initial assignment to final disposition. This object is available in API version 68.0 and later. - **[RepossessionActivity](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_repossessionactivity.htm)** Represents an activity or event logged during a repossession, such as a site visit, phone call, or tow initiation. This object is available in API version 68.0 and later. - **[RepossessionItem](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_repossessionitem.htm)** Represents an individual asset targeted for recovery within a repossession case. This object is available in API version 68.0 and later. - **[RepossessionItemCost](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_repossessionitemcost.htm)** Represents a cost incurred for a repossession item, such as transportation, legal, storage, or repair charges. This object is available in API version 68.0 and later. - **[RepossessionItemCostDetail](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_repossessionitemcostdetail.htm)** Represents an individual line-item charge that makes up the total cost of a repossession item. This object is available in API version 68.0 and later. - **[RepossessionItemProcessingHold](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_repossessionitemprocessinghold.htm)** Represents a hold that pauses the recovery process for a repossession item due to legal or operational constraints. This object is available in API version 68.0 and later. - **[RepossessionItemUser](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_repossessionitemuser.htm)** Represents the assignment of a user to a repossession item for a vendor's recovery task. This object is available in API version 68.0 and later. - **[RepossessionItemVendor](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_repossessionitemvendor.htm)** Represents the assignment of a partner account to a repossession item for recovery work such as towing, storage, or transport. This object is available in API version 68.0 and later. - **[RepossessionNoticeLog](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_repossessionnoticelog.htm)** Represents a log entry that records a legal notice issued to a borrower during the repossession process. This object is available in API version 68.0 and later. - **[RepossessionNoticeRule](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_repossessionnoticerule.htm)** Represents a rule that defines the legal notice requirements for a repossession scenario in a given jurisdiction. This object is available in API version 68.0 and later. - **[SellerProduct](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_sellerproduct.htm)** Represents information about the products associated with a seller. Provides insight into product availability, production details, and the seller's role for the product, such as for sales or for service. This object is available in API version 65.0 and later. - **[ServiceAppointment](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_serviceappointment.htm)** Represents a service appointment booked through Automotive Scheduler, for test drives or vehicle services. This object is available in API version 58.0 and later. - **[ServiceResourceSkill](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_serviceresourceskill.htm)** Represents the association between a skill and a service resource. This object is available in API version 58.0 and later. - **[ServiceTerritory](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_serviceterritory.htm)** Represents a dealer location where service resources are located and service appointments are performed. This object is available in API version 58.0 and later. - **[ServiceTerritoryMember](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_serviceterritorymember.htm)** Represents a service resource who can be assigned to an appointment in a service territory. This object is available in API version 58.0 and later. - **[Skill](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_skill.htm)** Represents a skill that service resources have. For technician type service resources, the skill represents their area of expertise. For asset type service resources, the skill must be specified as Test Drive. This object is available in API version 59.0 and later. - **[SkillRequirement](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_skillrequirement.htm)** Represents a skill that is required to complete a particular work type. This object is available in API version 58.0 and later. - **[TelemetryActionDefinition](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_telemetryactiondefinition.htm)** Represents the action taken on a telemetry signal sent from a connected asset or vehicle, such as getting the current status of a vehicle or its component, or sending a request to perform a remote action on the vehicle or its component. This object is available in API version 65.0 and later. - **[TelemetryActionDefStep](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_telemetryactiondefstep.htm)** Represents a step in the action for a telemetry signal definition. This object is available in API version 65.0 and later. - **[TelemetryActionRelatedProcess](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_telemetryactionrelatedprocess.htm)** Represents the relationship between a telemetry action and a process triggered by the action such as a service catalog item definition or a product. This object is available in API version 65.0 and later. - **[TelemetryActnDefStepAttr](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_telemetryactndefstepattr.htm)** Represents the attributes of a telemetry action definition step. This object is available in API version 65.0 and later. - **[TelemetryDefinition](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_telemetrydefinition.htm)** Represents the definition of the structure of a telemetry signal sent from a connected asset or vehicle. This object is available in API version 65.0 and later. - **[TelemetryDefinitionVersion](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_telemetrydefinitionversion.htm)** Represents a version of the structure of a telemetry signal sent from a connected asset or vehicle. This object is available in API version 65.0 and later. - **[TimeSlot](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_timeslot.htm)** Represents a period of time on a specified day of the week during which an appointment can be scheduled. This object is available in API version 58.0 and later. - **[TransactionJournal](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_transactionjournal.htm)** Represents proof of sale of parts and accessories submitted by a dealer to the vehicle manufacturer. This report can also be used for rebate payout calculations. This object is available in Automotive Cloud in API version 56.0 and later. - **[Vehicle](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_vehicle.htm)** Represents information about a vehicle. This object is available in API version 56.0 and later. - **[VehicleDefinition](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_vehicledefinition.htm)** Represents information about a typical vehicle model. This object is available in API version 56.0 and later. - **[VehDefSearchableField](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_vehdefsearchablefield.htm)** Represents multiple fields from objects such as Product, Price Book, and Vehicle Definition, that are used to search a vehicle's model specifications in vehicle and asset lending. This object is available in API version 63.0 and later. - **[VehicleSearchableField](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_vehiclesearchablefield.htm)** Represents a common dataset including multiple fields and values from multiple objects and is used as the basis for inventory search related to vehicles. This object is available in API version 58.0 and later. - **[Visit](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_visit.htm)** Represents information about a visit that a manager schedules for a field rep to perform, usually at dealer locations. This object is available in Automotive Cloud in API version 56.0 and later. - **[WarrantyTerm](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_warrantyterm.htm)** Represents warranty terms defining the labor, parts, and expenses covered, along with any exchange options, provided to rectify issues with products. This object is available in Manufacturing Cloud in API version 55.0 and later. - **[WarrantyTermCoverage](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_warrantytermcoverage.htm)** Represents a junction between the warranty term coverage and a product or codeset, such as the repair code or labor code. This object is available in API version 58.0 and later. - **[WorkType](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_worktype.htm)** Represents a type of work to be performed for a dealer location. Work types are templates that associate a work group to a service territory. This object is available in API version 58.0 and later. - **[WorkTypeGroup](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_worktypegroup.htm)** Represents a grouping of work types used to categorize types of available appointments. This object is available in API version 58.0 and later. - **[WorkTypeGroupMember](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/sforce_api_objects_worktypegroupmember.htm)** Represents the relationship between a work type and the work type group it belongs to. This object is available in API version 58.0 and later. #### See Also - [_Salesforce Help_: Automotive Cloud Data Model](https://help.salesforce.com/s/articleView?id=ind.auto_data_model.htm&type=5&language=en_US) # Claim Represents a warranty Claim submitted by a partner to a manufacturer, or a supplier recovery claim submitted by the manufacturer to a supplier. This object is available in API version 58.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules Automotive and Warranty Lifecycle Management must be enabled. ## Fields ### AccountId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the account related to the claim. This field is a relationship field. - **Relationship Name**: Account - **Relationship Type**: Lookup - **Refers To**: Account ### ClaimReason - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The reason for initiating the claim. ### ClaimReasonType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The category to which the claim reason belongs. Possible values are: Accident, or Natural Disaster. ### ClaimType - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the type of the claim. Possible values are: The default value is Warranty Claim. Pre Warranty Authorization, or Warranty Claim. ### ClaimTypeCode - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the type code of the claim. Possible values are: The default value is Warranty Claim. PreWarrantyAuthorization, SupplierRecoveryClaim, or WarrantyClaim. ### FinalizedDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date on which the claim was marked resolved, with claim status as approved or rejected. ### FnolChannel - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The channel through which the loss was reported. Possible values are: Chatbot, Mobile, Phone, or Web. ### IsClosed - **Type**: boolean - **Properties**: Defaulted on create, Filter, Group, Sort - **Description**: Indicates whether the claim has been closed (true) or not (false). The default value is false. ### 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. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The claim number in the claims management system. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: ID of the record owner. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### RelatedClaimId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID of the claim related to this claim. This field is a relationship field. - **Relationship Name**: RelatedClaim - **Relationship Type**: Lookup - **Refers To**: Claim ### Severity - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The severity of the claim. Possible values are: High, Low, or Medium. ### Status - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: The status of the claim. Possible values are: The default value is Draft. - Approved - Draft - Manual Review Needed - Rejected - Requested Information - Submitted - Under Review ### Summary - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The description of the claim. ### TotalAdjustedAmount - **Type**: currency - **Properties**: Filter, Nillable, Sort - **Description**: The claim amount that was approved. This field is a calculated field. ### TotalClaimedAmount - **Type**: currency - **Properties**: Filter, Nillable, Sort - **Description**: The total amount being claimed. This field is a calculated field. ### UsageType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The usage type of the Claims record. Possible values are: - Automotive ## 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. - [ClaimChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_change_event.htm): Change events are available for the object. - [ClaimFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_feed.htm): Feed tracking is available for the object. - [ClaimHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_history.htm): History is available for tracked fields of the object. - [ClaimOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_ownersharingrule.htm): Sharing rules are available for the object. - [ClaimShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_share.htm): Sharing is available for the object. # ClaimCoverage Represents a causal part in a defective asset that requires repair or replacement. This object is available in API version 58.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules Automotive and Warranty Lifecycle Management must be enabled. ## Fields ### AssetWarrantyId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The asset warranty ID of the defective asset in the associated claim item. This field is a relationship field. - **Relationship Name**: AssetWarranty - **Relationship Type**: Lookup - **Refers To**: AssetWarranty ### CausalPartId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the product part that causes the issues related to the claim. This field is a relationship field. - **Relationship Name**: CausalPart - **Relationship Type**: Lookup - **Refers To**: Product2 ### ClaimId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The ID of the claim record associated with this claim coverage. This field is a relationship field. - **Relationship Name**: Claim - **Relationship Type**: Lookup - **Refers To**: Claim ### ClaimItemId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the claim item record associated with the claim coverage. This field is a relationship field. - **Relationship Name**: ClaimItem - **Relationship Type**: Lookup - **Refers To**: ClaimItem ### ClaimParticipantId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the claim participant record associated with this claim coverage. This field is a relationship field. - **Relationship Name**: ClaimParticipant - **Relationship Type**: Lookup - **Refers To**: ClaimParticipant ### CoverageType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The type of claim coverage. Possible values are: Extended Warranty, None, or Standard Warranty. ### Description - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The description of the coverage for the claim. ### ExtlWorkOrderReference - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The external identifier of the work order. ### FaultCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The code ID that uniquely identifies the fault caused by the part. This field is a relationship field. - **Relationship Name**: FaultCode - **Relationship Type**: Lookup - **Refers To**: CodeSet ### 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. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the claim coverage. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the record owner. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### ProductRelatedMaterialId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the Product Related Material record that defines the association between the causal part and the product associated with the claim. This field is a relationship field. - **Relationship Name**: ProductRelatedMaterial - **Relationship Type**: Lookup - **Refers To**: ProductRelatedMaterial ### RelatedClaimCoverageId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The claim coverage against which the supplier recovery claim is created. This field is a relationship field. - **Relationship Name**: RelatedClaimCoverage - **Relationship Type**: Lookup - **Refers To**: ClaimCoverage ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The status of a claim coverage. Possible values are: Approved, Closed, Open, or Rejected. ### TotalAdjustedAmount - **Type**: currency - **Properties**: Filter, Nillable, Sort - **Description**: The total amount that's adjusted in a claim. This field is a calculated field. ### TotalClaimedAmount - **Type**: currency - **Properties**: Filter, Nillable, Sort - **Description**: The total amount being claimed. This field is a calculated field. ## 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. - [ClaimCoverageChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_change_event.htm): Change events are available for the object. - [ClaimCoverageFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_feed.htm): Feed tracking is available for the object. - [ClaimCoverageHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_history.htm): History is available for tracked fields of the object. - [ClaimCoverageOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_ownersharingrule.htm): Sharing rules are available for the object. - [ClaimCoverageShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_share.htm): Sharing is available for the object. # ClaimCoveragePaymentDetail Represents the claim coverage amount that must be paid to a claimant for a part replaced or replaced or a labor service performed to rectify a causal part in a defective asset. This object is available in API version 58.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules Automotive and Warranty Lifecycle Management must be enabled. ## Fields ### ActualExpense - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The actual expense of the part replacement or labor service. ### AdjustedAmount - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The amount the manufacturer intends to pay to the claimant for the repair, replacement, or labor service to rectify a causal part. ### ChargeType - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The type of charge. Possible values are: The default value is Replaced Part. Labor, Other, or Replaced Part. ### ChargeTypeCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unique code that identifies the labor charge or expense. This field is a relationship field. - **Relationship Name**: ChargeTypeCode - **Relationship Type**: Lookup - **Refers To**: CodeSet ### ClaimCoverageId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The ID of the claim coverage record associated with the Claim Coverage Payment Detail. This field is a relationship field. - **Relationship Name**: ClaimCoverage - **Relationship Type**: Lookup - **Refers To**: ClaimCoverage ### ClaimedAmount - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The amount claimed by the claimant as a part of the claim coverage payment detail. ### Comment - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The comments made by the warranty claims adjudicator while adjudicating the claim coverage payment detail. ### Description - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The description of the claim coverage payment detail. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record, a record related to this record, or a list view. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the claim coverage payment detail. ### PriceBookEntryId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The entry of the product related to the replacement part in the price book. This field is a relationship field. - **Relationship Name**: PriceBookEntry - **Relationship Type**: Lookup - **Refers To**: PricebookEntry ### ProductRelatedMaterialId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the product related material record that defines the association between the replacement part and the product associated with the claim. This field is a relationship field. - **Relationship Name**: ProductRelatedMaterial - **Relationship Type**: Lookup - **Refers To**: ProductRelatedMaterial ### Quantity - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The quantity of parts replaced or the number of labor hours. ### ReplacementPartId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The product part that's a replacement for the defective part. This field is a relationship field. - **Relationship Name**: ReplacementPart - **Relationship Type**: Lookup - **Refers To**: Product2 ### ReturnOrderId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The ID of the return order related to the claim coverage payment detail. This field is a relationship field. - **Relationship Name**: ReturnOrder - **Relationship Type**: Lookup - **Refers To**: ReturnOrder ### ReturnOrderLineItemId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the return order line item related to the claim coverage payment detail. This field is a relationship field. - **Relationship Name**: ReturnOrderLineItem - **Relationship Type**: Lookup - **Refers To**: ReturnOrderLineItem ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The status of claim coverage payment detail. Possible values are: Approved, None, or Rejected. ## 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. - [ClaimCoveragePaymentDetailChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_change_event.htm): Change events are available for the object. - [ClaimCoveragePaymentDetailFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_feed.htm): Feed tracking is available for the object. - [ClaimCoveragePaymentDetailHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_history.htm): History is available for tracked fields of the object. # ClaimItem Represents a defective asset that requires repair or replacement. This object is available in API version 58.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules Automotive and Warranty Lifecycle Management must be enabled. ## Fields ### AssetId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The asset associated with the claim. This field is a relationship field. - **Relationship Name**: Asset - **Relationship Type**: Lookup - **Refers To**: Asset ### AssetUsageUnitOfMeasure - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The unit of measure for the usage value of the asset. Possible values are: Hours, or Miles. ### AssetUsageValue - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The usage value for the asset at the time of occurrence of the fault. ### ClaimId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The parent claim that includes this claim item. This field is a relationship field. - **Relationship Name**: Claim - **Relationship Type**: Lookup - **Refers To**: Claim ### FaultDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date of occurrence of the fault in the asset. ### 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. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: Name of the claim item. ### RepairDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date of repair of the asset. ## 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. - [ClaimItemChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_change_event.htm): Change events are available for the object. - [ClaimItemFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_feed.htm): Feed tracking is available for the object. - [ClaimItemHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_history.htm): History is available for tracked fields of the object. # ClaimParticipant A junction object that associates the Claim object with the Account object. This object represents the participants of a claim. This object is available in API version 58.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules Automotive and Warranty Lifecycle Management must be enabled. ## Fields ### ClaimId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The ID of the claim in which this participant has one or more roles. This field is a relationship field. - **Relationship Name**: Claim - **Relationship Type**: Lookup - **Refers To**: Claim ### 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. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Auto-generated number for the name of the claim participant record. ### Roles - **Type**: multipicklist - **Properties**: Create, Filter, Update - **Description**: The roles that the claim participant can have in the claim. Possible value is: - Claimant ## 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. - [ClaimParticipantChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_change_event.htm): Change events are available for the object. - [ClaimParticipantFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_feed.htm): Feed tracking is available for the object. - [ClaimParticipantHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_history.htm): History is available for tracked fields of the object. # Codeset Represents various industry defined codes in the context of their systems and versions of those systems. This object is available in API version 58.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules Automotive and Warranty Lifecycle Management must be enabled. ## Fields ### Code - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The system-defined code that’s represented by this code set. ### CodeDescription - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Additional information associated with the code set. ### CodeSetKey - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: A unique key that identifies the concept represented by code sets across different systems and versions. This key is not case sensitive. ### CodeSetType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The type of the code set. ### EndDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The end date of the code set’s effective period. ### IsActive - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the code set is an active code set (true) or not (false). The default value is false. ### IsCustomCode - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the code set is defined by a specific organization, as opposed to recognized across the industry. The default value is false. ### IsPrimary - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the code set is the primary code set for the concept (true) or not (false). That is, it was selected manually by a user instead of being selected by an automated process. The default value is false. ### 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. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The textual representation of the meaning of the code. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: A reference to the person who owns the code set record. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### SourceSystem - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system that sets the context for the code and defines its meaning. ### StartDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The start date of the code set’s effective period. ### SystemVersion - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The version of the source system the code belongs to. ## 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. - [CodesetChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_change_event.htm): Change events are available for the object. - [CodesetFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_feed.htm): Feed tracking is available for the object. - [CodesetHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_history.htm): History is available for tracked fields of the object. - [CodesetOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_ownersharingrule.htm): Sharing rules are available for the object. - [CodesetShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_share.htm): Sharing is available for the object. # CodesetRelationship Represents a relationship between a codeset and its related codeset. For example, a labor code associated with a fault code. This object is available in API version 58.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### CodeSetId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The codeset that's associated with another related codeset. This field is a relationship field. - **Relationship Name**: CodeSet - **Relationship Type**: Lookup - **Refers To**: CodeSet ### CodeSetType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The type of the codeset. ### 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. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Autogenerated name of the codeset relationship. ### RelatedCodeSetId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The related codeset that's associated with the codeset. This field is a relationship field. - **Relationship Name**: RelatedCodeSet - **Relationship Type**: Lookup - **Refers To**: CodeSet ### RelatedCodeSetType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The type of the related codeset. ## 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. - [CodesetRelationshipFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_feed.htm): Feed tracking is available for the object. - [CodesetRelationshipHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_history.htm): History is available for tracked fields of the object. # CollectionPlanMilestone Represents a milestone in a collection plan, such as a right-to-cure notice or a notice of intent to repossess. This object is available in API version 68.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### CollectionPlanId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The collection plan record that's associated with the milestone. This field is a relationship field. - **Relationship Name**: CollectionPlan - **Relationship Type**: Master-Detail - **Refers To**: CollectionPlan ### Description - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The description of the milestone. ### ExpiredDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The expiration date of the milestone. ### MilestoneDate - **Type**: date - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The date on which the milestone occured. ### MilestoneType - **Type**: picklist - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Specifies the type of milestone. Possible values are: Right-to-Cure Notice Sent, Right-to-Cure Period Expired, Notice of Intent to Repossess Sent, Notice of Sale, or Post-Repossession Disclosure Sent. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unique identifier of the milestone in the external system. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The external system from where this record was imported. ### Stage - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the stage of the milestone. Possible values are: Active, Tentative, or Expired. ### StageComment - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The comments about the stage of the milestone. ### UsageType - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the usage type of the collection plan milestone. Possible values are: The default value is Repossession. Repossession, or Collections & Recovery. # ContactContactRelation Represents a relationship between contacts, such as two members in a household. This object is available in API version 57.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules Automotive and Group Membership must be enabled. ## Fields ### ContactId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: ID of the account associated with this contact contact relationship. This field is a relationship field. - **Relationship Name**: Contact - **Relationship Type**: Lookup - **Refers To**: Contact ### EndDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date when the relationship ends. ### HierarchyType - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Indicates the type of association to determine the hierarchy of relationship between the two parties. Possible values are: The default value is Parent. Child, Parent, or Peer. ### IsActive - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the contact is actively involved with the related contact. The default value is false. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record, a record related to this record, or a list view. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Name of the contact contact relationship. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: ID of the owner of this object. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### PartyRoleRelationId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The relationship between two contacts. This field is a relationship field. - **Relationship Name**: PartyRoleRelation - **Relationship Type**: Lookup - **Refers To**: PartyRoleRelation ### RelatedContactId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The related contact in the relationship. This field is a relationship field. - **Relationship Name**: RelatedContact - **Relationship Type**: Lookup - **Refers To**: Contact ### RelatedInverseRecordId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The record that specifies the inverse relationship between the contacts. This field is a relationship field. - **Relationship Name**: RelatedInverseRecord - **Relationship Type**: Lookup - **Refers To**: ContactContactRelation ### StartDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date when the relationship starts. ## 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. - [ContactContactRelationChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_change_event.htm): Change events are available for the object. - [ContactContactRelationFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_feed.htm): Feed tracking is available for the object. - [ContactContactRelationHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_history.htm): History is available for tracked fields of the object. - [ContactContactRelationOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_ownersharingrule.htm): Sharing rules are available for the object. - [ContactContactRelationShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_share.htm): Sharing is available for the object. # Criteria-Based Search and Filter in Automotive Cloud Configure a search based on a single searchable object that combines data that’s spread across multiple objects and fields.
Available in: Lightning Experience
Available in: Automotive Cloud, Health Cloud, Manufacturing Cloud, and Public Sector Solutions. View edition availability.
For more information about Criteria-Based Search and Filter, see [Criteria-Based Search and Filter](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/criteria_based_search_and_filter_overview.htm "HTML (New Window)"). # DealerVehDefSearchableField Represents information about dealerships selling and, or, servicing vehicles for location-based searches. Helps customers find nearby dealer locations for vehicle-related purchases and services. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### BodyType - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The body type or style of the vehicle, such as hatchback or coupe. ### BusinessBrandId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The business brand related to a vehicle model. This field is a relationship field. - **Relationship Name**: BusinessBrand - **Refers To**: BusinessBrand ### BusinessBrandName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the business brand. ### BusinessPartnerType - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The type of dealer that’s associated with a vehicle or its parts. ### BusinessProfileId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The business profile related to a dealer's account. This field is a relationship field. - **Relationship Name**: BusinessProfile - **Refers To**: BusinessProfile ### DealerAccountId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The account related to a dealer's business profile. This field is a relationship field. - **Relationship Name**: DealerAccount - **Refers To**: Account ### DealerLocation - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The location of the dealer. ### DealerName - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The name of the dealer. ### DealerPhone - **Type**: phone - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The phone number of the dealer. ### DealerRating - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The rating of the dealer. ### DealerServices - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The list of services offered by a dealer. ### DealerWebsite - **Type**: url - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The website of the dealer. ### FuelSource - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The power source used in a vehicle, such as gasoline or diesel. ### Industry - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The industry of the dealer. ### 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. ### MakeName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The make name of a vehicle. ### ModelName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The model name of a vehicle. ### ModelYear - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The model year of a vehicle. ### ProductCode - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ### ProductFamily - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unique code of a product related to a vehicle model. ### ProductId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The product related to a seller product. This field is a relationship field. - **Relationship Name**: Product - **Refers To**: Product2 ### ProductName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the product related to a vehicle model. ### RegionName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the region where the dealer operates from. ### SellerProductId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The seller product related to a product. This field is a relationship field. - **Relationship Name**: SellerProduct - **Refers To**: SellerProduct ### SellerRole - **Type**: textarea - **Properties**: Create, Update - **Description**: The role of the seller related to the product, such as for sales or for service. ### ServiceTerritoryAddress - **Type**: address - **Properties**: Filter, Nillable - **Description**: The address of the service territory related to a dealer's business profile. ### ServiceTerritoryCity - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The city of the service territory related to a dealer's business profile. ### ServiceTerritoryCountry - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The country of the service territory related to a dealer's business profile. ### ServiceTerritoryCountryCode - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The country code of the service territory related to a dealer's business profile. Possible values are: The default value is IN. - IN—India ### ServiceTerritoryId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The service territory related to a dealer's business profile. This field is a relationship field. - **Relationship Name**: ServiceTerritory - **Refers To**: ServiceTerritory ### ServiceTerritoryName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the service territory related to a dealer's business profile. ### TestDriveVehicleDefinition - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The vehicle definition of a vehicle that's available for a test drive at a dealership. ### TransmissionSystem - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The transmission type of the vehicle, such as manual or automatic. ### TrimType - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The trim type of the vehicle model, such as DX, GT, or LS. ### VehicleDefinitionId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The vehicle definition related to a product. This field is a relationship field. - **Relationship Name**: VehicleDefinition - **Refers To**: VehicleDefinition ### VehicleProductName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the vehicle definition related to a vehicle. ### VehicleServiceType - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The list of work type groups related to a dealer. # Error Message Output representation of the details of errors encountered during an API request execution. | Property | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | errorCode | String | An error code with the information about the error, for example, INSUFFICIENT\_PRIVILEGES. | Small, 29.0 | 23.0 | | message | String | Description of the error. | Small, 29.0 | 23.0 | # Field List Input representation of a field match that contains the field name and value. ## JSON Example { "fieldList": \[ { "field": "priority\_\_c", "value": "high" } \] } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | field | String | Name of the field. | Optional | 60.0 | | value | Object | Field value of the additional criteria for incoming events. | Optional | 60.0 | # FinancialAccount Represents a financing option, such as an automotive loan or lease related to a customer. This object is available in API version 60.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules Automotive and Vehicle and Asset Finance must be enabled. ## Fields ### AmountDue - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The amount that is due for payment for the financial account. ### AmountPastDue - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The payment amount that wasn't paid by the due date. ### BranchUnitId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The captive finance unit associated with the financial account. This field is a relationship field. - **Relationship Name**: BranchUnit - **Relationship Type**: Lookup - **Refers To**: BranchUnit ### ClosingDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date when the financial account was closed. ### CreditLimit - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The total credit limit avaialble for the financial account. ### DaysPastDue - **Type**: int - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The number of days past the payment due date. ### DownPaymentAmount - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: An initial up-front partial payment amount. ### FinancialAccountNumber - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The identifier of the financial account. ### InsurancePaidYearToDate - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The total amount of insurance premium paid in the current tax year. ### InterestPaidYearToDate - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The total amount of interest paid in the current tax year. ### InterestRate - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The rate of interest applied on the loan or lease. ### InterestType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the type of interest applied to the loan or lease. Possible values are: Fixed, or Variable. ### IsHeldAway - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether this financial account is owned externally (true) or in-house (false). The default value is false. ### IsOverdraftAllowed - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the financial account allows an overdraft (true) or not (false). The default value is false. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user referenced this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user viewed this record. ### MaturityDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date when the financial account with a fixed term matures. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the financial account. ### OpeningDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date when the financial account was opened. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The owner of the financial account record. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### PaymentDueDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date when the payment is due for the financial account. ### PrincipalAmount - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The principal amount on the financial account. ### PrincipalPaidYearToDate - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The total amount paid against the principal in the current tax year. ### ProductId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The product associated with the financial account. This field is a relationship field. - **Relationship Name**: Product - **Relationship Type**: Lookup - **Refers To**: Product2 ### RelatedFinancialAccountId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The parent of the financial account. This field is a relationship field. - **Relationship Name**: RelatedFinancialAccount - **Relationship Type**: Lookup - **Refers To**: FinancialAccount ### RemainingDuration - **Type**: int - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The duration in months from the current date to the maturity date or the prepayment date. ### RenewalDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date when the financial account is due for renewal. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The identifier of the financial account in an external system such as a captive finance dealer management system. ### Status - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the status of the financial account. Possible values are: The default value is Active. Active, Closed, Delinquent, or On Hold. ### Term - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The term for which a loan or lease is taken. ### TotalOutstandingAmount - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The total outstanding amount on the financial account. ### Type - **Type**: picklist - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Specifies the type of the financial account. Possible values are: Asset Lease, Asset Loan, Automotive Lease, or Automotive Loan. ## 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. - [FinancialAccountChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_change_event.htm): Change events are available for the object. - [FinancialAccountFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_feed.htm): Feed tracking is available for the object. - [FinancialAccountHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_history.htm): History is available for tracked fields of the object. - [FinancialAccountOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_ownersharingrule.htm): Sharing rules are available for the object. - [FinancialAccountShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_share.htm): Sharing is available for the object. # FinancialAccountAddress Represents an address related to a financial account. This object is available in API version 60.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules Automotive and Vehicle and Asset Finance must be enabled. ## Fields ### ActiveFromDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date from when the address is active for the financial account. ### ActiveToDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date from when the address stops being active for the financial account. ### Address - **Type**: address - **Properties**: Filter - **Description**: The address related to a financial account. ### City - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The city related to a financial account’s address. ### Country - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The country related to a financial account’s address. ### FinancialAccountId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The financial account related to an address. This field is a relationship field. - **Relationship Name**: FinancialAccount - **Relationship Type**: Lookup - **Refers To**: FinancialAccount ### 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 milestone location’s latitude and longitude coordinates. Possible values are: - Address - Block - City - County - ExtendedZip—Extended Zip - NearAddress—Near Address - Neighborhood - State - Street - Unknown - Zip ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date when a user referenced this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date when a user viewed this record. ### Latitude - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The latitude related to a financial account’s address. ### Longitude - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The longitude related to a financial account’s address. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of this record. ### PostalCode - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The postal code related to a financial account’s address. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The unique identifier of this record in an external system. ### State - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The state related to a financial account’s address. ### Street - **Type**: textarea - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The street related to a financial account’s address. ### Type - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the address type of the financial account. Possible values are: Billing Address, Communication Address, or Statement Address. ## 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. - [FinancialAccountAddressChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_change_event.htm): Change events are available for the object. - [FinancialAccountAddressFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_feed.htm): Feed tracking is available for the object. - [FinancialAccountAddressHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_history.htm): History is available for tracked fields of the object. # FinancialAccountBalance Represents the details about a financial account balance. This object is available in API version 60.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules Automotive and Vehicle and Asset Finance must be enabled. ## Fields ### Amount - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The balance amount in the financial account. ### BalanceAsOfDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Timestamp for when the balance was last retrieved from an external data source. ### FinancialAccountId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Financial account related to the balance. This field is a relationship field. - **Relationship Name**: FinancialAccount - **Relationship Type**: Lookup - **Refers To**: FinancialAccount ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date when a user referenced this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date when a user iewed this record. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the record. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The owner of this record. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The unique identifier of this record in an external system. ### Type - **Type**: picklist - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Specifies the type of balance in the financial account. Possible values are: Available Credit, Current Posted Balance, Lease Balance, Principal Balance, or Total Balance. ## 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. - [FinancialAccountBalanceChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_change_event.htm): Change events are available for the object. - [FinancialAccountBalanceFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_feed.htm): Feed tracking is available for the object. - [FinancialAccountBalanceHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_history.htm): History is available for tracked fields of the object. - [FinancialAccountBalanceOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_ownersharingrule.htm): Sharing rules are available for the object. - [FinancialAccountBalanceShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_share.htm): Sharing is available for the object. # FinancialAccountFee Represents the charges levied on a financial account This object is available in API version 60.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules Automotive and Vehicle and Asset Finance must be enabled. ## Fields ### Amount - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The amount that is charged for the request. ### EndDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date until when the applicable fee is charged on the financial account. ### FinancialAccountId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The financial account to which the fee is charged. This field is a relationship field. - **Relationship Name**: FinancialAccount - **Relationship Type**: Lookup - **Refers To**: FinancialAccount ### Frequency - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The frequency at which applicable fee is charged on the financial account, such as yearly or monthly. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date when a user referenced this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date when a user viewed this record. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the record. ### Rate - **Type**: percent - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The amount in percentage that is charged for the request. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The unique identifier of the financial account fee in an external system. ### StartDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date from when the applicable fee is charged on the financial accouint. ### Type - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the type of the financial account fee. Possible values are: - Excess Mileage Charge - Late Payment Fee - Loan Processing Fee - Prepayment Charge - Turn-In Fee - Wear and Tear Fee ## 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. - [FinancialAccountFeeChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_change_event.htm): Change events are available for the object. - [FinancialAccountFeeFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_feed.htm): Feed tracking is available for the object. - [FinancialAccountFeeHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_history.htm): History is available for tracked fields of the object. # FinancialAccountMilestone Represents the events in the lifecycle of a financial account. This object is available in API version 60.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### Address - **Type**: address - **Properties**: Filter, Nillable - **Description**: The address associated with the milestone. ### City - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The city where the milestone occurred. ### Country - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The country where the milestone occurred. ### Description - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The description of the milestone. ### ExpiredDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The expiration date of the milestone. ### FinancialAccountId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The ID of the financial account that's associated with the milestone. This field is a relationship field. - **Relationship Name**: FinancialAccount - **Relationship Type**: Master-detail - **Refers To**: FinancialAccount (the master object) ### 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 milestone location’s latitude and longitude coordinates. Possible values are: - Address - Block - City - County - ExtendedZip—Extended Zip - NearAddress—Near Address - Neighborhood - State - Street - Unknown - Zip ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user referenced this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user viewed this record. ### Latitude - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Used with Longitude to specify the precise geolocation of the milestone location. Acceptable values are numbers between –90 and 90 with up to 15 decimal places. ### LocationId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the location associated with the milestone. This field is a relationship field. - **Relationship Name**: Location - **Refers To**: Location ### Longitude - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Used with Latitude to specify the precise geolocation of the milestone location. Acceptable values are numbers between –180 and 180 with up to 15 decimal places. ### MilestoneDate - **Type**: date - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The date on which the milestone occurred. ### MilestoneType - **Type**: picklist - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Specifies the type of milestone. Possible values are: - Asset Repossessed - Beneficiary Added - Debt Charged Off - Marked Delinquent - Payment Deferred - Title Transferred ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the milestone. ### PostalCode - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The postal code of the location where the milestone occurred. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unique identifier of the milestone in the external system. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The external system from where the record was imported. ### Stage - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the stage of the milestone. Possible values are: Active, Expired, or Tentative. ### StageComment - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The comments about the stage of the milestone. For example, the reason for marking the milestone as tentative. ### State - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The state where the milestone occurred. ### Street - **Type**: textarea - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The street where the milestone occurred. ### UsageType - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the usage type of the financial account milestone. Possible values are: - Automotive ## 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. - [FinancialAccountMilestoneFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_feed.htm): Feed tracking is available for the object. - [FinancialAccountMilestoneHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_history.htm): History is available for tracked fields of the object. # FinancialAccountParty Represents the relationship between an account or a contact and a financial account. This object is available in API version 60.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules Automotive and Vehicle and Asset Finance must be enabled. ## Fields ### AccountId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The account related to a financial account. This field is a relationship field. - **Relationship Name**: Account - **Relationship Type**: Lookup - **Refers To**: Account ### ContactId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The contact related to a financial account. This field is a relationship field. - **Relationship Name**: Contact - **Relationship Type**: Lookup - **Refers To**: Contact ### FinancialAccountId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The financial account related to this record. This field is a relationship field. - **Relationship Name**: FinancialAccount - **Relationship Type**: Lookup - **Refers To**: FinancialAccount ### IsRoleActive - **Type**: boolean - **Properties**: Defaulted on create, Filter, Group, Sort - **Description**: Indicates whether the record is active (true) or not (false). The default value is false. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the record. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The owner of the record. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### Role - **Type**: picklist - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Specifies the role of the account or contact in relation to a financial account. Possible values are: - Beneficiary - Co-Owner - Driver - Guarantor - Leasee - Owner ### RoleEndDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date till when the party is related to a financial account. ### RoleStartDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date from when the party is related to a financial account. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The unique identifier of this record in an external system. ## 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. - [FinancialAccountPartyChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_change_event.htm): Change events are available for the object. - [FinancialAccountPartyFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_feed.htm): Feed tracking is available for the object. - [FinancialAccountPartyHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_history.htm): History is available for tracked fields of the object. - [FinancialAccountPartyOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_ownersharingrule.htm): Sharing rules are available for the object. - [FinancialAccountPartyShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_share.htm): Sharing is available for the object. # FinancialAccountStatement Represents a periodic statement summary for a financial account. This object is available in API version 60.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules Automotive and Vehicle and Asset Finance must be enabled. ## Fields ### Description - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The description of the financial account statement. ### EndDate - **Type**: date - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Indicates the end date of the financial account statement period. ### FinancialAccountId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The financial account associated with the financial account statement. This field is a relationship field. - **Relationship Name**: FinancialAccount - **Relationship Type**: Lookup - **Refers To**: FinancialAccount ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date when a user referenced this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date when a user viewed this record. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the record. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The unique identifier of the financial account statement in an external system. ### StartDate - **Type**: date - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Indicates the start date of the financial account statement period. ### Type - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the statement type. Possible values are: Account Closure Statement, Balance Statement, or Periodic Statement. ### Url - **Type**: url - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The URL of the statement attachment or file. ## 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. - [FinancialAccountStatementChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_change_event.htm): Change events are available for the object. - [FinancialAccountStatementFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_feed.htm): Feed tracking is available for the object. - [FinancialAccountStatementHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_history.htm): History is available for tracked fields of the object. # FinancialAccountTransaction Represents a single transaction related to a loan or a lease. This object is available in API version 60.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules Automotive and Vehicle and Asset Finance must be enabled. ## Fields ### Amount - **Type**: currency - **Properties**: Create, Filter, Sort, Update - **Description**: The transaction amount. ### DebitCreditIndicator - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies whether the transaction is of type Credit or Debit. Possible values are: Credit, or Debit. ### Description - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The transaction description. ### FinancialAccountId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The financial account related to the transaction. This field is a relationship field. - **Relationship Name**: FinancialAccount - **Relationship Type**: Lookup - **Refers To**: FinancialAccount ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date when a user referenced this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date when a user viewed this record. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the record. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The owner of this record. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### PostedDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date when the transaction was posted to the financial account. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The identifier of the financial account in an external system. ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the status of the transaction. Possible values are: Booked, or Pending. ### SubType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the subtype of the transaction. ### TransactionCode - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The identifier of the transaction. ### TransactionDate - **Type**: dateTime - **Properties**: Create, Filter, Sort, Update - **Description**: The date and time of the transaction. ### Type - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the type of the transaction. ## 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. - [FinancialAccountTransactionChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_change_event.htm): Change events are available for the object. - [FinancialAccountTransactionFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_feed.htm): Feed tracking is available for the object. - [FinancialAccountTransactionHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_history.htm): History is available for tracked fields of the object. - [FinancialAccountTransactionOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_ownersharingrule.htm): Sharing rules are available for the object. - [FinancialAccountTransactionShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_share.htm): Sharing is available for the object. # FinclAcctPtyFinclAsset Represents the financial account associated with the financial asset for a specific account or contact. This object is available in API version 60.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules Automotive and Vehicle and Asset Finance must be enabled. ## Fields ### AssociationEndDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date till when the party asset was associated with the financial account. ### AssociationStartDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date from when the party asset was associated with the financial account. ### AssociationType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the type of association between the financial account and the party asset. Possible values are: Collateral, or Trade In. ### FinancialAccountId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The financial account associated with the party asset. This field is a relationship field. - **Relationship Name**: FinancialAccount - **Relationship Type**: Lookup - **Refers To**: FinancialAccount ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date when a user referenced this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date when a user viewed this record. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The unique identifier of the Financial Account Party Asset. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The owner of this record. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### PartyFinancialAssetId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The party asset associated with the financial account. This field is a relationship field. - **Relationship Name**: PartyFinancialAsset - **Relationship Type**: Lookup - **Refers To**: PartyFinancialAsset ### PledgedAmount - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The monetary value of the asset pledged as the collateral for the associated financial account. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The unique identifier of the financial account party asset in an external system. ## 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. - [FinclAcctPtyFinclAssetChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_change_event.htm): Change events are available for the object. - [FinclAcctPtyFinclAssetFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_feed.htm): Feed tracking is available for the object. - [FinclAcctPtyFinclAssetHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_history.htm): History is available for tracked fields of the object. - [FinclAcctPtyFinclAssetOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_ownersharingrule.htm): Sharing rules are available for the object. - [FinclAcctPtyFinclAssetShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_share.htm): Sharing is available for the object. # Fleet Represents a group of assets or vehicles used in commercial or transport operations. This object is available in API version 59.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### ActiveAssetCount - **Type**: int - **Properties**: Filter, Group, Nillable, Sort - **Description**: The total number of assets associated with a fleet record. This field shows a rolled-up value based on the number of Fleet Asset records in Active status associated with a Fleet record. This field is a calculated field. ### CurrentOwnerId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The current owner of the fleet. This field is a relationship field. - **Relationship Name**: CurrentOwner - **Relationship Type**: Lookup - **Refers To**: Account ### EffectiveEndDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date until when a fleet is operational. ### EffectiveStartDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date from when a fleet is operational. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user referenced this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user viewed this record. ### LocationId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the location that the fleet is associated with. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of a fleet record. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the user or user group who owns this record. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### ParentFleetId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The parent fleet that a fleet record is part of in a hierarchy. This field is a relationship field. - **Relationship Name**: ParentFleet - **Relationship Type**: Lookup - **Refers To**: Fleet ### Status - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Specifies the status of a fleet record. Possible values are: The default value is Active. Active, or Inactive. ### Type - **Type**: picklist - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The type of a fleet record. Possible values are: Commercial, Employee, Executive, or Material. ## 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. - [FleetChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_change_event.htm): Change events are available for the object. - [FleetFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_feed.htm): Feed tracking is available for the object. - [FleetHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_history.htm): History is available for tracked fields of the object. - [FleetOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_ownersharingrule.htm): Sharing rules are available for the object. - [FleetShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_share.htm): Sharing is available for the object. # FleetAsset Represents the relationship between an asset or a vehicle and the fleet to which it belongs. This object is available in API version 59.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AssetId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The Asset associated with the Fleet Asset record. This field is a relationship field. - **Relationship Name**: Asset - **Relationship Type**: Lookup - **Refers To**: Asset ### AssetUsage - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The total usage of an asset such as the number of hours for which a machine runs. ### AssetUsageUomId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unit of measure for the total usage of an asset. This field is a relationship field. - **Relationship Name**: AssetUsageUom - **Relationship Type**: Lookup - **Refers To**: UnitOfMeasure ### EffectiveEndDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date until when a vehicle or an asset is part of the fleet. ### EffectiveStartDate - **Type**: date - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The date from when a vehicle or an asset is part of the fleet. ### FleetId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The fleet associated with the Fleet Asset record. This field is a relationship field. - **Relationship Name**: Fleet - **Relationship Type**: Lookup - **Refers To**: Fleet ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user referenced this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user viewed this record. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The autopopulated name of a Fleet Asset record. ### ResidualValue - **Type**: currency - **Properties**: Filter, Nillable, Sort - **Description**: The residual value of a vehicle. This value is derived from the Latest Residual Value field on a Vehicle record. ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Specifies the status of the vehicle or the asset in the associated fleet. Possible values are: - Active - Assigned - Inactive - Out of Service - Registered - Under Maintenance ### VehicleDistanceCovered - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: The total distance traveled by the vehicle. The value is derived from the Last Odometer Reading field on a Vehicle record. ### VehicleDistanceCoveredUom - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: The unit of measure for the total distance traveled by the vehicle. The value is derived from the Odometer Reading Unit of Measure field on a Vehicle record. ### VehicleId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The Vehicle associated with the Fleet Asset record. This field is a relationship field. - **Relationship Name**: Vehicle - **Relationship Type**: Lookup - **Refers To**: Vehicle ## 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. - [FleetAssetChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_change_event.htm): Change events are available for the object. - [FleetAssetFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_feed.htm): Feed tracking is available for the object. - [FleetAssetHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_history.htm): History is available for tracked fields of the object. # FleetParticipant Represents the relationship between a fleet and a participant, such as an account, a contact, or a user. This object is available in API version 59.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### EffectiveEndDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date until when a participant is associated with a fleet. ### EffectiveStartDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date from when a participant is associated with a fleet. ### FleetId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The fleet associated with the Fleet Participant record. This field is a relationship field. - **Relationship Name**: Fleet - **Relationship Type**: Lookup - **Refers To**: Fleet ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user referenced this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user viewed this record. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The autopopulated name of a Fleet Participant record. ### ParticipantId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The participant associated with a Fleet, such as an account, a user, or a contact. This field is a polymorphic relationship field. - **Relationship Name**: Participant - **Relationship Type**: Lookup - **Refers To**: Account, Contact, User ### ParticipantRole - **Type**: picklist - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The role of a participant associated with a fleet. Possible values are: Driver, Maintenance Associate, Manager, or Operations Manager. ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Specifies the status of the participant in relation to a fleet. Possible values are: Active, Inactive, or Resigned. ## 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. - [FleetParticipantChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_change_event.htm): Change events are available for the object. - [FleetParticipantFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_feed.htm): Feed tracking is available for the object. - [FleetParticipantHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_history.htm): History is available for tracked fields of the object. # Flow for Automotive Cloud Represents the metadata associated with a flow. With Flow, you can create an application that navigates users through a series of screens to query and update records in the database. You can also execute logic and provide branching capability based on user input to build dynamic applications. ## FlowActionCall Automotive Cloud exposes additional actionType values for the FlowActionCall Metadata type. For more information on Flow and FlowActionCall Metadata Type, see [Flow](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_visual_workflow.htm).
Field Name Field Type Description
actionType InvocableActionType (enumeration of type string) Required. The action type. Additional valid values only for Automotive Cloud include:
  • replenishInventoryUsingPolicy—Executes inventory policy to identify stock shortages, determine the optimal source location, and automate replenishment. Available in API version 65.0 and later.
  • scheduleSvcApptActnblEvntOrch—Creates service appointments in response to actionable events by identifying work type and assigning service territories. Available in API version 63.0 and later.
  • transformMfgProgramForecasts—Submits a message to a queue service to asynchronously process and transform manufacturing program forecasts. Available in API version 64.0 and later.
# GenericVisitTask Represents information about a task that can be performed during a visit. This object is available in Automotive Cloud in API version 56.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### DefinitionReferenceId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The definition record associated with the runtime record. The value is null when the definition record is created. This field is a relationship field. - **Relationship Name**: DefinitionReference - **Relationship Type**: Lookup - **Refers To**: GenericVisitTask ### Description - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The description of the task. ### EndDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The end date and time of the visit task. ### IsDefinition - **Type**: boolean - **Properties**: Defaulted on create, Filter, Group, Sort - **Description**: Indicates whether the record is a definition record. The default value is false. ### IsRequired - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether a task must be completed to complete a visit. The default value is false. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user referenced this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user viewed this record. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: Name of the generic visit task. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: ID of the generic visit task record owner. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### Sequence - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The sequence in which the visit task can be performed. ### StartDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The start date and time of the visit task. ### Status - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Specifies the status of the generic visit task. Possible values are: The default value is Is Defined. Completed, In Progress, Is Defined, or Not Started. ### StatusCode - **Type**: picklist - **Properties**: Defaulted on create, Filter, Group, Restricted picklist, Sort - **Description**: Specifies the status code of the generic visit task. Possible values are: The default value is IsDefined. - Completed - InProgress— In Progress - IsDefined— Is Defined - NotStarted— Not Started ### VisitId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The visit associated with the record. This field is a relationship field. - **Relationship Name**: Visit - **Relationship Type**: Lookup - **Refers To**: Visit ## 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. - [GenericVisitTaskFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_feed.htm): Feed tracking is available for the object. - [GenericVisitTaskHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_history.htm): History is available for tracked fields of the object. - [GenericVisitTaskOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_ownersharingrule.htm): Sharing rules are available for the object. - [GenericVisitTaskShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_share.htm): Sharing is available for the object. # GenericVisitTaskContext Represents the context or purpose for a generic visit task. This object is available in Automotive Cloud in API version 56.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### ContextId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the record that’s taken as the context for the visit task. For example, if a key performance indicator is recorded for a warranty of an asset, the Asset and the Warranty records are the contexts of the visit task. This field is a polymorphic relationship field. - **Relationship Name**: Context - **Relationship Type**: Lookup - **Refers To**: Account, Account\_\_c, AcctMgrTarget, AdvAccountForecastFact, AdvAcctForecastSetPartner, AdvAcctForecastSetUse, Assessment, AssessmentIndicatorDefinition, AssessmentQuestion, AssessmentQuestionAssignment, AssessmentQuestionResponse, AssessmentQuestionSet, AssessmentQuestionVersion, AssessmentTask, AssessmentTaskContentDocument, AssessmentTaskDefinition, Asset, AssetAccountParticipant, AssetContactParticipant, AssetMilestone, AssetRelationship, AssetWarranty, BusinessMilestone, BusinessProfile, Case, CommSubscriptionConsent, Contact, ContactRequest, Contract, EngagementAttendee, EngagementInteraction, EngagementTopic, GenericVisitTask, GenericVisitTaskContext, GnrcVstKeyPerformanceInd, GnrcVstTaskContextRelation, Image, InfoAuthorizationRequest, Lead, LeadLineItem, LeadPreferredSeller, ListEmail, Location, ManufacturingProgram, MfgProgramCpntFrcstFact, MfgProgramForecastFact, MfgProgramVariantFrcstFact, MultipartyInfoAuthRequest, OmniProcessAsmtQuestionVer, Opportunity, OpportunityPreferredSeller, Order, Organization, PartyConsent, PartyRelationshipGroup, PersonLifeEvent, PgmRebateTypBnftMapping, ProcessException, Product2, ProductCatalog, ProductCategory, ProductItem, ProductRelatedMaterial, ProductRequest, ProductRequestLineItem, ProductTransfer, ProgramRebateTypPayoutSrc, ProgramRebateType, ProgramRebateTypeBenefit, ProgramRebateTypeFilter, ProgramRebateTypePayout, ProgramRebateTypeProduct, ProgramRebateTypeReference, PurchaseQuantityRule, RebateClaim, RebateMemberAggregateItem, RebateMemberProductAggregate, RebatePayment, RebatePayoutAdjustment, RebateProgram, RebateProgramMember, RebateProgramMemberPayout, RebateProgramPayoutPeriod, ReceivedDocument, RecordAlert, SalesAgreement, ServiceAppointment, ServiceResource, Shipment, ShipmentItem, Solution, Supplier, TagCategory, UnitOfMeasureConversion, Vehicle, VehicleDefinition, Visit, VisitedParty, WarrantyTerm, WorkOrder, WorkOrderLineItem ### DefinitionReferenceId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The definition record associated with the runtime record. The value is null when the definition record is created. This field is a relationship field. - **Relationship Name**: DefinitionReference - **Relationship Type**: Lookup - **Refers To**: GenericVisitTaskContext ### Description - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The description of the visit task context. ### EndDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The end date and time of the visit task context in a visit. ### IsDefinition - **Type**: boolean - **Properties**: Defaulted on create, Filter, Group, Sort - **Description**: Indicates whether the record is a definition record. The default value is false. ### IsRequired - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the visit task context associated with the record is mandatory. The default value is false. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user referenced this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user viewed this record. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: Autogenerated unique identifier for the visit task context record. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: ID of the visit task context record owner. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### StartDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The start date and time of the visit task context in a visit. ### Status - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Specifies the status of the visit task context. Possible values are: The default value is Is Defined. Completed, In Progress, Is Defined, or Not Started. ### StatusCode - **Type**: picklist - **Properties**: Defaulted on create, Filter, Group, Restricted picklist, Sort - **Description**: Specifies the status code of the visit task context. Possible values are: The default value is IsDefined. - Completed - InProgress—In Progress - IsDefined—Is Defined - NotStarted—Not Started ### VisitId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The visit associated with the record. This field is a relationship field. - **Relationship Name**: Visit - **Relationship Type**: Lookup - **Refers To**: Visit ## 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. - [GenericVisitTaskContextFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_feed.htm): Feed tracking is available for the object. - [GenericVisitTaskContextHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_history.htm): History is available for tracked fields of the object. - [GenericVisitTaskContextOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_ownersharingrule.htm): Sharing rules are available for the object. - [GenericVisitTaskContextShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_share.htm): Sharing is available for the object. # GnrcVstKeyPerformanceInd Represents the key performance indicators that can be recorded while performing a task during a visit. You can compare the expected and actual metric values with the key performance indicator records. This object is available in Automotive Cloud in API version 56.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### ActualBooleanValue - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The actual boolean value recorded by the visitor for a key performance indicator. Possible values are: False, or True. ### ActualDateTimeValue - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The actual date and time value recorded by the visitor for a key performance indicator. ### ActualDecimalValue - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The actual decimal value recorded by the visitor for a key performance indicator. ### ActualIntegerValue - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The actual integer value recorded by the visitor for a key performance indicator. ### ActualStringValue - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The actual string value recorded by the visitor for a key performance indicator. ### AssessmentIndDefinitionId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The assessment indicator definition associated with the record. This field is a relationship field. - **Relationship Name**: AssessmentIndDefinition - **Relationship Type**: Lookup - **Refers To**: AssessmentIndicatorDefinition ### DefinitionReferenceId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The definition record associated with the runtime record. The value is null when the definition record is created. This field is a relationship field. - **Relationship Name**: DefinitionReference - **Relationship Type**: Lookup - **Refers To**: GnrcVstKeyPerformanceInd ### ExpectedBooleanValue - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The expected boolean value defined by a manager for a key performance indicator. Possible values are: False, or True. ### ExpectedDateTimeValue - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The expected date and time value defined by a manager for a key performance indicator. ### ExpectedDecimalValue - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The expected decimal value defined by a manager for a key performance indicator. ### ExpectedIntegerValue - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The expected integer value defined by a manager for a key performance indicator. ### ExpectedStringValue - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The expected string value defined by a manager for a key performance indicator. ### IsDefinition - **Type**: boolean - **Properties**: Defaulted on create, Filter, Group, Sort - **Description**: Indicates whether the record is a definition (true) or not (false). The default value is false. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user referenced this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user viewed this record. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Autogenerated unique identifier for the key performance indicator record. ### SequenceNumber - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The sequence in which the key performance indicator can be recorded. ### UnitOfMeasure - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: The unit of measure associated with the key performance indicator. Possible values are: The default value is Unit. Kilogram, Litre, Pack, or Unit. ### VisitTaskContextId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The visit task context associated with the record. This field is a relationship field. - **Relationship Name**: VisitTaskContext - **Relationship Type**: Lookup - **Refers To**: GenericVisitTaskContext ## 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. - [GnrcVstKeyPerformanceIndFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_feed.htm): Feed tracking is available for the object. - [GnrcVstKeyPerformanceIndHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_history.htm): History is available for tracked fields of the object. # GnrcVstTaskContextRelation Represents common attributes used for a visit task and a visit task context. This object is available in Automotive Cloud in API version 56.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user referenced this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user viewed this record. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Autogenerated unique identifier for the visit task context relation record. ### VisitTaskContextId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The visit task context associated with the record. This field is a relationship field. - **Relationship Name**: VisitTaskContext - **Relationship Type**: Lookup - **Refers To**: GenericVisitTaskContext ### VisitTaskContextSequence - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The sequence in which the visit task context that’s associated with the record can be performed. ### VisitTaskId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The visit task associated with the record. This field is a relationship field. - **Relationship Name**: VisitTask - **Relationship Type**: Lookup - **Refers To**: GenericVisitTask ## 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. - [GnrcVstTaskContextRelationFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_feed.htm): Feed tracking is available for the object. - [GnrcVstTaskContextRelationHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_history.htm): History is available for tracked fields of the object. # Holiday Represents a period during which a service resource is unavailable for appointment scheduling. Recurring holidays are not supported in Automotive Cloud. This object is available in API version 58.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update(), upsert() ## Special Access Rules Automotive and Automotive Scheduler must be enabled. ## Fields ### Description - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Text description of the holiday. ### EndTimeInMinutes - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The end time of the holiday in minutes. ### IsAllDay - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the duration of the holiday is all day (true) or not (false). The default value is false. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the holiday. ### StartTimeInMinutes - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The start time of the holiday in minutes. # Identity Verification and Engagements in Automotive Cloud The Identity Verification data model is used in configuring the process to verify the identity of a caller before their requests are processed by a customer service representative (CSR) in the Service Console for Automotive. The engagement data model is used to store details about an interaction between a caller and a CSR, after the identity of the caller is verified and the CSR is working in the console.
Available in: Enterprise, Unlimited, and Developer Editions.
For more information on Engagements, see [Engagement Data Model](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/engagement_data_model.htm). For more information on Identity Verification, see [Identity Verification](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/identity_verification.htm). # Inbound Event Output representation of the events processing request during incoming events. ## Sample Response { "sourceSystemIdentifier": "123", "status": "SUCCESS", "errors": \[ { "code": "CREATE\_OR\_UPDATE\_RECORD\_FAILED", "message": "Object: Vehicle, Error Message: duplicate value found: VehicleIdentificationNumber duplicates value on record with id: 0vLxx0000002d7eAI" } \], "actionResponse": \[ { "actionName": "action1", "actionOutput": { "key1": "value1", "key2": "value2" } }, { "actionName": "action2", "actionOutput": { "key1": "value1", "key2": "value2" } } \] } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | action​Response | [Action Response\[\]](connect_responses_action_response.htm "Output representation of the action response of an inbound event.") | Action response of the inbound events. | Small, 60.0 | 60.0 | | errors | [Error Response\[\]](connect_responses_error_message.htm "Output representation of the details of errors encountered during an API request execution.") | Error details if the request failed to process. | Small, 59.0 | 59.0 | | source​System​Identifier | String | Event ID that correlates to the inbound event. | Small, 59.0 | 59.0 | | status | String | Status of the inbound event API. | Small, 59.0 | 59.0 | # Inbound Event Input Input representation of the request to process incoming events from a telematics provider. ## JSON Example with Engine Overheating and Low Battery Fault { "sourceSystemIdentifier": "102", "type": "Transmission Issue", "subtype": "Transmission Over Temperature", "category": "FAULT", "eventData": "{"Event":{"vin":"EFGHTYUIF56789GH","id":"0vLSE00000000G92AI","businessSObjectType":"Vehicle","faults":\[{"code":"P0218","type":"repair","description":"Engine Overheating"},{"code":"P0219","type":"repair","description":"Low Battery Warning"}\],"location":{"latitude":34,"longitude":56},"signals":\[{"value":"34","timeStamp":"2023-05-16T15:13:41.236Z","dataType":"string","unit":"cm","name":"speed"}\]}}", "additionalEventCriteria": { "fieldList": \[ { "field": "priority\_\_c", "value": "high" } \] } } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | additional​EventCriteria | [Additional Criteria Input](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/connect_requests_additional_criteria.htm "Input representation of the additional event criteria generated during inbound events.") | Additional criteria for event processing. It captures additional attributes of telematics events in key-value pairs for tailored actions and workflows based on specific events. | Optional | 60.0 | | category | String | Category of the inbound event. | Optional | 60.0 | | eventData | String | Data associated with the event from telematics provider. | Optional | 60.0 | | sourceSystem​Identifier | String | ID to identify the source system. | Optional | 60.0 | | subtype | String | Subtype of the inbound event. | Optional | 60.0 | | type | String | Type of the inbound event. | Optional | 60.0 | # IndustriesAutomotiveSettings Represents the settings for enabling features like Automotive Cloud, Automotive Service Excellence, and Automotive Scheduler. This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm "HTML (New Window)") metadata type and inherits its fullName field. In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm "HTML (New Window)") for more details. ## File Suffix and Directory Location IndustriesAutomotiveSettings values are stored in a single file named IndustriesAutomotive.settings in the settings directory. ## Version IndustriesAutomotiveSettings components are available in API version 56.0 and later. ## Fields ### enableAutoAgentsPilot - **Field Type**: boolean - **Description**: Reserved for future use. ### enableAutomotiveAgents - **Field Type**: boolean - **Description**: Indicates whether the Automotive Agents feature of Automotive Cloud is enabled (true) or disabled (false) for your org. This field is available from API version 64.0 and later. - **Default value**: false ### enableAutomotiveServiceAgents - **Field Type**: boolean - **Description**: Indicates whether the Automotive Service Agents feature of Automotive Cloud is enabled (true) or disabled (false) for your org. This field is available from API version 67.0 and later. - **Default value**: false ### enableAutomotiveAppraisals - **Field Type**: boolean - **Description**: Indicates whether the automotive components for Appraisal Management feature of Automotive Cloud is enabled (true) or disabled (false) for your org. This field is available from API version 63.0 and later. - **Default value**: false ### enableAutomotiveCloud - **Field Type**: boolean - **Description**: Indicates whether the Automotive Cloud is enabled (true) or disabled (false) for your org. This field is available from API version 56.0 and later. - **Default value**: false ### enableAutomotiveScheduler - **Field Type**: boolean - **Description**: Indicates whether the Salesforce Scheduler feature of Automotive Cloud are enabled (true) or disabled (false) for your org. This field is available from API version 58.0 and later. - **Default value**: false ### enableAutomotiveServiceExcellence - **Field Type**: boolean - **Description**: Indicates whether the Service Excellence feature of Automotive Cloud are enabled (true) or disabled (false) for your org. This field is available from API version 56.0 and later. - **Default value**: false ### enableConnectedVehSrvcsCmpnt - **Field Type**: boolean - **Description**: Indicates whether the Connected Vehicle Services component feature of Automotive Cloud is enabled (true) or disabled (false) for your org. This field is available from API version 63.0 and later. - **Default value**: false ### enableDealerEssntlsAutomotive - **Field Type**: boolean - **Description**: Indicates whether the Dealer Essentials for Automotive feature of Automotive Cloud is enabled (true) or disabled (false) for your org. This field is available from API version 63.0 and later. - **Default value**: false ### enableGenAiForAutoPilot - **Field Type**: boolean - **Description**: Reserved for future use. ## Declarative Metadata Sample Definition The following is an example of a IndustriesAutomotiveSettings component. false false false false false false true false The following is an example package.xml that references the previous definition. IndustriesAutomotiveSettings Settings 56.0 # IndustriesEventOrchSettings Represents the settings for enabling Automotive cloud feature like Event Orchestration Decision Table. ## Parent Type and Manifest Access This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm "HTML (New Window)") metadata type and inherits its fullName field. In the package manifest, all the settings metadata types for the org are accessed using the “Settings” name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm "HTML (New Window)") for more details. ## File Suffix and Directory Location IndustriesEventOrchSettings values are stored in the v.settings file in the settings folder. The .settings files are different from other named components, because there is only one settings file for each settings component. ## Version IndustriesEventOrchSettings components are available in API version 60.0 and later. ## Fields ### enableEventOrchDecisionTable - **Description**: Indicates whether the Event Orchestration Decision Table feature of Automotive Cloud is enabled (true) or disabled (false) for your org. - **Default value**: false ## Declarative Metadata Sample Definition The following is an example of an IndustriesEventOrchSettings component. true The following is an example package.xml that references the previous definition. IndustriesEventOrchSettings Settings 60.0 ## Wildcard Support in the Manifest File The wildcard character \* (asterisk) in the package.xml manifest file doesn’t apply to metadata types for feature settings. The wildcard applies only when retrieving all settings, not for an individual setting. For details, see [Settings](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm "HTML (New Window)"). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm "HTML (New Window)"). # IndustriesManufacturingSettings Represents the settings for enabling features like Partner Lead Management, Partner Performance Management, Partner Visit Management, and Fleet Management. You also get access to settings for enabling features like Advanced Account Forecasts, Account Forecasts, Account Manager Targets, Manufacturing Programs, and Sales Agreements. This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm "HTML (New Window)") metadata type and inherits its fullName field. In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm "HTML (New Window)") for more details. ## File Suffix and Directory Location IndustriesManufacturingSettings values are stored in a single file named IndustriesManufacturing.settings in the settings directory. ## Version IndustriesManufacturingSettings components are available in API version 47.0 and later. ## Fields ### enableIndManufacturing - **Field Type**: boolean - **Description**: Indicates whether the Sales Agreements feature of Manufacturing cloud is enabled (true) or disabled (false) for your org. - **Default value**: false ### enableIndustriesMfgAccountForecast - **Field Type**: boolean - **Description**: Indicates whether the Account Forecasts feature of Manufacturing cloud is enabled (true) or disabled (false) for your org. - **Default value**: false ### enableIndustriesMfgAdvForecast - **Field Type**: boolean - **Description**: Indicates whether the Advanced Account Forecasting feature of Manufacturing cloud is enabled (true) or disabled (false) for your org. - **Default value**: false ### enableIndustriesMfgIAS - **Field Type**: boolean - **Description**: Indicates whether the Default Analytics Dashboards setting, available with the Sales Agreements feature, of Manufacturing cloud is enabled (true) or disabled (false) for your org. - **Default value**: false ![Note](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/images/icon_note.png) #### Note This feature is a Beta Service. Customer may opt to try such Beta Service in its sole discretion. Any use of the Beta Service is subject to the applicable Beta Services Terms provided at [Agreements and Terms](https://www.salesforce.com/company/legal/agreements/ "HTML (New Window)"). ### enableIndustriesMfgProgram - **Field Type**: boolean - **Description**: Indicates whether the Manufacturing Programs (program-based business) feature of Manufacturing cloud is enabled (true) or disabled (false) for your org. Available in API version 54.0 and later. - **Default value**: false ### enableIndustriesMfgTargets - **Field Type**: boolean - **Description**: Indicates whether the Account Manager Targets feature of Manufacturing cloud is enabled (true) or disabled (false) for your org. This field is available from API version 49.0 and later. - **Default value**: false ### enablePartnerLeadManagement - **Field Type**: boolean - **Description**: Indicates whether the Partner Lead Management feature is enabled (true) or disabled (false) for your org. This field is available from API version 56.0 and later. - **Default value**: false ### enablePartnerPerformanceManagement - **Field Type**: boolean - **Description**: Indicates whether the Partner Performance Management feature is enabled (true) or disabled (false) for your org. This field is available from API version 56.0 and later. - **Default value**: false ### enablePartnerVisitManagement - **Field Type**: boolean - **Description**: Indicates whether the Partner Visit Management feature is enabled (true) or disabled (false) for your org. This field is available from API version 56.0 and later. - **Default value**: false ### enableFleetManagement - **Field Type**: boolean - **Description**: Indicates whether the Fleet Management feature is enabled (true) or disabled (false) for your org. This field is available from API version 59.0 and later. - **Default value**: false ### enableFundingWorkbench - **Field Type**: boolean - **Description**: Indicates whether the Funding Workbench feature of Automotive cloud is enabled (true) or disabled (false) for your org. This field is available from API version 66.0 and later. - **Default value**: false ## Declarative Metadata Sample Definition The following is an example of a IndustriesManufacturingSettings component. false false false false false false false false false false false The following is an example package.xml that references the previous definition. IndustriesManufacturing Settings 56.0 # IndustriesSettings Represents the settings for enabling features like Criteria-Based Search and Filter that’s used for vehicle inventory visibility. This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/auto_metadata_api_types.htm "Metadata API enables you to access some types and feature settings that you can customize in the user interface. For more information about Metadata API and to find a complete reference of existing metadata types, see Metadata API Developer Guide.") metadata type and inherits its fullName field. ![Important](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. Because changing terms in our code can break current implementations, we maintained this metadata type’s name. In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/auto_metadata_api_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type. For more information, see Settings.") for more details. ## File Suffix and Directory Location IndustriesSettings are stored in a single file named Industries.settings in the settings directory. ## Version Industries settings are available in API version 47.0 and later. ## Special Access Rules Settings are specific to an industry vertical and are only available to customers with org editions where the vertical is enabled. ## Fields for Automotive Cloud ### enableCriteriaBasedSearchAndFilter - **Field Type**: boolean - **Description**: Indicates whether Criteria-Based Search and Filter is enabled (true) or disabled (false) for your org. This field is available in editions where Automotive Cloud is enabled. - **Default value**: false ### enableAppraisalMgmt - **Field Type**: boolean - **Description**: Indicates whether Appraisal Management is enabled (true) or disabled (false) for your org.. This field is available in editions where Automotive Cloud is enabled and from API version 63.0 and later. - **Default value**: false ## Declarative Metadata Sample Definition The following is an example of an Industries.Settings metadata component. true true The following is an example package.xml that references the previous definition. Industries Settings 47.0 # Interest Tags in Automotive Cloud Configure a common interest tag dictionary that users can use to consistently tag records such as vehicles, or leads.
Available in: Enterprise, Unlimited, and Developer Editions.
For more information about the resources of Interest Tags and how to use them, see the [Interest Tagging](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/interest_tagging_parent.htm) section of the Industries Common Resources Developer Guide. # Introduction to Automotive Cloud Developer Guide This guide provides information on the objects and APIs used by Automotive Cloud. You can also find developer resources for features that can be used to extend Automotive Cloud.
Available in: Enterprise, Unlimited, and Developer Editions.
The Automotive Cloud data model provides a set of objects and fields that you can use to store and manage information about vehicles, parts, and accessories. You can track and manage all stakeholders involved in the lifecycle of a vehicle, and you can use features such as Action Plans, Records Alerts, Timeline, or Interest Tags to access and share additional information. Extend Automotive Cloud with other standard objects such as BusinessBrand, BusinessMilestone, LifeEvent, GeoCode, and UnitOfMeasure. Use the Engagement data model and Identity Verification to work with Service Console for Automotive. If you’re using sales agreements, advanced account forecasting, program-based business, and account manager targets, refer to [Manufacturing Cloud Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.mfg_api_devguide.meta/mfg_api_devguide/mfg_api_overview.htm). Automotive Cloud integration assets are available in MuleSoft Direct for customers to deploy to their MuleSoft instance. The integration APIs give the customers the flexibility to extend or customize the integrations as required. See the [Automotive Cloud Integrations API](https://developer.salesforce.com/docs/industries/automotive/guide/get-started-with-automotive-industry-integrations.html) guide for more information and details about the Automotive Cloud integration assets. # Inventory Actions Item Input Input representation to perform the inventory product transfer. ## JSON Example { "serializedProductId": "0jRxx000000009hEAA", "sourceLocationId": "131xx0000004FoLAAU", "destinationLocationId": "131xx0000004FpxAAE" } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | destinationLocationId | String | ID of the location to which a serialized product is transferred. | Required | 59.0 | | serializedProductId | String | ID of the serialized product that is to be transferred from the source to destination. | Required | 59.0 | | sourceLocationId | String | ID of the location from where a serialized product is to be transferred to its destination. | Required | 59.0 | # Inventory Actions Query Input Input representation to perform the inventory actions query. ## JSON Example { "items": \[ { "serializedProductId": "0jRxx000000009hEAA", "sourceLocationId": "131xx0000004FoLAAU", "destinationLocationId": "131xx0000004FpxAAE" }, { "serializedProductId": "0jRxx00000000BJEAY", "sourceLocationId": "131xx0000004FoLAAU", "destinationLocationId": "131xx0000004FpxAAE" }, { "serializedProductId": "0jRxx00000000CvEAI", "sourceLocationId": "131xx0000004FoLAAU", "destinationLocationId": "131xx0000004FpxAAE" } \] } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | items | [Inventory Actions Item Input](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/connect_requests_inventory_actions_input_item.htm "Input representation to perform the inventory product transfer.")\[\] | Details to perform the inventory product transfer. | Required | 59.0 | # Inventory Actions Result Output representation of the results for the vehicle inventory transfer action search. ## Sample Response { "errors": {}, "results": { "0jRxx00000000rG": "0Luxx0000004Cc4CAE", "0jRxx00000000sr": "0Luxx0000004Cc4CAE" } } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | errors | Map | Details of the error message returned if the request failed to retrieve the product transfer action. | Small, 59.0 | 59.0 | | results | Map | Details of the retrieved product transfer records. | Small, 59.0 | 59.0 | # Inventory Objects in Automotive Cloud Automotive Cloud provides access to standard objects that you can use to organize products, track their movement, and monitor suppliers. You can access these objects when Automotive Cloud is enabled in your org.
Available in: Enterprise, Unlimited, and Developer Editions.
For more information about the objects you can use to manage and track products, locations, and suppliers, refer to these resources. - [AssociatedLocation](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_associatedlocation.htm) - [ProductAttribute](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_productattribute.htm) - [ProductAttributeSet](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_productattributeset.htm) - [ProductAttributeSetItem](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_productattributesetitem.htm) - [ProductAttributeSetProduct](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_productattributesetproduct.htm) - [ProductConsumed](https://developer.salesforce.com/docs/atlas.en-us.264.0.sfFieldRef.meta/sfFieldRef/salesforce_field_reference_ProductConsumed.htm) - [ProductConsumedState](https://developer.salesforce.com/docs/atlas.en-us.264.0.sfFieldRef.meta/sfFieldRef/salesforce_field_reference_ProductConsumedState.htm) - [ProductItem](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_productitem.htm) - [ProductItem Transaction](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_productitemtransaction.htm) - [ProductFulfillmentLocation](https://developer.salesforce.com/docs/atlas.en-us.264.0.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_hc_productfulfillmentlocation.htm) - [ProductMedia](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_productmedia.htm) - [ProductRequest](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_productrequest.htm) - [ProductRequestLineItem](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_productrequestlineitem.htm) - [ProductRequired](https://developer.salesforce.com/docs/atlas.en-us.264.0.sfFieldRef.meta/sfFieldRef/salesforce_field_reference_ProductRequired.htm) - [ProductTransfer](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_producttransfer.htm) - [ReturnOrder](https://developer.salesforce.com/docs/atlas.en-us.264.0.sfFieldRef.meta/sfFieldRef/salesforce_field_reference_ReturnOrder.htm) - [SerializedProduct](https://developer.salesforce.com/docs/atlas.en-us.264.0.sfFieldRef.meta/sfFieldRef/salesforce_field_reference_SerializedProduct.htm) - [SerializedProductTransaction](https://developer.salesforce.com/docs/atlas.en-us.264.0.sfFieldRef.meta/sfFieldRef/salesforce_field_reference_SerializedProductTransaction.htm) - [Shipment](https://developer.salesforce.com/docs/atlas.en-us.264.0.sfFieldRef.meta/sfFieldRef/salesforce_field_reference_Shipment.htm) - [ShipmentItem](https://developer.salesforce.com/docs/atlas.en-us.264.0.sfFieldRef.meta/sfFieldRef/salesforce_field_reference_ShipmentItem.htm) - [Supplier](https://developer.salesforce.com/docs/atlas.en-us.264.0.sfFieldRef.meta/sfFieldRef/salesforce_field_reference_Supplier.htm) - [SupplierProduct](https://developer.salesforce.com/docs/atlas.en-us.264.0.sfFieldRef.meta/sfFieldRef/salesforce_field_reference_SupplierProduct.htm) # Inventory Visibility Product Transfer Action Returns the results for vehicle inventory transfer action search based on the inventory visibility actions configuration defined by the admin. ## Resource /connect/inventory-visibility/actions ## Example https://yourInstance.salesforce.com/services/data/v68.0/connect/inventory-visibility/actions ## Available Version 59.0 ## Requires Chatter No ## HTTP Methods POST ## Request Parameters for POST
Parameter Name Type Description Required or Optional Available Version
actionName String The name of the inventory action type. This list is based on the inventory visibility action configuration. Possible value is:
  • ProductTransfer
 Required 59.0
## Request Body for POST ### JSON Example { "items": \[ { "serializedProductId": "0jRxx000000009hEAA", "sourceLocationId": "131xx0000004FoLAAU", "destinationLocationId": "131xx0000004FpxAAE" }, { "serializedProductId": "0jRxx00000000BJEAY", "sourceLocationId": "131xx0000004FoLAAU", "destinationLocationId": "131xx0000004FpxAAE" }, { "serializedProductId": "0jRxx00000000CvEAI", "sourceLocationId": "131xx0000004FoLAAU", "destinationLocationId": "131xx0000004FpxAAE" } \] } ### Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | items | [Inventory Actions Item Input](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/connect_requests_inventory_actions_input_item.htm "Input representation to perform the inventory product transfer.")\[\] | Details to perform the inventory product transfer. | Required | 59.0 | ## Response Body for POST [Inventory Actions Result](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/connect_responses_inventory_actions_result.htm "Output representation of the results for the vehicle inventory transfer action search.") # LeadLineItem Represents items such as vehicles, accessories, and parts that a lead is interested in. This object is available in API version 56.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### ApprovalStatus - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The approval status of the associated product. Possible values are: Approved, In Review, On Hold, or Rejected. ### AssetIdentificationNumber - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unique identifier of the associated product, such as a vehicle identification number or serial number of an accessory. ### Classification - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the classification type of the associated item such as new, used, or refurbished. Possible values are: New, Refurbished, or Used. ### Condition - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the condition of the associated item, such as excellent, fair, or unknown. Possible values are: Excellent, Fair, Good, Poor, or Unknown. ### InterestType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the lead's interest type such as buying an item, selling an item, leasing an item, and so on. Possible values are: - Buy - Lease - Sell - TestDrive—Test Drive - TradeIn—Trade-In ### ItemType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the type of item that the lead is interested in, such as a vehicle, parts of a vehicle, other accessories, and so on. Possible values are: Accessory, Part, Service, or Vehicle. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user referenced this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user viewed this record. ### LeadId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The parent Lead record that's associated with this line item. This field is a relationship field. - **Relationship Name**: Lead - **Relationship Type**: Lookup - **Refers To**: Lead ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the lead line item. ### PriceType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the type of price, such as quote, offer, or appraisal, associated with the item. Possible values are: - AppraisedCost— Appraised Cost - AskingPrice— Asking Price - InvoiceCost— Invoice Cost - MSRP— Manufacturer's Suggested Retail Price - OfferPrice— Offer Price - QuotePrice— Quote Price ### ProductId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The Product record associated with this line item. This field is a relationship field. - **Relationship Name**: Product - **Relationship Type**: Lookup - **Refers To**: Product2 ### Quantity - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The number of units of the item that the lead is interested in. ### UnitPrice - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The price per unit of the associated product. ## 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. - [LeadLineItemChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_change_event.htm): Change events are available for the object. - [LeadLineItemFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_feed.htm): Feed tracking is available for the object. - [LeadLineItemHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_history.htm): History is available for tracked fields of the object. # LeadPreferredSeller Represents the relationship between a lead and the dealer account that the lead selects, or the relationship between a lead and the account that provides the lead. This object is available in API version 56.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AccountId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The associated Account record. This field is a relationship field. - **Relationship Name**: Account - **Relationship Type**: Lookup - **Refers To**: Account ### AccountRole - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The role of the Account in relation to the associated Lead, such as the Lead's preferred dealer or lead provider. Possible values are: - Dealer - LeadProvider—Lead Provider ### ContactId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The associated Contact record. This field is a relationship field. - **Relationship Name**: Contact - **Relationship Type**: Lookup - **Refers To**: Contact ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user referenced this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user viewed this record. ### LeadId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The associated Lead record. This field is a relationship field. - **Relationship Name**: Lead - **Relationship Type**: Lookup - **Refers To**: Lead ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the lead preferred seller. ## 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. - [LeadPreferredSellerChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_change_event.htm): Change events are available for the object. - [LeadPreferredSellerFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_feed.htm): Feed tracking is available for the object. - [LeadPreferredSellerHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_history.htm): History is available for tracked fields of the object. # Lending Objects with Automotive Cloud Automotive Cloud provides access to Digital Lending objects that you can use to support the end-to-end lending lifecycle across automotive loan and lease products. Get access to a platform that serves as both the point-of-sale and loan origination system. You can access these objects when Digital Lending and Vehicle and Asset Lending are enabled in your org.
Available in: Enterprise, Unlimited, and Developer Editions.
For more information about the objects you can use to manage automotive lending processes, refer to these resources. - [Applicant](https://developer.salesforce.com/docs/atlas.en-us.264.0.financial_services_cloud_object_reference.meta/financial_services_cloud_object_reference/sforce_api_objects_applicant.htm) - [Application Action Item](https://developer.salesforce.com/docs/atlas.en-us.264.0.financial_services_cloud_object_reference.meta/financial_services_cloud_object_reference/sforce_api_objects_applicationactionitem.htm) - [Application Form](https://developer.salesforce.com/docs/atlas.en-us.264.0.financial_services_cloud_object_reference.meta/financial_services_cloud_object_reference/sforce_api_objects_applicationform.htm) - [Application Form Evaluation](https://developer.salesforce.com/docs/atlas.en-us.264.0.financial_services_cloud_object_reference.meta/financial_services_cloud_object_reference/sforce_api_objects_applicationformevaluation.htm) - [Application Form Participant](https://developer.salesforce.com/docs/atlas.en-us.264.0.financial_services_cloud_object_reference.meta/financial_services_cloud_object_reference/sforce_api_objects_applicationformparticipant.htm) - [Application Form Product](https://developer.salesforce.com/docs/atlas.en-us.264.0.financial_services_cloud_object_reference.meta/financial_services_cloud_object_reference/sforce_api_objects_applicationformproduct.htm) - [Application Form Product Deviations](https://developer.salesforce.com/docs/atlas.en-us.264.0.financial_services_cloud_object_reference.meta/financial_services_cloud_object_reference/sforce_api_objects_applicationformproductdev.htm) - [Application Form Product Fee](https://developer.salesforce.com/docs/atlas.en-us.264.0.financial_services_cloud_object_reference.meta/financial_services_cloud_object_reference/sforce_api_objects_applicationformproductfee.htm) - [Application Form Product Participant](https://developer.salesforce.com/docs/atlas.en-us.264.0.financial_services_cloud_object_reference.meta/financial_services_cloud_object_reference/sforce_api_objects_appformproductparticipant.htm) - [Application Form Product Proposal](https://developer.salesforce.com/docs/atlas.en-us.264.0.financial_services_cloud_object_reference.meta/financial_services_cloud_object_reference/sforce_api_objects_applicationformproductproposal.htm) - [Application Form Product Proposal Attribute](https://developer.salesforce.com/docs/atlas.en-us.264.0.financial_services_cloud_object_reference.meta/financial_services_cloud_object_reference/sforce_api_objects_appformprodtprpsattribute.htm) - [Application Form Seller Item](https://developer.salesforce.com/docs/atlas.en-us.264.0.financial_services_cloud_object_reference.meta/financial_services_cloud_object_reference/sforce_api_objects_applicationformselleritem.htm) - [Application Form Term](https://developer.salesforce.com/docs/atlas.en-us.264.0.financial_services_cloud_object_reference.meta/financial_services_cloud_object_reference/sforce_api_objects_applicationformterm.xml) - [Deviations](https://developer.salesforce.com/docs/atlas.en-us.264.0.financial_services_cloud_object_reference.meta/financial_services_cloud_object_reference/sforce_api_objects_deviation.htm) - [Group](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_group.htm) - [Index Rate](https://developer.salesforce.com/docs/atlas.en-us.264.0.financial_services_cloud_object_reference.meta/financial_services_cloud_object_reference/sforce_api_objects_indexrate.htm) - [Information Verification](https://developer.salesforce.com/docs/atlas.en-us.264.0.financial_services_cloud_object_reference.meta/financial_services_cloud_object_reference/sforce_api_objects_informationverification.htm) - [Participant Role](https://developer.salesforce.com/docs/atlas.en-us.264.0.financial_services_cloud_object_reference.meta/financial_services_cloud_object_reference/sforce_api_objects_participantrole.htm) - [Party Credit Profile](https://developer.salesforce.com/docs/atlas.en-us.264.0.financial_services_cloud_object_reference.meta/financial_services_cloud_object_reference/sforce_api_objects_partycreditprofile.htm) - [Party Expense](https://developer.salesforce.com/docs/atlas.en-us.264.0.financial_services_cloud_object_reference.meta/financial_services_cloud_object_reference/sforce_api_objects_partyexpense.htm) - [Party Financial Asset](https://developer.salesforce.com/docs/atlas.en-us.264.0.financial_services_cloud_object_reference.meta/financial_services_cloud_object_reference/sforce_api_objects_partyfinancialasset.htm) - [Party Financial Asset Additional Owner](https://developer.salesforce.com/docs/atlas.en-us.264.0.financial_services_cloud_object_reference.meta/financial_services_cloud_object_reference/fsc_sforce_api_objects_partyfinclassetaddlowner.htm) - [Party Financial Asset Lien](https://developer.salesforce.com/docs/atlas.en-us.264.0.financial_services_cloud_object_reference.meta/financial_services_cloud_object_reference/sforce_api_objects_partyfinancialassetlien.htm) - [Party Financial Liab Additional Borrower](https://developer.salesforce.com/docs/atlas.en-us.264.0.financial_services_cloud_object_reference.meta/financial_services_cloud_object_reference/fsc_sforce_api_objects_partyfinclliabaddlbrwr.htm) - [Party Financial Liability](https://developer.salesforce.com/docs/atlas.en-us.264.0.financial_services_cloud_object_reference.meta/financial_services_cloud_object_reference/fsc_sforce_api_objects_partyfinancialliability.htm) - [Party Identity Verification](https://developer.salesforce.com/docs/atlas.en-us.264.0.financial_services_cloud_object_reference.meta/financial_services_cloud_object_reference/sforce_api_objects_partyidentityverification.htm) - [Party Income](https://developer.salesforce.com/docs/atlas.en-us.264.0.financial_services_cloud_object_reference.meta/financial_services_cloud_object_reference/sforce_api_objects_partyincome.htm) - [Party Profile](https://developer.salesforce.com/docs/atlas.en-us.264.0.financial_services_cloud_object_reference.meta/financial_services_cloud_object_reference/sforce_api_objects_partyprofile.htm) - [Party Profile Address](https://developer.salesforce.com/docs/atlas.en-us.264.0.financial_services_cloud_object_reference.meta/financial_services_cloud_object_reference/sforce_api_objects_partyprofileaddress.htm) - [Party Profile Participant](https://developer.salesforce.com/docs/atlas.en-us.264.0.financial_services_cloud_object_reference.meta/financial_services_cloud_object_reference/sforce_api_objects_partyprofileparticipant.htm) - [Party Profile Risk](https://developer.salesforce.com/docs/atlas.en-us.264.0.financial_services_cloud_object_reference.meta/financial_services_cloud_object_reference/sforce_api_objects_partyprofilerisk.htm) - [Party Screening Summary](https://developer.salesforce.com/docs/atlas.en-us.264.0.financial_services_cloud_object_reference.meta/financial_services_cloud_object_reference/sforce_api_objects_partyscreeningsummary.htm) - [Payment Mandate](https://developer.salesforce.com/docs/atlas.en-us.264.0.financial_services_cloud_object_reference.meta/financial_services_cloud_object_reference/sforce_api_objects_paymentmandate.htm) - [Person Employment](https://developer.salesforce.com/docs/atlas.en-us.264.0.financial_services_cloud_object_reference.meta/financial_services_cloud_object_reference/sforce_api_objects_personemployment.htm) - [Product Fee](https://developer.salesforce.com/docs/atlas.en-us.264.0.financial_services_cloud_object_reference.meta/financial_services_cloud_object_reference/sforce_api_objects_productfee.htm) - [Product List Rate](https://developer.salesforce.com/docs/atlas.en-us.264.0.financial_services_cloud_object_reference.meta/financial_services_cloud_object_reference/sforce_api_objects_productlistrate.htm) - [Program](https://developer.salesforce.com/docs/atlas.en-us.264.0.psc_api.meta/psc_api/sforce_api_objects_program.htm) - [Term](https://developer.salesforce.com/docs/atlas.en-us.264.0.financial_services_cloud_object_reference.meta/financial_services_cloud_object_reference/sforce_api_objects_term.xml) - [Term Related Object](https://developer.salesforce.com/docs/atlas.en-us.264.0.financial_services_cloud_object_reference.meta/financial_services_cloud_object_reference/sforce_api_objects_termrelatedobject.xml) # Object Details Output Represents the details of the transformation object. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | errorReason | String | Indicates the reason for transformation failure. | Small, 55.0 | 55.0 | | inputIds | String\[\] | The record IDs of the input object corresponding to the output object. | Small, 55.0 | 55.0 | | isSuccess | Boolean | Indicates if the transformation is successful (true) or not (false). | Small, 55.0 | 55.0 | | outputId | String | The output record ID. | Small, 55.0 | 55.0 | # ObjectHierarchyRelationship Represents an organization’s field mappings for conversion of a lead’s related records to an opportunity’s related records. Fields can be mapped from LeadLineItem and LeadPreferredSeller to OpportunityLineItem and OpportunityPreferredSeller respectively. This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm "HTML (New Window)") metadata type and inherits its fullName field. ![Note](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/images/icon_note.png) #### Note Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## File Suffix and Directory Location ObjectHierarchyRelationship components have the suffix ObjectHierarchyRelationship.settings and are stored in the ObjectHierarchyRelationship folder. ## Version ObjectHierarchyRelationship components are available in API version 51.0 and later. ## Fields ### childObjectMapping - **Field Type**: [ObjectMapping](#auto_metadata_api_objecthierarchyrelationship_objectmapping) - **Description**: Set of inputObject, mappingFields, and outputObject entries. For example, fields from the input object of LeadLineItem maps to fields of the output object of OpportunityLineItem. ### inputObjRecordsGrpFieldName - **Field Type**: string - **Description**: The field name in the input object used to group the records. This field is available in API version 55.0 and later. ### mappingType - **Field Type**: ObjHierarchyMappingType (enumeration of type string) - **Description**: Specifies the type of relationship between two objects. This field is available in API version 55.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/images/icon_note.png) #### Note Use ParentToParent - **Possible values**: - ChildToChild - ParentToChild - ParentToParent - Support ### masterLabel - **Field Type**: string - **Description**: Label name of the mapping definition. ### outputPntRelationshipFieldName - **Field Type**: string - **Description**: The field name that defines the relationship between a parent and child for the output object. This field is available in API version 55.0 and later. ### parentObjectMapping - **Field Type**: [ObjectMapping](#auto_metadata_api_objecthierarchyrelationship_objectmapping) - **Description**: Required. Set of inputObject, mappingFields, and outputObject entries. For example, fields from the input object of LeadLineItem maps to fields of the output object of OpportunityLineItem. ### parentRecord - **Field Type**: string - **Description**: The parent record for this object hierarchy relationship. This field is available in API version 55.0 and later. ### parentRelationshipFieldName - **Field Type**: string - **Description**: Name of the field that defines the relationship between the parent and child. ### usageType - **Field Type**: MappingUsageType (enumeration of type string) - **Description**: Required. Name of the usage type of an object hierarchy relationship. - **Possible values**: - ConvertToSalesAgreement - CLMFieldMapping - EligibleProgramRebateType - MapJournalToMemberAggregate - TransformationMapping ## ObjectMapping Represents a set of inputObject, mappingFields, and outputObject entries. ### inputObject - **Field Type**: string - **Description**: Required. Name of the input object type containing the source fields for mapping. For example, LeadLineItem or LeadPreferredSeller. ### mappingFields - **Field Type**: [ObjectMapping​Field](#auto_metadata_api_objecthierarchyrelationship_objectmappingfield) - **Description**: Mapping of source object input fields to target object ### outputObject - **Field Type**: string - **Description**: Required. Name of the output object type receiving data conversion. For example, OpportunityLineItem or OpportunityPreferredSeller. ## ObjectMappingField Represents a set of inputField and outputField entries. ### inputField - **Field Type**: string - **Description**: Required. Field in the object specified by the inputObject field in [ObjectMapping](#auto_metadata_api_objecthierarchyrelationship_objectmapping). This field is mapped to the field in outputField, which is a field in the object specified by the outputObject field in [ObjectMapping](#auto_metadata_api_objecthierarchyrelationship_objectmapping). ### outputField - **Field Type**: string - **Description**: Required. Field in the object specified by the outputObject field in [ObjectMapping](#auto_metadata_api_objecthierarchyrelationship_objectmapping). This field is mapped to the field name in inputField, which is a field in the object specified by the inputObject field in [ObjectMapping](#auto_metadata_api_objecthierarchyrelationship_objectmapping). ## Declarative Metadata Sample Definition The following is an example of a ObjectHierarchyRelationship component. LeadPreferredSeller OpportunityPreferredSeller AccountId AccountId AccountRole AccountRole Name Name ParentToParent TransformationMapping The following is an example package.xml that references the previous definition. \* ObjectHierarchyRelationship 56.0 ## Usage Use the deploy() call to deploy metadata with a .zip file. Every .zip file contains a project manifest, a file that’s named package.xml, and a set of directories that contain the components. The manifest file defines the components that you’re trying to retrieve or deploy in the .zip file. The manifest also defines the API version that’s used for the deployment or retrieval. ## Wildcard Support in the Manifest File This metadata type supports the wildcard character \* (asterisk) in the package.xml manifest file. For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm "HTML (New Window)"). # OpportunityPreferredSeller Represents the relationship between an opportunity and a dealer account, or the relationship between an opportunity and the account that provided the lead from which the opportunity was created. This object is available in API version 56.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AccountId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The associated Account record. This field is a relationship field. - **Relationship Name**: Account - **Relationship Type**: Lookup - **Refers To**: Account ### AccountRole - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The role of the Account in relation to the associated Opportunity, such as the opportunity's preferred dealer, or the lead provider. Possible values are: - DataProvider—Data Provider - Dealer ### ContactId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The associated Contact record. This field is a relationship field. - **Relationship Name**: Contact - **Relationship Type**: Lookup - **Refers To**: Contact ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user referenced this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user viewed this record. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the opportunity preferred seller. ### OpportunityId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The associated Opportunity record. This field is a relationship field. - **Relationship Name**: Opportunity - **Relationship Type**: Lookup - **Refers To**: Opportunity ## 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. - [OpportunityPreferredSellerChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_change_event.htm): Change events are available for the object. - [OpportunityPreferredSellerFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_feed.htm): Feed tracking is available for the object. - [OpportunityPreferredSellerHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_history.htm): History is available for tracked fields of the object. # Orchestration Inbound Events (POST) Orchestrate and process inbound events from external sources. ## Resource /connect/orchestration/inbound-events ## Resource Example https://yourInstance.salesforce.com/services/data/v68.0/connect/orchestration/inbound-events ## Available Version 59.0 ## HTTP Methods POST #### See Also - [_Automotive Cloud Developer Guide_: REST Reference](https://developer.salesforce.com/docs/atlas.en-us.264.0.automotive_cloud.meta/automotive_cloud/auto_apis_rest_references.htm) ## Request Body for POST ### JSON Example with Engine Overheating and Low Battery Fault { "sourceSystemIdentifier": "102", "type": "Transmission Issue", "subtype": "Transmission Over Temperature", "category": "FAULT", "eventData": "{"Event":{"vin":"EFGHTYUIF56789GH","id":"0vLSE00000000G92AI","businessSObjectType":"Vehicle","faults":\[{"code":"P0218","type":"repair","description":"Engine Overheating"},{"code":"P0219","type":"repair","description":"Low Battery Warning"}\],"location":{"latitude":34,"longitude":56},"signals":\[{"value":"34","timeStamp":"2023-05-16T15:13:41.236Z","dataType":"string","unit":"cm","name":"speed"}\]}}", "additionalEventCriteria": { "fieldList": \[ { "field": "priority\_\_c", "value": "high" } \] } } ### Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | additional​EventCriteria | [Additional Criteria Input](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/connect_requests_additional_criteria.htm "Input representation of the additional event criteria generated during inbound events.") | Additional criteria for event processing. It captures additional attributes of telematics events in key-value pairs for tailored actions and workflows based on specific events. | Optional | 60.0 | | category | String | Category of the inbound event. | Optional | 60.0 | | eventData | String | Data associated with the event from telematics provider. | Optional | 60.0 | | sourceSystem​Identifier | String | ID to identify the source system. | Optional | 60.0 | | subtype | String | Subtype of the inbound event. | Optional | 60.0 | | type | String | Type of the inbound event. | Optional | 60.0 | ## Response Body for POST [Inbound Event](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/connect_responses_inbound_event_response.htm "Output representation of the events processing request during incoming events.") # PartyCreditPrflFinclAcct Represents information about financial accounts, such as a credit card, an auto loan, or a mortgage account, reported by a credit bureau. Helps lenders to review the details of a borrower's accounts, both active and inactive. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AccountBalance - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The outstanding balance on the financial account. ### AccountNumber - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The identifier of the financial account. ### AccountOwnership - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The ownership of the financial account. Possible values are: Individual, or Joint. ### ApprovedAmount - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The credit limit approved by the lender. ### ClosingDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date when the financial account was closed. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user referenced this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user viewed this record. ### LenderName - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The name of the lender. ### MonthsReviewed - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The number of months reviewed for the credit report. ### NinetyDayDelinquencyCount - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The number of times a payment has been 90 days late. ### OpeningDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date when the financial account was opened. ### PartyCreditProfileId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The party credit profile associated with the Financial Account. This field is a relationship field. - **Relationship Name**: PartyCreditProfile - **Relationship Type**: Master-detail - **Refers To**: PartyCreditProfile (the master object) ### PaymentFrequency - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The payment frequency for the financial account. Possible values are: - Monthly ### ReportingDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date when the financial account was reported to the credit bureau. ### SixtyDayDelinquencyCount - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The number of times a payment has been 60 days late. ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The current status of the financial account. Possible values are: Active, or Closed. ### TermDurationInMonths - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The duration of the credit in months. ### ThirtyDayDelinquencyCount - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The number of times a payment has been 30 days late. ### Type - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The type of financial account, such as a credit card, home loan, or auto loan. Possible values are: Auto Loan, Credit Card, or Home Loan. ## 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. - [PartyCreditPrflFinclAcctChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/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. - [PartyCreditPrflFinclAcctHistory](https://developer.salesforce.com/docs/atlas.en-us.260.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_history.htm): History is available for tracked fields of the object. - [PartyCreditPrflFinclAcctOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.260.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_ownersharingrule.htm): Sharing rules are available for the object. - [PartyCreditPrflFinclAcctShare](https://developer.salesforce.com/docs/atlas.en-us.260.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_share.htm): Sharing is available for the object. # PartyCreditProfileAlert Represents the alerts and triggers raised against a borrower's credit activities, such as sudden score changes, new accounts, and payment defaults. Aids in detecting fraud, identifying borrower errors, and facilitating verification processes. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### Description - **Type**: textarea - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The description of the alert. ### 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. ### PartyCreditProfileId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The party credit profile associated with the alert. This field is a relationship field. - **Relationship Name**: PartyCreditProfile - **Relationship Type**: Master-detail - **Refers To**: PartyCreditProfile (the master object) ### Type - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: The type of alert. Possible values are: Address Mismatch, Fraud, Identity Mismatch, or OFAC. ## 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. - [PartyCreditProfileAlertChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/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. - [PartyCreditProfileAlertHistory](https://developer.salesforce.com/docs/atlas.en-us.260.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_history.htm): History is available for tracked fields of the object. - [PartyCreditProfileAlertOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.260.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_ownersharingrule.htm): Sharing rules are available for the object. - [PartyCreditProfileAlertShare](https://developer.salesforce.com/docs/atlas.en-us.260.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_share.htm): Sharing is available for the object. # PartyCreditProfileInquiry Represents the details of inquiries made by external organizations to access a borrower's credit report. Can influence a lender's opinion of a borrower's risk profile based on the type of credit inquiries received. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### InquirerName - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The name of the inquirer. ### InquiryDate - **Type**: dateTime - **Properties**: Create, Filter, Sort, Update - **Description**: The date of inquiry. ### 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. ### PartyCreditProfileId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The party credit profile associated with the inquiry. This field is a relationship field. - **Relationship Name**: PartyCreditProfile - **Relationship Type**: Master-detail - **Refers To**: PartyCreditProfile (the master object) ## 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. - [PartyCreditProfileInquiryChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/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. - [PartyCreditProfileInquiryHistory](https://developer.salesforce.com/docs/atlas.en-us.260.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_history.htm): History is available for tracked fields of the object. - [PartyCreditProfileInquiryOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.260.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_ownersharingrule.htm): Sharing rules are available for the object. - [PartyCreditProfileInquiryShare](https://developer.salesforce.com/docs/atlas.en-us.260.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_share.htm): Sharing is available for the object. # PartyFinancialAsset Represents the financial assets owned by an account or a contact. This object is available in API version 60.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules Automotive and Vehicle and Asset Finance must be enabled. ## Fields ### AssetId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The asset owned by the party. This field is a relationship field. - **Relationship Name**: Asset - **Relationship Type**: Lookup - **Refers To**: Asset ### DeclarationDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date when the asset is declared. ### Description - **Type**: textarea - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The description of the asset. ### 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. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the party financial asset. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The owner of the party financial asset record. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### OwnershipEndDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the ownership of the asset ends. ### OwnershipPercent - **Type**: percent - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The share owned by the party in percentage. ### OwnershipStartDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the ownership of the asset starts. ### PartyId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The party that owns the asset. This field is a polymorphic relationship field. - **Relationship Name**: Party - **Relationship Type**: Lookup - **Refers To**: Account, Contact ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the status of the asset. Possible values are: Active, or Inactive. ### Type - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the type of asset. ### ValuationAmount - **Type**: currency - **Properties**: Create, Filter, Sort, Update - **Description**: The worth of the asset after valuation. ### ValuationDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the asset valuation was done. ## 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. - [PartyFinancialAssetChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_change_event.htm): Change events are available for the object. - [PartyFinancialAssetFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_feed.htm): Feed tracking is available for the object. - [PartyFinancialAssetHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_history.htm): History is available for tracked fields of the object. - [PartyFinancialAssetOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_ownersharingrule.htm): Sharing rules are available for the object. - [PartyFinancialAssetShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_share.htm): Sharing is available for the object. # PartyFinclAssetAddlOwner Represents an additional owner of a financial asset. This object is available in API version 60.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules Automotive and Vehicle and Asset Finance must be enabled. ## Fields ### AccountId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The account associated with the additional owner. This field is a relationship field. - **Relationship Name**: Account - **Relationship Type**: Lookup - **Refers To**: Account ### ContactId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The contact associated with the additional owner. This field is a relationship field. - **Relationship Name**: Contact - **Relationship Type**: Lookup - **Refers To**: Contact ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date when a user referenced this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date when a user viewed this record. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The unique identifier of the party asset additional owner. ### OwnershipSharePercent - **Type**: percent - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The percentage of the asset ownership between the primary and additional owner. ### PartyFinancialAssetId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The asset associated with the additional owner. This field is a relationship field. - **Relationship Name**: PartyFinancialAsset - **Relationship Type**: Lookup - **Refers To**: PartyFinancialAsset ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The unique identifier of the record in an external system. ## 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. - [PartyFinclAssetAddlOwnerChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_change_event.htm): Change events are available for the object. - [PartyFinclAssetAddlOwnerFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_feed.htm): Feed tracking is available for the object. - [PartyFinclAssetAddlOwnerHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_history.htm): History is available for tracked fields of the object. # PartyRelationshipGroup Represents a group of people living together such as a household, or a group of people affiliated with each other. This object is available in Automotive Cloud in API version 56.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AccountId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The parent account associated with the party relationship group. This field is unique within your organization. This field is a relationship field. - **Relationship Name**: Account - **Relationship Type**: Lookup - **Refers To**: Account ### Category - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the category of the party relationship group. Possible values are: Meals together, or Staying under same roof. ### Description - **Type**: textarea - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The description of the party relationship group. ### EndDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The end date associated with the party relationship group. ### GroupIncome - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The total income of the party relationship group. ### GroupSize - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The number of active members in the party relationship group. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user referenced this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user viewed this record. ### LifetimeAcsryPurchaseValue - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The total value of vehicle accessories purchased by all members in the party relationship group. ### LifetimeSvcPurchaseCount - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The total value of vehicle services purchased by all members in the party relationship group. ### LifetimeVehPurchaseCount - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The total count of vehicles purchased by all members in the party relationship group. ### LifetimeVehPurchaseValue - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The total value of vehicles purchased by all members in the party relationship group. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: Name of the party relationship group. ### PrimaryAddress - **Type**: address - **Properties**: Filter, Nillable - **Description**: The primary address of the party relationship group. ### PrimaryCity - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The primary city of the party relationship group. ### PrimaryCountry - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The primary country of the party relationship group. ### PrimaryGeocodeAccuracy - **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 primary relationship group’s latitude and longitude coordinates. Possible values are: - Address - Block - City - County - ExtendedZip - NearAddress - Neighborhood - State - Street - Unknown - Zip ### PrimaryLatitude - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Used with Longitude to specify the precise geolocation of the party relationship group. Acceptable values are numbers between –90 and 90 with up to 15 decimal places. ### PrimaryLongitude - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Used with Latitude to specify the precise geolocation of the party relationship group. Acceptable values are numbers between –180 and 180 with up to 15 decimal places. ### PrimaryPostalCode - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The primary postal code of the party relationship group. ### PrimaryState - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The primary state of the party relationship group. ### PrimaryStreet - **Type**: textarea - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The primary street of the party relationship group. ### StartDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The start date associated with the party relationship group. ### Status - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The status of the party relationship group. Possible values are: The default value is Active. Active, or Inactive. ### Subtype - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the subclassification of the party relationship group type. Possible values are: Extension Household, Nuclear Household, or Three Person Household. ### Type - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the type of the party relationship group. Possible values are: The default value is Group. Group, or Household. ## 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. - [PartyRelationshipGroupChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_change_event.htm): Change events are available for the object. - [PartyRelationshipGroupFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_feed.htm): Feed tracking is available for the object. - [PartyRelationshipGroupHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_history.htm): History is available for tracked fields of the object. # PartyRoleRelation Represents information about the type of relationship between the participants in a group or household. This object is available in API version 58.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules Automotive and Group Membership must be enabled. ## Fields ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record, a record related to this record, or a list view. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: Name of the party role relationship. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: ID of the owner of this object. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### RelatedInverseRecordId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The record that specifies the inverse relationship between the roles. This field is a relationship field. - **Relationship Name**: RelatedInverseRecord - **Relationship Type**: Lookup - **Refers To**: PartyRoleRelation ### RelatedRoleName - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The role that's related to another role in the relationship. ### RelationshipObjectName - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update - **Description**: The object that's associated with the relationship. Possible values are: The default value is Account\_Account\_Relationship. - Account\_Account\_Relationship—Account Account Relationship - Contact\_Contact\_Relationship—Contact Contact Relationship ### RoleName - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The name of the role in the relationship. ### ShouldCreaInversRoleAuto - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort - **Description**: Indicates whether a role record should be created automatically for the relationship (true) or not (false). The default value is false. ## 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. - [PartyRoleRelationChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_change_event.htm): Change events are available for the object. - [PartyRoleRelationFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_feed.htm): Feed tracking is available for the object. - [PartyRoleRelationHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_history.htm): History is available for tracked fields of the object. - [PartyRoleRelationOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_ownersharingrule.htm): Sharing rules are available for the object. - [PartyRoleRelationShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_share.htm): Sharing is available for the object. # Penny Perfect Pricing in Automotive Cloud Get instant pricing for advanced order line items based on the pricing data that you set up, and flatten account hierarchies for reporting and analytics. For more information about Penny Perfect Pricing, see the [Penny Perfect Pricing Developer Guide](https://developer.salesforce.com/docs/industries/penny-perfect-pricing/overview). # ProductFaultCode Represents a relationship between a product or product family and the fault code. This object is available in API version 58.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules Automotive and Warranty Lifecycle Management must be enabled. ## Fields ### FaultCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The fault code associated with the product or product family. This field is a relationship field. - **Relationship Name**: FaultCode - **Relationship Type**: Lookup - **Refers To**: CodeSet ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The auto-generated number for the name of the product fault code. ### ProductFamily - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The product family associated with the fault code. Possible value is: - None ### ProductId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the product associated with the fault code. This field is a relationship field. - **Relationship Name**: Product - **Refers To**: Product2 ## 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. - [ProductFaultCodeFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_feed.htm): Feed tracking is available for the object. - [ProductFaultCodeHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_history.htm): History is available for tracked fields of the object. # ProductLaborCode Represents a junction between the labor code that's applicable to a product or product family and the required standard effort. This object is available in API version 58.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules Automotive and Warranty Lifecycle Management must be enabled. ## Fields ### LaborCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The labor code associated with the product or product family. This field is a relationship field. - **Relationship Name**: LaborCode - **Relationship Type**: Lookup - **Refers To**: CodeSet ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The auto-generated number for the name of the product labor code. ### ProductFamily - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The product family associated with the labor code. Possible value is: - None ## 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. - [ProductLaborCodeFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_feed.htm): Feed tracking is available for the object. - [ProductLaborCodeHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_history.htm): History is available for tracked fields of the object. # ProductSvcCampaignDef Represents information about the product or part that is impacted in a product service campaign. Stores the granular details related to product faults, facilitating efficient execution of the product service campaign. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### BusinessBrandId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: Auto-populated based on the business brand on the product record related to the product service campaign definition. This field is a relationship field. - **Relationship Name**: BusinessBrand - **Refers To**: BusinessBrand ### Description - **Type**: textarea - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The description of the product service campaign definition. ### EndingSerialNumber - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The serial number of the last impacted item in a serialized batch of items associated with a product service campaign. ### ImpactedUnitCount - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The actual number of units impacted of the product service campaign definition. ### MakeName - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: Auto-populated based on the make name on the product record related to the product service campaign definition. ### ManufacturerLocationId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The location of the manufacturer associated with the product service campaign definition. This field is a relationship field. - **Relationship Name**: ManufacturerLocation - **Refers To**: Location ### ModelName - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: Auto-populated based on the model name on the product record related to the product service campaign definition. ### ModelYear - **Type**: int - **Properties**: Filter, Group, Nillable, Sort - **Description**: Auto-populated based on the model year on the product record related to the product service campaign definition. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the product service campaign definition. ### ProductId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The impacted product of a product service campaign. This field is a relationship field. - **Relationship Name**: Product - **Refers To**: Product2 ### ProductSvcCampaignGrpDefId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The product service campaign group definition associated with the product service campaign definition. This field is a relationship field. - **Relationship Name**: ProductSvcCampaignGrpDef - **Relationship Type**: Master-detail - **Refers To**: ProductSvcCampaignGrpDef (the master object) ### ProductionEndDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date when a manufacturer ended production for a faulty product associated with a product service campaign. ### ProductionStartDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date when a manufacturer began production for a faulty product associated with a product service campaign. ### StartingSerialNumber - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The serial number of the first impacted item in a serialized batch of items associated with a product service campaign. # ProductSvcCmpnDefProdtBtch Represents the production batch details for a product campaign definition item. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the product service campaign definition production batch. ### ProductSvcCampaignDefId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The product service campaign definition associated with the product service campaign definition production batch. This field is a relationship field. - **Relationship Name**: ProductSvcCampaignDef - **Relationship Type**: Master-detail - **Refers To**: ProductSvcCampaignDef (the master object) ### ProductionBatchId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The production batch associated with the product service campaign definition production batch. This field is a relationship field. - **Relationship Name**: ProductionBatch - **Refers To**: ProductionBatch ## 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. - [ProductSvcCmpnDefProdtBtchChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_change_event.htm): Change events are available for the object. - [ProductSvcCmpnDefProdtBtchHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_history.htm): History is available for tracked fields of the object. # ProductWarrantyTerm Defines the relationship between a product or product family and a warranty term. This object is available in API version 56.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules Automotive and Warranty Lifecycle Management must be enabled. ## Fields ### CoveredProductFamily - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The product family that the warranty term applies to. Possible value is: - None ### CoveredProductId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the product that the warranty term applies to. This field is a relationship field. - **Relationship Name**: CoveredProduct - **Relationship Type**: Lookup - **Refers To**: Product2 ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date when the product warranty term was last modified. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date when the product warranty term was last viewed. ### ProductWarrantyTermNumber - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The identifier for this product warranty term. ### WarrantyTermId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The ID of the associated warranty term. This field is a relationship field. - **Relationship Name**: WarrantyTerm - **Relationship Type**: Lookup - **Refers To**: WarrantyTerm ## 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. - [ProductWarrantyTermChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_change_event.htm): Change events are available for the object. - [ProductWarrantyTermFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_feed.htm): Feed tracking is available for the object. - [ProductWarrantyTermHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_history.htm): History is available for tracked fields of the object. # PtyCrPrflFinclAcctActvty Represents information about the payments made by a borrower reported by a credit bureau. Reveals a borrower's payment behavior on past debts, indicating timely, delayed, or skipped payments. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### IsPaymentMadeOnTime - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the payment was made on time (true) or not (false). The default value is false. ### 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. ### PartyCreditPrflFinclAcctId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The financial account associated with the payment activity. This field is a relationship field. - **Relationship Name**: PartyCreditPrflFinclAcct - **Relationship Type**: Master-detail - **Refers To**: PartyCreditPrflFinclAcct (the master object) ### PaymentMonth - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: The month of payment. Possible values are: June, August, or February. ### PaymentYear - **Type**: int - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The year of payment. ## 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. - [PtyCrPrflFinclAcctActvtyChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/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. - [PtyCrPrflFinclAcctActvtyHistory](https://developer.salesforce.com/docs/atlas.en-us.260.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_history.htm): History is available for tracked fields of the object. # RebateClaim Represents proof of sale of a vehicle submitted by a dealer in the form of a retail delivery report. This report can also be used for rebate payout calculations. This object is available in Automotive Cloud in API version 56.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AssetId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The asset associated with the record. This field is a relationship field. - **Relationship Name**: Asset - **Relationship Type**: Lookup - **Refers To**: Asset ### AssetIdentificationNumber - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unique identifier of the associated vehicle or asset, such as a vehicle identification number or serial number of an accessory. ### AssetSaleType - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the type of sale that's associated with the rebate claim. Possible values are: The default value is Lease. Cash, Lease, or Loan. ### ClaimAmount - **Type**: currency - **Properties**: Create, Filter, Sort, Update - **Description**: The amount claimed by the dealer. ### ClaimDate - **Type**: dateTime - **Properties**: Create, Filter, Sort, Update - **Description**: The date when the claim is submitted by the dealer. ### ClaimedByAccountId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The account of the dealer who is submitting the claim. This field is a relationship field. - **Relationship Name**: ClaimedByAccount - **Relationship Type**: Lookup - **Refers To**: Account ### ClaimedByAccountNumber - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The reference number of the account of the dealer who is submitting the claim. ### Description - **Type**: textarea - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The description of the claim. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user referenced this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user viewed this record. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Autogenerated unique identifier for the rebate claim record. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: ID of the rebate claim record owner. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### ParticipatingAccountId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The account of a participant in the claim. It can be the end customer or a partner. This field is a relationship field. - **Relationship Name**: ParticipatingAccount - **Relationship Type**: Lookup - **Refers To**: Account ### ParticipatingAccountNumber - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The reference number of the account of a participant in the claim. ### ProcessingStatus - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: The processing status of the rebate claim. Possible values are: The default value is New. Approved, New, Rejected, System Failed, or System Processed. ### ProcessingStatusMessage - **Type**: string - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The message with the details of the rebate claim’s processing status when it isn’t completed. ### ProductCode - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The reference number of the product for which the rebate claim is submitted. ### ProductId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The product for which the rebate claim is submitted. This field is a relationship field. - **Relationship Name**: Product - **Relationship Type**: Lookup - **Refers To**: Product2 ### ProgramReferenceNumber - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The reference number of the rebate program that the dealer is enrolled in. ![Note](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/images/icon_note.png) #### Note Use this field if you have enabled Rebate Management in your org. ### Quantity - **Type**: double - **Properties**: Create, Filter, Sort, Update - **Description**: The quantity of the product for which the rebate claim is submitted. ### ReferencePricePerUnit - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The price of a product unit that’s agreed upon between the manufacturer and the dealer or between the dealer and customer for the rebate claim. ### ResalePricePerUnit - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The price at which a unit of the product was bought by the customer. ### SaleApprovalDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date on which the manufacturer approves the retail delivery report (RDR) of the dealer and acknowledges the sale of the vehicle. ### SalePricePerUnit - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The original price at which a product unit is sold to the dealer by the manufacturer. ### TradedFromAccountId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The account of the dealer who sells a product to another dealer or distributor who further fulfills the final demand. This field is a relationship field. - **Relationship Name**: TradedFromAccount - **Relationship Type**: Lookup - **Refers To**: Account ### TradedToAccountId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The account of the dealer who purchases a product from another dealer or distributor to complete their inventory requirement. This field is a relationship field. - **Relationship Name**: TradedToAccount - **Relationship Type**: Lookup - **Refers To**: Account ### VehicleDeliveryStatus - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the delivery status of the associated vehicle. Possible values are: The default value is Planned. - Delivered - InTransit—In Transit - Planned - UnderInspection—Under Inspection ### VehicleDlvrOdometerReading - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The odometer reading that’s taken at the time of vehicle delivery. ### VehicleId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The vehicle associated with the rebate claim. This field is a relationship field. - **Relationship Name**: Vehicle - **Relationship Type**: Lookup - **Refers To**: Vehicle ## 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. - [RebateClaimFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_feed.htm): Feed tracking is available for the object. - [RebateClaimHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_history.htm): History is available for tracked fields of the object. - [RebateClaimOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_ownersharingrule.htm): Sharing rules are available for the object. - [RebateClaimShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_share.htm): Sharing is available for the object. # Record Alerts in Automotive Cloud Use objects and APIs for Record Alerts to configure alerts on records within or outside your org.
Available in: Enterprise, Unlimited, and Developer Editions.
For more information on Record Alerts, see [Record Alerts](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/record_alerts_parent.htm). # Repossession Represents a repossession case that tracks the recovery of an asset from initial assignment to final disposition. This object is available in API version 68.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AccountId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The customer account associated with the repossession. This field is a relationship field. - **Relationship Name**: Account - **Relationship Type**: Lookup - **Refers To**: Account ### CollectionPlanId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The collection plan record associated with the repossession. This field is a relationship field. - **Relationship Name**: CollectionPlan - **Relationship Type**: Lookup - **Refers To**: CollectionPlan ### EndDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date the repossession case was closed, either through asset recovery, customer redemption, or account write-off. ### FinancialAccountId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The specific lending or lease account associated with the repossession. This field is a relationship field. - **Relationship Name**: FinancialAccount - **Relationship Type**: Lookup - **Refers To**: FinancialAccount ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: A unique system-generated identifier for the repossession record. ### Purpose - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The purpose of the initiated repossession process, such as lease expiry, delinquency, or lapsed insurance coverage. Possible values are: - Delinquency - Lease Expiry - Lapsed Insurance Coverage - Prohibited Use of Vehicle - Vehicle Abandonment - Voluntary Surrender ### Stage - **Type**: picklist - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The current stage of the repossession, tracking the lifecycle from initial assignment to final asset disposition. Possible values are: Pre-Repossession, Repossession In Progress, or Repossession Complete. ### StartDate - **Type**: date - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The date the repossession process was officially initiated. # RepossessionActivity Represents an activity or event logged during a repossession, such as a site visit, phone call, or tow initiation. This object is available in API version 68.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### Comments - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The additional details regarding the repossession activity. ### Description - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The description of the repossession activity. ### GeoLocation - **Type**: location - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The latitude and longitude coordinates of the location where the activity was logged, for verifying field presence. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The identifier for the repossession activity record. ### RepossessionId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The repossession record associated with the repossession activity record. This field is a relationship field. - **Relationship Name**: Repossession - **Relationship Type**: Lookup - **Refers To**: Repossession ### RepossessionItemId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The repossession item record associated with the repossession activity record. This field is a relationship field. - **Relationship Name**: RepossessionItem - **Relationship Type**: Lookup - **Refers To**: RepossessionItem ### Timestamp - **Type**: dateTime - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The precise timestamp when the repossession activity occurred, essential for time-sensitive legal tracking. ### Type - **Type**: picklist - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The nature of the repossession activity being logged, such as site visit, phone call, or tow initiation. Possible values are: Site Visit, Phone Call, Tow Initiated, or Condition Report. ### UserId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The user record associated with the repossession activity record, who performed or recorded the activity. This field is a relationship field. - **Relationship Name**: User - **Relationship Type**: Lookup - **Refers To**: User ### UserRole - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The functional role of the person performing the repossession activity at the time of entry. Possible values are: Recovery Agent, Collections Specialist, or Third-party Vendor. # RepossessionItem Represents an individual asset targeted for recovery within a repossession case. This object is available in API version 68.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AssetId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The physical property, such as a vehicle or equipment, being targeted for recovery as the repossession item. This field is a relationship field. - **Relationship Name**: Asset - **Relationship Type**: Lookup - **Refers To**: Asset ### CompletionDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date when the repossession for the item was finalized or the asset was successfully secured. ### InitiationDate - **Type**: date - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The date when the recovery activity for the repossession item was initiated. ### IsOnHold - **Type**: boolean - **Properties**: Filter, Group, Sort - **Description**: Indicates whether the repossession activity for the item is paused (true) or not (false), due to legal or operational constraints. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The auto-generated unique identifier for a repossession item record. ### PartyFinancialAssetId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The party financial asset record associated with the repossession item. This field is a relationship field. - **Relationship Name**: PartyFinancialAsset - **Relationship Type**: Lookup - **Refers To**: PartyFinancialAsset ### RelatedItemId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The related item associated with the repossession item which can be either a party financial asset or an asset record, establishing a relationship with the repossession record. This field is a relationship field. - **Relationship Name**: RelatedItem - **Relationship Type**: Lookup - **Refers To**: PartyFinancialAsset Asset ### RepossessionId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The repossession record associated with the repossession item. This field is a relationship field. - **Relationship Name**: Repossession - **Relationship Type**: Lookup - **Refers To**: Repossession ### Stage - **Type**: picklist - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The current stage of the repossession item. Possible values are: Pending, In Progress, or Completed. # RepossessionItemCost Represents a cost incurred for a repossession item, such as transportation, legal, storage, or repair charges. This object is available in API version 68.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### CostbookId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The costbook record associated with the repossession item cost record to define the standard price list or a vendor rate card, ensuring that the costs being applied align with pre-negotiated contracts. This field is a relationship field. - **Relationship Name**: Costbook - **Relationship Type**: Lookup - **Refers To**: Costbook ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The identifier for the repossession item cost record. ### RepossessionItemId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The repossession item record associated with the repossession item cost record. This field is a relationship field. - **Relationship Name**: RepossessionItem - **Relationship Type**: Lookup - **Refers To**: RepossessionItem ### TotalCost - **Type**: currency - **Properties**: Filter, Group, Nillable, Sort - **Description**: A derived currency amount that represents the final expense value collected from the associated repossession item cost detail records. ### Type - **Type**: picklist - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The categorized picklist defining the nature of the expense, crucial for financial reporting and tax categorization. Possible values are: Transportation, Legal, Storage, or Repair. # RepossessionItemCostDetail Represents an individual line-item charge that makes up the total cost of a repossession item. This object is available in API version 68.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### Cost - **Type**: currency - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The currency for the repossession item cost detail. ### CostbookEntryId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The costbook entry record associated with the repossession item cost detail record, linking the item to a pre-defined standard rate or unit price for the service. This field is a relationship field. - **Relationship Name**: CostbookEntry - **Relationship Type**: Lookup - **Refers To**: CostbookEntry ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The identifier for the repossession item cost detail record. ### ProductId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The product2 entry associated with the repossesion item cost detail. This field is a relationship field. - **Relationship Name**: Product - **Relationship Type**: Lookup - **Refers To**: Product2 ### RepossessionItemCostId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The repossession item cost record associated with the repossession item cost detail record. This field is a relationship field. - **Relationship Name**: RepossessionItemCost - **Relationship Type**: Master-Detail - **Refers To**: RepossessionItemCost ### Type - **Type**: picklist - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The nature of the repossession cost item, such as labor, administrative, or surcharge. Possible values are: Surcharge, Service Tax, or Documentation. # RepossessionItemProcessingHold Represents a hold that pauses the recovery process for a repossession item due to legal or operational constraints. This object is available in API version 68.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### EndDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date the hold is scheduled to expire or was actually concluded. ### HoldReason - **Type**: picklist - **Properties**: Create, Filter, Group, Sort, Update - **Description**: A categorized explanation for why the recovery process has been paused. Possible values are: Bankruptcy Stay, Promise To Pay, or Legal Dispute. ### HoldReasonReferenceId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The payment schedule record associated with the repossession hold, that justifies the hold. This field is a relationship field. - **Relationship Name**: HoldReasonReference - **Relationship Type**: Lookup - **Refers To**: PaymentSchedule ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The auto-generated unique identifier for a repossession hold record. ### Notes - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The detailed qualitative information regarding the circumstances of the hold or specific instructions for the recovery representative. ### PlacedById - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The internal user associated with the repossession hold, who authorized and initiated the hold. This field is a relationship field. - **Relationship Name**: PlacedBy - **Relationship Type**: Lookup - **Refers To**: User ### ReleasedById - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The internal user associated with the repossession hold, who authorized the resumption of the repossession process. This field is a relationship field. - **Relationship Name**: ReleasedBy - **Relationship Type**: Lookup - **Refers To**: User ### ReleaseReason - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The justification for lifting the hold. Possible values are: Bankruptcy dismissed by court, or Funds verified in account. ### RepossessionItemId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The repossession item record associated with the repossession hold. This field is a relationship field. - **Relationship Name**: RepossessionItem - **Relationship Type**: Lookup - **Refers To**: RepossessionItem ### StartDate - **Type**: date - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The date the hold was officially applied and recovery efforts were ordered to stop. ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The current status of the repossession hold record. Possible values are: Active, Released, or Expired. # RepossessionItemUser Represents the assignment of a user to a repossession item for a vendor's recovery task. This object is available in API version 68.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AssignmentPurpose - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The functional role or task assigned to an individual vendor user for a repossession item including responsibilities, such as field investigation, legal serving, or physical transport, ensuring clear accountability. Possible values are: Primary Recovery Agent, Spotter, Legal Process Server, or Transport Driver. ### AssignmentStatus - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The current work state or availability of the assigned user. Possible values are: Active, Off-duty, or Completed. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The auto-generated unique identifier for the repossession item vendor user record. ### RepossessionItemId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The repossession item associated with the repossession item user record. This field is a relationship field. - **Relationship Name**: RepossessionItem - **Relationship Type**: Lookup - **Refers To**: RepossessionItem ### RepossessionItemVendorId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The repossession item vendor record associated with the repossession item user record. This field is a relationship field. - **Relationship Name**: RepossessionItemVendor - **Relationship Type**: Lookup - **Refers To**: RepossessionItemVendor ### UserId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The user associated with the repossession item vendor user record, who is performing the field work or managing the task. This field is a relationship field. - **Relationship Name**: User - **Relationship Type**: Lookup - **Refers To**: User # RepossessionItemVendor Represents the assignment of a partner account to a repossession item for recovery work such as towing, storage, or transport. This object is available in API version 68.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AccountId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The account record associated with the assignee. This field is a relationship field. - **Relationship Name**: Account - **Relationship Type**: Lookup - **Refers To**: Account ### AssignmentPurpose - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The purpose defining why an account or a user was assigned to the repossession item. Possible values are: Towing, Long-term Storage, or Auction Transport. ### AssignmentStatus - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The current status of the assignee's work on the repossession. Possible values are: Proposed, Accepted, or Declined. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The auto-generated unique identifier for the repossession item assignment record. ### RepossessionItemId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The repossession item associated with the repossession item assignment record. This field is a relationship field. - **Relationship Name**: RepossessionItem - **Relationship Type**: Lookup - **Refers To**: RepossessionItem # RepossessionNoticeLog Represents a log entry that records a legal notice issued to a borrower during the repossession process. This object is available in API version 68.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### BusinessKey - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: A composite key combining notice type, related item, recipient, and delivery channel to prevent duplicate notices being logged for the same combination. ### CollectionPlanId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The collection plan associated with this notice. This field is a relationship field. - **Relationship Name**: CollectionPlan - **Relationship Type**: Lookup - **Refers To**: CollectionPlan ### ContentDocumentId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The generated notice document attached to this record, typically the PDF that was sent to the recipient. This field is a relationship field. - **Relationship Name**: ContentDocument - **Relationship Type**: Lookup - **Refers To**: ContentDocument ### DeliveryChannel - **Type**: picklist - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The channel through which the notice was actually delivered. ### DeliveryConfirmationTimestamp - **Type**: dateTime - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date and time at which delivery of the notice was confirmed. ### DeliveryStatus - **Type**: picklist - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The delivery outcome of the notice. ### ExternalReferenceId - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The identifier assigned to this notice by the external system that delivered it. ### FinancialAccountId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The financial account associated with this notice. This field is a relationship field. - **Relationship Name**: FinancialAccount - **Relationship Type**: Lookup - **Refers To**: FinancialAccount ### NoticeType - **Type**: picklist - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The type of legal notice represented by this log entry. ### RecipientId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The borrower who received the notice, such as a Contact for individual borrowers or an Account for business borrowers. This field is a relationship field. - **Relationship Name**: Recipient - **Relationship Type**: Lookup - **Refers To**: Account Contact ### RelatedItemId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The collection plan or financial account this notice was issued against. This field is a relationship field. - **Relationship Name**: RelatedItem - **Relationship Type**: Lookup - **Refers To**: CollectionPlan FinancialAccount ### RepossessionNoticeRuleId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The repossession notice rule associated with the repossession notice log. This field is a relationship field. - **Relationship Name**: RepossessionNoticeRule - **Relationship Type**: Lookup - **Refers To**: RepossessionNoticeRule ### RepossessionReason - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The type of reason for initiating the repossession, such as delinquency, lease end, or voluntary surrender. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the external system that delivered this notice, such as the customer's email platform or postal service provider. # RepossessionNoticeRule Represents a rule that defines the legal notice requirements for a repossession scenario in a given jurisdiction. This object is available in API version 68.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### Description - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: An explanation of the rule's purpose, intended for administrators reviewing or maintaining the rule set. ### EffectiveEndDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date on which this rule stops being active. ### EffectiveStartDate - **Type**: date - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The date on which this rule becomes active. ### JurisdictionCode - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The state or regional jurisdiction whose law this rule implements. ### MinimumDelinquencyDays - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The minimum number of days an account must be past due for this rule to apply at the time of evaluation. ### NoticeDeliveryChannel - **Type**: picklist - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The delivery channel required for the notice, such as certified mail or email. Possible values are: EMAIL, or DIRECT\_POST. ### NoticeExpirationDays - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The number of days after notice delivery until the milestone expires for the repossession notice rule. ### NoticeType - **Type**: picklist - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The type of legal notice this rule requires. Possible values are: RightToCureNotice, or NoticeOfDefault. ### OutstandingBalance - **Type**: currency - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The minimum outstanding balance an account must carry for this rule to apply at the time of evaluation. ### ProductType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The type of financial product this rule applies to. Possible values are: AUTO\_LOAN, or AUTO\_LEASE. ### RepossessionReason - **Type**: picklist - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The type of reason for initiating the repossession, such as delinquency, lease end, or voluntary surrender. # Request Bodies Here’s a list of Automotive Cloud Business API request bodies. - **[Additional Criteria Input](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/connect_requests_additional_criteria.htm)** Input representation of the additional event criteria generated during inbound events. - **[Field List](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/connect_requests_field_list.htm)** Input representation of a field match that contains the field name and value. - **[Inbound Event Input](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/connect_requests_inbound_event_input.htm)** Input representation of the request to process incoming events from a telematics provider. - **[Inventory Actions Query Input](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/connect_requests_inventory_actions_query.htm)** Input representation to perform the inventory actions query. - **[Inventory Actions Item Input](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/connect_requests_inventory_actions_input_item.htm)** Input representation to perform the inventory product transfer. - **[Transformation Input](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/auto_request_body_transformation_input.htm)** Input representation for converting an input object type to an output object type. # Resources Here’s a list of Automotive Cloud Business API resources. - **[Inventory Visibility Product Transfer Action](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/connect_resources_inventory_visibility_action.htm)** Returns the results for vehicle inventory transfer action search based on the inventory visibility actions configuration defined by the admin. - **[Orchestration Inbound Events (POST)](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/connect_resources_inbound_events.htm)** Orchestrate and process inbound events from external sources. - **[Transformations](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/auto_resources_transformations.htm)** Perform the business transformation of lead line item or lead preferred seller data (source object) to opportunities line item or opportunity preferred seller data (target object). The following are some of the transformation scenarios: LeadLineItem to OpportunityLineItem, and LeadPreferredSeller to OpportunityPreferredSeller. # Response Bodies Here’s a list of Automotive Cloud Business API response bodies. - **[Action Response](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/connect_responses_action_response.htm)** Output representation of the action response of an inbound event. - **[Error Message](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/connect_responses_error_message.htm)** Output representation of the details of errors encountered during an API request execution. - **[Inbound Event](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/connect_responses_inbound_event_response.htm)** Output representation of the events processing request during incoming events. - **[Inventory Actions Result](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/connect_responses_inventory_actions_result.htm)** Output representation of the results for the vehicle inventory transfer action search. - **[Object Details Output](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/auto_connect_responses_output_object_detail.htm)** Represents the details of the transformation object. - **[Transformation Output](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/auto_response_body_transformation_output.htm)** Represents the details of the transformation from source object to target object. # REST Reference You can access Automotive Cloud Business APIs using REST endpoints. These REST APIs follow similar conventions as Connect REST APIs. To understand the architecture, authentication, rate limits, and how the requests and responses work, see [Connect REST API Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.chatterapi.meta/chatterapi/intro_what_is_chatter_connect.htm). - **[Resources](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/auto_apis_resources.htm)** Here’s a list of Automotive Cloud Business API resources. - **[Request Bodies](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/auto_apis_request_bodies.htm)** Here’s a list of Automotive Cloud Business API request bodies. - **[Response Bodies](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/auto_apis_response_bodies.htm)** Here’s a list of Automotive Cloud Business API response bodies. # SellerProduct Represents information about the products associated with a seller. Provides insight into product availability, production details, and the seller's role for the product, such as for sales or for service. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AccountId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The account associated with the product. This field is a relationship field. - **Relationship Name**: Account - **Relationship Type**: Master-detail - **Refers To**: Account (the master object) ### EndDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date when the seller stopped selling or servicing this product. ### IsActive - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the product is still associated with the seller (true) or not (false). The default value is false. ### 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. ### ProductId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The product associated with the account. This field is a relationship field. - **Relationship Name**: Product - **Refers To**: Product2 ### SellerRole - **Type**: multipicklist - **Properties**: Create, Filter, Update - **Description**: The role of the seller related to the product, such as for sales or for service. ### StartDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date when the seller started selling or servicing this product. ## 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. - [SellerProductHistory](https://developer.salesforce.com/docs/atlas.en-us.260.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_history.htm): History is available for tracked fields of the object. # Service Process Studio in Automotive Cloud Build enhanced customer service experiences through real-time integration and detailed service rules configurations. For more information on Service Process Studio, see [Service Process Studio](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/service_process_studio.htm). # ServiceAppointment Represents a service appointment booked through Automotive Scheduler, for test drives or vehicle services. This object is available in API version 58.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules Automotive and Automotive Scheduler must be enabled. ## Fields ### ActualDuration - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The number of minutes that it took the resource to complete the appointment. When values are first added to the Actual Start and Actual End fields, the Actual Duration is automatically populated to list the difference between the Actual Start and Actual End. If the Actual Start and Actual End fields are subsequently updated, the Actual Duration field doesn’t re-update, but you can manually update it. ### ActualEndTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The actual date and time the appointment ended. ### ActualStartTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The actual date and time the appointment started. ### AdditionalInformation - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Represents additional information about the service appointment. ### Address - **Type**: address - **Properties**: Filter - **Description**: The address where the appointment is taking place. ### AppointmentNumber - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: An auto-assigned number that identifies the appointment. ### ArrivalWindowEndTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The end of the window of time in which the technician is scheduled to arrive at the site. ### ArrivalWindowStartTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The beginning of the window of time in which the technician is scheduled to arrive at the site. ### CancellationReason - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The reason for the service appointment cancellation. ### City - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The city where the appointment is completed. Maximum length is 40 characters. ### Comments - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The comments for the service appointment. ### Country - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The country where the appointment is completed. Maximum length is 80 characters. ### Description - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The description of the appointment. ### DueDate - **Type**: dateTime - **Properties**: Create, Filter, Sort, Update - **Description**: The date by which the appointment must be completed. ### Duration - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The estimated length of the appointment as derived from the associated work type. The duration is in minutes or hours based on the value selected in the Duration Type field. ### DurationType - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The unit of duration as specified for the associated work type. Possible values are: The default value is Hours. Hours, or Minutes. ### EarliestStartTime - **Type**: dateTime - **Properties**: Create, Filter, Sort, Update - **Description**: The date after which the appointment must be completed. ### 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. Usually provided by a geocoding service based on the address’s latitude and longitude coordinates. Possible values are: - Address - Block - City - County - ExtendedZip - NearAddress - Neighborhood - State - Street - Unknown - Zip ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date when the service appointment was last modified. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date when the service appointment was last viewed. ### Latitude - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Used with Longitude to specify the precise geolocation of the address where the service appointments is completed. 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 where the service appointment is completed. Acceptable values are numbers between –180 and 180 with up to 15 decimal places. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The owner of the appointment. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### ParentRecordId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort - **Description**: The parent record related to the appointment. The parent record can’t be updated after the service appointment is created. For test drive appointments, the parent record is a lead or an opportunity. For vehicle service appointments, theparent record is an asset that’s related to the vehicle. This field is a polymorphic relationship field. - **Relationship Name**: ParentRecord - **Relationship Type**: Lookup - **Refers To**: Account, Asset, Case, Lead, Opportunity, WorkOrder, WorkOrderLineItem ### ParentRecordType - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: (Read only) The type of parent record that provides context for the appointment, such as Asset, Lead, or Opportunity. ### PostalCode - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The postal code where the appointment is completed. Maximum length is 20 characters. ### SchedEndTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The time at which the appointment is scheduled to end. ### SchedStartTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The time at which the appointment is scheduled to start. ### ServiceTerritoryId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The service territory associated with the appointment. This field is a relationship field. - **Relationship Name**: ServiceTerritory - **Relationship Type**: Lookup - **Refers To**: ServiceTerritory ### State - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The state where the service appointment is completed. Maximum length is 80 characters. ### Status - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: The status of the appointment. The picklist values can be customized. Possible values are: The default value is None. - Canceled - Cannot Complete - Checked In - Completed - Dispatched - In Progress - None - Scheduled ### StatusCategory - **Type**: picklist - **Properties**: Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort - **Description**: The category that each Status value falls into. The Status Category field’s values are identical to the default Status values. Possible values are: The default value is None. - Canceled—Canceled - CannotComplete—Cannot Complete - CheckedIn—Checked In - Completed - Dispatched - InProgress—In Progress - None - Scheduled ### Street - **Type**: textarea - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The street number and name where the service appointment is completed. ### Subject - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: An autopopulated phrase describing the type of appointment, such as Test Drive Appointment or Vehicle Service Appointment. ### WorkTypeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The work type associated with the service appointment. This field is a relationship field. - **Relationship Name**: WorkType - **Relationship Type**: Lookup - **Refers To**: WorkType ## 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. - [ServiceAppointmentChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_change_event.htm): Change events are available for the object. - [ServiceAppointmentFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_feed.htm): Feed tracking is available for the object. - [ServiceAppointmentHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_history.htm): History is available for tracked fields of the object. - [ServiceAppointmentOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_ownersharingrule.htm): Sharing rules are available for the object. - [ServiceAppointmentShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_share.htm): Sharing is available for the object. # ServiceResourceSkill Represents the association between a skill and a service resource. This object is available in API version 58.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update(), upsert() ## Special Access Rules Automotive and Automotive Scheduler must be enabled. ## Fields ### EffectiveEndDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date when the skill expires. ### EffectiveStartDate - **Type**: dateTime - **Properties**: Create, Filter, Sort, Update - **Description**: The date from when a service resource is assigned the skill. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date when the resource skill was last modified. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date when the resource skill was last viewed. ### ServiceResourceId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The service resource related to the record. This field is a relationship field. - **Relationship Name**: ServiceResource - **Relationship Type**: Lookup - **Refers To**: ServiceResource ### SkillId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The skill related to the record. This field is a relationship field. - **Relationship Name**: Skill - **Relationship Type**: Lookup - **Refers To**: Skill ### SkillLevel - **Type**: double - **Properties**: Create, Defaulted on create, Filter, Nillable, Sort, Update - **Description**: The service resource’s skill level. Skill level can range from zero to 99.99. ### SkillNumber - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: An autogenerated number identifying the resource skill assignment. ## 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. - [ServiceResourceSkillChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_change_event.htm): Change events are available for the object. - [ServiceResourceSkillFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_feed.htm): Feed tracking is available for the object. - [ServiceResourceSkillHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_history.htm): History is available for tracked fields of the object. # ServiceTerritory Represents a dealer location where service resources are located and service appointments are performed. This object is available in API version 58.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules Automotive and Automotive Scheduler must be enabled. ## Fields ### Address - **Type**: address - **Properties**: Filter, Nillable - **Description**: An address to associate with a dealer’s location. ### City - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The city of the associated address. The Automotive appointment booking flows for test drives and vehicle services use the dealer name or city name as search input for the appointment location. Maximum length is 40 characters. ### Country - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The country to associate with the territory. Maximum length is 80 characters. ### Description - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The description of the territory. ### 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. Usually provided by a geocoding service based on the address’s latitude and longitude coordinates. Possible values are: - Address - Block - City - County - ExtendedZip - NearAddress - Neighborhood - State - Street - Unknown - Zip ### IsActive - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the service territory is meant to be used (true) or not (false). If a territory is inactive, you can’t add members to it or link it to service appointments. The default value is false. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date when the record was last modified. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date when the record was last viewed. ### Latitude - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Used with Longitude to specify the precise geolocation of the address where the service appointments is completed. 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 where the service appointment is completed. 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 a dealer location. The Automotive appointment booking flows for test drives and vehicle services use the dealer name or city name as search input for the appointment location. ### OperatingHoursId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The territory’s operating hours, which indicate when service appointments within the territory can occur. Service resources who are members of a territory and work types related to a territory automatically inherit the territory’s operating hours unless different hours are specified on the resource or the work type record. This field is a relationship field. - **Relationship Name**: OperatingHours - **Relationship Type**: Lookup - **Refers To**: OperatingHours ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The owner of the record. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### ParentTerritoryId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The territory’s parent service territory, if it has one. A service territory hierarchy can contain up to 10,000 territories. This field is a relationship field. - **Relationship Name**: ParentTerritory - **Relationship Type**: Lookup - **Refers To**: ServiceTerritory ### PostalCode - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The postal code of the address associated with the territory. Maximum length is 20 characters. ### State - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The state of the address associated with the territory. Maximum length is 80 characters. ### Street - **Type**: textarea - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The street number and name of the address associated with the territory. ## 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. - [ServiceTerritoryChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_change_event.htm): Change events are available for the object. - [ServiceTerritoryFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_feed.htm): Feed tracking is available for the object. - [ServiceTerritoryHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_history.htm): History is available for tracked fields of the object. - [ServiceTerritoryOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_ownersharingrule.htm): Sharing rules are available for the object. - [ServiceTerritoryShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_share.htm): Sharing is available for the object. # ServiceTerritoryMember Represents a service resource who can be assigned to an appointment in a service territory. This object is available in API version 58.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update(), upsert() ## Special Access Rules Automotive and Automotive Scheduler must be enabled. ## Fields ### Address - **Type**: address - **Properties**: Filter, Nillable - **Description**: The member’s address. ### City - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The city of the member’s address. Maximum length is 40 characters. ### Country - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The country of the member’s address. Maximum length is 80 characters. ### EffectiveEndDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date when the service resource is no longer a member of the territory. ### EffectiveStartDate - **Type**: dateTime - **Properties**: Create, Filter, Sort, Update - **Description**: The date when the service resource becomes a member of the service territory. ### 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. Usually provided by a geocoding service based on the address’s latitude and longitude coordinates. Possible values are: - Address - Block - City - County - ExtendedZip - NearAddress - Neighborhood - State - Street - Unknown - Zip ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date when the territory member was last modified. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date when the territory member was last viewed. ### Latitude - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Used with Longitude to specify the precise geolocation of the member’s 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 member’s address. Acceptable values are numbers between –180 and 180 with up to 15 decimal places. ### MemberNumber - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: (Read only) An auto-generated number identifying the service territory member. ### OperatingHoursId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The operating hours assigned to the service territory member. If no operating hours are specified, the member is assumed to use their parent service territory’s operating hours. If a member needs special operating hours, create them in Setup and select them in the Operating Hours lookup field on the member’s detail page. This field is a relationship field. - **Relationship Name**: OperatingHours - **Relationship Type**: Lookup - **Refers To**: OperatingHours ### PostalCode - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The postal code of the member’s address. Maximum length is 20 characters. ### ServiceResourceId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The service resource assigned to the service territory. This field is a relationship field. - **Relationship Name**: ServiceResource - **Relationship Type**: Lookup - **Refers To**: ServiceResource ### ServiceTerritoryId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The service territory that the service resource is assigned to. This field is a relationship field. - **Relationship Name**: ServiceTerritory - **Relationship Type**: Lookup - **Refers To**: ServiceTerritory ### State - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The state of the member’s address. Maximum length is 80 characters. ### Street - **Type**: textarea - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The street number and name of the member’s address. ### TerritoryType - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the type of the territory in relation to the resource who is a member. Possible values are: The default value is P. - P—Primary - R—Relocation - S—Secondary ## 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. - [ServiceTerritoryMemberChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_change_event.htm): Change events are available for the object. - [ServiceTerritoryMemberFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_feed.htm): Feed tracking is available for the object. - [ServiceTerritoryMemberHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_history.htm): History is available for tracked fields of the object. # Settings Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type. For more information, see **[Settings](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm)**. - **[IndustriesAutomotiveSettings](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/auto_metadata_api_industriesautomotivesettings.htm)** Represents the settings for enabling features like Automotive Cloud, Automotive Service Excellence, and Automotive Scheduler. - **[IndustriesEventOrchSettings](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/auto_metadata_api_industrieseventorchsettings.htm)** Represents the settings for enabling Automotive cloud feature like Event Orchestration Decision Table. - **[IndustriesManufacturingSettings](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/auto_metadata_api_industriesmanufacturingsettings.htm)** Represents the settings for enabling features like Partner Lead Management, Partner Performance Management, Partner Visit Management, and Fleet Management. You also get access to settings for enabling features like Advanced Account Forecasts, Account Forecasts, Account Manager Targets, Manufacturing Programs, and Sales Agreements. - **[IndustriesSettings](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/auto_metadata_api_industriessettings.htm)** Represents the settings for enabling features like Criteria-Based Search and Filter that’s used for vehicle inventory visibility. # Skill Represents a skill that service resources have. For technician type service resources, the skill represents their area of expertise. For asset type service resources, the skill must be specified as Test Drive. This object is available in API version 59.0 and later. ## Supported Calls create(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules Automotive and Automotive Scheduler must be enabled. ## Fields ### Description - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The description of the skill. ### DeveloperName - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The unique name of the object in the API. This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date when the record was last viewed. ### MasterLabel - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the skill. ### TypeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The type of skill. This field is a relationship field. - **Relationship Name**: Type - **Relationship Type**: Lookup - **Refers To**: SkillType ## 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. - [SkillChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_change_event.htm): Change events are available for the object. # SkillRequirement Represents a skill that is required to complete a particular work type. This object is available in API version 58.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update(), upsert() ## Special Access Rules Automotive and Automotive Scheduler must be enabled. ## Fields ### 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. ### RelatedRecordId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The record that the skill is required for. The related record is a work type in Automotive Cloud. This field is a polymorphic relationship field. - **Relationship Name**: RelatedRecord - **Relationship Type**: Lookup - **Refers To**: WorkOrder, WorkOrderLineItem, WorkType ### SkillId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The skill that is required. This field is a relationship field. - **Relationship Name**: Skill - **Relationship Type**: Lookup - **Refers To**: Skill ### SkillLevel - **Type**: double - **Properties**: Create, Defaulted on create, Filter, Nillable, Sort, Update - **Description**: he level of the skill required. Skill levels can range from zero to 99.99. ### SkillNumber - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: An auto-generated number identifying the skill requirement. ## 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. - [SkillRequirementChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_change_event.htm): Change events are available for the object. - [SkillRequirementFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_feed.htm): Feed tracking is available for the object. - [SkillRequirementHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_history.htm): History is available for tracked fields of the object. # StandardObjectNameChangeEvent 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. ## Supported Calls describeSObjects() ## Special Access Rules - All objects may not be available in your org. Some objects require specific feature settings and permissions to be enabled. - For more special access rules, if any, see the documentation for the standard object. For example, for AccountChangeEvent, see the special access rules for Account. ## Change Event Support Change events are available for all custom objects and a subset of standard objects. Change events that correspond to custom settings are partially supported. They aren't supported in Apex triggers but are supported in other types of subscribers. For more information about standard object support, see the Objects That Support Change Events section below. ## Change Event Name The name of a change event is based on the name of the corresponding object for which it captures the changes. - **Standard Object Change Event Name**: ChangeEvent Example: AccountChangeEvent - **Custom Object Change Event Name**: \_\_ChangeEvent Example: MyCustomObject\_\_ChangeEvent ## Change Event Fields The fields that a change event can include correspond to the fields on the associated parent Salesforce object, with a few exceptions. For example, AccountChangeEvent fields correspond to the fields on Account. The fields that a change event doesn’t include are: - The IsDeleted system field. - The SystemModStamp system field. - Any field whose value isn’t on the record and is derived from another record or from a formula, except roll-up summary fields, which are included. Examples are formula fields. Examples of fields with derived values include LastActivityDate and PhotoUrl. Each change event also contains header fields. The header fields are included inside the ChangeEventHeader field. They contain information about the event, such as whether the change was an update or delete and the name of the object, like Account. In addition to the event payload, the event schema ID is included in the schema field. Also included is the event-specific field, replayId, which is used for retrieving past events. ## Event Message Example This example is an event message in JSON format for a new account record creation. { "schema": "IeRuaY6cbI\_HsV8Rv1Mc5g", "payload": { "ChangeEventHeader": { "entityName": "Account", "recordIds": \[ "" \], "changeType": "CREATE", "changeOrigin": "com/salesforce/api/soap/51.0;client=SfdcInternalAPI/", "transactionKey": "0002343d-9d90-e395-ed20-cf416ba652ad", "sequenceNumber": 1, "commitTimestamp": 1612912679000, "commitNumber": 10716283339728, "commitUser": "" }, "Name": "Acme", "Description": "Everyone is talking about the cloud. But what does it mean?", "OwnerId": "", "CreatedDate": "2021-02-09T23:17:59Z", "CreatedById": "", "LastModifiedDate": "2021-02-09T23:17:59Z", "LastModifiedById": "" }, "event": { "replayId": 6 } } ## API Version and Schema When you subscribe to change events, the subscription uses the latest API version and the event messages received reflect the latest field definitions. For more information, see [API Version and Event Schema](https://developer.salesforce.com/docs/atlas.en-us.264.0.change_data_capture.meta/change_data_capture/cdc_message_structure.htm#cdc_event_schema.htm) in the Change Data Capture Developer Guide. ## Usage For more information about Change Data Capture, see [Change Data Capture Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.change_data_capture.meta/change_data_capture/cdc_intro.htm). ## Objects That Support Change Events These objects have associated ChangeEvent objects. - AssetAccountParticipant - Vehicle - VehicleDefinition # TelemetryActionDefinition Represents the action taken on a telemetry signal sent from a connected asset or vehicle, such as getting the current status of a vehicle or its component, or sending a request to perform a remote action on the vehicle or its component. ## Parent Type This type extends the Metadata metadata type and inherits its fullName field. ## File Suffix and Directory Location TelemetryActionDefinition components have the suffix .TelemetryActionDefinition and are stored in the TelemetryActionDefinitions folder. ## Version TelemetryActionDefinition components are available in API version 65.0 and later. ## Fields ### actionName - **Field Type**: string - **Description**: Required. The full name of the action related to a telemetry definition. ### description - **Field Type**: string - **Description**: The description of the telemetry action definition. ### developerName - **Field Type**: string - **Description**: The developer’s internal name for the API. For example, if you create a record with MyCustomRecord name, you cannot create another record with that same name. ### executionProcedure - **Field Type**: string - **Description**: The execution procedure that's used to fulfill telemetry action related processes. ### isActive - **Field Type**: boolean - **Description**: Indicates whether the telemetry definition version is active (true) or not (false). - **Default value**: false ### isProtected - **Field Type**: boolean - **Description**: An auto-generated value that doesn’t impact the behavior of the metadata type. - **Default value**: false ### masterLabel - **Field Type**: string - **Description**: Required. A user-friendly name for TelemetryActionDefinition, which is defined when the TelemetryActionDefinition is created. ### telemetryDefinitionVersion - **Field Type**: string - **Description**: Required. The telemetry definition version related to the action. ## Declarative Metadata Sample Definition The following is an example of a TelemetryActionDefinition component. HoodStatusControl Action to monitor and control vehicle hood open/close status and switch operations HoodStatusControl HoodControlFlow true false Hood Status Control VehicleBodyMonitoringv1 The following is an example package.xml that references the previous definition. \* TelemetryActionDefinition 65.0 # TelemetryActionDefinition Represents the action taken on a telemetry signal sent from a connected asset or vehicle, such as getting the current status of a vehicle or its component, or sending a request to perform a remote action on the vehicle or its component. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Fields ### ActionName - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The full name of the action related to a telemetry definition. ### Description - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The description of the telemetry action definition. ### ExecutionProcedureIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unique identifier for the execution procedure that completes the telemetry action related processes. ### IsActive - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the action is active (true) or not (false). The default value is false. ### Language - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort - **Description**: The language of the telemetry action definition. Possible values are: - en\_IN—English (Indian) - en\_US—English ### TelemetryDefinitionVersionId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The telemetry definition version related to the action. This field is a relationship field. - **Relationship Name**: TelemetryDefinitionVersion - **Refers To**: TelemetryDefinitionVersion # TelemetryActionDefStep Represents a step in the action for a telemetry signal definition. ## Parent Type This type extends the Metadata metadata type and inherits its fullName field. ## File Suffix and Directory Location TelemetryActionDefStep components have the suffix .TelemetryActionDefStep and are stored in the TelemetryActionDefSteps folder. ## Version TelemetryActionDefStep components are available in API version 65.0 and later. ## Fields ### delayInSeconds - **Field Type**: int - **Description**: Indicates a delay (in seconds) before the step is executed. ### developerName - **Field Type**: string - **Description**: The developer’s internal name for the API. For example, if you create a record with MyCustomRecord name, you cannot create another record with that same name. ### groupName - **Field Type**: string - **Description**: Required. The name of the group that the telemetry action definition step belongs to. Steps in a group are shown together in an intake form. ### isProtected - **Field Type**: boolean - **Description**: An auto-generated value that doesn’t impact the behavior of the metadata type. - **Default value**: false ### masterLabel - **Field Type**: string - **Description**: Required. A user-friendly name for TelemetryActionDefStep, which is defined when the TelemetryActionDefStep is created. ### operationType - **Field Type**: TelemetryActnDefStepOpType (enumeration of type string) - **Description**: Required. Specifies the type of the operation that's performed in the telemetry action definition step. Values are: - Retrieve - Submit ### remoteEndPointUrl - **Field Type**: string - **Description**: The URL of the remote end point to which a request is shared to execute the telemetry action step. ### sequenceNumber - **Field Type**: int - **Description**: Required. The sequence number of a step in the action related to a telemetry definition. ### targetComponentPath - **Field Type**: string - **Description**: Required. The hierarchical path representing the target component in the telemetry system of a connected asset or vehicle where the action is targeted. ### telemetryActionDefinition - **Field Type**: string - **Description**: Required. The telemetry action definition related to the step. ## Declarative Metadata Sample Definition The following is an example of a TelemetryActionDefStep component. 0 HoodStatusControl\_HoodPositionStep BodyControlResponse false Hood Position Monitor Submit https://api.sample-vehicle-management.com/hood Vehicle.Body.Hood HoodStatusControl The following is an example package.xml that references the previous definition. \* TelemetryActionDefStep 65.0 # TelemetryActionDefStep Represents a step in the action for a telemetry signal definition. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Fields ### GroupName - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The name of the group that the telemetry action definition step belongs to. Steps in a group are shown together in an intake form. ### Language - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort - **Description**: The language of the telemetry action definition step. Possible values are: - en\_IN—English (Indian) - en\_US—English ### OperationType - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the type of the operation that's performed in the telemetry action definition step. Possible values are: Retrieve, or Submit. ### RemoteEndPointUrl - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The URL of the remote end point to which a request is shared to execute the telemetry action step. ### SequenceNumber - **Type**: int - **Properties**: Filter, Group, Sort - **Description**: The sequence number of a step in the action related to a telemetry definition. ### TargetComponentPath - **Type**: string - **Properties**: Create, Filter, Group, Sort - **Description**: The hierarchical path representing the target component in the telemetry system of a connected asset or vehicle where the action is targeted. ### TelemetryActionDefinitionId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The telemetry action definition related to the step. This field is a relationship field. - **Relationship Name**: TelemetryActionDefinition - **Refers To**: TelemetryActionDefinition # TelemetryActionRelatedProcess Represents the relationship between a telemetry action and a process triggered by the action such as a service catalog item definition or a product. This object is available in API version 65.0 and later. ## Supported Calls describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search() ## Fields ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the telemetry action related process. ### RelatedProcessId - **Type**: reference - **Properties**: Filter, Group, Sort - **Description**: The process triggered by the action defined for a telemetry definition. This field is a polymorphic relationship field. - **Relationship Name**: RelatedProcess - **Refers To**: Product2, SvcCatalogItemDef ### TelemetryActionDefinitionId - **Type**: reference - **Properties**: Filter, Group, Sort - **Description**: The action related to a telemetry definition. This field is a relationship field. - **Relationship Name**: TelemetryActionDefinition - **Refers To**: TelemetryActionDefinition # TelemetryActnDefStepAttr Represents the attributes of a telemetry action definition step. ## Parent Type This type extends the Metadata metadata type and inherits its fullName field. ## File Suffix and Directory Location TelemetryActnDefStepAttr components have the suffix .TelemetryActnDefStepAttr and are stored in the TelemetryActnDefStepAttrs folder. ## Version TelemetryActnDefStepAttr components are available in API version 65.0 and later. ## Fields ### allowedValues - **Field Type**: string - **Description**: The allowed values for the telemetry action definition step attribute. ### attributeName - **Field Type**: string - **Description**: Required. The name of the telemetry action definition step attribute. ### dataType - **Field Type**: TelActnDefStepAttrDataType (enumeration of type string) - **Description**: Required. The data type of the telemetry action definition step attribute. Values are: - Boolean - Double - Float - Int16 - Int32 - Int8 - Integer - String - Uint16 - Uint32 - Uint64 - Uint8 ### description - **Field Type**: string - **Description**: The description of the telemetry action definition step attribute. ### developerName - **Field Type**: string - **Description**: The developer’s internal name for the API. For example, if you create a record with MyCustomRecord name, you cannot create another record with that same name. ### isProtected - **Field Type**: boolean - **Description**: An auto-generated value that doesn’t impact the behavior of the metadata type. - **Default value**: false ### masterLabel - **Field Type**: string - **Description**: Required. A user-friendly name for TelemetryActnDefStepAttr, which is defined when the TelemetryActnDefStepAttr is created. ### maximumValue - **Field Type**: double - **Description**: The maximum value allowed for the telemetry action definition step attribute. ### minimumValue - **Field Type**: double - **Description**: The minimum value allowed for the telemetry action definition step attribute. ### telemetryActnDefStep - **Field Type**: string - **Description**: Required. The telemetry action definition step that this attribute belongs to. ### type - **Field Type**: TelemetryActnDefStepAttrType (enumeration of type string) - **Description**: Required. The type of the telemetry action definition step attribute. Values are: - Actuator - Sensor ### unitOfMeasure - **Field Type**: string - **Description**: The unit of measure of the telemetry action definition step attribute. ## Declarative Metadata Sample Definition The following is an example of a TelemetryActnDefStepAttr component. INACTIVE,CLOSE,OPEN Position int8 sliding action such as window. HoodStatusControl\_HoodPositionStep\_Position false Hood Position Control HoodStatusControl\_HoodPositionStep Actuator Action The following is an example package.xml that references the previous definition. \* TelemetryActnDefStepAttr 65.0 # TelemetryActnDefStepAttr Represents the attributes of a telemetry action definition step. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Fields ### AllowedValues - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The allowed values for the telemetry action definition step attribute. ### AttributeName - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The name of the telemetry action definition step attribute. ### DataType - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: The data type of the telemetry action definition step attribute. Possible values are: - Boolean - Double - Float - Int16 - Int32 - Int8 - Integer - String - Uint16 - Uint32 - Uint64 - Uint8 ### Description - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The description of the telemetry action definition step attribute. ### DeveloperName - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The name of the telemetry action definition step attribute. ### Language - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort - **Description**: The language of the telemetry action definition step attribute. Possible values are: - en\_IN—English (Indian) - en\_US—English ### MaximumValue - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The maximum value allowed for the telemetry action definition step attribute. ### MinimumValue - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The minimum value allowed for the telemetry action definition step attribute. ### TelemetryActnDefStepId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The telemetry action definition step that this attribute belongs to. This field is a relationship field. - **Relationship Name**: TelemetryActnDefStep - **Refers To**: TelemetryActionDefStep ### Type - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: The type of the telemetry action definition step attribute. ### UnitOfMeasure - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unit of measure of the telemetry action definition step attribute. # TelemetryDefinition Represents the definition of the structure of a telemetry signal sent from a connected asset or vehicle. ## Parent Type This type extends the Metadata metadata type and inherits its fullName field. ## File Suffix and Directory Location TelemetryDefinition components have the suffix .TelemetryDefinition and are stored in the TelemetryDefinitions folder. ## Version TelemetryDefinition components are available in API version 65.0 and later. ## Fields ### description - **Field Type**: string - **Description**: The description of the telemetry definition. ### developerName - **Field Type**: string - **Description**: The developer’s internal name for the API. For example, if you create a record with MyCustomRecord name, you cannot create another record with that same name. ### isProtected - **Field Type**: boolean - **Description**: An auto-generated value that doesn’t impact the behavior of the metadata type. - **Default value**: false ### isTemplate - **Field Type**: boolean - **Description**: Required. Indicates whether the telemetry definition is a template (true) or not (false). - **Default value**: false ### masterLabel - **Field Type**: string - **Description**: Required. A user-friendly name for TelemetryDefinition, which is defined when the TelemetryDefinition is created. ### usageType - **Field Type**: TelemetryDefinitionUsageType (enumeration of type string) - **Description**: The usage type of the telemetry definition. - **Possible values**: - ConnectedAsset—Connected Asset - ConnectedVehicle—Connected Vehicle ## Declarative Metadata Sample Definition The following is an example of a TelemetryDefinition component. Telemetry definition for monitoring vehicle engine parameters including temperature, RPM, and fuel consumption VehicleEngineMonitoring false false VehicleEngineMonitoring ConnectedVehicle The following is an example package.xml that references the previous definition. \* TelemetryDefinition 65.0 # TelemetryDefinition Represents the definition of the structure of a telemetry signal sent from a connected asset or vehicle. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Fields ### Description - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The description of the telemetry definition. ### IsTemplate - **Type**: boolean - **Properties**: Defaulted on create, Filter, Group, Sort - **Description**: Indicates whether the telemetry definition is a template (true) or not (false). The default value is false. ### LatestVersionId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The latest version of the telemetry definition. The telemetry definition version with the highest version number is the latest. This field is a relationship field. - **Relationship Name**: LatestVersion - **Refers To**: TelemetryDefinitionVersion ### Language - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort - **Description**: The language of the telemetry definition. Possible values are: - en\_IN—English (Indian) - en\_US—English ### UsageType - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: The usage type of the telemetry definition. Possible values are: - ConnectedAsset—Connected Asset - ConnectedVehicle—Connected Vehicle # TelemetryDefinitionVersion Represents a version of the structure of a telemetry signal sent from a connected asset or vehicle. ## Parent Type This type extends the Metadata metadata type and inherits its fullName field. ## File Suffix and Directory Location TelemetryDefinitionVersion components have the suffix .TelemetryDefinitionVersion and are stored in the TelemetryDefinitionVersions folder. ## Version TelemetryDefinitionVersion components are available in API version 65.0 and later. ## Fields ### description - **Field Type**: string - **Description**: The description of the telemetry definition version. ### developerName - **Field Type**: string - **Description**: The developer’s internal name for the API. For example, if you create a record with MyCustomRecord name, you cannot create another record with that same name. ### isActive - **Field Type**: boolean - **Description**: Indicates whether the telemetry definition version is active (true) or not (false). - **Default value**: false ### isProtected - **Field Type**: boolean - **Description**: An auto-generated value that doesn’t impact the behavior of the metadata type. - **Default value**: false ### masterLabel - **Field Type**: string - **Description**: Required. A user-friendly name for TelemetryDefinitionVersion, which is defined when the TelemetryDefinitionVersion is created. ### telemetryComponentStructure - **Field Type**: string - **Description**: The structure of the components in the telemetry definition that send signals, represented in a JSON format. ### telemetryDefinition - **Field Type**: string - **Description**: Required. The telemetry definition that's associated with the telemetry definition version. ### versionNumber - **Field Type**: int - **Description**: Required. The version number of the telemetry definition version. ## Declarative Metadata Sample Definition The following is an example of a TelemetryDefinitionVersion component. Initial version of vehicle engine monitoring telemetry definition VehicleEngineMonitoringv1 false false Vehicle Engine Monitoring v1.0 ewogICAgIlZlaGljbGUiOiB7CiAgICAgICAgImNoaWxkcmVuIjogewogICAgICAgICAgICAiQm9keSI6IHsKICAgICAgICAgICAgICAgICJjaGlsZHJlbiI6IHsKICAgICAgICAgICAgICAgICAgICAiSG9vZCI6IHsKICAgICAgICAgICAgICAgICAgICAgICAgImNoaWxkcmVuIjogewogICAgICAgICAgICAgICAgICAgICAgICAgICAgIlBvc2l0aW9uIjogewogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICJjb21tZW50IjogIi4iLAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICJkYXRhdHlwZSI6ICJ1aW50OCIsCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgImRlc2NyaXB0aW9uIjogIkl0ZW0gcG9zaXRpb24uIDAgPSBTdGFydCBwb3NpdGlvbiAxMDAgPSBFbmQgcG9zaXRpb24uIiwKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAibWF4IjogMTAwLAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICJtaW4iOiAwLAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICJ0eXBlIjogImFjdHVhdG9yIiwKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAidW5pdCI6ICJwZXJjZW50IgogICAgICAgICAgICAgICAgICAgICAgICAgICAgfSwKICAgICAgICAgICAgICAgICAgICAgICAgICAgICJTd2l0Y2giOiB7CiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgImFsbG93ZWQiOiBbCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICJJTkFDVElWRSIsCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICJDTE9TRSIsCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICJPUEVOIiwKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIk9ORV9TSE9UX0NMT1NFIiwKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIk9ORV9TSE9UX09QRU4iCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgXSwKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAiZGF0YXR5cGUiOiAic3RyaW5nIiwKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAiZGVzY3JpcHRpb24iOiAic2xpZGluZyBhY3Rpb24gc3VjaCBhcyB3aW5kb3cuIiwKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAidHlwZSI6ICJhY3R1YXRvciIKICAgICAgICAgICAgICAgICAgICAgICAgICAgIH0KICAgICAgICAgICAgICAgICAgICAgICAgfSwKICAgICAgICAgICAgICAgICAgICAgICAgImNvbW1lbnQiOiAiIiwKICAgICAgICAgICAgICAgICAgICAgICAgImRlc2NyaXB0aW9uIjogIkhvb2Qgc3RhdHVzIiwKICAgICAgICAgICAgICAgICAgICAgICAgInR5cGUiOiAiYnJhbmNoIgogICAgICAgICAgICAgICAgICAgIH0KICAgICAgICAgICAgICAgIH0sCiAgICAgICAgICAgICAgICAiZGVzY3JpcHRpb24iOiAiQWxsIGJvZHkgY29tcG9uZW50cy4iLAogICAgICAgICAgICAgICAgInR5cGUiOiAiYnJhbmNoIgogICAgICAgICAgICB9CiAgICAgICAgfSwKICAgICAgICAiZGVzY3JpcHRpb24iOiAiSGlnaC1sZXZlbCB2ZWhpY2xlIGRhdGEuIiwKICAgICAgICAidHlwZSI6ICJicmFuY2giCiAgICB9Cn0= VehicleEngineMonitoring 1 The following is an example package.xml that references the previous definition. \* TelemetryDefinitionVersion 65.0 # TelemetryDefinitionVersion Represents a version of the structure of a telemetry signal sent from a connected asset or vehicle. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Fields ### Description - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The description of the telemetry definition version. ### IsActive - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the telemetry definition version is active (true) or not (false). The default value is false. ### Language - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort - **Description**: The language of the telemetry definition version. Possible values are: - en\_IN—English (Indian) - en\_US—English ### TelemetryComponentStructure - **Type**: base64 - **Properties**: Create, Nillable, Update - **Description**: The structure of the components in the telemetry definition that send signals, represented in a JSON format. ### TelemetryDefinitionId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The telemetry definition that's associated with the telemetry definition version. This field is a relationship field. - **Relationship Name**: TelemetryDefinition - **Refers To**: TelemetryDefinition ### VersionNumber - **Type**: int - **Properties**: Filter, Group, Nillable, Sort - **Description**: The version number of the telemetry definition version. # Timeline in Automotive Cloud Use Timeline to configure a chronological view of records from multiple objects.
Available in: Enterprise, Unlimited, and Developer Editions.
For more information about Timeline, see [TimelineObjectDefinition](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/tooling_api_objects_timelineobjectdefinition.htm). # TimeSlot Represents a period of time on a specified day of the week during which an appointment can be scheduled. This object is available in API version 58.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Special Access Rules Automotive and Automotive Scheduler must be enabled. ## Fields ### DayOfWeek - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update - **Description**: The day of the week when the time slot takes place. Possible values are: The default value is Sunday. - Friday - Monday - Saturday - Sunday - Thursday - Tuesday - Wednesday ### EndTime - **Type**: time - **Properties**: Create, Filter, Sort, Update - **Description**: The time when the time slot ends. ### 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. ### MaxAppointments - **Type**: int - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Maximum number of appointments for a single time slot. ### OperatingHoursId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The operating hours that the time slot belongs to. An operating hours’ time slots appear in the Operating Hours related list. This field is a relationship field. - **Relationship Name**: OperatingHours - **Relationship Type**: Lookup - **Refers To**: OperatingHours ### StartTime - **Type**: time - **Properties**: Create, Filter, Sort, Update - **Description**: The time when the time slot starts. ### TimeSlotNumber - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the time slot. The name is auto-populated to a day and time format—for example, Monday 9:00 AM - 10:00 PM—but you can manually update it. ### WorkTypeGroupId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Work type group assigned to the time slot. This field is a relationship field. - **Relationship Name**: WorkTypeGroup - **Relationship Type**: Lookup - **Refers To**: WorkTypeGroup ## 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. - [TimeSlotChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_change_event.htm): Change events are available for the object. - [TimeSlotHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_history.htm): History is available for tracked fields of the object. # TransactionJournal Represents proof of sale of parts and accessories submitted by a dealer to the vehicle manufacturer. This report can also be used for rebate payout calculations. This object is available in Automotive Cloud in API version 56.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### AccountId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The dealer account associated with the record. This field is a relationship field. - **Relationship Name**: Account - **Relationship Type**: Lookup - **Refers To**: Account ### ActivityDate - **Type**: dateTime - **Properties**: Create, Filter, Sort, Update - **Description**: The date of the transaction. ### ErrorDescription - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The description of the error in the journal record. ### ExternalTransactionNumber - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The transaction number from the external systems. ### InvoiceDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date the invoice was generated. ### JournalDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date of the journal. ### JournalTypeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The type of journal transaction. This field is a relationship field. - **Relationship Name**: JournalType - **Relationship Type**: Lookup - **Refers To**: JournalType ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user referenced this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user viewed this record. ### MemberId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The rebate program member associated with this record. This field is a polymorphic relationship field. - **Relationship Name**: Member - **Relationship Type**: Lookup - **Refers To**: RebateProgramMember ![Note](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/images/icon_note.png) #### Note Use this field if you have enabled Rebate Management in your org and the dealer submitting the transaction is part of a rebate program. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Autogenerated unique identifier of the transaction journal record. ### OrderId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The order associated with the transaction. This field is a relationship field. - **Relationship Name**: Order - **Relationship Type**: Lookup - **Refers To**: Order ### OrderItemId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The order items associated with the transaction. This field is a relationship field. - **Relationship Name**: OrderItem - **Relationship Type**: Lookup - **Refers To**: OrderItem ### ProductCategoryId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The category of the product associated with the transaction. This field is a relationship field. - **Relationship Name**: ProductCategory - **Relationship Type**: Lookup - **Refers To**: ProductCategory ### ProductId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The product associated with the transaction. This field is a relationship field. - **Relationship Name**: Product - **Relationship Type**: Lookup - **Refers To**: Product2 ### Quantity - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The product quantity associated with the transaction. ### QuantityUnitOfMeasureId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unit of measure associated with the record. This field is a relationship field. - **Relationship Name**: QuantityUnitOfMeasure - **Relationship Type**: Lookup - **Refers To**: UnitOfMeasure ### RebatePgmReferenceNumber - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The reference number of the rebate program in which the dealer is enrolled. ![Note](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/images/icon_note.png) #### Note Use this field if you have enabled Rebate Management in your org and the dealer submitting the transaction is part of a rebate program. ### ReferenceRecordId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The record of an asset or vehicle that's associated with this transaction. This field is a polymorphic relationship field. - **Relationship Name**: ReferenceRecord - **Relationship Type**: Lookup - **Refers To**: Asset, Vehicle ### ShipToAccountId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The customer or partner account associated with the transaction. This field is a relationship field. - **Relationship Name**: ShipToAccount - **Relationship Type**: Lookup - **Refers To**: Account ### TradedFromAccountId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The account of the dealer who sells a product to another dealer or distributor who further fulfills the final demand. This field is a relationship field. - **Relationship Name**: TradedFromAccount - **Relationship Type**: Lookup - **Refers To**: Account ### TradedToAccountId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The account of the dealer who purchases a product from another dealer or distributor to complete their inventory requirement. This field is a relationship field. - **Relationship Name**: TradedToAccount - **Relationship Type**: Lookup - **Refers To**: Account ### TransactionAmount - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The total amount of the transaction. ### UsageType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort - **Description**: Type of journal record. Possible values are: Analytics, Loyalty, Rebates, or Auto. ## 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. - [TransactionJournalChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_change_event.htm): Change events are available for the object. # Transformation Input Input representation for converting an input object type to an output object type. ## JSON Example { “inputObjectIds”: \[ “0sTxx000000003FEAQ”, “0sTxx000000004rEAA”, “0sTxx0000000001EAA”, “0sTxx000000001dEAA” \], “inputObjectName”: “LeadLineItem”, “usageType”: “TransformationMapping”, “outputObjectName”: “OpportunityLineItem”, “outputObjectDefaultValues”: { “OpportunityLineItem” : { “OpportunityId”: "abcd1234", “CurrencyIsoCode”:“USD” // This is required in mutli currency enabled org. } } } ## Properties
Name Type Description Required or Optional Available Version
inputObjectIds String[] The list of record IDs for the input object type containing the mapping definition used to create the business transformation. The list of IDs must all be for the same object type. Required 55.0
inputObjectName String The name of the input object containing the mapping definition used to create the business transformation. Possible values are:
  • MfgProgramCpntFrcstFact
  • ManufacturingProgram
  • MfgProgramCpntFrcstFact
  • Period
  • Quote
  • QuoteLineItem
 Required 55.0
outputObjectDefaultValues Map<String, String>> The default values for the output object that are created from the input object IDs. Optional 55.0
outputObjectName String The name of the output object that is created from the input object IDs. Required 55.0
usageType String Usage type of the transformation. Possible values are:
  • ConvertToSalesAgreement
  • CLMFieldMapping
  • EligibleProgramRebateType
  • MapJournalToMemberAggregate
  • TransformationMapping
 Required 55.0
# Transformation Output Represents the details of the transformation from source object to target object. ## JSON Example { "outputObjectDetails": \[ { "outputId": "Y\_id1", "inputIds": \[ "X\_id1", "X\_id2" \] } \], "errorDetails": \[ { "inputIds": \[ "X\_id3", "X\_id4" \], "errorReason": "Mandatory field1 missing value" } \], "Status" : "" } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | outputObjectDetails | [Object Details Output](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/auto_connect_responses_output_object_detail.htm "Represents the details of the transformation object.")\[\] | Provides information on the input and output IDs, error details, and the status of the transformation. | Small, 55.0 | 55.0 | | status | String | The status of the transformation request. | Small, 55.0 | 55.0 | # Transformations Perform the business transformation of lead line item or lead preferred seller data (source object) to opportunities line item or opportunity preferred seller data (target object). The following are some of the transformation scenarios: LeadLineItem to OpportunityLineItem, and LeadPreferredSeller to OpportunityPreferredSeller. ## Resource /connect/manufacturing/transformations ## Resource Example https://yourInstance.salesforce.com/services/data/vXX.X/connect​/manufacturing/transformations ## Available Version 55.0 ## Requires Chatter No ## HTTP Methods POST ## Request Body for POST ### JSON Example { “inputObjectIds”: \[ “0sTxx000000003FEAQ”, “0sTxx000000004rEAA”, “0sTxx0000000001EAA”, “0sTxx000000001dEAA” \], “inputObjectName”: “LeadLineItem”, “usageType”: “TransformationMapping”, “outputObjectName”: “OpportunityLineItem”, “outputObjectDefaultValues”: { “OpportunityLineItem” : { “OpportunityId”: "abcd1234", “CurrencyIsoCode”:“USD” // This is required in multi currency enabled org. } } } ### Properties
Name Type Description Required or Optional Available Version
inputObjectIds String[] The list of record IDs for the input object type containing the mapping definition used to create the business transformation. The list of IDs must all be for the same object type. Required 55.0
inputObjectName String The name of the input object containing the mapping definition used to create the business transformation. Possible values are:
  • MfgProgramCpntFrcstFact
  • ManufacturingProgram
  • MfgProgramCpntFrcstFact
  • Period
  • Quote
  • QuoteLineItem
 Required 55.0
outputObjectDefaultValues Map<String, String>> The default values for the output object that are created from the input object IDs. Optional 55.0
outputObjectName String The name of the output object that is created from the input object IDs. Required 55.0
usageType String Usage type of the transformation. Possible values are:
  • ConvertToSalesAgreement
  • CLMFieldMapping
  • EligibleProgramRebateType
  • MapJournalToMemberAggregate
  • TransformationMapping
 Required 55.0
## Response Body for POST [Transformation Output](https://developer.salesforce.com/docs/atlas.en-us.automotive_cloud.meta/automotive_cloud/auto_response_body_transformation_output.htm "Represents the details of the transformation from source object to target object.") # VehDefSearchableField Represents multiple fields from objects such as Product, Price Book, and Vehicle Definition, that are used to search a vehicle's model specifications in vehicle and asset lending. This object is available in API version 63.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### BodyType - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The body type or style of the vehicle, such as hatchback, SUV, or coupe. ### BusinessBrandId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of a Business Brand record related to a vehicle model. This field is a relationship field. - **Relationship Name**: BusinessBrand - **Refers To**: BusinessBrand ### BusinessBrandName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the business brand related to a vehicle model. ### DoorCount - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The number of doors in the vehicle model, such as 2 or 4. ### DoorStyle - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The door style of the vehicle. ### DrivetrainSystem - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The drivetrain system implemented in the vehicle. ### EmissionStandard - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The emission standard applicable to the vehicle, such as EURO 5, or LEV. ### EngineCapacity - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The engine capacity of the vehicle model, such as 1900 cc. ### FuelSource - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The power source used in the vehicle. ### GeoCountryId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The Geo Country code associated with the specific vehicle model and variant. This field is a relationship field. - **Relationship Name**: GeoCountry - **Refers To**: GeoCountry ### GeoCountryName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The country associated with the specific vehicle model and variant. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date the associated location was last modified. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date the associated location was last viewed. ### ListPrice - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The price of the vehicle definition configured in the price book entry. ### MainBatteryType - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The type of battery used in the vehicle, such as Lithium Ion, or gel cell battery (Dry Cell). ### MakeName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The make name of a vehicle. ### ModelName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The model name of a vehicle. ### ModelVersionName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The version name associated with the vehicle model. ### ModelYear - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The model year of a vehicle. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the vehicle definition searchable field. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The owner ID of the vehicle definition searchable field. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### PriceBookEntryId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the Price Book Entry record related to the product. This field is a relationship field. - **Relationship Name**: PriceBookEntry - **Refers To**: PricebookEntry ### ProductCode - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unique code of a Product record related to the vehicle model. ### ProductFamily - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The product family to which a vehicle belongs. ### ProductId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The ID of the Product record related to a vehicle defintion. This field is a relationship field. - **Relationship Name**: Product - **Refers To**: Product2 ### ProductImageUrl - **Type**: url - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The URL to the image of a product. ### TopSpeed - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The highest speed the vehicle model can achieve. ### TransmissionSystem - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The transmission type of the vehicle. ### TrimType - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The trim type of the vehicle model, such as DX, GT,or LS. ### UniversalProductCode - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The universal product code used to track the part used in the product. ### VariantName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The variant of a specific vehicle, such as LS or XD. ### VehicleClass - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The classification or category of the vehicle such as sport, utility, or sedan. ### VehicleDefinitionId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The ID of the Vehicle Definition record. This field is a relationship field. - **Relationship Name**: VehicleDefinition - **Refers To**: VehicleDefinition ### VehicleDefinitionName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the vehicle definition related to a vehicle. ## 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. - [VehDefSearchableFieldOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_ownersharingrule.htm): Sharing rules are available for the object. - [VehDefSearchableFieldShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_share.htm): Sharing is available for the object. # Vehicle Represents information about a vehicle. This object is available in API version 56.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### ActiveRecallCount - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The number of active recalls for parts related to the vehicle. ### ActiveServiceContractCount - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The number of active service contracts for the vehicle. ### ActiveSubscriptionCount - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The number of active subscriptions for the vehicle. ### ActiveWarrantyCount - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The number of active warranties for the vehicle. ### AssetId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The asset associated with the vehicle. This field is unique within your organization. This field is a relationship field. - **Relationship Name**: Asset - **Relationship Type**: Lookup - **Refers To**: Asset ### AverageMarketValue - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The average market value of the vehicle. ### ChassisNumber - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The chassis number that is unique to the vehicle. ### Classification - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: Auto-populated based on the vehicle classification specified on the related vehicle definition. ### ConditionType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the current status of the vehicle. Possible values are: New, Old, or Scrap. ### CurrentOwnerId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The current owner of the vehicle. This field is a relationship field. - **Relationship Name**: CurrentOwner - **Relationship Type**: Lookup - **Refers To**: Account ### CylinderCount - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The number of cylinders in the engine of the vehicle. ### DrivetrainSystem - **Type**: picklist - **Properties**: Filter, Group, Nillable, Sort - **Description**: Auto-populated based on the drivetrain system specified on the related vehicle definition. ### EngineName - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: Auto-populated based on the engine name specified on the related vehicle definition. ### EngineNumber - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The engine number of the vehicle. ### ExteriorColor - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The exterior color of the vehicle. ### FrontRimSize - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The rim size of the front wheel of the vehicle. ### FrontTireSize - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The size of the front tire of the vehicle. ### FuelSource - **Type**: picklist - **Properties**: Filter, Group, Nillable, Sort - **Description**: Auto-populated based on the fuel source specified on the related vehicle definition. ### GearBoxType - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The gear box type for the vehicle. ### HeadUnitName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The head unit of the vehicle. ### HeadUnitSecurityCode - **Type**: encryptedstring - **Properties**: Create, Nillable, Update - **Description**: The anti-theft code or security code that unlocks the head unit of a car. If the factory car stereo is stolen from the vehicle, the head unit becomes inoperable without this code. ### HighestMarketValue - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The highest market value of the vehicle. ### IgnitionKeyCode - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unique code associated with a vehicle's ignition key that is useful in case it's stolen or replaced. ### InteriorColor - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The interior color of the vehicle. ### IsConnectedServiceActive - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether connected services for a vehicle are active (true) or not (false). The default value is false. ### IsRecallOpen - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicate whether a recall is required for the vehicle. The default value is false. ### IsTelematicsServiceActive - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the vehicle has any subscription to Telematics Services or not. Telematics services collect key performance data related to a vehicle. The default value is false. ### LastOdometerReading - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The last odometer reading that was recorded for the vehicle. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user referenced this record. ### LastServiceDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date when the vehicle was last serviced. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user viewed this record. ### LatestResidualValue - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The residual value of the vehicle. ### LatestResidualValueDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date when the residual value is calculated. ### Location - **Type**: address - **Properties**: Filter, Nillable - **Description**: The current location of the vehicle. ### LocationCity - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The city where the vehicle is located. ### LocationCountry - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The country where the vehicle is located. ### LocationGeocodeAccuracy - **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 vehicle’s latitude and longitude coordinates. Possible values are: - Address - Block - City - County - ExtendedZip - NearAddress - Neighborhood - State - Street - Unknown - Zip ### LocationLatitude - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Used with Longitude to specify the precise geolocation of the vehicle. Acceptable values are numbers between –90 and 90 with up to 15 decimal places. ### LocationLongitude - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Used with Latitude to specify the precise geolocation of the vehicle. Acceptable values are numbers between –180 and 180 with up to 15 decimal places. ### LocationPostalCode - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The postal code where the vehicle is located. ### LocationState - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The state where the vehicle is located. ### LocationStreet - **Type**: textarea - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The street where the vehicle is located. ### LowestMarketValue - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The lowest market value of the vehicle. ### MakeName - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: Auto-populated based on the make name on the product record related to the vehicle definition. ### ManufacturedDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The manufacturing date of the vehicle. ### ManufacturerWarrantyEndDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date until which the factory warranty is applicable for the vehicle. ### ManufacturerWarrantyStartDt - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date from which the factory warranty is applicable for the vehicle. ### ManufacturingBatchNumber - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The manufacturing batch number of the vehicle. ### ManufacturingPlantName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the manufacturing plant for the vehicle. ### MarketPrice - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The market price of the vehicle. ### MarketPriceDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date when the market price is calculated. ### MarketPriceSource - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The source for the market price of the vehicle. Possible values are: NationalAutomobileDealersAssociation, or KellyBluebook. ### ModelName - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: Auto-populated based on the model name on the product record related to the vehicle definition. ### ModelYear - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: Auto-populated based on the model year on the product record related to the vehicle definition. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the vehicle. ### OdometerReadingDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The most recent date when the odometer reading was taken. ### OdometerReadingUomId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The odometer reading UOM associated with the vehicle. This field is a relationship field. - **Relationship Name**: OdometerReadingUom - **Relationship Type**: Lookup - **Refers To**: UnitOfMeasure ### OdometerState - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the current status of the odometer in the vehicle. Use this field because the field OdometerStatus will be deprecated soon. ### OdometerStatus - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the condition of the odometer such as new, tampered, or replaced. Possible values are: - Altered - ExceedsMechanicalLimit—Exceeds Mechanical Limit - Exempt - New - Normal - Replaced - Tampered ### RearRimSize - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The rim size of the rear wheel of the vehicle. ### RearTireSize - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The size of the rear tire of the vehicle. ### RegistrationRegionCode - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the state code associated with this registration number. Possible values are: - AZ - CA - IA - NJ - NY - TX ### RegistrationValidityDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date until which the registration of the vehicle is valid. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The unique identifier of the vehicle in the external system. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The external system from where this record was imported. ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The status of the vehicle. Possible values are: At Dealer Location, In Service, In Repair, or In Manufacturing. ### SteeringType - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The steering type of the vehicle. ### StockCode - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unique code assigned to a vehicle at the dealership to keep track of the inventory. ### TrimLevel - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: Auto-populated based on the trim level on the product record related to the vehicle definition. ### UpholsteryColor - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The color of the upholstery of the vehicle. ### UpholsteryType - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The type of upholstery material of the vehicle. ### VehicleDefinitionId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The vehicle specification associated with the vehicle. This field is a relationship field. - **Relationship Name**: VehicleDefinition - **Relationship Type**: Lookup - **Refers To**: VehicleDefinition ### VehicleIdentificationNumber - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The number that uniquely identifies the vehicle. This field is unique within your organization. ### VehicleRegistrationNumber - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The registration number issued for the vehicle. ## 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. - [VehicleChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_change_event.htm) (API Version 66.0): Change events are available for the object. - [VehicleFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_feed.htm): Feed tracking is available for the object. - [VehicleHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_history.htm) (API Version 66.0): History is available for tracked fields of the object. # VehicleDefinition Represents information about a typical vehicle model. This object is available in API version 56.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AccelerationTime - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The acceleration time of the vehicle model. ### AuxiliaryBatteryType - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The type of auxiliary battery used in the vehicle model. ### BatteryCapacity - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The capacity of the battery fitted in the vehicle model. ### BodyType - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The body type of the vehicle model. ### CombinedFuelEconomy - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The overall fuel consumption, which is the total of urban and extra-urban fuel consumption. ### CurbWeight - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The weight of the vehicle model without any payload, such as fuel, passengers, cargo, and so on. ### DoorCount - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The number of doors in the vehicle model. ### DoorStyle - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The style of doors in a vehicle. Use this field because the field DoorStyleType will be deprecated soon. ### DoorStyleType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The door style of the vehicle model. Possible values are: - Butterfly - GullWing—Gull Wing - Regular - Scissor ### DrivetrainSystem - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The drivetrain system implemented in the vehicle. Use this field because the field DrivetrainType will be deprecated soon. ### DrivetrainType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The drivetrain system implemented in the vehicle model. Possible values are: - AWD - FWD - FourWD—4WD - RWD ### EmissionStandard - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The emission standard applicable to the vehicle model. ### EngineCubicCapacity - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The engine capacity of the vehicle model. ### EngineName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The engine used in the vehicle model. ### ExternalReferenceNumber - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unique identifier of the vehicle model. This is an external ID. ### ExtraUrbanFuelEconomy - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The fuel consumption in the country roads and motorways driving environment. ### FuelSource - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The power source used in the vehicle. Use this field because the field FuelType will be deprecated soon. ### FuelTankCapacity - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The fuel tank capacity of the vehicle model. ### FuelType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The power source used in the vehicle model. Possible values are: Battery, CNG, Diesel, Gasoline, or Hybrid. ### GeoCountryId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The country associated with the vehicle model’s specifications. This field is a relationship field. - **Relationship Name**: GeoCountry - **Relationship Type**: Lookup - **Refers To**: GeoCountry ### Height - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The height of the vehicle model. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user referenced this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user viewed this record. ### Length - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The length of the vehicle model. ### MainBatteryType - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The type of main battery used in the vehicle model. ### MaximumBatteryRange - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The distance the vehicle model can run with the available battery capacity. ### MaximumGrossWeight - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The weight of the vehicle model with the maximum payload that it can carry. ### MaximumTorque - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The maximum torque of the vehicle model. ### MinimumBatteryRange - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The minimum range of the battery for the vehicle model. ### ModelCode - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The code of the vehicle model. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the vehicle model. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the user who owns this record. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### ProductId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The Product record associated with the vehicle model. This field is a relationship field. - **Relationship Name**: Product - **Relationship Type**: Lookup - **Refers To**: Product2 ### TopSpeed - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The highest speed that the vehicle model can achieve. ### TotalPower - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The maximum power that the vehicle model can deliver. ### TransmissionSystem - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The transmission system implemented in the vehicle. Use this field because the field TransmissionType will be deprecated soon. ### TransmissionType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The transmission type of the vehicle model. Possible values are: Automatic, or Manual. ### UrbanFuelEconomy - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The fuel consumption in the city driving environment. ### VariantName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The variant name associated with the vehicle model. ### VehicleClass - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The classification of the vehicle model. ### Wheelbase - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The wheelbase of the vehicle model. ### Width - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The width of the vehicle model. ## 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. - [VehicleDefinitionChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_change_event.htm) (API Version 66.0): Change events are available for the object. - [VehicleDefinitionFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_feed.htm): Feed tracking is available for the object. - [VehicleDefinitionHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_history.htm): History is available for tracked fields of the object. # VehicleSearchableField Represents a common dataset including multiple fields and values from multiple objects and is used as the basis for inventory search related to vehicles. This object is available in API version 58.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules Automotive and Criteria-Based Search and Filter must be enabled. ## Fields ### AssetId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Lookup to an Asset record. This field is a relationship field. - **Relationship Name**: Asset - **Relationship Type**: Lookup - **Refers To**: Asset ### BodyType - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The body type or style of the vehicle, such as hatchback, SUV, or coupe. ### BusinessBrandId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Lookup to the Business Brand related to a vehicle model. This field is a relationship field. - **Relationship Name**: BusinessBrand - **Relationship Type**: Lookup - **Refers To**: BusinessBrand ### BusinessBrandName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the business brand related to a vehicle model. ### CurrentOwnerAccountId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Lookup to an Account record that's the current owner of a vehicle. This field is a relationship field. - **Relationship Name**: CurrentOwnerAccount - **Relationship Type**: Lookup - **Refers To**: Account ### CurrentOwnerName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the current owner of a vehicle. ### DealerAccountId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Lookup to an Account record related to the dealer of a vehicle. This field is a relationship field. - **Relationship Name**: DealerAccount - **Relationship Type**: Lookup - **Refers To**: Account ### DealerName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the dealer account related to a vehicle. ### DoorCount - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The number of doors in the vehicle model, such as 2 or 4. ### DoorStyleType - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The style of doors in the vehicle model, such as wing doors, swing-up doors, or switchblade doors. ### EmissionStandard - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The emission standard applicable to the vehicle, such as EURO 5, or LEV. ### EngineCubicCapacity - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The engine capacity of the vehicle model, such as 1900 cc. ### ExteriorColor - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The exterior color of a vehicle. ### FuelType - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The power source used in the vehicle such as Gasoline, CNG, Hybrid, Battery, or Diesel. ### GearBoxType - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The type of gear box in a vehicle, such as AMT or CVT. ### GeoCountryId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Lookup to the Geo Country code associated with the specific vehicle model. This field is a relationship field. - **Relationship Name**: GeoCountry - **Relationship Type**: Lookup - **Refers To**: GeoCountry ### GeoCountryName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The country associated with the specific vehicle model and variant. ### InventoryLocationCoordinates - **Type**: location - **Properties**: Nillable - **Description**: The latitude and longitude coordinates of an inventory location for a vehicle. ### InventoryLocationCoordinatesLatitude - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Used with Longitude to specify the precise geolocation of an inventory location. Acceptable values are numbers between –90 and 90 with up to 15 decimal places. ### InventoryLocationCoordinatesLongitude - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Used with Longitude to specify the precise geolocation of an inventory location. Acceptable values are numbers between –180 and 180 with up to 15 decimal places. ### InventoryLocationId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Lookup to a Location record related to the product item for a vehicle. This field is a relationship field. - **Relationship Name**: InventoryLocation - **Relationship Type**: Lookup - **Refers To**: Location ### InventoryLocationName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of an inventory location for a vehicle. ### InventoryLocationType - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The type of an inventory location for a vehicle. ### IsProductSerialized - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the product is serialized (true), or not (false). The default value is false. ### IsRecallOpen - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether a vehicle is open for recall (true) or not (false). The default value is false. ### LastOdometerReading - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The latest odometer reading for a vehicle. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date when the record was last modified. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date when the record was last viewed. ### MainBatteryType - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The type of battery used in the vehicle, such as Lithium Ion, or gel cell battery (Dry Cell). ### MakeName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The make name of a vehicle. ### ManufacturedDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date on which a vehicle is manufactured. ### MarketPrice - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The market price of a vehicle. ### ModelName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The model name of a vehicle. ### ModelYear - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The model year of a vehicle. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The system-defined name of the VehicleSearchableField record. ### OdometerStatus - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The status of a vehicle's odometer, such as new or tampered. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The owner of the VehicleSearchableField record. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### ParentInventoryLocationId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Lookup to the parent inventory location for a vehicle. This field is a relationship field. - **Relationship Name**: ParentInventoryLocation - **Relationship Type**: Lookup - **Refers To**: Location ### ParentInventoryLocationName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the parent inventory location for a vehicle. ### ParentInventoryLocationType - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The type of the parent inventory location for a vehicle. ### ProductCode - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unique code of a Product record related to the vehicle model. ### ProductFamily - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The product family to which a vehicle belongs. ### ProductId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Lookup to a Product record related to a vehicle. This field is a relationship field. - **Relationship Name**: Product - **Relationship Type**: Lookup - **Refers To**: Product2 ### ProductImageUrl - **Type**: url - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The URL to the image of a product. Available in API version 63.0 and later. ### ProductItemId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Lookup to a Product Item record where the product is related to a vehicle model. This field is a relationship field. - **Relationship Name**: ProductItem - **Relationship Type**: Lookup - **Refers To**: ProductItem ### ProductItemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the product item that tracks the location of a specific vehicle. ### RegistrationRegionCode - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unique identification code of the area or region where the vehicle was registered, such as CA or DL. ### SerializedProductId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Lookup to the Serialized Product record related to a vehicle. This field is a relationship field. - **Relationship Name**: SerializedProduct - **Relationship Type**: Lookup - **Refers To**: SerializedProduct ### SerializedProductName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the serialized product related to a vehicle. ### SteeringType - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The type of steering in a vehicle, such as hydraulic or electric. ### TopSpeed - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The highest speed the vehicle model can achieve. ### TotalQuantityAtLocation - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The total quantity of product items at a specific inventory location for a vehicle. ### TotalQuantityUnitOfMeasure - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unit of measure used for the total quantity of product items. ### TransmissionType - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The transmission type of the vehicle, such as manual or automatic. ### TrimType - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The trim type of the vehicle model, such as DX, GT,or LS. ### UniversalProductCode - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The universal product code used to track the parts used in the vehicle. ### VariantName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The variant name associated with the vehicle model. ### VehicleClassification - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The classification or category of the vehicle such as sport, utility, or sedan. ### VehicleConditionType - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The condition type of a vehicle, such as new, running, or faulty. ### VehicleCurrentLocation - **Type**: address - **Properties**: Filter, Nillable - **Description**: The current address of a vehicle. ### VehicleCurrentLocationCity - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The city specified in the current address of a vehicle. ### VehicleCurrentLocationCountry - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The country specified in the current address of a vehicle. ### VehicleCurrentLocationGeocodeAccuracy - **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 vehicle’s latitude and longitude coordinates. Possible values are: - Address - Block - City - County - ExtendedZip - NearAddress - Neighborhood - State - Street - Unknown - Zip ### VehicleCurrentLocationLatitude - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Used with Longitude to specify the precise geolocation of the vehicle. Acceptable values are numbers between –90 and 90 with up to 15 decimal places. ### VehicleCurrentLocationLongitude - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Used with Latitude to specify the precise geolocation of the vehicle. Acceptable values are numbers between –180 and 180 with up to 15 decimal places. ### VehicleCurrentLocationPostalCode - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The postal code where the vehicle is located. ### VehicleCurrentLocationState - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The state where the vehicle is located. ### VehicleCurrentLocationStreet - **Type**: textarea - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The street where the vehicle is located. ### VehicleDefinitionId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Lookup to a Vehicle Definition record. This field is a relationship field. - **Relationship Name**: VehicleDefinition - **Relationship Type**: Lookup - **Refers To**: VehicleDefinition ### VehicleId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Lookup to a Vehicle recoord. This field is a relationship field. - **Relationship Name**: Vehicle - **Relationship Type**: Lookup - **Refers To**: Vehicle ### VehicleIdentificationNumber - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unique identification number of a vehicle. ### VehicleName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of a vehicle. ### VehicleProductName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the vehicle definition related to a vehicle. ### VehicleRegistrationNumber - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The registration number of a vehicle. ### VehicleStatus - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The status of a vehicle, such as in repair or in dealer lot. ### VehicleStockCode - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unique code assigned to a vehicle to keep track of the inventory. ## 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. - [VehicleSearchableFieldOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_ownersharingrule.htm): Sharing rules are available for the object. - [VehicleSearchableFieldShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_share.htm): Sharing is available for the object. # Visit Represents information about a visit that a manager schedules for a field rep to perform, usually at dealer locations. This object is available in Automotive Cloud in API version 56.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AccountId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The account associated with the visit. This field is a relationship field. - **Relationship Name**: Account - **Relationship Type**: Lookup - **Refers To**: Account ### ActualVisitEndTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the visit ended. ### ActualVisitStartTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the visit started. ### AddressId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The address associated with the visit. This field is a relationship field. - **Relationship Name**: Address - **Relationship Type**: Lookup - **Refers To**: Address ### ContactId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The contact associated with the visit. This field is a relationship field. - **Relationship Name**: Contact - **Relationship Type**: Lookup - **Refers To**: Contact ### ContextId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The purpose of the visit. This field is a polymorphic relationship field. - **Relationship Name**: Context - **Relationship Type**: Lookup - **Refers To**: Account\_\_c, Case ### InstructionDescription - **Type**: textarea - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Special instructions provided by a manager that the visitor refers to during a visit. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user referenced this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user viewed this record. ### LocationId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The location of the dealer or partner where the visit must be conducted. This field is a relationship field. - **Relationship Name**: Location - **Relationship Type**: Lookup - **Refers To**: Location ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Unique identifier for the visit record. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: ID of the visit record owner. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### PlaceId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: ID of the place that the visitor visits. This field is a polymorphic relationship field. - **Relationship Name**: Place - **Relationship Type**: Lookup - **Refers To**: Address, Location ### PlannedVisitEndTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the visit is expected to end. ### PlannedVisitStartTime - **Type**: dateTime - **Properties**: Create, Filter, Sort, Update - **Description**: The date and time when the visit is expected to start. ### Status - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update - **Description**: The status of the visit. Visitors can’t edit this field. Possible values are: The default value is Planned. - Abandoned - Completed - Error - InProgress—In Progress - None - Planned - Unscheduled ### StatusRemarks - **Type**: textarea - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The reasons for abandoning or completing the visit as provided by the visitor. ### UserId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The user associated with the visit. This field is a relationship field. - **Relationship Name**: User - **Relationship Type**: Lookup - **Refers To**: User ### VisitPriority - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The priority of the visit. Possible values are: High, Low, or Medium. ### VisitTypeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The type of visit such as inspection type, or work type. This field is a polymorphic relationship field. - **Relationship Name**: VisitType - **Relationship Type**: Lookup - **Refers To**: WorkType ### VisitorId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the person visiting the place. This field is a polymorphic relationship field. - **Relationship Name**: Visitor - **Relationship Type**: Lookup - **Refers To**: Contact, ServiceResource, User ## 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. - [VisitFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_feed.htm): Feed tracking is available for the object. - [VisitHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_history.htm): History is available for tracked fields of the object. - [VisitOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_ownersharingrule.htm): Sharing rules are available for the object. - [VisitShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_share.htm): Sharing is available for the object. # WarrantyTerm Represents warranty terms defining the labor, parts, and expenses covered, along with any exchange options, provided to rectify issues with products. This object is available in Manufacturing Cloud in API version 55.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### Code - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: A code or other identifier associated with this warranty term. ### Description - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The description of the warranty term. ### EffectiveStartDate - **Type**: picklist - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The date on which the warranty term became available for use. Possible values are: Install Date, Manufacture Date, or Purchase Date. ### ExchangeType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The type of exchange offered. Possible values are: Advance Exchange, Loaner, or Return Exchange. ### Exclusions - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The description of any exclusions. ### ExpensesCovered - **Type**: percent - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The percentage of expenses covered. ### ExpensesCoveredDuration - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The duration for which expenses are covered. ### ExpensesCoveredUnitOfTime - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The unit in which expenses covered duration is measured. Possible values are: Days, Months, Weeks, or Years. ### IsActive - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the warranty term is active (true) or not (false). The default value is false. ### IsTransferable - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the warranty can be transferred to a new owner (true) or not (false). The default value is false. ### LaborCovered - **Type**: percent - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The percentage of labor covered. ### LaborCoveredDuration - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The duration for which labor is covered. ### LaborCoveredUnitOfTime - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The unit in which labor covered duration is measured. Possible values are: Days, Months, Weeks, or Years. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date when the warranty term was last modified. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date when the warranty term was last viewed. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The warranty term’s assigned owner. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### PartsCovered - **Type**: percent - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The percentage of parts covered. ### PartsCoveredDuration - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The duration for which parts are covered. ### PartsCoveredUnitOfTime - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The unit in which parts covered duration is measured. Possible values are: Days, Months, Weeks, or Years. ### Pricebook2Id - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the price book item associated with this warranty term. This field is a relationship field. - **Relationship Name**: Pricebook2 - **Relationship Type**: Lookup - **Refers To**: Pricebook2 ### UsageCovered - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The product usage that's covered in the warranty term. ### UsageCoveredUomId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unit of measure for the product usage. This field is a relationship field. - **Relationship Name**: UsageCoveredUom - **Relationship Type**: Lookup - **Refers To**: UnitOfMeasure ### WarrantyDuration - **Type**: int - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The duration of the warranty offered by this term. ### WarrantyTermName - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the warranty term. ### WarrantyType - **Type**: picklist - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The type of warranty. Possible values are: Repair, Standard, or Supplier. ### WarrantyUnitOfTime - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: The unit in which the warranty duration is measured. Possible values are: Days, Months, Weeks, or Years. ## 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. - [WarrantyTermChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_change_event.htm): Change events are available for the object. - [WarrantyTermFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_feed.htm): Feed tracking is available for the object. - [WarrantyTermHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_history.htm): History is available for tracked fields of the object. - [WarrantyTermOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_ownersharingrule.htm): Sharing rules are available for the object. - [WarrantyTermShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_share.htm): Sharing is available for the object. # WarrantyTermCoverage Represents a junction between the warranty term coverage and a product or codeset, such as the repair code or labor code. This object is available in API version 58.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules ## Fields ### CoveredCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The labor code or expense code that's associated with the coverage for the warranty term. This field is a relationship field. - **Relationship Name**: CoveredCode - **Relationship Type**: Lookup - **Refers To**: CodeSet ### IsExcluded - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the product, labor code, or fault code is excluded from the warranty term (true) or not (false). The default value is false. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The autogenerated name of the warranty term coverage. ### ProductPartId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The part of the product that's covered in the warranty term. This field is a relationship field. - **Relationship Name**: ProductPart - **Relationship Type**: Lookup - **Refers To**: Product2 ### WarrantyTermId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The warranty term associated with the product, fault, or labor code. This field is a relationship field. - **Relationship Name**: WarrantyTerm - **Relationship Type**: Lookup - **Refers To**: WarrantyTerm ## 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. - [WarrantyTermCoverageFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_feed.htm): Feed tracking is available for the object. - [WarrantyTermCoverageHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_history.htm): History is available for tracked fields of the object. # WorkType Represents a type of work to be performed for a dealer location. Work types are templates that associate a work group to a service territory. This object is available in API version 58.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules Automotive and Automotive Scheduler must be enabled. ## Fields ### ApptStartTimeIntvlInMin - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specify the time interval in minutes between appointment start times. ### BlockTimeAfterAppointment - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specify the after buffer time for the service appointment. ### BlockTimeAfterUnit - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specify the unit of time for BlockTimeAfterAppointment. Possible values are: The default value is Minutes. - Hours—Hour(s) - Minutes—Minute(s) ### BlockTimeBeforeAppointment - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specify the before buffer time for the service appointment. ### BlockTimeBeforeUnit - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specify the unit of time for BlockTimeBeforeAppointment. Possible values are: The default value is Minutes. - Hours—Hour(s) - Minutes—Minute(s) ### Description - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The description of the work type. ### DurationInMinutes - **Type**: double - **Properties**: Filter, Nillable, Sort ### DurationType - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update - **Description**: The unit of the Estimated Duration: Minutes or Hours. Possible values are: The default value is Hours. Hours, or Minutes. ### EstimatedDuration - **Type**: double - **Properties**: Create, Filter, Sort, Update - **Description**: The estimated length of the work. The estimated duration is in minutes or hours based on the value selected in the Duration Type field. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date when the work type was last modified. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date when the work type was last viewed by the current user. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the work type. ### OperatingHoursId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the operating hours that’s assigned to the work type. If a service resource needs special operating hours, create them in Setup and select them in the Operating Hours lookup field on the member’s detail page. This field is a relationship field. - **Relationship Name**: OperatingHours - **Relationship Type**: Lookup - **Refers To**: OperatingHours ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The work type’s owner. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### TimeFrameEndUnit - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specify the unit of time for TimeFrame End. Possible values are: The default value is Days. - Days—Day(s) - Hours—Hour(s) ### TimeFrameStartUnit - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specify the unit of time for TimeFrame Start. Possible values are: The default value is Days. - Days—Day(s) - Hours—Hour(s) ### TimeframeEnd - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specify the timeframe end to show only time slots that end before the duration that is set in Timeframe End. ### TimeframeStart - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specify the timeframe start to show only time slots that start after the duration that is set in Timeframe Start. ## 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. - [WorkTypeChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_change_event.htm): Change events are available for the object. - [WorkTypeFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_feed.htm): Feed tracking is available for the object. - [WorkTypeHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_history.htm): History is available for tracked fields of the object. - [WorkTypeOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_ownersharingrule.htm): Sharing rules are available for the object. - [WorkTypeShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_share.htm): Sharing is available for the object. # WorkTypeGroup Represents a grouping of work types used to categorize types of available appointments. This object is available in API version 58.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules Automotive and Automotive Scheduler must be enabled. ## Fields ### AdditionalInformation - **Type**: multipicklist - **Properties**: Create, Filter, Nillable, Update - **Description**: Specifies the additional information for the work type group. ### Category - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The category of work type group that determines the type of appointment you create. You must create only one work type group record with the Test Drive category. You can create multiple work type group records with the Vehicle Service category. Possible values are: Test Drive, or Vehicle Service. ### Description - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The description of the work type group. ### GroupType - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the group type of the work type group. Possible values are: The default value is Default. Capacity, or Default. ### IsActive - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether this work type group can be used for appointment scheduling (true) or not (false). The default value is false. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date and time that the current user last viewed a record related to this object. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this object. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of this work type group. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the user who created this record. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### ParentTopicId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The parent work type group that's associated with the work type group. Available in API 56.0 and later. This field is a relationship field. - **Relationship Name**: ParentTopic - **Refers To**: WorkTypeGroup ## 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. - [WorkTypeGroupFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_feed.htm): Feed tracking is available for the object. - [WorkTypeGroupHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_history.htm): History is available for tracked fields of the object. - [WorkTypeGroupOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_ownersharingrule.htm): Sharing rules are available for the object. - [WorkTypeGroupShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_share.htm): Sharing is available for the object. # WorkTypeGroupMember Represents the relationship between a work type and the work type group it belongs to. This object is available in API version 58.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules Automotive and Automotive Scheduler must be enabled. ## Fields ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date and time that the current user last viewed a record related to this object. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this object. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Autogenerated number identifying the work type group membership. ### WorkTypeGroupId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The ID of the work type group that this record belongs to. This field is a relationship field. - **Relationship Name**: WorkTypeGroup - **Relationship Type**: Lookup - **Refers To**: WorkTypeGroup ### WorkTypeId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The ID of the work type that this record corresponds to. This field is a relationship field. - **Relationship Name**: WorkType - **Relationship Type**: Lookup - **Refers To**: WorkType ## 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. - [WorkTypeGroupMemberFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_feed.htm): Feed tracking is available for the object. - [WorkTypeGroupMemberHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_history.htm): History is available for tracked fields of the object.