Get all subscription balance true-up estimates
get
/crmRestApi/resources/11.13.18.05/subscriptionBalanceRegisters/{BalanceRegisterNumber}/child/registerPeriods/{BalanceRegisterPeriodNumber}/child/estimates/{BalanceEstimateNumber}/child/trueupEstimates
Request
Path Parameters
-
BalanceEstimateNumber(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=
-
BalanceRegisterPeriodNumber(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- PrimaryKey Finds the subscription true-up estimate with the specified primary key.
Finder Variables- TrueupEstimateId; integer; The unique identifier of the subscription true-up estimate.
- TrueupEstimatesAltKey Finds the subscription true-up estimate with the specified alternative key.
Finder Variables- TrueupEstimateNumber; string; The true-up estimate number used to find balance true-up alternative key.
- PrimaryKey Finds the subscription true-up estimate with the specified primary 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 actual usage amount of true up estimate.
- ActualUsageQuantity; number; The actual usage quantity of true up estimate.
- AppliedRolloverAmount; number; The applied rollover amount of true-up estimate.
- AppliedRolloverQuantity; number; The applied rollover quantity of true-up estimate.
- CreatedBy; string; The user who created the true up estimate
- CreationDate; string; The date when the true up estimate was created.
- CurrencyCode; string; The actual currency code of true up estimate.
- EstimatedAmount; number; The actual estimated amount of true up estimate.
- EstimatedQuantity; number; The actual estimated quantity of true up estimate.
- LastUpdateDate; string; The date when the true up estimate was last updated.
- LastUpdateLogin; string; The login of the user who last updated the true up estimate.
- LastUpdatedBy; string; The user who has last updated the true up estimate.
- ObjectVersionNumber; integer; The object version number updated after every update of a true up estimate.
- OverrideEstimatedAmount; number; The override estimated amount of true up estimate.
- OverrideEstimatedQuantity; number; The override estimated quantity of true-up estimate.
- OverrideUsageAmount; number; The override usage amount of true up estimate.
- OverrideUsageQuantity; number; The override usage quantity of true up estimate.
- ParentEstimateId; integer; The parent estimate identifier of true up estimate.
- QuantityUnitOfMeasure; string; The quantity unit of measure of true up estimate.
- RemainingEstimatedAmount; number; The remaining estimated amount of true-up estimate.
- RemainingEstimatedQuantity; number; The remaining estimated quantity of true-up estimate.
- TrueupAmount; number; The true up amount of true-up estimate.
- TrueupDate; string; The true up date of true up estimate.
- TrueupEstimateId; integer; The true up estimate identifier of true up estimate.
- TrueupEstimateNumber; string; The true up estimate number of true up estimate.
- TrueupHoldFlag; boolean; Indicates whether the true up hold is enabled.
- TrueupReason; string; The true up reason of true up estimate.
- TrueupReasonDescription; string; The true up reason description of true up estimate.
- TrueupStatus; string; The true up status of true-up estimate.
- TrueupType; string; The true up type of true up estimate.
-
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-registerPeriods-estimates-trueupEstimates
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-registerPeriods-estimates-trueupEstimates-item-response
Type:
Show Source
object
-
ActualUsageAmount: number
Title:
Consumed Amount
The actual usage amount of true up estimate. -
ActualUsageQuantity: number
Title:
Consumed Quantity
The actual usage quantity of true up estimate. -
AppliedRolloverAmount: number
Title:
Ad-hoc Applied Rollover Amount
The applied rollover amount of true-up estimate. -
AppliedRolloverQuantity: number
Title:
Ad-hoc Applied Rollover Quantity
The applied rollover quantity of true-up estimate. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the true up estimate -
CreationDate: string
(date-time)
Read Only:
true
The date when the true up estimate was created. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
The actual currency code of true up estimate. -
EstimatedAmount: number
Title:
Prorated Estimated Amount
The actual estimated amount of true up estimate. -
EstimatedQuantity: number
Title:
Prorated Estimated Quantity
The actual estimated quantity of true up estimate. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the true up estimate was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who has last updated the true up estimate. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the true up estimate. -
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 true up estimate.
-
OverrideEstimatedAmount: number
Title:
Override Estimated Amount
The override estimated amount of true up estimate. -
OverrideEstimatedQuantity: number
Title:
Override Estimated Quantity
The override estimated quantity of true-up estimate. -
OverrideUsageAmount: number
Title:
Override Consumed Amount
The override usage amount of true up estimate. -
OverrideUsageQuantity: number
Title:
Override Consumed Quantity
The override usage quantity of true up estimate. -
ParentEstimateId: integer
(int64)
The parent estimate identifier of true up estimate.
-
QuantityUnitOfMeasure: string
Title:
UOM
Maximum Length:3
The quantity unit of measure of true up estimate. -
RemainingEstimatedAmount: number
Title:
Remaining Amount
The remaining estimated amount of true-up estimate. -
RemainingEstimatedQuantity: number
Title:
Remaining Quantity
The remaining estimated quantity of true-up estimate. -
TrueupAmount: number
Title:
True-Up Amount
The true up amount of true-up estimate. -
TrueupDate: string
(date)
Title:
Date
The true up date of true up estimate. -
TrueupEstimateId: integer
(int64)
The true up estimate identifier of true up estimate.
-
TrueupEstimateNumber: string
Maximum Length:
120
The true up estimate number of true up estimate. -
TrueupHoldFlag: boolean
Title:
Hold true-up
Maximum Length:1
Indicates whether the true up hold is enabled. -
TrueupReason: string
Title:
Reason
Maximum Length:30
The true up reason of true up estimate. -
TrueupReasonDescription: string
Title:
Reason Description
Maximum Length:120
The true up reason description of true up estimate. -
TrueupStatus: string
Title:
True-Up Status
Maximum Length:30
The true up status of true-up estimate. -
TrueupType: string
Title:
True-Up Type
Maximum Length:30
The true up type of true up estimate.
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.