AssetId |
- Type
- reference
- Properties
- Create, Filter, Group, Sort
- Description
- The unique identifier of the new asset, which is the
asset that is taking the place of the existing
asset.
- This field is a relationship field.
- Relationship Name
- Asset
- Relationship Type
- Lookup
- Refers To
- Asset
|
AssetRelationshipNumber |
- Type
- string
- Properties
- Autonumber, Defaulted on create, Filter, idLookup,
Sort
- Description
- An auto-generated number identifying the asset
relationship.
|
AssetRole |
- Type
- picklist
- Properties
- Filter, Group, Nillable, Restricted picklist, Sort
- Description
- Describes the position of the main asset relative to the
other assets in the relationship.
- This field is available in API version 58.0 and later. This field is available in
orgs with Subscription Management or Revenue Cloud.
- Possible values are:
-
Add-on—The main asset is an
add-on.
-
Bundle—The main asset is the
bundle parent.
-
Set—The asset is the main asset
in the set.
|
CurrencyIsoCode |
- Type
- picklist
- Properties
- Create, Defaulted on create, Filter, Group, Nillable,
Restricted picklist, Sort, Update
- Description
- Three-letter ISO 4217 currency code associated with the
asset. The default value is USD.
|
FromDate |
- Type
- dateTime
- Properties
- Create, Filter, Nillable, Sort, Update
- Description
- The date when the new asset was installed.
|
GroupingKey |
- Type
- string
- Properties
- Filter, Group, idLookup, Nillable, Sort
- Description
- Read-only field used to indicate the bundle that an
asset belongs to. For example, if two assets have the
same GroupingKey value, then it means that the assets
are bundled together.
- This field is available in API v.60.0 and later. This field is available in orgs with
Subscription Management or Revenue Cloud.
|
ProductRelationshipTypeId |
- Type
- reference
- Properties
- Filter, Group, Nillable, Sort
- Description
- The unique identifier of the record that describes the
relationship between the main and associated assets.
- This field is available in API version 58.0 and later. This field is available in orgs
with Subscription Management.
- This field is a relationship field.
- Relationship Name
- ProductRelationshipType
- Relationship Type
- Lookup
- Refers To
- ProductRelationshipType
|
ProductRelatedComponent |
- Type
- reference
- Properties
- Filter, Group, Nillable, Sort
- Description
- The product related component that’s associated with the
asset relationship.
- This field is a relationship field.
- This field is available in API 60.0 and later in Revenue Cloud.
- Relationship Name
- ProductRelatedComponent
- Relationship Type
- Lookup
- Refers To
- ProductRelatedComponent
|
RelatedAssetId |
- Type
- reference
- Properties
- Create, Filter, Group, Sort, Update
- Description
- The existing asset that is being modified.
- This field is a relationship field.
- Relationship Name
- RelatedAsset
- Relationship Type
- Lookup
- Refers To
- Asset
|
RelatedAssetPricing |
- Type
- picklist
- Properties
- Filter, Group, Nillable, Restricted picklist, Sort
- Description
- Specifies whether the price of the related asset is
included in the bundle price. Valid values are:
- IncludedInBundlePrice
- NotIncludedInBundlePrice
- This field is available in API version 59.0 and later in
Revenue Cloud.
|
RelatedAssetQtyScaleMethod |
- Type
- picklist
- Properties
- Filter, Group, Nillable, Restricted picklist, Sort
- Description
- Specifies how the quantity of the related asset changes
relative to the quantity of the parent asset. Valid
values are:
- This field is available in API version 59.0 and later in
Revenue Cloud.
|
RelatedAssetRole |
- Type
- picklist
- Properties
- Filter, Group, Nillable, Restricted picklist, Sort
- Description
- Describes the position of the associated asset relative
to other assets in the relationship.
- This field is available in API version 58.0 and later. This field is available in orgs
with Subscription Management or Revenue Cloud.
- Valid values are:
-
Add-on—The main asset is an
add-on.
-
Bundle—The main asset is the
bundle parent.
-
Set—The asset is the main asset
in the set.
-
Simple—The asset is purchased
individually and isn’t associated with
variations.
-
Variation
Parent——The main asset is the
variation parent.
|
RelationshipType |
- Type
- picklist
- Properties
- Create, Defaulted on create, Filter, Group, Nillable,
Sort, Update
- Description
- The type of relationship between the existing asset and
the new asset. This field comes with three
values—Replacement, Upgrade, and
Crossgrade—, but you can create more values in
Setup.
- Possible values are:
-
Crossgrade—The new asset is a
crossgrade of an existing asset. For example,
changing a subscription to a plan with the same
service, but that runs for a longer amount of
time.
-
Replacement—The new asset is
replacing an existing asset. For example, a
customer’s faulty widget that was under warranty
is being replaced with a new one.
-
Upgrade—The new asset is an
upgrade of an existing asset. For example,
upgrading a customer’s existing subscription plan
to a new plan with more services.
- The default value is Replacement.
|
ToDate |
- Type
- dateTime
- Properties
- Create, Filter, Nillable, Sort, Update
- Description
- The date when the modified asset is uninstalled.
|