Get all subscription balance register commitments
get
/crmRestApi/resources/11.13.18.05/subscriptionBalanceRegisters/{BalanceRegisterNumber}/child/registerCommitments
Request
Path Parameters
-
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=
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 -
finder: string
Used as a predefined finder to search the collection.
Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables- CommitmentAltKey Finds the subscription balance commitment with the specified alternative key.
Finder Variables- BalanceCommitmentNumber; string; The balance commitment number used to find balance commitment alternative key.
- PrimaryKey Finds the subscription balance commitment with the specified primary key.
Finder Variables- BalanceCommitmentId; integer; The unique identifier of the subscription balance commitment.
- CommitmentAltKey Finds the subscription balance commitment with the specified alternative key.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
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 -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- ActualUsageAmount; number; The consumed amount of the subscription balance commitments.
- ActualUsageQuantity; number; The consumed quantity of the subscription balance commitments.
- BalanceCode; string; The balance code of the subscription balance commitments.
- BalanceCommitmentId; integer; The balance register commitment identifier of the subscription balance register commitments.
- BalanceCommitmentNumber; string; The balance register commitment number of the subscription balance commitments.
- BalanceRegisterId; integer; The balance register identifier of the subscription balance commitments.
- BalanceRegisterPeriodId; integer; The balance register period identifier of the subscription balance commitments.
- BalanceRegisterPeriodNumber; string; The balance register period number of the subscription balance register commitments.
- ChargeDefinitionName; string; The charge definition name of the subscription balance register commitments.
- CommitmentAmount; number; The committed amount of the subscription balance commitments.
- CommitmentQuantity; number; The committed quantity of the subscription balance commitments.
- CreatedBy; string; The user who created the subscription balance commitment.
- CreationDate; string; The date when the subscription balance commitment was created.
- CurrencyCode; string; The currency code of the subscription balance commitments.
- EndDate; string; The end date of the subscription balance commitments.
- LastUpdateDate; string; The date when the subscription balance commitment was last updated.
- LastUpdateLogin; string; The login of the user who last updated the subscription balance commitments.
- LastUpdatedBy; string; The user who has last updated the subscription balance commitments.
- ObjectVersionNumber; integer; The object version number updated after every update of a subscription balance commitments.
- PartyName; string; The party name of the subscription balance register commitments.
- PartyNumber; string; The party number of the subscription balance register commitments.
- ProductEndDate; string; The product end date of the subscription balance register commitments.
- ProductName; string; The product name of the subscription balance register commitments.
- ProductNumber; string; The product number of the subscription balance register commitments.
- ProductStartDate; string; The product start date of the subscription balance register commitments.
- QuantityUnitOfMeasure; string; The quantity unit of measure of the subscription balance register commitments.
- RemainingCommitmentAmount; number; The remaining committed amount of the subscription balance commitments.
- RemainingCommitmentQuantity; number; The remaining committed quantity of the subscription balance commitments.
- StartDate; string; The start date of the subscription balance register commitments.
- SubscriptionEndDate; string; The subscription end date of the subscription balance register commitments.
- SubscriptionNumber; string; The subscription number of the subscription balance register commitments.
- SubscriptionProductPuid; string; The subscription product PUID of the subscription balance register commitments.
- SubscriptionStartDate; string; The subscription start date of the subscription balance register commitments.
- TerminatedCommitmentAmount; number; The terminated commitment amount of the subscription balance register commitments.
- TerminatedCommitmentQuantity; number; The terminated commitment quantity of the subscription balance register commitments.
- TrueupAmount; number; The true-up amount of the subscription balance register commitment.
- TrueupDate; string; The true-up date of the subscription balance register commitment.
- TrueupStatus; string; The true-up status of the subscription balance register commitment.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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.
There's no request body for this operation.
Back to TopResponse
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-registerCommitments
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : subscriptionBalanceRegisters-registerCommitments-item-response
Type:
Show Source
object
-
ActualUsageAmount: number
Title:
Consumed Amount
The consumed amount of the subscription balance commitments. -
ActualUsageQuantity: number
Title:
Consumed Quantity
The consumed quantity of the subscription balance commitments. -
BalanceCode: string
Title:
Balance Code
Read Only:true
Maximum Length:30
The balance code of the subscription balance commitments. -
BalanceCommitmentId: integer
(int64)
The balance register commitment identifier of the subscription balance register commitments.
-
BalanceCommitmentNumber: string
Title:
Commitment Period Number
Maximum Length:120
The balance register commitment number of the subscription balance commitments. -
BalanceRegisterId: integer
(int64)
The balance register identifier of the subscription balance commitments.
-
BalanceRegisterPeriodId: integer
(int64)
The balance register period identifier of the subscription balance commitments.
-
BalanceRegisterPeriodNumber: string
Title:
Register Period Number
Read Only:true
Maximum Length:120
The balance register period number of the subscription balance register commitments. -
ChargeDefinitionName: string
Title:
Charge
Read Only:true
Maximum Length:80
The charge definition name of the subscription balance register commitments. -
CommitmentAmount: number
Title:
Amount
The committed amount of the subscription balance commitments. -
CommitmentQuantity: number
Title:
Quantity
The committed quantity of the subscription balance commitments. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the subscription balance commitment. -
CreationDate: string
(date-time)
Read Only:
true
The date when the subscription balance commitment was created. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
The currency code of the subscription balance commitments. -
EndDate: string
(date)
Title:
End Date
The end date of the subscription balance commitments. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the subscription balance commitment was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who has last updated the subscription balance commitments. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the subscription balance commitments. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Read Only:
true
The object version number updated after every update of a subscription balance commitments. -
PartyName: string
Title:
Customer
Read Only:true
Maximum Length:360
The party name of the subscription balance register commitments. -
PartyNumber: string
Title:
Party Number
Read Only:true
Maximum Length:30
The party number of the subscription balance register commitments. -
ProductEndDate: string
(date)
Title:
Product End Date
Read Only:true
The product end date of the subscription balance register commitments. -
ProductName: string
Title:
Product Name
Read Only:true
Maximum Length:300
The product name of the subscription balance register commitments. -
ProductNumber: string
Title:
Product Number
Read Only:true
Maximum Length:300
The product number of the subscription balance register commitments. -
ProductStartDate: string
(date)
Title:
Product Start Date
Read Only:true
The product start date of the subscription balance register commitments. -
QuantityUnitOfMeasure: string
Title:
UOM
Maximum Length:3
The quantity unit of measure of the subscription balance register commitments. -
RemainingCommitmentAmount: number
Title:
Remaining Amount
The remaining committed amount of the subscription balance commitments. -
RemainingCommitmentQuantity: number
Title:
Remaining Quantity
The remaining committed quantity of the subscription balance commitments. -
StartDate: string
(date)
Title:
Start Date
The start date of the subscription balance register commitments. -
SubscriptionEndDate: string
(date)
Title:
Subscription End Date
Read Only:true
The subscription end date of the subscription balance register commitments. -
SubscriptionNumber: string
Title:
Subscription Number
Read Only:true
Maximum Length:120
The subscription number of the subscription balance register commitments. -
SubscriptionProductPuid: string
Title:
Subscription Product PUID
Read Only:true
Maximum Length:120
The subscription product PUID of the subscription balance register commitments. -
SubscriptionStartDate: string
(date)
Title:
Subscription Start Date
Read Only:true
The subscription start date of the subscription balance register commitments. -
TerminatedCommitmentAmount: number
Title:
Terminated Amount
The terminated commitment amount of the subscription balance register commitments. -
TerminatedCommitmentQuantity: number
Title:
Terminated Quantity
The terminated commitment quantity of the subscription balance register commitments. -
TrueupAmount: number
Title:
True-Up Amount
The true-up amount of the subscription balance register commitment. -
TrueupDate: string
(date)
Title:
True-Up Date
The true-up date of the subscription balance register commitment. -
TrueupStatus: string
Title:
True-Up Status
Maximum Length:30
The true-up status of the subscription balance register commitment.
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.