Jump to

• Request
• Response

Get all sales leads

get

/crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/assetLeads

Request

Path Parameters

• AssetId(required): integer(int64)
  The unique identifier of the asset.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• effectiveDate: string
  This query parameter is used to fetch resources which are effective dated as of the specified start date. The value of this query parameter is a string having a date in yyyy-MM-dd format
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • LeadsFinderByContactId: Finds the list of leads with the specified contact ID.
    Finder Variables:
    • ContactId; integer; The unique identifier of the contact.
    • SysEffectiveDate; object.
  • MklLeadVOAltKey: Finds a lead with the specified lead number.
    Finder Variables:
    • LeadNumber; string.
  • MyLeadsFinder: Finds the leads with the specified values.
    Finder Variables:
    • Name; string; Finds the leads with the specified lead name.
    • ResourcePartyIdRest; integer; The unique identifier of the resource.
    • RestCreationDateLower; string; Finds the leads that are created before the date specified.
    • RestCreationDateUpper; string; Finds the leads with the specified creation date.
    • RestRecordSet; string.
    • RestStatusCode; string.
    • SysEffectiveDate; object.
  • PrimaryKey: Finds the leads by primary key.
    Finder Variables:
    • LeadId; integer; The unique identifier of the lead.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • AILeadScore; number; The AI calculated probability of the lead being converted to an opportunity.
  • AcceptedDateTime; string; The date and time when the sales lead is accepted by a resource assigned to it.
  • AccountPartyNumber; string; The name of the owner of a sales lead.
  • AssetId; integer; The unique identifier for the asset associated with the sales lead.
  • AssetNumber; string; The unique number for the asset associated with the sales lead.
  • AssetSerialNumber; string; The serial number for the asset associated with the sales lead.
  • AssignmentStatusCode; string; Includes the current assignment related status for the lead, for example whether the lead is assigned or unassigned.
  • BudgetStatus; string; The budget status associated with the budget amount associated with this sales lead.
  • CampaignName; string; The name of the campaign associated with the sales lead.
  • ChannelType; string; The channel through which this lead contacted the company.
  • ConflictId; integer; The value guarantees the uniqueness of the row when duplicates are created in different databases such as mobile databases, or the server.
  • ContactPartyNumber; string; The account number alternate key for referenced customer.
  • ContactTimezoneCd; string; The preferred time zone of the contact pursued on the lead.
  • CreationDate; string; The date and time when the record was created.
  • CustomerId; integer; The unique identifier of the customer. It is a reference to the customer record in the TCA schema.
  • CustomerPartyName; string; The name of the customer.
  • DealAmount; number; The total amount attributed to a lead.
  • EligibleForConversionFlag; boolean; Specifies whether the lead is eligible for conversion to opportunity.
  • IBAssetNumber; string; The unique number for the IB Asset associated with the sales lead.
  • IBAssetSerialNumber; string; The unique serial number for the IB Asset associated with the sales lead.
  • JobTitle; string; The job title of the primary contact on the sales lead.
  • LastAssignmentDate; string; The date on which the lead was last reassigned.
  • LastUpdateDate; string; The date and time when the row was last updated.
  • Latitude; number; The latitude information for the location.
  • LeadAcceptedFlag; boolean; Indicates if the lead has been accepted.
  • LeadAging; number; The number of days elapsed since the lead was created.
  • LeadCreatedBy; string; The user who created this record.
  • LeadCreationDate; string; The date and time when this record is created.
  • LeadId; integer; The unique identifier of the lead.
  • LeadLastUpdateDate; string; The date and time of the last update of the row.
  • LeadLastUpdatedBy; string; The user who last updated the row.
  • LeadNumber; string; The user friendly unique identifier for a lead.
  • LeadOrigin; string; The origin of the lead.
  • Longitude; number; The longitude information for the location.
  • Name; string; The name of the lead used for identifying the lead.
  • OwnerId; integer; The party identifier associated with the owner of this sales lead.
  • OwnerPartyName; string; The name associated with the owner of this sales lead.
  • OwnerPartyNumber; string; The alternate identifier of the primary contact.
  • PartnerCompanyNumber; string; The alternate partner number key for the referenced partner company.
  • PartnerId; integer; The unique identifier for the primary partner associated with the lead.
  • PartnerPartyName; string; The name associated with the primary partner of this sales lead. This is a deal specific attribute.
  • PartnerProgramNumber; string; The partner program number alternate key for the referenced partner program.
  • PrimaryCampaignId; integer; The unique identifier of the primary campaign of the Lead. It is a reference key to campaign object.
  • PrimaryCampaignName; string; The name of the primary campaign of the lead.
  • PrimaryCampaignNumber; string; The alternate identifier for primary campaign of the lead.
  • PrimaryCompetitorName; string; The name of the primary competitor of the lead.
  • PrimaryCompetitorPartyId; integer; The unique identifier of the primary competitor of the lead. It is a reference key to competitor object.
  • PrimaryCompetitorPartyNumber; string; The alternate identifier for primary competitor of the lead.
  • PrimaryContactAddress1; string; The first line of address associated with the primary contact of the lead.
  • PrimaryContactAddress2; string; The second line of address associated with the primary contact of the lead.
  • PrimaryContactCity; string; The city where the primary contact of the lead is located.
  • PrimaryContactCountry; string; The country where the primary contact of the lead is located.
  • PrimaryContactCounty; string; The county where the primary contact of the lead is located.
  • PrimaryContactEmailAddress; string; The email address for the primary sales lead contact on the lead.
  • PrimaryContactId; integer; The identifier of the sales lead contact marked as a primary lead contact.
  • PrimaryContactPartyName; string; The name associated with the primary lead contact.
  • PrimaryContactPersonFirstName; string; The first name of the primary contact for a lead.
  • PrimaryContactPersonLastName; string; The last name of the primary contact for a lead.
  • PrimaryContactPersonMiddleName; string; The middle name of the primary contact for a lead.
  • PrimaryContactPostalCode; string; The zip code where the primary contact of the lead is located.
  • PrimaryContactState; string; The state where the primary contact of the lead is located.
  • PrimaryInventoryItemNumber; string; The alternate key for referenced the primary inventory item.
  • PrimaryPhoneNumber; string; The primary phone number for the sales lead contact.
  • PrimaryProductGroupReferenceNumber; string; The alternate key for the referenced primary product group.
  • ProductGroupName; string; The name of the product group associated with a lead.
  • Rank; string; The rank associated with this sales lead.
  • RawPrimaryPhoneNumber; string; The raw value of the lead primary phone number.
  • ReassignReasonCode; string; The pre-defined code used to indicate the reason for lead reassignment.
  • RecordSet; string; The record visibility filters for lead search based on the resource and the leads to which the resource is associated to. The set is a group of lead records considered as the base group before other search criteria is used to further refine the search results.
  • RegistrationNumber; string; The registration number of the sales lead. This unique identifier is generated when the sales lead is approved. This is a deal specific attribute.
  • RegistrationStatus; string; The approval status of the sales lead. This is a deal specific attribute.
  • RegistrationType; string; The registration type of the sales lead. This is a deal specific attribute.
  • RejectReasonCode; string; The pre-defined code used to indicate the reason for rejecting a lead.
  • RetireReasonCode; string; The pre-defined code used to indicate the reason for retiring a lead.
  • SalesTargetLeadStage; string; The lead's current stage in the account based selling process.
  • Score; integer; The score associated with this sales lead. This score is computed based on the scoring rules.
  • SourceCode; string; The marketing source code associated with this sales lead.
  • StatusCode; string; The pre-defined code used to indicate the status of a lead.
  • Timeframe; string; The timeframe associated with this sales lead.
  • WorkPhoneNumber; string; The work phone number for the sales lead contact.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Header Parameters

• Effective-Of:
  This header accepts a string value. The string is a semi-colon separated list of =. It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers.
• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : assets-assetLeads

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/assets-assetLeads-item-response"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object assets-assetLeads-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/assets-assetLeads-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : assets-assetLeads-item-response

Type: object

Show Source

• AcceptedDate: string (date)
  Title: Accepted Date

  Read Only: true

  The date on which lead was accepted by a resource assigned to it.
• AcceptedDateTime: string (date-time)
  Title: Accepted Date

  Read Only: true

  The date and time when the sales lead is accepted by a resource assigned to it.
• AccountPartyNumber: string
  Title: Account Number

  Read Only: true

  Maximum Length: 30

  The name of the owner of a sales lead.
• AddrElementAttribute1: string
  Title: Contact Address Attribute 1

  Maximum Length: 150

  Additional address element to support flexible address format.
• AddrElementAttribute2: string
  Title: Contact Address Attribute 2

  Maximum Length: 150

  Additional address element to support flexible address format.
• AddrElementAttribute3: string
  Title: Contact Address Attribute 3

  Maximum Length: 150

  Additional address element to support flexible address format.
• AddrElementAttribute4: string
  Title: Contact Address Attribute 4

  Maximum Length: 150

  Additional address element to support flexible address format.
• AddrElementAttribute5: string
  Title: Contact Address Attribute 5

  Maximum Length: 150

  Additional address element to support flexible address format.
• AddressLinesPhonetic: string
  Title: Contact Phonetic Address

  Maximum Length: 560

  The phonetic or Kana representation of the Kanji address lines (used in Japan).
• AILeadScore: number
  Title: AI Lead Score

  Read Only: true

  The AI calculated probability of the lead being converted to an opportunity.
• ApprovalDate: string (date)
  Title: Registration Approval Date

  The date on which a partner registered lead is approved by internal channel manager.
• ApprovalDateTime: string (date-time)
  Title: Registration Approval Date

  The date and time when the sales lead is approved. This is only applicable to deal registrations.
• AssetId: integer (int64)
  Title: Asset ID

  The unique identifier for the asset associated with the sales lead.
• AssetNumber: string
  Title: Asset Number

  Maximum Length: 100

  The unique number for the asset associated with the sales lead.
• AssetSerialNumber: string
  Title: Asset Serial Number

  Read Only: true

  Maximum Length: 100

  The serial number for the asset associated with the sales lead.
• AssignmentStatusCode: string
  Title: Assignment Status

  Maximum Length: 30

  Includes the current assignment related status for the lead, for example whether the lead is assigned or unassigned.
• BudgetAmount: number
  Title: Budget Amount

  The budget amount associated with this sales lead.
• BudgetCurrencyCode: string
  Title: Budget Currency

  Maximum Length: 80

  The currency code associated with the budget amount associated with this sales lead.
• BudgetStatus: string
  Title: Budget Status

  Maximum Length: 120

  The budget status associated with the budget amount associated with this sales lead.
• Building: string
  Title: Building

  Maximum Length: 40

  The specific building name or number at a given address.
• BusinessUnitId: integer (int64)
  Title: Business Unit Identifier

  The business unit identifier associated with the business unit of the sales lead creator.
• CampaignName: string
  Title: Campaign

  Read Only: true

  Maximum Length: 250

  The name of the campaign associated with the sales lead.
• ChannelType: string
  Title: Source

  Maximum Length: 30

  The channel through which this lead contacted the company.
• ClassCode1: string
  Title: Industry Classification Code

  Maximum Length: 30

  The auxiliary dimension for the Account.
• ClassCode2: string
  Title: Auxiliary Classification Code 1

  Maximum Length: 30

  The auxiliary dimension for the Account.
• ClassCode3: string
  Title: Auxiliary Classification Code 2

  Maximum Length: 30

  The auxiliary dimension for the Account.
• ClassCode4: string
  Title: Auxiliary Classification Code 3

  Maximum Length: 30

  The auxiliary dimension for the Account.
• ConflictId: integer (int64)
  Title: Conflict Identifier

  Default Value: 1

  The value guarantees the uniqueness of the row when duplicates are created in different databases such as mobile databases, or the server.
• ContactDoNotPreference: boolean
  Title: Don't Contact Preference

  Maximum Length: 30

  Indicates that the primary contact of the service request does not want to be contacted.
• ContactFormattedAddress: string
  Title: Primary Contact Address

  Read Only: true

  The primary address of a lead's primary contact.
• ContactPartyNumber: string
  Title: Primary Contact Number

  Read Only: true

  Maximum Length: 30

  The account number alternate key for referenced customer.
• ContactTimezoneCd: string
  Title: Contact Time Zone

  Maximum Length: 35

  The preferred time zone of the contact pursued on the lead.
• ConvertedDateTime: string (date-time)
  Title: Converted Date

  The date and time when the sales lead is converted to an opportunity.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created this record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the record was created.
• CurrencyCode: string
  Title: Currency

  Maximum Length: 15

  The currency code for the lead.
• CustomerId: integer (int64)
  Title: Customer ID

  The unique identifier of the customer. It is a reference to the customer record in the TCA schema.
• CustomerNeed: string
  Title: Customer Need

  Maximum Length: 30

  Indicates what need the lead product serves for the lead customer.
• CustomerPartyName: string
  Title: Account Name

  Maximum Length: 360

  The name of the customer.
• DealAmount: number
  Title: Deal Size

  The total amount attributed to a lead.
• DecisionMakerIdentifiedFlag: boolean
  Title: Decision Maker Identified

  Maximum Length: 120

  Default Value: false

  Indicates if the decision maker at customer site has been identified.
• DeleteFlag: boolean
  Read Only: true

  Indicates if the user has access to delete the record.
• Description: string
  Title: Description

  Maximum Length: 2000

  The description associated with this sales lead.
• Distance: number
  Title: Distance

  Read Only: true

  The distance from the input location.
• EligibleForConversionFlag: boolean
  Title: Eligible for Conversion

  Maximum Length: 1

  Specifies whether the lead is eligible for conversion to opportunity.
• EnableCreateAccount: string
  Title: Create Account

  Maximum Length: 1

  Indicates whether new account should be created during lead conversion.
• EnableCreateContact: string
  Title: Create Contact

  Maximum Length: 1

  Indicates whether new contact should be created during lead conversion.
• EstimatedCloseDate: string (date)
  Title: Estimated Close Date

  The estimated close date for a deal once registered.
• ExpirationDate: string (date)
  Title: Expiration Date

  The expiration date associated with this sales lead.
• FloorNumber: string
  Title: Contact Address Floor Number

  Maximum Length: 40

  The specific floor number at a given address or in a particular building when building number is provided.
• FollowupTimestamp: string (date)
  Title: Next Follow-up Date

  Indicates when the sales lead needs to be followed up.
• FormattedPhoneNumber1: string
  Title: Contact Phone

  Read Only: true

  The formatted phone number of the primary contact for the lead.
• IBAssetId: integer (int64)
  Title: Installed Base Asset

  The unique identifier for the IB Asset associated with the sales lead.
• IBAssetNumber: string
  Title: Installed Base Asset Number

  Read Only: true

  Maximum Length: 80

  The unique number for the IB Asset associated with the sales lead.
• IBAssetSerialNumber: string
  Title: Installed Base Asset Serial Number

  Read Only: true

  Maximum Length: 80

  The unique serial number for the IB Asset associated with the sales lead.
• InventoryItemDescription: string
  Title: Product Item

  Maximum Length: 240

  The description of the product added to a lead.
• JobTitle: string
  Title: Job Title

  Maximum Length: 100

  The job title of the primary contact on the sales lead.
• LastAssignmentDate: string (date-time)
  Title: Last Automatic Assignment Date

  The date on which the lead was last reassigned.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date and time when the row was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the row.
• LastUpdateLogin: string
  Title: Last Updated Login

  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the row.
• Latitude: number
  Title: Latitude

  The latitude information for the location.
• LeadAcceptedFlag: boolean
  Title: Accepted

  Maximum Length: 4

  Indicates if the lead has been accepted.
• LeadAging: number
  Title: Age in Days

  Read Only: true

  The number of days elapsed since the lead was created.
• LeadCreatedBy: string
  Title: Lead Created By

  Maximum Length: 64

  The user who created this record.
• LeadCreationDate: string (date-time)
  Title: Lead Creation Date

  The date and time when this record is created.
• LeadId: integer (int64)
  Title: Lead Identifier

  The unique identifier of the lead.
• LeadLastUpdateDate: string (date-time)
  Title: Lead Last Update Date

  The date and time of the last update of the row.
• LeadLastUpdatedBy: string
  Title: Lead Last Updated By

  Maximum Length: 64

  The user who last updated the row.
• LeadNumber: string
  Title: Lead Number

  Maximum Length: 30

  The user friendly unique identifier for a lead.
• LeadOrigin: string
  Title: Origin

  Maximum Length: 30

  Default Value: SALES_LEAD

  The origin of the lead.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Longitude: number
  Title: Longitude

  The longitude information for the location.
• Name: string
  Title: Lead Name

  Maximum Length: 250

  The name of the lead used for identifying the lead.
• OpportunityName: string
  Title: Opportunity Name

  The name of the opportunity created from converting the lead.
• OpportunityOwnerNumber: string
  Title: Opportunity Owner Number

  The alternate identifier for the owner of the opportunity created from converting the lead.
• OrganizationSize: string
  Title: Organization Size

  Maximum Length: 30

  The size of the organization.
• OrganizationType: string
  Title: Organization Type

  Maximum Length: 30

  The type of the organization.
• OwnerId: integer (int64)
  Title: Owner ID

  The party identifier associated with the owner of this sales lead.
• OwnerPartyName: string
  Title: Owner

  Maximum Length: 360

  The name associated with the owner of this sales lead.
• OwnerPartyNumber: string
  Title: Owner Number

  Read Only: true

  Maximum Length: 30

  The alternate identifier of the primary contact.
• PartnerCompanyNumber: string
  Title: Partner Number

  Maximum Length: 30

  The alternate partner number key for the referenced partner company.
• PartnerId: integer (int64)
  Title: Primary Partner Identifier

  The unique identifier for the primary partner associated with the lead.
• PartnerPartyName: string
  Title: Primary Partner

  The name associated with the primary partner of this sales lead. This is a deal specific attribute.
• PartnerProgramId: integer (int64)
  Title: Partner Program

  A reference to the partner program in which the primary partner associated with this sales lead is enrolled. This is a deal specific attribute.
• PartnerProgramNumber: string
  Title: Partner Program Number

  Maximum Length: 30

  The partner program number alternate key for the referenced partner program.
• PartnerType: string
  Title: Partner Type

  Maximum Length: 30

  Indicates the type of the primary partner associated with this sales lead. This is a deal specific attribute.
• PostalPlus4Code: string
  Title: Postal Code

  Maximum Length: 10

  The four digit extension to the United States Postal ZIP code.
• PrimaryCampaignId: integer (int64)
  Title: Primary Campaign ID

  The unique identifier of the primary campaign of the Lead. It is a reference key to campaign object.
• PrimaryCampaignName: string
  Title: Primary Campaign

  The name of the primary campaign of the lead.
• PrimaryCampaignNumber: string
  Title: Primary Campaign Number

  Maximum Length: 30

  The alternate identifier for primary campaign of the lead.
• PrimaryCompetitorName: string
  Title: Primary Competitor

  The name of the primary competitor of the lead.
• PrimaryCompetitorPartyId: integer
  Title: Primary Competitor Party ID

  The unique identifier of the primary competitor of the lead. It is a reference key to competitor object.
• PrimaryCompetitorPartyNumber: string
  Title: Primary Competitor Party Number

  Read Only: true

  Maximum Length: 30

  The alternate identifier for primary competitor of the lead.
• PrimaryContactAddress1: string
  Title: Primary Contact Address 1

  Maximum Length: 240

  The first line of address associated with the primary contact of the lead.
• PrimaryContactAddress2: string
  Title: Primary Contact Address 2

  Maximum Length: 240

  The second line of address associated with the primary contact of the lead.
• PrimaryContactAddress3: string
  Title: Primary Contact Address 3

  Maximum Length: 240

  The third line of address associated with the primary contact of the lead.
• PrimaryContactAddress4: string
  Title: Primary Contact Address 4

  Maximum Length: 240

  The fourth line of address associated with the primary contact of the lead.
• PrimaryContactCity: string
  Title: Primary Contact City

  Maximum Length: 60

  The city where the primary contact of the lead is located.
• PrimaryContactCountry: string
  Title: Country

  Maximum Length: 2

  The country where the primary contact of the lead is located.
• PrimaryContactCountryName: string
  Title: Country Name

  Read Only: true

  The full name associated with primary contact country code.
• PrimaryContactCounty: string
  Title: Primary Contact County

  Maximum Length: 60

  The county where the primary contact of the lead is located.
• PrimaryContactEmailAddress: string
  Title: Contact Email

  Maximum Length: 320

  The email address for the primary sales lead contact on the lead.
• PrimaryContactEmailPreference: string
  Title: Email Preference

  Maximum Length: 30

  Indicates if the primary contact has an email preference of do not email, ok to email, or no value.
• PrimaryContactEmailVerificationDate: string (date-time)
  Title: Email Verification Date

  The verification date for primary contact email address.
• PrimaryContactEmailVerificationStatus: string
  Title: Email Verification Status

  Maximum Length: 30

  The verification status for primary contact email address.
• PrimaryContactId: integer (int64)
  Title: Primary Contact ID

  The identifier of the sales lead contact marked as a primary lead contact.
• PrimaryContactMailPreference: string
  Title: Mail Preference

  Maximum Length: 30

  Indicates if the primary contact has a mail preference.
• PrimaryContactPartyName: string
  Title: Primary Contact Name

  Maximum Length: 450

  The name associated with the primary lead contact.
• PrimaryContactPersonFirstName: string
  Title: Primary Contact First Name

  Maximum Length: 150

  The first name of the primary contact for a lead.
• PrimaryContactPersonLastName: string
  Title: Primary Contact Last Name

  Maximum Length: 150

  The last name of the primary contact for a lead.
• PrimaryContactPersonMiddleName: string
  Title: Primary Contact Middle Name

  Maximum Length: 150

  The middle name of the primary contact for a lead.
• PrimaryContactPhonePreference: string
  Title: Phone Preference

  Maximum Length: 30

  Indicates if the primary contact has a phone preference of do not call, ok to call, or no value.
• PrimaryContactPostalCode: string
  Title: Primary Contact Postal Code

  Maximum Length: 60

  The zip code where the primary contact of the lead is located.
• PrimaryContactProvince: string
  Title: Primary Contact Province

  Maximum Length: 60

  The province where the primary contact of the lead is located.
• PrimaryContactRelationshipId: integer (int64)
  Title: Primary Contact Relationship ID

  The unique identifier of the relationship primary contact has with its parent organization.
• PrimaryContactState: string
  Title: Primary Contact State

  Maximum Length: 60

  The state where the primary contact of the lead is located.
• PrimaryInventoryItemId: integer (int64)
  Title: Primary Product ID

  The unique identifier of the primary product associated with a lead.
• PrimaryInventoryItemNumber: string
  Title: Primary Inventory Item Number

  Read Only: true

  Maximum Length: 300

  The alternate key for referenced the primary inventory item.
• PrimaryInventoryOrgId: integer (int64)
  Title: Primary Product Organization ID

  The unique identifier of the organization to which the primary product associated with a lead belongs.
• PrimaryPhoneAreaCode: string
  Title: Primary Phone Area Code

  Maximum Length: 10

  The primary phone area code for the sales lead contact.
• PrimaryPhoneCountryCode: string
  Title: Primary Phone Country Code

  Maximum Length: 10

  The primary phone country code for the sales lead contact.
• PrimaryPhoneNumber: string
  Title: Contact Phone

  Maximum Length: 40

  The primary phone number for the sales lead contact.
• PrimaryPhoneVerificationDate: string (date-time)
  Title: Primary Phone Verification Date

  The verification date for lead primary phone.
• PrimaryPhoneVerificationStatus: string
  Title: Primary Phone Verification Status

  Maximum Length: 30

  The verification status for lead primary phone.
• PrimaryProductGroupId: integer
  Title: Primary Product Group ID

  The unique identifier of the primary product group associated with a lead.
• PrimaryProductGroupReferenceNumber: string
  Title: Primary Product Group Reference Number

  Maximum Length: 50

  The alternate key for the referenced primary product group.
• ProductGroupDescription: string
  Title: Product Group Description

  Read Only: true

  Maximum Length: 1000

  The description of the product or product group associated with a lead.
• ProductGroupName: string
  Title: Product Group

  Maximum Length: 250

  The name of the product group associated with a lead.
• ProductType: string
  Title: Product Type

  The type of the primary product, such as item or product group.
• ProgramName: string
  Title: Partner Program

  The name of the partner program in which the primary partner associated with this sales lead is enrolled. This is a deal specific attribute.
• Project: string
  Title: Customer Project

  Maximum Length: 30

  The customer project identified for this sales lead.
• QualificationScore: integer (int64)
  Title: Qualification Score

  Read Only: true

  Default Value: 0

  The qualification score for a lead.
• QualifiedDate: string (date)
  Title: Qualification Date

  Indicates the date when this sales lead was qualified.
• QualifiedDateTime: string (date-time)
  Title: Qualification Date

  The date and time when the sales lead is qualified.
• Rank: string
  Title: Rank

  Maximum Length: 30

  The rank associated with this sales lead.
• RawPrimaryPhoneNumber: string
  Title: Raw Phone Number

  The raw value of the lead primary phone number.
• ReassignComment: string
  Title: Reassign Comments

  Maximum Length: 1000

  The comment provided by a user while requesting the lead reassignment.
• ReassignReasonCode: string
  Title: Reassign Reason

  Maximum Length: 30

  The pre-defined code used to indicate the reason for lead reassignment.
• RecordSet: string
  Title: Record Set

  Read Only: true

  The record visibility filters for lead search based on the resource and the leads to which the resource is associated to. The set is a group of lead records considered as the base group before other search criteria is used to further refine the search results.
• RegistrationNumber: string
  Title: Registration Number

  Maximum Length: 120

  The registration number of the sales lead. This unique identifier is generated when the sales lead is approved. This is a deal specific attribute.
• RegistrationStatus: string
  Title: Registration Status

  Maximum Length: 120

  The approval status of the sales lead. This is a deal specific attribute.
• RegistrationType: string
  Title: Registration Type

  Maximum Length: 120

  The registration type of the sales lead. This is a deal specific attribute.
• RejectByUserId: integer (int64)
  Title: Reject by User ID

  The identifier of the sales representative who rejected this sales lead.
• RejectComment: string
  Title: Rejection Comments

  Maximum Length: 250

  The comments provided by the sales representative who rejected this sales lead.
• RejectedDateTime: string (date-time)
  Title: Rejected Time Stamp

  The date and time when the sales lead is rejected.
• RejectReasonCode: string
  Title: Reject Reason

  Maximum Length: 30

  The pre-defined code used to indicate the reason for rejecting a lead.
• RetireComment: string
  Title: Retirement Comments

  Maximum Length: 250

  The comments recorded when the sales lead is moved to a retired status.
• RetiredDateTime: string (date-time)
  Title: Retired Time Stamp

  The date and time when the sales lead is moved to a retired status.
• RetireReasonCode: string
  Title: Retire Reason

  Maximum Length: 30

  The pre-defined code used to indicate the reason for retiring a lead.
• SalesChannel: string
  Title: Sales Channel

  Maximum Length: 120

  Indicates the sales channel responsible for following up on this sales lead.
• SalesTargetLeadEloquaSyncDate: string (date-time)
  Title: Last Sync to Marketing Date

  The date on which the current sales target lead contacts are last synced to Eloqua.
• SalesTargetLeadOptOutComment: string
  Title: Opt-out Comment

  Maximum Length: 1000

  The comments provided by the sales representative who opted out this lead.
• SalesTargetLeadOptOutDate: string (date-time)
  Title: Opt-out Date

  The date of opting out the lead from sales target campaign.
• SalesTargetLeadOptOutReasonCode: string
  Title: Opt-out Reason

  Maximum Length: 32

  The reason for opting out the lead from sales target campaign.
• SalesTargetLeadStage: string
  Title: Stage

  Maximum Length: 32

  The lead's current stage in the account based selling process.
• SalesTargetLeadValidationDueDate: string (date-time)
  Title: Validation Due Date

  The date on which the sales target lead validation is due.
• Score: integer (int64)
  Title: Score

  The score associated with this sales lead. This score is computed based on the scoring rules.
• SourceCode: string
  Title: Source Code

  Maximum Length: 30

  The marketing source code associated with this sales lead.
• StatusCode: string
  Title: Status

  Maximum Length: 30

  Default Value: UNQUALIFIED

  The pre-defined code used to indicate the status of a lead.
• Timeframe: string
  Title: Time Frame

  Maximum Length: 120

  The timeframe associated with this sales lead.
• ToReassignFlag: boolean
  Title: Reassign

  Maximum Length: 1

  Default Value: false

  Identifies leads that are marked for reassignment.
• UpdateFlag: boolean
  Read Only: true

  Indicates if the user has access to update the record.
• WorkPhoneAreaCode: string
  Title: Work Phone Area Code

  Maximum Length: 10

  The work phone area code for the sales lead contact.
• WorkPhoneCountryCode: string
  Title: Work Phone Country Code

  Maximum Length: 10

  The work phone country code for the sales lead contact.
• WorkPhoneNumber: string
  Title: Work Phone Number

  Maximum Length: 40

  The work phone number for the sales lead contact.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"date"
            },
            "x-queryable":true
        },
        "RejectByUserId":{
            "title":"Reject by User ID",
            "type":"integer",
            "description":"The identifier of the sales representative who rejected this sales lead.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "RetiredDateTime":{
            "title":"Retired Time Stamp",
            "type":"string",
            "description":"The date and time when the sales lead is moved to a retired status.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "EligibleForConversionFlag":{
            "title":"Eligible for Conversion",
            "maxLength":"1",
            "type":"boolean",
            "description":"Specifies whether the lead is eligible for conversion to opportunity.",
            "nullable":true,
            "x-hints":{
                "controlType":"check_box",
                "AttributeType":"Checkbox"
            },
            "x-queryable":true
        },
        "ProductGroupName":{
            "title":"Product Group",
            "maxLength":"250",
            "type":"string",
            "description":"The name of the product group associated with a lead.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "PrimaryContactProvince":{
            "title":"Primary Contact Province",
            "maxLength":"60",
            "type":"string",
            "description":"The province where the primary contact of the lead is located.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "protectionKey":"PartySiteEO.Province",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Province"
            }
        },
        "ConflictId":{
            "title":"Conflict Identifier",
            "type":"integer",
            "description":"The value guarantees the uniqueness of the row when duplicates are created in different databases such as mobile databases, or the server.",
            "format":"int64",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"15"
            },
            "x-queryable":true
        },
        "PrimaryContactPostalCode":{
            "title":"Primary Contact Postal Code",
            "maxLength":"60",
            "type":"string",
            "description":"The zip code where the primary contact of the lead is located.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.PostalCode",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Postal Code"
            },
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":"15",
            "type":"string",
            "description":"The currency code for the lead.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "DealAmount":{
            "title":"Deal Size",
            "type":"number",
            "description":"The total amount attributed to a lead.",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryContactPhonePreference":{
            "title":"Phone Preference",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates if the primary contact has a phone preference of do not call, ok to call, or no value.",
            "nullable":true,
            "x-queryable":false
        },
        "IBAssetId":{
            "title":"Installed Base Asset",
            "type":"integer",
            "description":"The unique identifier for the IB Asset associated with the sales lead.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18",
                "dependencies":[
                    "IBAssetNumber"
                ]
            }
        },
        "PrimaryContactEmailAddress":{
            "title":"Contact Email",
            "maxLength":"320",
            "type":"string",
            "description":"The email address for the primary sales lead contact on the lead.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "PrimaryPhoneVerificationDate":{
            "title":"Primary Phone Verification Date",
            "type":"string",
            "description":"The verification date for lead primary phone.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "PrimaryContactEmailPreference":{
            "title":"Email Preference",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates if the primary contact has an email preference of do not email, ok to email, or no value.",
            "nullable":true,
            "x-queryable":false
        },
        "Distance":{
            "title":"Distance",
            "type":"number",
            "description":"The distance from the input location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "Latitude",
                    "Longitude"
                ]
            }
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "PrimaryProductGroupId":{
            "title":"Primary Product Group ID",
            "type":"integer",
            "description":"The unique identifier of the primary product group associated with a lead.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "SmartPickerEntityName":"CRMProductGroup",
                "RecentItemEntityName":"CRMProductGroup"
            }
        },
        "ConvertedDateTime":{
            "title":"Converted Date",
            "type":"string",
            "description":"The date and time when the sales lead is converted to an opportunity.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created this record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "PrimaryPhoneAreaCode":{
            "title":"Primary Phone Area Code",
            "maxLength":"10",
            "type":"string",
            "description":"The primary phone area code for the sales lead contact.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneAreaCode",
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Area Code"
            }
        },
        "PartnerProgramId":{
            "title":"Partner Program",
            "type":"integer",
            "description":"A reference to the partner program in which the primary partner associated with this sales lead is enrolled. This is a deal specific attribute.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ProductType":{
            "title":"Product Type",
            "type":"string",
            "description":"The type of the primary product, such as item or product group.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "LeadNumber":{
            "title":"Lead Number",
            "maxLength":"30",
            "type":"string",
            "description":"The user friendly unique identifier for a lead.",
            "nullable":true,
            "x-queryable":true
        },
        "CustomerId":{
            "title":"Customer ID",
            "type":"integer",
            "description":"The unique identifier of the customer. It is a reference to the customer record in the TCA schema.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "SmartPickerEntityName":"Account",
                "RecentItemEntityName":"accounts"
            },
            "x-queryable":true
        },
        "LeadAging":{
            "title":"Age in Days",
            "type":"number",
            "description":"The number of days elapsed since the lead was created.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "LeadCreationDate"
                ]
            },
            "x-queryable":true
        },
        "Longitude":{
            "title":"Longitude",
            "type":"number",
            "description":"The longitude information for the location.",
            "nullable":true,
            "x-queryable":true
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates if the user has access to delete the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ContactPartyNumber":{
            "title":"Primary Contact Number",
            "maxLength":"30",
            "type":"string",
            "description":"The account number alternate key for referenced customer.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ContactFormattedAddress":{
            "title":"Primary Contact Address",
            "type":"string",
            "description":"The primary address of a lead's primary contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PrimaryContactAddress1",
                    "PrimaryContactAddress2",
                    "PrimaryContactAddress3",
                    "PrimaryContactAddress4",
                    "PrimaryContactCity",
                    "PrimaryContactCounty",
                    "PrimaryContactState",
                    "PrimaryContactPostalCode",
                    "PrimaryContactCountry",
                    "PrimaryContactCountryName",
                    "PrimaryContactProvince",
                    "AddressLinesPhonetic",
                    "AddrElementAttribute1",
                    "AddrElementAttribute2",
                    "AddrElementAttribute3",
                    "AddrElementAttribute4",
                    "AddrElementAttribute5",
                    "Building",
                    "FloorNumber"
                ]
            }
        },
        "Project":{
            "title":"Customer Project",
            "maxLength":"30",
            "type":"string",
            "description":"The customer project identified for this sales lead.",
            "nullable":true,
            "x-queryable":false
        },
        "QualifiedDate":{
            "title":"Qualification Date",
            "type":"string",
            "description":"Indicates the date when this sales lead was qualified.",
            "format":"date",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "QualifiedDateTime"
                ]
            }
        },
        "LeadCreatedBy":{
            "title":"Lead Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created this record.",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "<",
                    "<=",
                    ">",
                    ">=",
                    "BETWEEN",
                    "NOTBETWEEN",
                    "CONTAINS",
                    "DOESNOTCONTAIN"
                ]
            },
            "x-queryable":true
        },
        "OrganizationSize":{
            "title":"Organization Size",
            "maxLength":"30",
            "type":"string",
            "description":"The size of the organization.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SalesTargetLeadEloquaSyncDate":{
            "title":"Last Sync to Marketing Date",
            "type":"string",
            "description":"The date on which the current sales target lead contacts are last synced to Eloqua.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "LastAssignmentDate":{
            "title":"Last Automatic Assignment Date",
            "type":"string",
            "description":"The date on which the lead was last reassigned.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryPhoneNumber":{
            "title":"Contact Phone",
            "maxLength":"40",
            "type":"string",
            "description":"The primary phone number for the sales lead contact.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneNumber",
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Phone"
            },
            "x-queryable":true
        },
        "PrimaryProductGroupReferenceNumber":{
            "title":"Primary Product Group Reference Number",
            "maxLength":"50",
            "type":"string",
            "description":"The alternate key for the referenced primary product group.",
            "nullable":false,
            "x-queryable":true
        },
        "AssetId":{
            "title":"Asset ID",
            "type":"integer",
            "description":"The unique identifier for the asset associated with the sales lead.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "SmartPickerEntityName":"Asset",
                "RecentItemEntityName":"assets",
                "dependencies":[
                    "AssetProduct",
                    "AssetNumber"
                ]
            },
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Updated Login",
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the row.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "IBAssetSerialNumber":{
            "title":"Installed Base Asset Serial Number",
            "maxLength":"80",
            "type":"string",
            "description":"The unique serial number for the IB Asset associated with the sales lead.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Building":{
            "title":"Building",
            "maxLength":"40",
            "type":"string",
            "description":"The specific building name or number at a given address.",
            "nullable":true,
            "x-queryable":false
        },
        "SalesTargetLeadValidationDueDate":{
            "title":"Validation Due Date",
            "type":"string",
            "description":"The date on which the sales target lead validation is due.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "PartnerProgramNumber":{
            "title":"Partner Program Number",
            "maxLength":"30",
            "type":"string",
            "description":"The partner program number alternate key for the referenced partner program.",
            "nullable":false,
            "x-queryable":true
        },
        "SourceCode":{
            "title":"Source Code",
            "maxLength":"30",
            "type":"string",
            "description":"The marketing source code associated with this sales lead.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "CampaignNameLOV"
                ]
            },
            "x-queryable":true
        },
        "FloorNumber":{
            "title":"Contact Address Floor Number",
            "maxLength":"40",
            "type":"string",
            "description":"The specific floor number at a given address or in a particular building when building number is provided.",
            "nullable":true,
            "x-queryable":false
        },
        "PrimaryContactId":{
            "title":"Primary Contact ID",
            "type":"integer",
            "description":"The identifier of the sales lead contact marked as a primary lead contact.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "SmartPickerEntityName":"Contact",
                "RecentItemEntityName":"contacts"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"2000",
            "type":"string",
            "description":"The description associated with this sales lead.",
            "nullable":true,
            "x-queryable":false
        },
        "OwnerPartyNumber":{
            "title":"Owner Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate identifier of the primary contact.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryContactMailPreference":{
            "title":"Mail Preference",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates if the primary contact has a mail preference.",
            "nullable":true,
            "x-queryable":false
        },
        "PrimaryContactState":{
            "title":"Primary Contact State",
            "maxLength":"60",
            "type":"string",
            "description":"The state where the primary contact of the lead is located.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.State",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"State"
            },
            "x-queryable":true
        },
        "JobTitle":{
            "title":"Job Title",
            "maxLength":"100",
            "type":"string",
            "description":"The job title of the primary contact on the sales lead.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkPhoneAreaCode":{
            "title":"Work Phone Area Code",
            "maxLength":"10",
            "type":"string",
            "description":"The work phone area code for the sales lead contact.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneAreaCode",
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Area Code"
            }
        },
        "AccountPartyNumber":{
            "title":"Account Number",
            "maxLength":"30",
            "type":"string",
            "description":"The name of the owner of a sales lead.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BudgetStatus":{
            "title":"Budget Status",
            "maxLength":"120",
            "type":"string",
            "description":"The budget status associated with the budget amount associated with this sales lead.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "BusinessUnitId"
                ]
            },
            "x-queryable":true
        },
        "SalesTargetLeadOptOutReasonCode":{
            "title":"Opt-out Reason",
            "maxLength":"32",
            "type":"string",
            "description":"The reason for opting out the lead from sales target campaign.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "BusinessUnitId"
                ]
            }
        },
        "InventoryItemDescription":{
            "title":"Product Item",
            "maxLength":"240",
            "type":"string",
            "description":"The description of the product added to a lead.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "OwnerId":{
            "title":"Owner ID",
            "type":"integer",
            "description":"The party identifier associated with the owner of this sales lead.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "RecentItemEntityName":"resources"
            },
            "x-queryable":true
        },
        "RetireReasonCode":{
            "title":"Retire Reason",
            "maxLength":"30",
            "type":"string",
            "description":"The pre-defined code used to indicate the reason for retiring a lead.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "BusinessUnitId"
                ]
            },
            "x-queryable":true
        },
        "PrimaryCompetitorPartyNumber":{
            "title":"Primary Competitor Party Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate identifier for primary competitor of the lead.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RetireComment":{
            "title":"Retirement Comments",
            "maxLength":"250",
            "type":"string",
            "description":"The comments recorded when the sales lead is moved to a retired status.",
            "nullable":true,
            "x-queryable":false
        },
        "AddressLinesPhonetic":{
            "title":"Contact Phonetic Address",
            "maxLength":"560",
            "type":"string",
            "description":"The phonetic or Kana representation of the Kanji address lines (used in Japan).",
            "nullable":true,
            "x-queryable":false
        },
        "PrimaryCampaignName":{
            "title":"Primary Campaign",
            "type":"string",
            "description":"The name of the primary campaign of the lead.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "PrimaryCampaignName1"
                ]
            },
            "x-queryable":true
        },
        "RegistrationNumber":{
            "title":"Registration Number",
            "maxLength":"120",
            "type":"string",
            "description":"The registration number of the sales lead. This unique identifier is generated when the sales lead is approved. This is a deal specific attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "ApprovalDateTime":{
            "title":"Registration Approval Date",
            "type":"string",
            "description":"The date and time when the sales lead is approved. This is only applicable to deal registrations.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "IBAssetNumber":{
            "title":"Installed Base Asset Number",
            "maxLength":"80",
            "type":"string",
            "description":"The unique number for the IB Asset associated with the sales lead.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LeadLastUpdatedBy":{
            "title":"Lead Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the row.",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "<",
                    "<=",
                    ">",
                    ">=",
                    "BETWEEN",
                    "NOTBETWEEN",
                    "CONTAINS",
                    "DOESNOTCONTAIN"
                ]
            },
            "x-queryable":true
        },
        "PrimaryCampaignId":{
            "title":"Primary Campaign ID",
            "type":"integer",
            "description":"The unique identifier of the primary campaign of the Lead. It is a reference key to campaign object.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "RecentItemEntityName":"campaigns"
            },
            "x-queryable":true
        },
        "RegistrationStatus":{
            "title":"Registration Status",
            "maxLength":"120",
            "type":"string",
            "description":"The approval status of the sales lead. This is a deal specific attribute.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Rank":{
            "title":"Rank",
            "maxLength":"30",
            "type":"string",
            "description":"The rank associated with this sales lead.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "BusinessUnitId"
                ]
            },
            "x-queryable":true
        },
        "PrimaryPhoneVerificationStatus":{
            "title":"Primary Phone Verification Status",
            "maxLength":"30",
            "type":"string",
            "description":"The verification status for lead primary phone.",
            "nullable":true,
            "x-queryable":false
        },
        "OpportunityOwnerNumber":{
            "title":"Opportunity Owner Number",
            "type":"string",
            "description":"The alternate identifier for the owner of the opportunity created from converting the lead.",
            "nullable":true,
            "x-queryable":false
        },
        "RejectReasonCode":{
            "title":"Reject Reason",
            "maxLength":"30",
            "type":"string",
            "description":"The pre-defined code used to indicate the reason for rejecting a lead.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "BusinessUnitId"
                ]
            },
            "x-queryable":true
        },
        "PrimaryPhoneCountryCode":{
            "title":"Primary Phone Country Code",
            "maxLength":"10",
            "type":"string",
            "description":"The primary phone country code for the sales lead contact.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date associated with this sales lead.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "ToReassignFlag":{
            "title":"Reassign",
            "maxLength":"1",
            "type":"boolean",
            "description":"Identifies leads that are marked for reassignment.",
            "nullable":false,
            "default":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"check_box",
                "AttributeType":"Checkbox"
            }
        },
        "PartnerCompanyNumber":{
            "title":"Partner Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate partner number key for the referenced partner company.",
            "nullable":false,
            "x-queryable":true
        },
        "PrimaryContactPersonFirstName":{
            "title":"Primary Contact First Name",
            "maxLength":"150",
            "type":"string",
            "description":"The first name of the primary contact for a lead.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonFirstName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"First Name"
            },
            "x-queryable":true
        },
        "FormattedPhoneNumber1":{
            "title":"Contact Phone",
            "type":"string",
            "description":"The formatted phone number of the primary contact for the lead.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ReassignReasonCode":{
            "title":"Reassign Reason",
            "maxLength":"30",
            "type":"string",
            "description":"The pre-defined code used to indicate the reason for lead reassignment.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "BusinessUnitId"
                ]
            },
            "x-queryable":true
        },
        "ChannelType":{
            "title":"Source",
            "maxLength":"30",
            "type":"string",
            "description":"The channel through which this lead contacted the company.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "BusinessUnitId"
                ]
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"date"
            },
            "x-queryable":true
        },
        "PartnerType":{
            "title":"Partner Type",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the type of the primary partner associated with this sales lead. This is a deal specific attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "PartnerId"
                ]
            }
        },
        "PrimaryContactCountry":{
            "title":"Country",
            "maxLength":"2",
            "type":"string",
            "description":"The country where the primary contact of the lead is located.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "PrimaryContactCountryName"
                ]
            },
            "x-queryable":true
        },
        "AILeadScore":{
            "title":"AI Lead Score",
            "type":"number",
            "description":"The AI calculated probability of the lead being converted to an opportunity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryContactPersonMiddleName":{
            "title":"Primary Contact Middle Name",
            "maxLength":"150",
            "type":"string",
            "description":"The middle name of the primary contact for a lead.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonMiddleName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Middle Name"
            },
            "x-queryable":true
        },
        "PrimaryCompetitorName":{
            "title":"Primary Competitor",
            "type":"string",
            "description":"The name of the primary competitor of the lead.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "PrimaryCompetitorName1"
                ]
            },
            "x-queryable":true
        },
        "PartnerId":{
            "title":"Primary Partner Identifier",
            "type":"integer",
            "description":"The unique identifier for the primary partner associated with the lead.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "SmartPickerEntityName":"Partner",
                "RecentItemEntityName":"partners"
            },
            "x-queryable":true
        },
        "LeadLastUpdateDate":{
            "title":"Lead Last Update Date",
            "type":"string",
            "description":"The date and time of the last update of the row.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ContactTimezoneCd":{
            "title":"Contact Time Zone",
            "maxLength":"35",
            "type":"string",
            "description":"The preferred time zone of the contact pursued on the lead.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ProductGroupDescription":{
            "title":"Product Group Description",
            "maxLength":"1000",
            "type":"string",
            "description":"The description of the product or product group associated with a lead.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Latitude":{
            "title":"Latitude",
            "type":"number",
            "description":"The latitude information for the location.",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryCampaignNumber":{
            "title":"Primary Campaign Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate identifier for primary campaign of the lead.",
            "nullable":false,
            "x-queryable":true
        },
        "PrimaryContactCounty":{
            "title":"Primary Contact County",
            "maxLength":"60",
            "type":"string",
            "description":"The county where the primary contact of the lead is located.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.County",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"County"
            },
            "x-queryable":true
        },
        "StatusCode":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"The pre-defined code used to indicate the status of a lead.",
            "nullable":true,
            "default":"UNQUALIFIED",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AssetNumber":{
            "title":"Asset Number",
            "maxLength":"100",
            "type":"string",
            "description":"The unique number for the asset associated with the sales lead.",
            "nullable":true,
            "x-queryable":true
        },
        "Name":{
            "title":"Lead Name",
            "maxLength":"250",
            "type":"string",
            "description":"The name of the lead used for identifying the lead.",
            "nullable":false,
            "x-queryable":true
        },
        "LeadAcceptedFlag":{
            "title":"Accepted",
            "maxLength":"4",
            "type":"boolean",
            "description":"Indicates if the lead has been accepted.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EnableCreateAccount":{
            "title":"Create Account",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether new account should be created during lead conversion.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"check_box"
            }
        },
        "QualificationScore":{
            "title":"Qualification Score",
            "type":"integer",
            "description":"The qualification score for a lead.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "default":"0",
            "x-queryable":false,
            "x-hints":{
                "precision":"10"
            }
        },
        "LeadOrigin":{
            "title":"Origin",
            "maxLength":"30",
            "type":"string",
            "description":"The origin of the lead.",
            "nullable":true,
            "default":"SALES_LEAD",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ClassCode4":{
            "title":"Auxiliary Classification Code 3",
            "maxLength":"30",
            "type":"string",
            "description":"The auxiliary dimension for the Account.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "ClassCode3":{
            "title":"Auxiliary Classification Code 2",
            "maxLength":"30",
            "type":"string",
            "description":"The auxiliary dimension for the Account.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "PrimaryContactEmailVerificationDate":{
            "title":"Email Verification Date",
            "type":"string",
            "description":"The verification date for primary contact email address.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ClassCode2":{
            "title":"Auxiliary Classification Code 1",
            "maxLength":"30",
            "type":"string",
            "description":"The auxiliary dimension for the Account.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "RecordSet":{
            "title":"Record Set",
            "type":"string",
            "description":"The record visibility filters for lead search based on the resource and the leads to which the resource is associated to. The set is a group of lead records considered as the base group before other search criteria is used to further refine the search results.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PrimaryInventoryItemNumber":{
            "title":"Primary Inventory Item Number",
            "maxLength":"300",
            "type":"string",
            "description":"The alternate key for referenced the primary inventory item.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "PrimaryInventoryOrgId"
                ]
            },
            "x-queryable":true
        },
        "ClassCode1":{
            "title":"Industry Classification Code",
            "maxLength":"30",
            "type":"string",
            "description":"The auxiliary dimension for the Account.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "PrimaryContactEmailVerificationStatus":{
            "title":"Email Verification Status",
            "maxLength":"30",
            "type":"string",
            "description":"The verification status for primary contact email address.",
            "nullable":true,
            "x-queryable":false
        },
        "AcceptedDateTime":{
            "title":"Accepted Date",
            "type":"string",
            "description":"The date and time when the sales lead is accepted by a resource assigned to it.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryContactPersonLastName":{
            "title":"Primary Contact Last Name",
            "maxLength":"150",
            "type":"string",
            "description":"The last name of the primary contact for a lead.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonLastName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Last Name"
            },
            "x-queryable":true
        },
        "Timeframe":{
            "title":"Time Frame",
            "maxLength":"120",
            "type":"string",
            "description":"The timeframe associated with this sales lead.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "BusinessUnitId"
                ]
            },
            "x-queryable":true
        },
        "PrimaryContactCountryName":{
            "title":"Country Name",
            "type":"string",
            "description":"The full name associated with primary contact country code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OwnerPartyName":{
            "title":"Owner",
            "maxLength":"360",
            "type":"string",
            "description":"The name associated with the owner of this sales lead.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "BusinessUnitId":{
            "title":"Business Unit Identifier",
            "type":"integer",
            "description":"The business unit identifier associated with the business unit of the sales lead creator.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "="
                ],
                "precision":"18"
            }
        },
        "AddrElementAttribute5":{
            "title":"Contact Address Attribute 5",
            "maxLength":"150",
            "type":"string",
            "description":"Additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":false
        },
        "LeadCreationDate":{
            "title":"Lead Creation Date",
            "type":"string",
            "description":"The date and time when this record is created.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "BudgetCurrencyCode":{
            "title":"Budget Currency",
            "maxLength":"80",
            "type":"string",
            "description":"The currency code associated with the budget amount associated with this sales lead.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "AddrElementAttribute1":{
            "title":"Contact Address Attribute 1",
            "maxLength":"150",
            "type":"string",
            "description":"Additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":false
        },
        "ProgramName":{
            "title":"Partner Program",
            "type":"string",
            "description":"The name of the partner program in which the primary partner associated with this sales lead is enrolled. This is a deal specific attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "PartnerProgramName"
                ]
            }
        },
        "AddrElementAttribute2":{
            "title":"Contact Address Attribute 2",
            "maxLength":"150",
            "type":"string",
            "description":"Additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":false
        },
        "AddrElementAttribute3":{
            "title":"Contact Address Attribute 3",
            "maxLength":"150",
            "type":"string",
            "description":"Additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":false
        },
        "SalesTargetLeadStage":{
            "title":"Stage",
            "maxLength":"32",
            "type":"string",
            "description":"The lead's current stage in the account based selling process.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AssetSerialNumber":{
            "title":"Asset Serial Number",
            "maxLength":"100",
            "type":"string",
            "description":"The serial number for the asset associated with the sales lead.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApprovalDate":{
            "title":"Registration Approval Date",
            "type":"string",
            "description":"The date on which a partner registered lead is approved by internal channel manager.",
            "format":"date",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "ApprovalDateTime"
                ]
            }
        },
        "AddrElementAttribute4":{
            "title":"Contact Address Attribute 4",
            "maxLength":"150",
            "type":"string",
            "description":"Additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":false
        },
        "Score":{
            "title":"Score",
            "type":"integer",
            "description":"The score associated with this sales lead. This score is computed based on the scoring rules.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"10"
            },
            "x-queryable":true
        },
        "OpportunityName":{
            "title":"Opportunity Name",
            "type":"string",
            "description":"The name of the opportunity created from converting the lead.",
            "nullable":true,
            "x-queryable":false
        },
        "PostalPlus4Code":{
            "title":"Postal Code",
            "maxLength":"10",
            "type":"string",
            "description":"The four digit extension to the United States Postal ZIP code.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "protectionKey":"PartySiteEO.PostalPlus4Code",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Postal Code Extension"
            }
        },
        "PrimaryInventoryItemId":{
            "title":"Primary Product ID",
            "type":"integer",
            "description":"The unique identifier of the primary product associated with a lead.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18",
                "SmartPickerEntityName":"CRMProduct",
                "RecentItemEntityName":"CRMProduct"
            }
        },
        "RejectComment":{
            "title":"Rejection Comments",
            "maxLength":"250",
            "type":"string",
            "description":"The comments provided by the sales representative who rejected this sales lead.",
            "nullable":true,
            "x-queryable":false
        },
        "AssignmentStatusCode":{
            "title":"Assignment Status",
            "maxLength":"30",
            "type":"string",
            "description":"Includes the current assignment related status for the lead, for example whether the lead is assigned or unassigned.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RawPrimaryPhoneNumber":{
            "title":"Raw Phone Number",
            "type":"string",
            "description":"The raw value of the lead primary phone number.",
            "nullable":true,
            "x-queryable":true
        },
        "CustomerPartyName":{
            "title":"Account Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the customer.",
            "nullable":true,
            "x-queryable":true
        },
        "EnableCreateContact":{
            "title":"Create Contact",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether new contact should be created during lead conversion.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"check_box"
            }
        },
        "ReassignComment":{
            "title":"Reassign Comments",
            "maxLength":"1000",
            "type":"string",
            "description":"The comment provided by a user while requesting the lead reassignment.",
            "nullable":true,
            "x-queryable":false
        },
        "WorkPhoneNumber":{
            "title":"Work Phone Number",
            "maxLength":"40",
            "type":"string",
            "description":"The work phone number for the sales lead contact.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneNumber",
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Phone"
            },
            "x-queryable":true
        },
        "CustomerNeed":{
            "title":"Customer Need",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates what need the lead product serves for the lead customer.",
            "nullable":true,
            "x-queryable":false
        },
        "CampaignName":{
            "title":"Campaign",
            "maxLength":"250",
            "type":"string",
            "description":"The name of the campaign associated with the sales lead.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "SourceCode"
                ]
            },
            "x-queryable":true
        },
        "BudgetAmount":{
            "title":"Budget Amount",
            "type":"number",
            "description":"The budget amount associated with this sales lead.",
            "nullable":true,
            "x-queryable":false
        },
        "PrimaryContactCity":{
            "title":"Primary Contact City",
            "maxLength":"60",
            "type":"string",
            "description":"The city where the primary contact of the lead is located.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.City",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"City"
            },
            "x-queryable":true
        },
        "DecisionMakerIdentifiedFlag":{
            "title":"Decision Maker Identified",
            "maxLength":"120",
            "type":"boolean",
            "description":"Indicates if the decision maker at customer site has been identified.",
            "nullable":true,
            "default":false,
            "x-queryable":false
        },
        "SalesChannel":{
            "title":"Sales Channel",
            "maxLength":"120",
            "type":"string",
            "description":"Indicates the sales channel responsible for following up on this sales lead.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AcceptedDate":{
            "title":"Accepted Date",
            "type":"string",
            "description":"The date on which lead was accepted by a resource assigned to it.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "AcceptedDateTime"
                ]
            }
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates if the user has access to update the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PartnerPartyName":{
            "title":"Primary Partner",
            "type":"string",
            "description":"The name associated with the primary partner of this sales lead. This is a deal specific attribute.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "PartnerPartyName1"
                ]
            },
            "x-queryable":true
        },
        "PrimaryContactPartyName":{
            "title":"Primary Contact Name",
            "maxLength":"450",
            "type":"string",
            "description":"The name associated with the primary lead contact.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Name",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "FollowupTimestamp":{
            "title":"Next Follow-up Date",
            "type":"string",
            "description":"Indicates when the sales lead needs to be followed up.",
            "format":"date",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"date"
            }
        },
        "EstimatedCloseDate":{
            "title":"Estimated Close Date",
            "type":"string",
            "description":"The estimated close date for a deal once registered.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "RejectedDateTime":{
            "title":"Rejected Time Stamp",
            "type":"string",
            "description":"The date and time when the sales lead is rejected.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "ContactDoNotPreference":{
            "title":"Don't Contact Preference",
            "maxLength":"30",
            "type":"boolean",
            "description":"Indicates that the primary contact of the service request does not want to be contacted.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"check_box",
                "AttributeType":"Checkbox"
            }
        },
        "RegistrationType":{
            "title":"Registration Type",
            "maxLength":"120",
            "type":"string",
            "description":"The registration type of the sales lead. This is a deal specific attribute.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "BusinessUnitId"
                ]
            },
            "x-queryable":true
        },
        "LeadId":{
            "title":"Lead Identifier",
            "type":"integer",
            "description":"The unique identifier of the lead.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "WorkPhoneCountryCode":{
            "title":"Work Phone Country Code",
            "maxLength":"10",
            "type":"string",
            "description":"The work phone country code for the sales lead contact.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "PrimaryContactAddress1":{
            "title":"Primary Contact Address 1",
            "maxLength":"240",
            "type":"string",
            "description":"The first line of address associated with the primary contact of the lead.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address1",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 1",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "PrimaryContactAddress4":{
            "title":"Primary Contact Address 4",
            "maxLength":"240",
            "type":"string",
            "description":"The fourth line of address associated with the primary contact of the lead.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address4",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 4",
                "protectionTokenizationScheme":"WORD"
            }
        },
        "PrimaryContactAddress3":{
            "title":"Primary Contact Address 3",
            "maxLength":"240",
            "type":"string",
            "description":"The third line of address associated with the primary contact of the lead.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address3",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 3",
                "protectionTokenizationScheme":"WORD"
            }
        },
        "SalesTargetLeadOptOutComment":{
            "title":"Opt-out Comment",
            "maxLength":"1000",
            "type":"string",
            "description":"The comments provided by the sales representative who opted out this lead.",
            "nullable":true,
            "x-queryable":false
        },
        "PrimaryContactAddress2":{
            "title":"Primary Contact Address 2",
            "maxLength":"240",
            "type":"string",
            "description":"The second line of address associated with the primary contact of the lead.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address2",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 2",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "PrimaryInventoryOrgId":{
            "title":"Primary Product Organization ID",
            "type":"integer",
            "description":"The unique identifier of the organization to which the primary product associated with a lead belongs.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "OrganizationType":{
            "title":"Organization Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of the organization.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "QualifiedDateTime":{
            "title":"Qualification Date",
            "type":"string",
            "description":"The date and time when the sales lead is qualified.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "PrimaryContactRelationshipId":{
            "title":"Primary Contact Relationship ID",
            "type":"integer",
            "description":"The unique identifier of the relationship primary contact has with its parent organization.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "PrimaryCompetitorPartyId":{
            "title":"Primary Competitor Party ID",
            "type":"integer",
            "description":"The unique identifier of the primary competitor of the lead. It is a reference key to competitor object.",
            "nullable":true,
            "x-hints":{
                "RecentItemEntityName":"competitors"
            },
            "x-queryable":true
        },
        "SalesTargetLeadOptOutDate":{
            "title":"Opt-out Date",
            "type":"string",
            "description":"The date of opting out the lead from sales target campaign.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

acceptLead

Operation: /crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/assetLeads/action/acceptLead

Parameters:

• AssetId: $request.path.AssetId

This method lets you accept a lead.

convertLeadToOpty

Operation: /crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/assetLeads/action/convertLeadToOpty

Parameters:

• AssetId: $request.path.AssetId

This method lets you convert a lead to an opportunity.

rankLead

Operation: /crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/assetLeads/action/rankLead

Parameters:

• AssetId: $request.path.AssetId

This method lets you rank a lead.

rejectLead

Operation: /crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/assetLeads/action/rejectLead

Parameters:

• AssetId: $request.path.AssetId

This method lets you reject a lead.

runAssignment

Operation: /crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/assetLeads/action/runAssignment

Parameters:

• AssetId: $request.path.AssetId

This method lets you assign a lead.

scoreLead

Operation: /crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/assetLeads/action/scoreLead

Parameters:

• AssetId: $request.path.AssetId

This method lets you score a lead.

Back to Top