Create a balance profile charge
post
/crmRestApi/resources/11.13.18.05/subscriptionBalanceProfiles/{BalanceProfileNumber}/child/profileCharges
Request
Path Parameters
-
BalanceProfileNumber(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=
Header Parameters
-
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AllowanceGrantFlag: boolean
Title:
Enable allowance
Maximum Length:1
Default Value:false
Indicates whether the allowance grant is enabled for a balance register profile charge. -
BalanceProfileChargeId: integer
(int64)
The balance profile charge identifier of the subscription balance profile charges.
-
BalanceProfileChargeNumber: string
Title:
Profile Charge Number
Maximum Length:120
The balance profile charge number of the subscription balance profile charges. -
BalanceProfileId: integer
(int64)
The balance profile identifier of the subscription balance profile charges.
-
BillingFrequency: string
Maximum Length:
30
The billing frequency of the subscription balance profile charge. -
BillingFrequencyUnitOfMeasure: string
Title:
Billing Frequency
Maximum Length:25
The billing frequency unit of measure of the subscription balance profile charge. -
ChargeDefinitionCode: string
Maximum Length:
30
The charge definition code of the subscription balance profile charges. -
ChargeDefinitionId: integer
(int64)
Title:
Charge Name
The balance charge definition identifier of the subscription balance profile charges. -
ChargePeriod: string
Title:
Periodicity
Maximum Length:30
The charge period of the subscription balance profile charges. -
ChargePeriodUnitOfMeasure: string
Title:
Periodicity
Maximum Length:25
The charge period unit of measure of the subscription balance profile charges. -
CommitmentFlag: boolean
Title:
Enable commitment
Maximum Length:1
Default Value:false
Indicates whether the commitment is enabled for a balance register profile charge. -
EstimateFlag: boolean
Title:
Enable estimate
Maximum Length:1
Default Value:false
Indicates whether the estimate is enabled for a balance register profile charge. -
InvoicingRule: string
Title:
Invoicing Rule
Maximum Length:30
The invoicing rule of the subscription balance profile charge. -
InvoicingRuleId: integer
(int64)
The invoicing rule identifier of the subscription balance profile charge.
-
ObjectVersionNumber: integer
(int32)
The object version number updated after every update of a subscription profile charge.
-
RelatedChargeDefinitionCode: string
Title:
Related Charge
Maximum Length:30
The charge definition code of the related profile charge. -
RelatedChargeDefinitionId: integer
(int64)
Title:
Related Charge
The charge definition identifier of the related profile charge. -
RelatedProfileChargeId: integer
(int64)
The balance profile charge identifier of the related charge identifier.
-
UsageCaptureFlag: boolean
Title:
Enable usage capture
Maximum Length:1
Default Value:false
Indicates whether the usage capture is enabled for a balance register profile charge.
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.
Root Schema : subscriptionBalanceProfiles-profileCharges-item-response
Type:
Show Source
object
-
AllowanceGrantFlag: boolean
Title:
Enable allowance
Maximum Length:1
Default Value:false
Indicates whether the allowance grant is enabled for a balance register profile charge. -
BalanceProfileChargeId: integer
(int64)
The balance profile charge identifier of the subscription balance profile charges.
-
BalanceProfileChargeNumber: string
Title:
Profile Charge Number
Maximum Length:120
The balance profile charge number of the subscription balance profile charges. -
BalanceProfileId: integer
(int64)
The balance profile identifier of the subscription balance profile charges.
-
BillingFrequency: string
Maximum Length:
30
The billing frequency of the subscription balance profile charge. -
BillingFrequencyUnitOfMeasure: string
Title:
Billing Frequency
Maximum Length:25
The billing frequency unit of measure of the subscription balance profile charge. -
ChargeDefinitionCode: string
Maximum Length:
30
The charge definition code of the subscription balance profile charges. -
ChargeDefinitionId: integer
(int64)
Title:
Charge Name
The balance charge definition identifier of the subscription balance profile charges. -
ChargePeriod: string
Title:
Periodicity
Maximum Length:30
The charge period of the subscription balance profile charges. -
ChargePeriodUnitOfMeasure: string
Title:
Periodicity
Maximum Length:25
The charge period unit of measure of the subscription balance profile charges. -
CommitmentFlag: boolean
Title:
Enable commitment
Maximum Length:1
Default Value:false
Indicates whether the commitment is enabled for a balance register profile charge. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the subscription balance profile charges. -
CreationDate: string
(date-time)
Read Only:
true
The date when the subscription balance profile charge was created. -
EstimateFlag: boolean
Title:
Enable estimate
Maximum Length:1
Default Value:false
Indicates whether the estimate is enabled for a balance register profile charge. -
InvoicingRule: string
Title:
Invoicing Rule
Maximum Length:30
The invoicing rule of the subscription balance profile charge. -
InvoicingRuleId: integer
(int64)
The invoicing rule identifier of the subscription balance profile charge.
-
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the subscription profile charge was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who has last updated the subscription balance criterion. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the subscription profile charge. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
The object version number updated after every update of a subscription profile charge.
-
RelatedChargeDefinitionCode: string
Title:
Related Charge
Maximum Length:30
The charge definition code of the related profile charge. -
RelatedChargeDefinitionId: integer
(int64)
Title:
Related Charge
The charge definition identifier of the related profile charge. -
RelatedProfileChargeId: integer
(int64)
The balance profile charge identifier of the related charge identifier.
-
UsageCaptureFlag: boolean
Title:
Enable usage capture
Maximum Length:1
Default Value:false
Indicates whether the usage capture is enabled for a balance register profile charge.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.