Salesforce Docs Portal

BusinessLicense

Represents the licenses of a party role like healthcare provider or producer.

Special Access Rules

In Life Science Cloud, this object is available in API version 65.0 and later.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

Fields

AccountId

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The ID of the organization holding the license. This field is a relationship field.
  • Relationship Name: Account
  • Refers To: Account

ComplianceScope

  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Description: The scope of compliance for the business license.

    This field is available with the Life Sciences Cloud for Customer Engagement Add-on license in API version 65.0 and later.

  • Possible values:
    • Address
    • Jurisdiction
    • StateDistributorLicense

ContactId

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The ID of the person who holds the license and is listed as a contact. This field is a relationship field.
  • Relationship Name: Contact
  • Refers To: Contact

ContactPointAddressId

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The ID of the person who holds the license and is listed as a contact. This field is a relationship field. This field is available with the Life Sciences Cloud for Customer Engagement Add-on license in API version 65.0 and later.
  • Relationship Name: ContactPointAddress
  • Refers To: ContactPointAddress

Description

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Description of the license.

HealthCareFacilityId

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The ID associated with the healthcare facility. This field is a relationship field. This field is available with the Life Sciences Cloud for Customer Engagement Add-on license in API version 65.0 and later.
  • Relationship Name: HealthCareFacility
  • Refers To: HealthcareFacility

HealthcareProviderId

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The ID of the Healthcare Provider who holds this license. This field is a relationship field. This field is a lookup to HealthcareProvider.
  • Relationship Name: HealthcareProvider
  • Refers To: HealthcareProvider

Identifier

  • Type: string
  • Properties: Create, Filter, Group, idLookup, Nillable, Sort, Update
  • Description: Issuer's ID for the licensee. This field is unique within your organization.

IsActive

  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Indicates whether the license is active (true) or not (false).
  • Default value: false

IsLicenseValidated

  • Type: boolean
  • Properties: Defaulted on create, Filter, Group, Sort
  • Description: Indicates whether the business license is valid (true) or not (false). This field is a calculated field. This field is available with the Life Sciences Cloud for Customer Engagement Add-on license in API version 65.0 and later.
  • Default value: false

IsPrimaryLicense

  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Indicates if the license is the primary license.
  • Default value: false

IssueDate

  • Type: date
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The date the license or certification was issued.

Issuer

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: License issuer's name.

JurisdictionCountry

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Country where license is valid.

JurisdictionOther

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Name of other jurisdiction.

JurisdictionState

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: State where license is valid.

JurisdictionType

  • Type: picklist
  • Properties: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
  • Description: Jurisdiction for the license.
  • Default value: STATE
  • Possible values:
    • COUNTRY
    • COUNTY
    • PROVINCE
    • STATE

LastReferencedDate

  • Type: dateTime
  • Properties: Filter, Nillable, Sort
  • Description: The timestamp for when the current user last referenced a record related to this record. This field is available with the Life Sciences Cloud for Customer Engagement Add-on license in API version 65.0 and later.

LastViewedDate

  • Type: dateTime
  • Properties: Filter, Nillable, Sort
  • Description: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. This field is available with the Life Sciences Cloud for Customer Engagement Add-on license in API version 65.0 and later.

LicenseClass

  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The class that the distributor’s license belongs to.
  • Possible values:
    • APN - Advanced Practice Nurse
    • LPN - Licensed Practical Nurse
    • MD - Medical Doctor (MD)
    • PC - Professional Counselor
    • PT - Physical Therapist

LicenseNumber

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The number of the license.

LineOfAuthority

  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The line of authority that the distributor is licensed for.

    This field is available with the Life Sciences Cloud for Customer Engagement Add-on license in API version 65.0 and later.

  • Possible values:
    • Accident & Health or Sickness
    • Casualty
    • Property

Name

  • Type: string
  • Properties: Create, Filter, Group, idLookup, Sort, Update
  • Description: Name of the business or professional license.

OwnerId

  • Type: reference
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: The ID of the user who owns this record. This field is a polymorphic relationship field.
  • Relationship Name: Owner
  • Refers To: Group, User

PeriodEnd

  • Type: dateTime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: License's expiration date.

PeriodStart

  • Type: dateTime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: License's effective start date.

ResidenceStatus

  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Residence status of the producer.

    This field is available with the Life Sciences Cloud for Customer Engagement Add-on license in API version 65.0 and later.

  • Possible values:
    • Non-resident
    • Resident

SourceSystemUpdateDate

  • Type: date
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Represents the date when the record was last updated in the source system.

StateDstrLicenseCategory

  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Description: The State Distributor License category for the business license.
  • Possible values:
    • CategoryII—Category II
    • CategoryIII—Category III
    • LimitedCategoryII—Limited Category II
    • LimitedCategoryIII—Limited Category III

This field is available with the Life Sciences Cloud for Customer Engagement Add-on license in API version 65.0 and later.

Status

  • Type: picklist
  • Properties: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
  • Description: Current status of the license.
  • Default value: Inactive
  • Possible values:
    • Draft
    • Inactive
    • Revoked
    • Verified

UserId

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The person who holds the license and is listed as a user. This field is a relationship field.
  • Relationship Name: User
  • Refers To: User

VerificationStatus

  • Type: picklist
  • Properties: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
  • Description: Current status for the license.
  • Default value: Authorized
  • Possible values:
    • Authorized

VerifiedDate

  • Type: date
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: License was validated on this date.

Associated Objects

This object has the following associated objects. Unless noted, they are available in the same API version as this object.

BusinessLicenseFeed
Feed tracking is available for the object.
BusinessLicenseHistory
History is available for tracked fields of the object.
BusinessLicenseOwnerSharingRule
Sharing rules are available for the object.
BusinessLicenseShare
Sharing is available for the object.