Update a subscription balance register allowance grant
patch
/crmRestApi/resources/11.13.18.05/subscriptionBalanceRegisters/{BalanceRegisterNumber}/child/registerAllowances/{AllowanceGrantNumber}
Request
Path Parameters
-
AllowanceGrantNumber(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=
-
BalanceRegisterNumber(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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AllowanceGrantNumber: string
Title:
Allowance Grant Number
Maximum Length:120
The balance register allowance grant number of the subscription balance allowance grants. -
Amount: number
The amount of the subscription balance allowance grants.
-
BalanceRegisterId: integer
(int64)
The balance register identifier of the subscription balance allowance grants.
-
BalanceRegisterPeriodId: integer
(int64)
The balance register period identifier of the subscription balance allowance grants.
-
ConsumedAmount: number
Title:
Consumed Amount
The consumed amount of the subscription balance allowance grants. -
ConsumedQuantity: number
Title:
Consumed Quantity
The consumed quantity of the subscription balance allowance grants. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
The currency code of the subscription balance allowance grants. -
EndDate: string
(date)
Title:
End Date
The date when the allowance grant ends. -
GrantDate: string
(date)
Title:
Grant Date
The date when the allowance is granted. -
ObjectVersionNumber: integer
(int32)
The object version number updated after every update of a subscription balance allowance grants.
-
Quantity: number
The quantity of the subscription balance allowance grants.
-
QuantityUnitOfMeasure: string
Title:
UOM
Maximum Length:3
The quantity unit of measure of the subscription balance allowance grants. -
RemainingAmount: number
Title:
Remaining Amount
The remaining amount of the subscription balance allowance grants. -
RemainingQuantity: number
Title:
Remaining Quantity
The remaining quantity of the subscription balance allowance grants. -
RolloverEndDate: string
(date)
Title:
Rollover End Date
The rollover end date of the subscription balance allowance grants. -
StartDate: string
(date)
Title:
Start Date
The start date of the subscription balance allowance grants. -
TerminatedAmount: number
Title:
Terminated Amount
The terminated amount of the subscription balance register allowance grants. -
TerminatedQuantity: number
Title:
Terminated Quantity
The terminated quantity of the subscription balance register allowance grants.
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 : subscriptionBalanceRegisters-registerAllowances-item-response
Type:
Show Source
object
-
AllowanceGrantId: integer
(int64)
The balance register allowance grant identifier of the subscription balance register allowance grants.
-
AllowanceGrantNumber: string
Title:
Allowance Grant Number
Maximum Length:120
The balance register allowance grant number of the subscription balance allowance grants. -
Amount: number
The amount of the subscription balance allowance grants.
-
BalanceCode: string
Title:
Balance Code
Read Only:true
Maximum Length:30
The balance code of the subscription balance allowance grants. -
BalanceRegisterId: integer
(int64)
The balance register identifier of the subscription balance allowance grants.
-
BalanceRegisterPeriodId: integer
(int64)
The balance register period identifier of the subscription balance allowance grants.
-
BalanceRegisterPeriodNumber: string
Title:
Register Period Number
Read Only:true
Maximum Length:120
The balance register period number of the subscription balance register allowance grants. -
ConsumedAmount: number
Title:
Consumed Amount
The consumed amount of the subscription balance allowance grants. -
ConsumedQuantity: number
Title:
Consumed Quantity
The consumed quantity of the subscription balance allowance grants. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the subscription balance allowance grant. -
CreationDate: string
(date-time)
Read Only:
true
The date when the subscription balance allowance grant was created. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
The currency code of the subscription balance allowance grants. -
EndDate: string
(date)
Title:
End Date
The date when the allowance grant ends. -
GrantDate: string
(date)
Title:
Grant Date
The date when the allowance is granted. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the subscription balance allowance grant was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who has last updated the subscription balance allowance grants. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the subscription balance allowance grants. -
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 balance allowance grants.
-
PartyName: string
Title:
Customer
Read Only:true
Maximum Length:360
The party name of the subscription balance register allowance grants. -
PartyNumber: string
Title:
Party Number
Read Only:true
Maximum Length:30
The party number of the subscription balance register allowance grants. -
ProductEndDate: string
(date)
Title:
Product End Date
Read Only:true
The product end date of the subscription balance register allowance grants. -
ProductName: string
Title:
Product Name
Read Only:true
Maximum Length:300
The product name of the subscription balance allowance grants. -
ProductNumber: string
Title:
Product Number
Read Only:true
Maximum Length:300
The product number of the subscription balance allowance grants. -
ProductStartDate: string
(date)
Title:
Product Start Date
Read Only:true
The product start date of the subscription balance register allowance grants. -
Quantity: number
The quantity of the subscription balance allowance grants.
-
QuantityUnitOfMeasure: string
Title:
UOM
Maximum Length:3
The quantity unit of measure of the subscription balance allowance grants. -
RemainingAmount: number
Title:
Remaining Amount
The remaining amount of the subscription balance allowance grants. -
RemainingQuantity: number
Title:
Remaining Quantity
The remaining quantity of the subscription balance allowance grants. -
RolloverEndDate: string
(date)
Title:
Rollover End Date
The rollover end date of the subscription balance allowance grants. -
StartDate: string
(date)
Title:
Start Date
The start date of the subscription balance allowance grants. -
SubscriptionEndDate: string
(date)
Title:
Subscription End Date
Read Only:true
The subscription end date of the subscription balance register allowance grants. -
SubscriptionNumber: string
Title:
Subscription Number
Read Only:true
Maximum Length:120
The subscription number of the subscription balance allowance grants. -
SubscriptionProductPuid: string
Title:
Subscription Product PUID
Read Only:true
Maximum Length:120
The subscription product PUID of the subscription balance allowance grants. -
SubscriptionStartDate: string
(date)
Title:
Subscription Start Date
Read Only:true
The subscription start date of the subscription balance register allowance grants. -
TerminatedAmount: number
Title:
Terminated Amount
The terminated amount of the subscription balance register allowance grants. -
TerminatedQuantity: number
Title:
Terminated Quantity
The terminated quantity of the subscription balance register allowance grants.
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.