afv-library/skills/platform-data-and-tooling-api-context-get/assets/enterprise_api/AssetStatePeriod.json

{
  "sections": [
    "title",
    "description",
    "fields",
    "special_access_rules",
    "wsdl_segment",
    "field_reference"
  ],
  "title": "AssetStatePeriod - Data API",
  "description": "Represents a time span when an asset has the same quantity, amount, and monthly recurring revenue (MRR). An asset has as many asset state periods as there are changes to it (asset actions) during its lifecycle. The dashboard and related pages show the current asset state period. The fields can’t be edited. This object is available in API version 50.0 and later.",
  "fields_columns": [
    "type",
    "properties",
    "description",
    "relationship_name",
    "relationship_type",
    "refers_to"
  ],
  "fields": {
    "Amount": {
      "type": "currency",
      "properties": "Createable, Filter, Sort, Updateable",
      "description": "An asset’s total amount during an asset state period. Revenue Cloud doesn't set or use this field's value currently."
    },
    "AssetId": {
      "type": "reference",
      "properties": "Createable, Filter, Group, Sort",
      "description": "The asset related to an asset state period. Label is Asset. This field is a relationship field.",
      "relationship_name": "Asset",
      "relationship_type": "Lookup",
      "refers_to": "Asset"
    },
    "AssetStatePeriodNumber": {
      "type": "string",
      "properties": "Autonumber, Defaulted on create, Filter, idLookup, Sort",
      "description": "The ID of the asset state period. Label is Name."
    },
    "BillingFrequency": {
      "type": "picklist",
      "properties": "Createable, Filter, Group, Nillable, Restricted picklist, Sort, Updateable",
      "description": "The time period that indicates how often the line item is billed. Possible values are: Annual Monthly Quarterly Semi-Annual Available in API version 65.0 and later."
    },
    "BindingInstanceTargetId": {
      "type": "reference",
      "properties": "Createable, Filter, Group, Nillable, Sort, Updateable",
      "description": "The ID of a custom product target for a usage-based quote line item, order Item, or asset allocation. This field is a polymorphic relationship field.",
      "relationship_name": "BindingInstanceTarget",
      "refers_to": "Account, Asset, BindingObjectCustomExt, Contract"
    },
    "Discount": {
      "type": "percent",
      "properties": "Createable, Filter, Nillable, Sort, Updateable",
      "description": "Editable number from 0 to 100. Available in API version 65.0 and later."
    },
    "DiscountAmount": {
      "type": "currency",
      "properties": "Createable, Filter, Nillable, Sort, Updateable",
      "description": "The fixed amount discount to apply to the line item. Available in API version 65.0 and later."
    },
    "EndDate": {
      "type": "dateTime",
      "properties": "Createable, Filter, Nillable, Sort, Updateable",
      "description": "The end date and time of an asset state period. On an asset that is an evergreen subscription, the last asset state period has no end date."
    },
    "LegalEntityId": {
      "type": "reference",
      "properties": "Createable, Filter, Group, Nillable, Sort, Updateable",
      "description": "The ID of the related legal entity. This field is a relationship field.",
      "relationship_name": "LegalEntity",
      "refers_to": "LegalEntity"
    },
    "Mrr": {
      "type": "currency",
      "properties": "Createable, Filter, Sort, Updateable",
      "description": "An asset’s monthly recurring revenue during an asset state period."
    },
    "PriceRevisionPolicy": {
      "type": "reference",
      "properties": "Createable, Filter, Group, Sort, Updateable",
      "description": "Specifies the price uplift policy associated with this asset state period. This field is a relationship field. This field is available in API version 65.0 and later.",
      "relationship_name": "Price Revision Policy",
      "relationship_type": "Lookup",
      "refers_to": "PriceRevisionPolicy"
    },
    "Quantity": {
      "type": "double",
      "properties": "Createable, Filter, Sort, Updateable",
      "description": "The total quantity of an asset during an asset state period."
    },
    "RampIdentifier": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The ramp record used to group order item segments for this asset state period. This field is available in orgs that have Revenue Cloud when the Ramp Deals setting is enabled. The maximum supported length is 255 characters from API version 67.0 and later. This field is available in API version 62.0 and later."
    },
    "SegmentIdentifier": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The order item segment for this asset state period. This field is available in orgs that have Revenue Cloud when the Ramp Deals setting is enabled. The maximum supported length is 255 characters from API version 67.0 and later. This field is available in API version 62.0 and later."
    },
    "SegmentName": {
      "type": "string",
      "properties": "Createable, Filter, Group, Nillable, Sort, Updateable",
      "description": "The name of the order item segment for this asset state period. This field is available in orgs that have Revenue Cloud when the Ramp Deals setting is enabled. The maximum supported length is 255 characters from API version 67.0 and later. This field is available in API version 62.0 and later."
    },
    "SegmentType": {
      "type": "picklist",
      "properties": "Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Updateable",
      "description": "The period for the order item segment for this asset state period. Valid values are: Custom Free Trial Yearly The default value is Yearly. This field is available in orgs that have Revenue Cloud when the Ramp Deals setting is enabled. This field is available in API version 62.0 and later."
    },
    "StartDate": {
      "type": "dateTime",
      "properties": "Createable, Filter, Sort, Updateable",
      "description": "The start date and time of an asset state period."
    },
    "UnitPrice": {
      "type": "currency",
      "properties": "Createable, Filter, Nillable, Sort, Updateable",
      "description": "The price per unit for the line item. Available in API version 65.0 and later. Revenue Cloud won't populate this field in API version 66.0 and later."
    },
    "UnitPriceUplift": {
      "type": "percent",
      "properties": "Createable, Filter, Nillable, Sort, Updateable",
      "description": "Indicates the percentage increase of a line item's unit price. Available in API version 65.0 and later."
    }
  },
  "special_access_rules": "To use Customer Asset Lifecycle Management APIs, you must have the Access Customer Asset Lifecycle Management APIs permission and Read access to the Asset, Asset Action, Asset Action Source, and Asset State Period objects.\n\nTo use Customer Asset Lifecycle Management APIs,\n         you must have the Access Customer Asset Lifecycle Management APIs permission and Read\n         access to the Asset, Asset Action, Asset Action Source, and Asset State Period\n         objects.",
  "wsdl_segment": "```xml\n<complexType name=\"AssetStatePeriod\">\n  <complexContent>\n    <extension base=\"ens:sObject\">\n      <sequence>\n        <element name=\"Amount\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:double\"/>\n        <element name=\"ApprovalSubmissions\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"ApprovalWorkItems\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"Asset\" nillable=\"true\" minOccurs=\"0\" type=\"ens:Asset\"/>\n        <element name=\"AssetId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"AssetStatePeriodAttributes\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"AssetStatePeriodNumber\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"BillingFrequency\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"CreatedBy\" nillable=\"true\" minOccurs=\"0\" type=\"ens:User\"/>\n        <element name=\"CreatedById\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"CreatedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"Discount\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:double\"/>\n        <element name=\"DiscountAmount\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:double\"/>\n        <element name=\"EndDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"FlowOrchestrationWorkItems\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"IsDeleted\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <element name=\"LastModifiedBy\" nillable=\"true\" minOccurs=\"0\" type=\"ens:User\"/>\n        <element name=\"LastModifiedById\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"LastModifiedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"LegalEntity\" nillable=\"true\" minOccurs=\"0\" type=\"ens:LegalEntity\"/>\n        <element name=\"LegalEntityId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"Mrr\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:double\"/>\n        <element name=\"ProcessInstances\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"ProcessSteps\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"Quantity\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:double\"/>\n        <element name=\"StartDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"SystemModstamp\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"UnitPrice\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:double\"/>\n        <element name=\"UnitPriceUplift\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:double\"/>\n        <element name=\"UserRecordAccess\" nillable=\"true\" minOccurs=\"0\" type=\"ens:UserRecordAccess\"/>\n      </sequence>\n    </extension>\n  </complexContent>\n</complexType>\n<simpleType name=\"ID\">\n  <restriction base=\"xsd:string\">\n    <length value=\"18\"/>\n    <pattern value=\"[a-zA-Z0-9]{18}\"/>\n  </restriction>\n</simpleType>\n<simpleType name=\"QueryLocator\">\n  <restriction base=\"xsd:string\"/>\n</simpleType>\n<complexType name=\"QueryResult\">\n  <sequence>\n    <element name=\"done\" type=\"xsd:boolean\"/>\n    <element name=\"queryLocator\" type=\"tns:QueryLocator\" nillable=\"true\"/>\n    <element name=\"records\" type=\"ens:sObject\" nillable=\"true\" minOccurs=\"0\" maxOccurs=\"unbounded\"/>\n    <element name=\"size\" type=\"xsd:int\"/>\n  </sequence>\n</complexType>\n```",
  "field_reference": {
    "Amount": {
      "field_label": "Amount",
      "type": "currency",
      "precision": "18",
      "scale": "2"
    },
    "AssetId": {
      "field_label": "Asset ID",
      "type": "reference",
      "length": "18"
    },
    "AssetStatePeriodNumber": {
      "field_label": "Name",
      "type": "string",
      "length": "255"
    },
    "BillingFrequency": {
      "field_label": "Billing Frequency",
      "type": "picklist",
      "length": "255"
    },
    "BindingInstanceTargetId": {
      "field_label": "BindingInstanceTarget ID",
      "type": "reference",
      "length": "18"
    },
    "CreatedById": {
      "field_label": "Created By ID",
      "type": "reference",
      "length": "18"
    },
    "CreatedDate": {
      "field_label": "Created Date",
      "type": "datetime"
    },
    "CurrencyIsoCode": {
      "field_label": "Currency ISO Code",
      "type": "picklist",
      "length": "3"
    },
    "Discount": {
      "field_label": "Discount",
      "type": "percent",
      "precision": "5",
      "scale": "2"
    },
    "DiscountAmount": {
      "field_label": "Discount Amount",
      "type": "currency",
      "precision": "18",
      "scale": "2"
    },
    "EndDate": {
      "field_label": "End Date",
      "type": "datetime"
    },
    "Id": {
      "field_label": "Asset State Period ID",
      "type": "id",
      "length": "18"
    },
    "IsDeleted": {
      "field_label": "Deleted",
      "type": "boolean"
    },
    "LastModifiedById": {
      "field_label": "Last Modified By ID",
      "type": "reference",
      "length": "18"
    },
    "LastModifiedDate": {
      "field_label": "Last Modified Date",
      "type": "datetime"
    },
    "LegalEntityId": {
      "field_label": "Legal Entity ID",
      "type": "reference",
      "length": "18"
    },
    "Mrr": {
      "field_label": "Monthly Recurring Revenue",
      "type": "currency",
      "precision": "18",
      "scale": "2"
    },
    "PriceRevisionPolicyId": {
      "field_label": "Price Revision Policy ID",
      "type": "reference",
      "length": "18"
    },
    "Quantity": {
      "field_label": "Quantity",
      "type": "double",
      "precision": "14",
      "scale": "2"
    },
    "RampIdentifier": {
      "field_label": "Ramp Identifier",
      "type": "string",
      "length": "255"
    },
    "SegmentIdentifier": {
      "field_label": "Segment Identifier",
      "type": "string",
      "length": "255"
    },
    "SegmentName": {
      "field_label": "Segment Name",
      "type": "string",
      "length": "255"
    },
    "SegmentType": {
      "field_label": "Segment Type",
      "type": "picklist",
      "length": "255"
    },
    "StartDate": {
      "field_label": "Start Date",
      "type": "datetime"
    },
    "SystemModstamp": {
      "field_label": "System Modstamp",
      "type": "datetime"
    },
    "UnitPrice": {
      "field_label": "Unit Price",
      "type": "currency",
      "precision": "18",
      "scale": "2"
    },
    "UnitPriceUplift": {
      "field_label": "Unit Price Uplift",
      "type": "percent",
      "precision": "5",
      "scale": "2"
    }
  },
  "field_reference_columns": [
    "field_label",
    "type",
    "precision",
    "scale",
    "length"
  ]
}