GET action not supported
get
/fscmRestApi/resources/11.13.18.05/ledgerBalances/{ledgerBalancesUniqID}
Request
Path Parameters
-
ledgerBalancesUniqID(required): string
This is the hash key of the attributes which make up the composite key--- AccountGroupName, AccountName, LedgerSetName, LedgerName, Currency, CurrentAccountingPeriod and AccountCombination ---for the Ledger Balances resource and used to uniquely identify an instance of Ledger Balances. The client should not generate the hash key value. Instead, the client should query on the Ledger Balances collection resource with a filter on the primary key values in order to navigate to a specific instance of Ledger Balances.
For example: ledgerBalances?q=AccountGroupName=<value1>;AccountName=<value2>;LedgerSetName=<value3>;LedgerName=<value4>;Currency=<value5>;CurrentAccountingPeriod=<value6>;AccountCombination=<value7>
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 -
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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 : ledgerBalances-item-response
Type:
Show Source
object
-
AccountCombination: string
Title:
Account Combination
The concatenated segment value string that denotes the requested general ledger account, with the chart of accounts delimiter as the segment separator. A percent sign for a segment indicates that all values for that segment apply. -
AccountGroupName: string
Title:
Account Group Name
The value that uniquely identifies the account group. -
AccountName: string
Title:
Account Name
Maximum Length:255
The name of the account defined as part of the account group. -
ActualBalance: string
Title:
Actual Balance
Read Only:true
The actual balance for the provided budget-based account group and other criteria. -
AmountType: string
Title:
Amount Type
The amount type requested for the account balance. Values include Base, PTD, YTD and QTD. The default value is Base. -
BeginningBalance: string
Title:
Beginning Balance
Read Only:true
The beginning account balance for the provided criteria. -
BudgetBalance: string
Title:
Budget Balance
Read Only:true
The budget balance for the provided budget-based account group and other criteria. -
Currency: string
Title:
Currency
The currency in which balances are requested. -
CurrencyType: string
Title:
Currency Type
The currency type requested for the account balance. The default value is Total. -
CurrentAccountingPeriod: string
Title:
Accounting Period
The accounting period, quarter, or year, for which balances are requested. -
CurrentPeriodBalance: string
Title:
Period Balance
The account balance for the requested accounting period. -
DetailAccountCombination: string
Title:
Detail Account Combination
Read Only:true
The concatenated segment value string that denotes the detail general ledger account that is returned for a requested general ledger account, with the chart of accounts delimiter as the segment separator. Applicable to Detail Mode only. -
EndingBalance: string
Title:
Ending Balance
Read Only:true
The ending account balance for the provided criteria. -
ErrorDetail: string
Title:
Error Detail
Read Only:true
The error message received from the Oracle Essbase server in the event of a request processing failure. -
LedgerName: string
Title:
Ledger
The name of the ledger for which balances are requested. -
LedgerSetName: string
Title:
Ledger Set
The name of the ledger set for which balances are requested. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PeriodActivity: string
Title:
Period Activity
Read Only:true
The period account balance for the provided criteria. -
PeriodName: string
Title:
Period Name
Read Only:true
The name of the accounting period for which account balances are returned. Applicable to Detail Mode only. -
Scenario: string
Title:
Scenario
The scenario for an account group definition with a budget-based comparison option. Valid values include Forecast Q1 and Original Budget. -
Segment10TreeCode: string
The tree code for Segment 10.
-
Segment11TreeCode: string
The tree code for Segment 11.
-
Segment12TreeCode: string
The tree code for Segment 12.
-
Segment13TreeCode: string
The tree code for Segment 13.
-
Segment14TreeCode: string
The tree code for Segment 14.
-
Segment15TreeCode: string
The tree code for Segment 15.
-
Segment16TreeCode: string
The tree code for Segment 16.
-
Segment17TreeCode: string
The tree code for Segment 17.
-
Segment18TreeCode: string
The tree code for Segment 18.
-
Segment19TreeCode: string
The tree code for Segment 19.
-
Segment1TreeCode: string
The tree code for Segment 1.
-
Segment20TreeCode: string
The tree code for Segment 20.
-
Segment21TreeCode: string
The tree code for Segment 21.
-
Segment22TreeCode: string
The tree code for Segment 22.
-
Segment23TreeCode: string
The tree code for Segment 23.
-
Segment24TreeCode: string
The tree code for Segment 24.
-
Segment25TreeCode: string
The tree code for Segment 25.
-
Segment26TreeCode: string
The tree code for Segment 26.
-
Segment27TreeCode: string
The tree code for Segment 27.
-
Segment28TreeCode: string
The tree code for Segment 28.
-
Segment29TreeCode: string
The tree code for Segment 29.
-
Segment2TreeCode: string
The tree code for Segment 2.
-
Segment30TreeCode: string
The tree code for Segment 30.
-
Segment3TreeCode: string
The tree code for Segment 3.
-
Segment4TreeCode: string
The tree code for Segment 4.
-
Segment5TreeCode: string
The tree code for Segment 5.
-
Segment6TreeCode: string
The tree code for Segment 6.
-
Segment7TreeCode: string
The tree code for Segment 7.
-
Segment8TreeCode: string
The tree code for Segment 8.
-
Segment9TreeCode: string
The tree code for Segment 9.
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.