Create Assets and Related Records

You are here:

Create Assets and Related Records

Use the composite API to create multiple Asset records and related records, such as Asset Action, Asset Action Source, Asset State Period, Asset Relationship records.

Resource

https://yourInstance.salesforce.com/services/data/vXX.X/composite

JSON Request Sample

This sample request demonstrates how to create assets.

{
  "allOrNone": true,
  "compositeRequest": [
    {
      "method": "POST",
      "url": "/services/data/vXX.X/sobjects/Asset",
      "referenceId": "refAsset1",
      "body": {
        "AccountId": "{{accountId}}",
        "Name": "InfinitraBytes Firewall",
        "Product2Id": "{{termedProductId1}}",
        "ContactId": "{{contactId}}",
        "HasLifecycleManagement": true,
        "LifecycleStartDate": "2023-04-05T00:00:00.000+0000",
        "LifecycleEndDate": "2024-04-05T23:59:59.000+0000",
        "CurrentMRR": 1000,
        "CurrentQuantity": 10,
        "TotalLifecycleAmount": 12000
      }
    },
    {
      "method": "POST",
      "url": "/services/data/vXX.X/sobjects/Asset",
      "referenceId": "refAsset2",
      "body": {
        "AccountId": "{{accountId}}",
        "Name": "InfinitraBytes Router",
        "Product2Id": "{{termedProductId2}}",
        "ContactId": "{{contactId}}",
        "HasLifecycleManagement": true,
        "LifecycleStartDate": "2023-05-05T00:00:00.000+0000",
        "LifecycleEndDate": "2024-04-05T23:59:59.000+0000",
        "CurrentMRR": 0,
        "CurrentQuantity": 0,
        "TotalLifecycleAmount": 5500
      }
    },
    {
      "method": "POST",
      "url": "/services/data/vXX.X/sobjects/AssetAction",
      "referenceId": "refAA1",
      "body": {
        "AssetId": "@{refAsset1.id}",
        "Type": "Generate",
        "category": "Initial Sale",
        "CategoryEnum": "Initial Sale",
        "ActionDate": "{{currentDate}}",
        "quantityChange": 10,
        "mrrChange": 1000,
        "amount": 12000,
        "TotalInitialSaleAmount": 12000,
        "TotalMrr": 1000
      }
    },
    {
      "method": "POST",
      "url": "/services/data/vXX.X/sobjects/AssetAction",
      "referenceId": "refAA2",
      "body": {
        "AssetId": "@{refAsset2.id}",
        "Type": "Generate",
        "category": "Initial Sale",
        "CategoryEnum": "Initial Sale",
        "ActionDate": "{{currentDate}}",
        "quantityChange": 5,
        "mrrChange": 500,
        "amount": 5500,
        "TotalInitialSaleAmount": 5500,
        "TotalMrr": 500
      }
    },
    {
      "method": "POST",
      "url": "/services/data/vXX.X/sobjects/AssetStatePeriod",
      "referenceId": "refASP1",
      "body": {
        "AssetId": "@{refAsset1.id}",
        "startDate": "2023-04-05T00:00:00.000+0000",
        "endDate": "2024-04-05T23:59:59.000+0000",
        "quantity": 10,
        "amount": 0,
        "mrr": 1000
      }
    },
    {
      "method": "POST",
      "url": "/services/data/vXX.X/sobjects/AssetStatePeriod",
      "referenceId": "refASP2",
      "body": {
        "AssetId": "@{refAsset2.id}",
        "startDate": "2023-05-05T00:00:00.000+0000",
        "endDate": "2024-04-05T23:59:59.000+0000",
        "quantity": 5,
        "amount": 0,
        "mrr": 500
      }
    },
    {
      "method": "POST",
      "url": "/services/data/vXX.X/sobjects/AssetActionSource",
      "referenceId": "refAAS1",
      "body": {
        "AssetActionId": "@{refAA1.id}",
        "transactionDate": "{{currentDate}}",
        "adjustmentAmount": 0,
        "productAmount": 12000,
        "estimatedTax": 0,
        "actualTax": 0,
        "startDate": "2023-04-05T00:00:00.000+0000",
        "endDate": "2024-04-05T23:59:59.000+0000",
        "quantity": 10,
        "ExternalReference": "ABC",
        "ExternalReferenceDataSource": "ExtABC",
        "ReferenceEntityItemId": "{{orderItemId1}}"
      }
    },
    {
      "method": "POST",
      "url": "/services/data/vXX.X/sobjects/AssetActionSource",
      "referenceId": "refAAS2",
      "body": {
        "AssetActionId": "@{refAA2.id}",
        "transactionDate": "{{currentDate}}",
        "adjustmentAmount": 0,
        "productAmount": 5500,
        "estimatedTax": 0,
        "actualTax": 0,
        "startDate": "2023-05-05T00:00:00.000+0000",
        "endDate": "2024-04-05T23:59:59.000+0000",
        "quantity": 5,
        "ExternalReference": "ABC",
        "ExternalReferenceDataSource": "ExtABC",
        "ReferenceEntityItemId": "{{orderItemId2}}"
      }
    },
    {
      "method": "POST",
      "url": "/services/data/vXX.X/sobjects/AssetRelationship",
      "referenceId": "refAR1",
      "body": {
        "AssetId": "@{refAsset1.id}",
        "AssetRole": "Bundle",
        "FromDate": "2023-05-05T00:00:00.000+0000",
        "GroupingKey": "InfinitraBytesFirewallWithSwitch",
        "ProductRelationshipTypeId": "{{productRelationshipType}}",
        "RelatedAssetId": "@{refAsset2.id}",
        "RelatedAssetRole": "BundleComponent"
      }
    }
  ]
}

Considerations

Keep these considerations in mind when creating assets and their related records.

When migrating numerical fields, having 0 or null as the field value is an important distinction. When you amend an asset, the field values 0 and null are treated differently. If the field value is null but the system sets the value to 0, this could be treated as a field amendment and trigger certain behavior.
When using Asset Contract Relationship records, the lifecycle start date and lifecycle end date of the assets must be between the contract dates.

Make sure that you migrate these records and fields.

Asset Records

These Asset fields are required.

Asset Field	Requirement
ContactId	ContactId is a required field.
HasLifecycleManagement	Specify `True`. These features are available only if the hasLifecycleManagement value is True: Customer Asset Lifecycle Management features and ARC APIs Display of assets in the Managed Assets Viewer UI
LifecycleEndDate	Specify the LifecycleEndDate in the DateTime format. For example, 23:59:59, which is in the HH:MM:SSS format. Don't specify the LifecycleEndDate if the migrated asset is for a one-time or evergreen product.
LifecycleStartDate	Specify the LifecycleStartDate in the DateTime format. For example, 00:00:00, which is in the HH:MM:SS format. Specify the start date of assets in 24-hour increments, unless there’s a business need for higher time precision.
Product2Id	Product2Id is a required field. Specify the ID of either a termed or evergreen product that's related to the asset.
RenewalTermUnit	Specify either `Annual` or `Months`. When renewing an asset by using Asset Renewal API, the RenewalTermUnit should match the PricingTermUnit of the product selling model.
TotalLifecycleAmount	Specify an accurate total amount for the entire lifecycle of the asset.

See Asset.

Asset Action Records

To amend, renew, or cancel an asset, the asset requires related Asset Action records.

Asset Action Field	Requirement
ActionDate	ARC APIs don’t use the ActionDate. However, if the ActionDate of ARC is earlier than the ActionDate of the root assets or the assets in the bundle, the Create Asset From Order API request fails.
CategoryEnum	Specify a valid picklist value. If you don’t specify the CategoryEnum, the Create Asset From Order API request fails and shows the error “The asset isn't related to an asset action".
TotalCancellationsAmount	Specify the total amount for the cancellation asset action. Specify the TotalCancellationsAmount, even if it's 0, to maintain an accurate TotalAmount value for asset actions.
TotalDownsellsAmount	Specify the total amount for the Downsells asset action. Specify the TotalDownsellsAmount, even if it's 0, to maintain an accurate TotalAmount value for asset actions.
TotalInitialSaleAmount	Specify the total amount for the initial-sale asset action. Specify the TotalInitialSaleAmount, even if it's 0, to maintain an accurate TotalAmount value for asset actions.
TotalMrr	Specify the monthly recurring revenue (MRR) for the asset action. Specify the TotalMrr, even if it's 0, to maintain accurate Customer Asset Lifecycle Management UX charts.
TotalQuantity	Specify the total quantity for asset action. Specify the TotalQuantity, even if it's 0, to maintain accurate Customer Asset Lifecycle Management UX charts.
TotalRenewalsAmount	Specify the total amount for Renewal asset action. Specify the TotalRenewalsAmount, even if it's 0, to maintain an accurate TotalAmount value for asset actions.
TotalUpsellsAmount	Specify the total amount for Upsells asset action. Specify the TotalUpsellsAmount, even if it's 0, to maintain an accurate TotalAmount value for asset actions.

See AssetAction.

Asset Action Source Records

These Asset Action Source fields are required.

Asset Action Source Field	Requirement
ConstraintEngineNodeStatus	The ConstraintEngineNodeStatus value maintains the historical values of migrated asset attributes. See Create the ConstraintEngineNodeStatus Custom Field.
EndDate	Only subscriptions have the EndDate based on the related contract. The source Asset records from Salesforce CPQ don't have the EndDate. The EndDate is needed for migrating assets from the Salesforce CPQ managed package to Agentforce Revenue Management. If it isn’t specified, the cancellation of migrated assets fails.
ListPrice	The ListPrice is derived from the related Asset record. The ListPrice is needed for migrating assets from the Salesforce CPQ managed package to Agentforce Revenue Management. If it isn’t populated, the amendment and cancellation of migrated assets fails.
NetUnitPrice	The NetUnitPrice is derived from the related Asset record. The NetUnitPrice is needed for migrating assets from the Salesforce CPQ managed package to Agentforce Revenue Management. If it isn’t specified, the amendment and cancellation of migrated assets fails.
PeriodBoundary	Specify a valid picklist value. The PeriodBoundary is needed for migrating assets from the Salesforce CPQ managed package to Agentforce Revenue Management. If it isn’t specified, the renewal of migrated assets fails.
PricebookEntryId	Specify the price book entry ID. The PricebookEntryId is needed for migrating assets from the Salesforce CPQ managed package to Agentforce Revenue Management. If it isn’t specified, the cancellation of migrated assets fails.
ProductAmount	Specify the amount paid for the product. The ProductAmount is needed to maintain an accurate Subtotal value for the asset action source.
ProductSellingModelId	Specify the product selling model ID that’s related to the pricebook entry ID. The ProductSellingModelId is needed for migrating assets from the Salesforce CPQ managed package to Agentforce Revenue Management. If it isn’t specified, the cancellation of migrated assets fails.
Quantity	The Quantity is derived from the related Asset record. Only subscriptions have the Quantity based on the related contract. The source Asset records from Salesforce CPQ don't have the Quantity. The Quantity is required for migrating assets from Salesforce CPQ managed package to Agentforce Revenue Management. If it isn’t populated, cancellation of the migrated asset will fail.
StartDate	Only subscriptions have the StartDate based on the related contract. The source Asset records from Salesforce CPQ don't have the StartDate. The Quantity is needed for migrating assets from the Salesforce CPQ managed package to Agentforce Revenue Management. If it isn’t specified, the cancellation of migrated assets fails.
TotalPrice	The TotalPrice is derived from the related Asset record. The TotalPrice is needed for migrating assets from the Salesforce CPQ managed package to Agentforce Revenue Management. If it isn’t specified, the amendment and cancellation of migrated assets fails.
UnitPrice	The UnitPrice is derived from the related Asset record. The UnitPrice is needed for migrating assets from the Salesforce CPQ managed package to Agentforce Revenue Management. If it isn’t populated, the amendment and cancellation of migrated assets fails.

See AssetActionSource.

Asset State Period Records

If you want to amend, renew, or cancel an asset, the asset should have related Asset State Period records.

When an asset has multiple asset state periods, the asset state periods must be continuous. There can be no time gap or overlaps between subsequent asset state periods.

Important You can't currently create a lookup relationship from the Asset object to the Asset State Period object.

Asset State Period Field	Requirement
Amount	Specify 0 for every transaction item.
EndDate	Specify the EndDate in the HH:MM:SSS format. If the product is a one-time product, the end date must be null. From Winter ’26, the EndDate doesn't have to be 23:59:59. Asset state periods must be at least 24 hours long.
StartDate	Specify the StartDate in the HH:MM:SS format. From Winter ’26, the StartDate doesn't have to be 00:00:00. Asset state periods must be at least 24 hours long.

Asset State Period Field

Requirement

Amount

Specify 0 for every transaction item.

EndDate

Specify the EndDate in the HH:MM:SSS format.

If the product is a one-time product, the end date must be null.

From Winter ’26, the EndDate doesn't have to be 23:59:59.

Asset state periods must be at least 24 hours long.

StartDate

Specify the StartDate in the HH:MM:SS format.

From Winter ’26, the StartDate doesn't have to be 00:00:00.

Asset state periods must be at least 24 hours long.

See AssetStatePeriod.

Asset Relationship Records

These Asset Relationship fields are required.

Asset Relationship Field	Field Value Details
AssetRole	The AssetRole should not be null. The default AssetRole value is Bundle.
FromDate	Specify the latest StartDate of the Asset and RelatedAsset.
GroupingKey	A unique identifier that indicates 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. The GroupingKey remains the same across the bundle and helps with searching the entire bundle structure.
ProductRelatedComponent	Specify the ProductRelatedComponent.Id of the related bundle component record. The ProductRelatedComponent is required for amendment of migrated bundled assets.
ProductRelationshipTypeId	Specify the ProductRelationshipTypeId.
RelatedAssetPricing	The RelatedAssetPricing is included in the bundle price if the DoesBundlePriceIncludeChild value of the related ProductRelatedComponent is set to `true`. If the DoesBundlePriceIncludeChild value is set to `false`, the RelatedAssetPricing isn’t included in bundle price. The RelatedAssetPricing is required for amendment of migrated bundled assets.
RelatedAssetQtyScaleMethod	Specify the QuantityScaleMethod of the related ProductRelatedComponent of the relevant bundle component record corresponding to this asset. The RelatedAssetQtyScaleMethod is required for amendment of migrated bundled assets.
RelatedAssetRole	The RelatedAssetRole should not be null. The default RelatedAssetRole value is BundleComponent.
ToDate	Specify the ToDate only for cancellation. It’s the nearest EndDate of the Asset and RelatedAsset.

See AssetRelationship.

Create Assets and Related Records

Considerations

Asset Records

Asset Action Records

Asset Action Source Records

Asset State Period Records

Asset Relationship Records

See Also

General Information

Required Cookies

Functional Cookies

Advertising Cookies

General Information

Required Cookies

Functional Cookies

Advertising Cookies

Cookie List

Product Area

Feature Impact

Edition

Experience

Create Assets and Related Records

Considerations

Asset Records

Asset Action Records

Asset Action Source Records

Asset State Period Records

Asset Relationship Records

See Also