Jump to

• Request
• Response

Get a charge component

get

/crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/charges/{ChargePuid2}/child/chargeComponents/{ChargeComponentPuid}

Request

Path Parameters

• ChargeComponentPuid(required): string
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• ChargePuid(required): string
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• CoveredLevelPuid(required): string
  The public unique identifier of the covered level.
• SubscriptionProductPuid(required): string
  The public unique identifier of the subscription product.

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>
• 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
• 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
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Header Parameters

• Metadata-Context: string
  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: string
  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 : subscriptionProducts-coveredLevels-charges-chargeComponents-item-response

Type: object

Show Source

• ChargeComponentId: integer (int64)
  The identifier of the charge component.
• ChargeComponentPuid: string
  Maximum Length: 120

  The PUID of the charge component.
• ChargeCurrency: string
  Title: Currency

  Maximum Length: 15

  The charge currency of the charge component.
• ChargeCurrencyExtAmount: number
  Title: Extended Amount

  The extended amount of the charge component in charge currency.
• ChargeCurrencyName: string
  Title: Currency

  Read Only: true

  Maximum Length: 80

  The name of the charge currency.
• ChargeCurrencyUnitPrice: number
  Title: Currency Unit Price

  The unit price of the charge component in charge currency.
• ChargeId: integer (int64)
  Title: Charge ID

  The identifier of the charge.
• CoverageExtendedAmount: number
  Title: Coverage Extended Amount

  The extended coverage amount of the charge component.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the record.
• CreationDate: string (date-time)
  Read Only: true

  The date when the record was created.
• Explanation: string
  Title: Explanation

  Maximum Length: 1000

  The explanation for the charge component.
• ExplanationMessageName: string
  Title: Explanation Message

  Maximum Length: 30

  The explanation message name of the charge component.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the subscription was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the subscription.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the subscription.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  The object version number of the charge component.
• Price: number
  Title: Amount

  The price of the charge component.
• PriceElement: string
  Title: Price Element

  Maximum Length: 30

  The price element of the charge component.
• PriceElementName: string
  Title: Price Element

  Read Only: true

  Maximum Length: 80

  The name of the price element associated with the charge component.
• PriceElementUsage: string
  Title: Price Element Usage

  Maximum Length: 30

  The price element usage of the charge component.
• PriceElementUsageName: string
  Title: Price Element Usage

  Read Only: true

  Maximum Length: 80

  The name of the price element usage associated with the charge component.
• PriceforQuantity: number
  Title: Price

  The price for quantity of the charge component.
• PricingSourceId: integer (int64)
  The identifier of the pricing source of the charge component.
• PricingSourceType: string
  Title: Pricing Source Type

  Maximum Length: 30

  The type of pricing source of the charge component.
• PricingSourceTypeName: string
  Title: Pricing Source Type

  Read Only: true

  Maximum Length: 80

  The name of the pricing source type.
• RollupFlag: boolean
  Title: Rollup Flag

  Maximum Length: 1

  The indicator of whether charge component should be rolled up or not.
• SequenceNumber: integer (int32)
  Title: Sequence Number

  The sequence number of the charge component.
• SubscriptionCurrency: string
  Title: Subscription Currency

  Maximum Length: 15

  The subscription currency of the charge component.
• SubscriptionCurrencyName: string
  Title: Subscription Currency

  Read Only: true

  Maximum Length: 80

  The name of the subscription currency.
• SubscriptionId: integer (int64)
  Title: Subscription ID

  The identifier of the subscription.
• TaxIncludedFlag: boolean
  Title: Tax Included Flag

  Maximum Length: 1

  The indicator of whether tax is included for the charge component or not.
• UnitPrice: number
  Title: Unit Price

  The unit price of the charge component.

{
    "type":"object",
    "properties":{
        "ChargeComponentId":{
            "type":"integer",
            "description":"The identifier of the charge component.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChargeComponentPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The PUID of the charge component.",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeCurrency":{
            "title":"Currency",
            "maxLength":15,
            "type":"string",
            "description":"The charge currency of the charge component.",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeCurrencyExtAmount":{
            "title":"Extended Amount",
            "type":"number",
            "description":"The extended amount of the charge component in charge currency.",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeCurrencyName":{
            "title":"Currency",
            "maxLength":80,
            "type":"string",
            "description":"The name of the charge currency.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargeCurrencyUnitPrice":{
            "title":"Currency Unit Price",
            "type":"number",
            "description":"The unit price of the charge component in charge currency.",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeId":{
            "title":"Charge ID",
            "type":"integer",
            "description":"The identifier of the charge.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CoverageExtendedAmount":{
            "title":"Coverage Extended Amount",
            "type":"number",
            "description":"The extended coverage amount of the charge component.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Explanation":{
            "title":"Explanation",
            "maxLength":1000,
            "type":"string",
            "description":"The explanation for the charge component.",
            "nullable":true,
            "x-queryable":true
        },
        "ExplanationMessageName":{
            "title":"Explanation Message",
            "maxLength":30,
            "type":"string",
            "description":"The explanation message name of the charge component.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the subscription was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the subscription.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the subscription.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number of the charge component.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "Price":{
            "title":"Amount",
            "type":"number",
            "description":"The price of the charge component.",
            "nullable":true,
            "x-queryable":true
        },
        "PriceElement":{
            "title":"Price Element",
            "maxLength":30,
            "type":"string",
            "description":"The price element of the charge component.",
            "nullable":true,
            "x-queryable":true
        },
        "PriceElementName":{
            "title":"Price Element",
            "maxLength":80,
            "type":"string",
            "description":"The name of the price element associated with the charge component.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "help":{
                    "instruction":"Element Name"
                }
            },
            "x-queryable":true
        },
        "PriceElementUsage":{
            "title":"Price Element Usage",
            "maxLength":30,
            "type":"string",
            "description":"The price element usage of the charge component.",
            "nullable":true,
            "x-queryable":true
        },
        "PriceElementUsageName":{
            "title":"Price Element Usage",
            "maxLength":80,
            "type":"string",
            "description":"The name of the price element usage associated with the charge component.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PriceforQuantity":{
            "title":"Price",
            "type":"number",
            "description":"The price for quantity of the charge component.",
            "nullable":true,
            "x-queryable":true
        },
        "PricingSourceId":{
            "type":"integer",
            "description":"The identifier of the pricing source of the charge component.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PricingSourceType":{
            "title":"Pricing Source Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of pricing source of the charge component.",
            "nullable":true,
            "x-queryable":true
        },
        "PricingSourceTypeName":{
            "title":"Pricing Source Type",
            "maxLength":80,
            "type":"string",
            "description":"The name of the pricing source type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RollupFlag":{
            "title":"Rollup Flag",
            "maxLength":1,
            "type":"boolean",
            "description":"The indicator of whether charge component should be rolled up or not.",
            "nullable":true,
            "x-queryable":true
        },
        "SequenceNumber":{
            "title":"Sequence Number",
            "type":"integer",
            "description":"The sequence number of the charge component.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "SubscriptionCurrency":{
            "title":"Subscription Currency",
            "maxLength":15,
            "type":"string",
            "description":"The subscription currency of the charge component.",
            "nullable":true,
            "x-queryable":true
        },
        "SubscriptionCurrencyName":{
            "title":"Subscription Currency",
            "maxLength":80,
            "type":"string",
            "description":"The name of the subscription currency.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SubscriptionId":{
            "title":"Subscription ID",
            "type":"integer",
            "description":"The identifier of the subscription.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TaxIncludedFlag":{
            "title":"Tax Included Flag",
            "maxLength":1,
            "type":"boolean",
            "description":"The indicator of whether tax is included for the charge component or not.",
            "nullable":true,
            "x-queryable":true
        },
        "UnitPrice":{
            "title":"Unit Price",
            "type":"number",
            "description":"The unit price of the charge component.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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."
        }
    }
}

Back to Top