Create a balance profile balance code
post
/crmRestApi/resources/11.13.18.05/subscriptionBalanceProfiles/{BalanceProfileNumber}/child/profileBalanceCodes
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
-
AllowanceGrantCodeFlag: boolean
Title:
Enable allowance
Maximum Length:1
Default Value:false
The balance code should be used for allowance grant of the subscription profile balance code. -
BalanceCode: string
Title:
Code
Maximum Length:30
The balance code of the subscription balance profile balance code. -
BalanceCodeId: integer
(int64)
Title:
Balance Code
The unique identifier of the balance code. -
BalancePrecedence: number
Title:
Precedence
The precedence for balance code for given subscription balance profile. -
BalanceProfileChargeId: integer
(int64)
The unique identifier of the balance profile charge.
-
BalanceProfileId: integer
(int64)
The unique identifier of the balance profile.
-
CommitmentCodeFlag: boolean
Title:
Enable commitment
Maximum Length:1
Default Value:false
Indicates whether the balance code is for enable commitments. -
EstimateCodeFlag: boolean
Title:
Enable estimate
Maximum Length:1
Default Value:false
Indicates whether the balance code is for enable estimates. -
ProfileBalanceCodeId: integer
(int64)
The unique identifier of the balance profile code.
-
ProfileBalanceCodeNumber: string
Maximum Length:
120
The alternate identifier of the profile balance code.
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-profileBalanceCodes-item-response
Type:
Show Source
object
-
AllowanceGrantCodeFlag: boolean
Title:
Enable allowance
Maximum Length:1
Default Value:false
The balance code should be used for allowance grant of the subscription profile balance code. -
BalanceCode: string
Title:
Code
Maximum Length:30
The balance code of the subscription balance profile balance code. -
BalanceCodeDescription: string
Title:
Name
Read Only:true
Maximum Length:120
The balance code description of the subscription profile balance code. -
BalanceCodeId: integer
(int64)
Title:
Balance Code
The unique identifier of the balance code. -
BalancePrecedence: number
Title:
Precedence
The precedence for balance code for given subscription balance profile. -
BalanceProfileChargeId: integer
(int64)
The unique identifier of the balance profile charge.
-
BalanceProfileId: integer
(int64)
The unique identifier of the balance profile.
-
CommitmentCodeFlag: boolean
Title:
Enable commitment
Maximum Length:1
Default Value:false
Indicates whether the balance code is for enable commitments. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the subscription profile balance code. -
CreationDate: string
(date-time)
Read Only:
true
The date when the subscription profile balance code was created. -
EstimateCodeFlag: boolean
Title:
Enable estimate
Maximum Length:1
Default Value:false
Indicates whether the balance code is for enable estimates. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the subscription profile balance code was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who has last updated the subscription profile balance code. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the subscription profile balance code. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Read Only:
true
The object version number of the subscription profile balance code. -
ProfileBalanceCodeId: integer
(int64)
The unique identifier of the balance profile code.
-
ProfileBalanceCodeNumber: string
Maximum Length:
120
The alternate identifier of the profile balance code.
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.