Jump to

• Request
• Response
• Examples

Get all account balances

get

/fscmRestApi/resources/11.13.18.05/ledgerBalances

Request

Query Parameters

• 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:
  
  

  • AccountBalanceFinder: Finds the general ledger balance amount of the account that matches the account combination, ledger name, currency and accounting period.
    Finder Variables:
    • accountCombination; string; The account, or accounts if a percent sign is used for a segment.
    • accountingPeriod; string; The accounting period, quarter, or year, for which balances are requested.
    • amountType; string; The amount type, such as PTD for period-to-date.
    • currency; string; The currency in which balances are requested.
    • currencyType; string; The currency type, such as Entered.
    • effectiveDate; string; The effective date of the account hierarchy tree version.
    • ledgerName; string; The name of the ledger for which balances are requested.
    • ledgerSetName; string; The name of the ledger set for which balances are requested.
    • maxFetchLimit; string; The value (Y or N, with Y as the default), that allows for skipping the validation error when records exceed 10,000.
    • mode; string; The method for how account balances are retrieved, with Summary or Detail as valid values.
    • scenario; string; The scenario for an account group definition with a budget-based comparison option.
    • 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.
  • AccountGroupBalanceFinder: Finds the general ledger balance amount of the account that matches the account group name, account name, ledger name, currency, and accounting period.
    Finder Variables:
    • accountGroupName; string; The account group name.
    • accountName; string; The name of the account defined as part of the account group.
    • accountingPeriod; string; The accounting period, quarter, or year, for which balances are requested.
    • currency; string; The currency in which balances are requested.
    • ledgerName; string; The name of the ledger for which balances are requested.
  • PrimaryKey: Finds the general ledger balance amount of the account that matches the primary key criteria specified.
    Finder Variables:
    • AccountCombination; string; The concatenated segment value string that denotes the general ledger account, with the chart of accounts delimiter as the segment separator, and where a percent sign for a segment represents all values for that segment.
    • AccountGroupName; string; The value that uniquely identifies the account group.
    • AccountName; string; The name of the account defined as part of the account group.
    • Currency; string; The currency in which balances are requested.
    • CurrentAccountingPeriod; string; The accounting period, quarter, or year, for which balances are requested.
    • LedgerName; string; The name of the ledger for which balances are requested.
    • LedgerSetName; string; The name of the ledger set for which balances are requested.
• 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:
  

  • AccountCombination; string; 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; The value that uniquely identifies the account group.
  • AccountName; string; The name of the account defined as part of the account group.
  • ActualBalance; string; The actual balance for the provided budget-based account group and other criteria.
  • AmountType; string; The amount type requested for the account balance. Values include Base, PTD, YTD and QTD. The default value is Base.
  • BeginningBalance; string; The beginning account balance for the provided criteria.
  • BudgetBalance; string; The budget balance for the provided budget-based account group and other criteria.
  • Currency; string; The currency in which balances are requested.
  • CurrencyType; string; The currency type requested for the account balance. The default value is Total.
  • CurrentAccountingPeriod; string; The accounting period, quarter, or year, for which balances are requested.
  • CurrentPeriodBalance; string; The account balance for the requested accounting period.
  • DetailAccountCombination; string; 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; The ending account balance for the provided criteria.
  • ErrorDetail; string; The error message received from the Oracle Essbase server in the event of a request processing failure.
  • LedgerName; string; The name of the ledger for which balances are requested.
  • LedgerSetName; string; The name of the ledger set for which balances are requested.
  • PeriodActivity; string; The period account balance for the provided criteria.
  • PeriodName; string; The name of the accounting period for which account balances are returned. Applicable to Detail Mode only.
  • Scenario; string; 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.
• 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 Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  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(required):
  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.

Body ()

Root Schema : ledgerBalances

Type: object

Show Source

• 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.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"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."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/ledgerBalances-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object ledgerBalances-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/ledgerBalances-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : ledgerBalances-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "EndingBalance":{
            "title":"Ending Balance",
            "type":"string",
            "description":"The ending account balance for the provided criteria.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ErrorDetail":{
            "title":"Error Detail",
            "type":"string",
            "description":"The error message received from the Oracle Essbase server in the event of a request processing failure.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "Segment4TreeCode":{
            "type":"string",
            "description":"The tree code for Segment 4.",
            "nullable":true,
            "x-queryable":true
        },
        "Segment25TreeCode":{
            "type":"string",
            "description":"The tree code for Segment 25.",
            "nullable":true,
            "x-queryable":true
        },
        "Currency":{
            "title":"Currency",
            "type":"string",
            "description":"The currency in which balances are requested.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "Segment27TreeCode":{
            "type":"string",
            "description":"The tree code for Segment 27.",
            "nullable":true,
            "x-queryable":true
        },
        "Segment2TreeCode":{
            "type":"string",
            "description":"The tree code for Segment 2.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LedgerName":{
            "title":"Ledger",
            "type":"string",
            "description":"The name of the ledger for which balances are requested.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "Segment30TreeCode":{
            "type":"string",
            "description":"The tree code for Segment 30.",
            "nullable":true,
            "x-queryable":true
        },
        "AccountGroupName":{
            "title":"Account Group Name",
            "type":"string",
            "description":"The value that uniquely identifies the account group.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "Segment28TreeCode":{
            "type":"string",
            "description":"The tree code for Segment 28.",
            "nullable":true,
            "x-queryable":true
        },
        "Segment14TreeCode":{
            "type":"string",
            "description":"The tree code for Segment 14.",
            "nullable":true,
            "x-queryable":true
        },
        "Segment11TreeCode":{
            "type":"string",
            "description":"The tree code for Segment 11.",
            "nullable":true,
            "x-queryable":true
        },
        "AccountCombination":{
            "title":"Account Combination",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "Segment6TreeCode":{
            "type":"string",
            "description":"The tree code for Segment 6.",
            "nullable":true,
            "x-queryable":true
        },
        "Segment16TreeCode":{
            "type":"string",
            "description":"The tree code for Segment 16.",
            "nullable":true,
            "x-queryable":true
        },
        "Scenario":{
            "title":"Scenario",
            "type":"string",
            "description":"The scenario for an account group definition with a budget-based comparison option. Valid values include Forecast Q1 and Original Budget.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "PeriodActivity":{
            "title":"Period Activity",
            "type":"string",
            "description":"The period account balance for the provided criteria.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Segment18TreeCode":{
            "type":"string",
            "description":"The tree code for Segment 18.",
            "nullable":true,
            "x-queryable":true
        },
        "CurrentAccountingPeriod":{
            "title":"Accounting Period",
            "type":"string",
            "description":"The accounting period, quarter, or year, for which balances are requested.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "AmountType":{
            "title":"Amount Type",
            "type":"string",
            "description":"The amount type requested for the account balance. Values include Base, PTD, YTD and QTD. The default value is Base.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "Segment23TreeCode":{
            "type":"string",
            "description":"The tree code for Segment 23.",
            "nullable":true,
            "x-queryable":true
        },
        "PeriodName":{
            "title":"Period Name",
            "type":"string",
            "description":"The name of the accounting period for which account balances are returned. Applicable to Detail Mode only.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "Segment21TreeCode":{
            "type":"string",
            "description":"The tree code for Segment 21.",
            "nullable":true,
            "x-queryable":true
        },
        "CurrencyType":{
            "title":"Currency Type",
            "type":"string",
            "description":"The currency type requested for the account balance. The default value is Total.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "Segment8TreeCode":{
            "type":"string",
            "description":"The tree code for Segment 8.",
            "nullable":true,
            "x-queryable":true
        },
        "BeginningBalance":{
            "title":"Beginning Balance",
            "type":"string",
            "description":"The beginning account balance for the provided criteria.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AccountName":{
            "title":"Account Name",
            "maxLength":255,
            "type":"string",
            "description":"The name of the account defined as part of the account group.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "Segment20TreeCode":{
            "type":"string",
            "description":"The tree code for Segment 20.",
            "nullable":true,
            "x-queryable":true
        },
        "DetailAccountCombination":{
            "title":"Detail Account Combination",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "Segment1TreeCode":{
            "type":"string",
            "description":"The tree code for Segment 1.",
            "nullable":true,
            "x-queryable":true
        },
        "CurrentPeriodBalance":{
            "title":"Period Balance",
            "type":"string",
            "description":"The account balance for the requested accounting period.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "Segment24TreeCode":{
            "type":"string",
            "description":"The tree code for Segment 24.",
            "nullable":true,
            "x-queryable":true
        },
        "Segment3TreeCode":{
            "type":"string",
            "description":"The tree code for Segment 3.",
            "nullable":true,
            "x-queryable":true
        },
        "BudgetBalance":{
            "title":"Budget Balance",
            "type":"string",
            "description":"The budget balance for the provided budget-based account group and other criteria.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "Segment26TreeCode":{
            "type":"string",
            "description":"The tree code for Segment 26.",
            "nullable":true,
            "x-queryable":true
        },
        "ActualBalance":{
            "title":"Actual Balance",
            "type":"string",
            "description":"The actual balance for the provided budget-based account group and other criteria.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "Segment13TreeCode":{
            "type":"string",
            "description":"The tree code for Segment 13.",
            "nullable":true,
            "x-queryable":true
        },
        "Segment29TreeCode":{
            "type":"string",
            "description":"The tree code for Segment 29.",
            "nullable":true,
            "x-queryable":true
        },
        "Segment9TreeCode":{
            "type":"string",
            "description":"The tree code for Segment 9.",
            "nullable":true,
            "x-queryable":true
        },
        "Segment12TreeCode":{
            "type":"string",
            "description":"The tree code for Segment 12.",
            "nullable":true,
            "x-queryable":true
        },
        "Segment7TreeCode":{
            "type":"string",
            "description":"The tree code for Segment 7.",
            "nullable":true,
            "x-queryable":true
        },
        "Segment15TreeCode":{
            "type":"string",
            "description":"The tree code for Segment 15.",
            "nullable":true,
            "x-queryable":true
        },
        "Segment5TreeCode":{
            "type":"string",
            "description":"The tree code for Segment 5.",
            "nullable":true,
            "x-queryable":true
        },
        "LedgerSetName":{
            "title":"Ledger Set",
            "type":"string",
            "description":"The name of the ledger set for which balances are requested.",
            "nullable":true,
            "x-queryable":true
        },
        "Segment10TreeCode":{
            "type":"string",
            "description":"The tree code for Segment 10.",
            "nullable":true,
            "x-queryable":true
        },
        "Segment17TreeCode":{
            "type":"string",
            "description":"The tree code for Segment 17.",
            "nullable":true,
            "x-queryable":true
        },
        "Segment22TreeCode":{
            "type":"string",
            "description":"The tree code for Segment 22.",
            "nullable":true,
            "x-queryable":true
        },
        "Segment19TreeCode":{
            "type":"string",
            "description":"The tree code for Segment 19.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top

Examples

Example 1

The following example shows how to retrieve all the ledger balances of an account in an account group by submitting a GET request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourcecollection+json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/ledgerBalances?onlyData=true&finder=AccountGroupBalanceFinder;accountGroupName=Unallocated,accountName=Building Rent,accountingPeriod=Jan-16,currency=USD,ledgerName=Vision Foods - USA Ledger&fields=AccountGroupName,AccountName,LedgerName,Currency,CurrentAccountingPeriod,AccountCombination,CurrentPeriodBalance,AmountType

Example Response Body

The following example shows the contents of the response body in JSON format:

{
    "items": [
        {
            "AccountGroupName": "Unallocated",
            "AccountName": "Building Rent",
            "LedgerName": "Vision Foods - USA Ledger",
            "Currency": "USD",
            "CurrentAccountingPeriod": "Jan-16",
            "AccountCombination": "3121-311-3111-1211-52231-1121-1111-0000",
            "CurrentPeriodBalance": "42983.00",
            "AmountType": "PTD"
        }
    ],
    "count": 1,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/ledgerBalances",
            "name": "ledgerBalances",
            "kind": "collection"
        }
    ]
}

Example 2

The following example shows how to retrieve all the ledger balances of an account in a budget based account group by submitting a GET request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourcecollection+json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/ledgerBalances?onlyData=true&finder=AccountGroupBalanceFinder;accountGroupName=Wine Revenues,accountName=Chardonnay,accountingPeriod=Jan-16,currency=USD,ledgerName=Vision Foods - USA Ledger&fields=AccountGroupName,AccountName,LedgerName,Currency,CurrentAccountingPeriod,AccountCombination,ActualBalance,BudgetBalance,AmountType

Example Response Body

The following example shows the contents of the response body in JSON format:

{
    "items": [
        {
            "AccountGroupName": "Wine Revenues",
            "AccountName": "Chardonnay",
            "LedgerName": "Vision Foods - USA Ledger",
            "Currency": "USD",
            "CurrentAccountingPeriod": "Jan-16",
            "AccountCombination": "3121-311-3111-1211-40110-1121-1111-0000",
            "ActualBalance": "-13148402.00",
            "BudgetBalance": "-12953000.00",
            "AmountType": "PTD"
        }
    ],
    "count": 1,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/ledgerBalances",
            "name": "ledgerBalances",
            "kind": "collection"
        }
    ]
}

Example 3

The following example shows how to retrieve all the summary level ledger balances for an account combination by submitting a GET request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourcecollection+json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/ledgerBalances?onlyData=true&finder=AccountBalanceFinder;accountCombination=3121-%-%-%-11010-%-%-%,accountingPeriod=Jan-16,currency=USD,ledgerName=Vision Foods - USA Ledger,mode=Summary,amountType=PTD&fields=LedgerName,PeriodName,Currency,DetailAccountCombination,Scenario,BeginningBalance,PeriodActivity,EndingBalance,AmountType,CurrencyType,ErrorDetail

Example Response Body

The following example shows the contents of the response body in JSON format:

{
    "items": [
        {
            "LedgerName": "Vision Foods - USA Ledger",
            "PeriodName": "N/A",
            "Currency": "USD",
            "DetailAccountCombination": "N/A",
            "Scenario": "N/A",
            "BeginningBalance": "4281224341.10",
            "PeriodActivity": "63317809.00",
            "EndingBalance": "4344542150.10",
            "AmountType": "PTD",
            "CurrencyType": "Total",
            "ErrorDetail": "N/A"
        }
    ],
    "count": 1,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/ledgerBalances",
            "name": "ledgerBalances",
            "kind": "collection"
        }
    ]
}

Example 4

The following example shows how to retrieve ledger balances, for all the detail account combinations that are part of the balance of a requested account combination, by submitting a GET request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourcecollection+json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/ledgerBalances?onlyData=true&finder=AccountBalanceFinder;accountCombination=3121-%-%-%-11010-%-%-%,accountingPeriod=Jan-16,currency=USD,ledgerName=Vision Foods - USA Ledger,amountType=PTD,mode=Detail&fields=LedgerName,PeriodName,Currency,DetailAccountCombination,Scenario,BeginningBalance,PeriodActivity,EndingBalance,AmountType,CurrencyType,ErrorDetail

Example Response Body

The following example shows the contents of the response body in JSON format:

{
    "items": [
        {
            "LedgerName": "Vision Foods - USA Ledger",
            "PeriodName": "Jan-16",
            "Currency": "USD",
            "DetailAccountCombination": "3121-000-0000-0000-11010-0000-0000-0000",
            "Scenario": "N/A",
            "BeginningBalance": "18401596.46",
            "PeriodActivity": "0.00",
            "EndingBalance": "18401596.46",
            "AmountType": "PTD",
            "CurrencyType": "Total",
            "ErrorDetail": "N/A"
        },
        {
            "LedgerName": "Vision Foods - USA Ledger",
            "PeriodName": "Jan-16",
            "Currency": "USD",
            "DetailAccountCombination": "3121-000-5611-6611-11010-5711-0000-0000",
            "Scenario": "N/A",
            "BeginningBalance": "3821523474.80",
            "PeriodActivity": "0.00",
            "EndingBalance": "3821523474.80",
            "AmountType": "PTD",
            "CurrencyType": "Total",
            "ErrorDetail": "N/A"
        },
        ...
    ],
    "count": 5,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/ledgerBalances",
            "name": "ledgerBalances",
            "kind": "collection"
        }
    ]
}

Example 5

The following example shows how to retrieve all the summary level budget balances for an account combination by submitting a GET request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourcecollection+json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/ledgerBalances?onlyData=true&finder=AccountBalanceFinder;accountCombination=3121-%-%-%-40110-%-%-%,accountingPeriod=Jan-16,currency=USD,ledgerName=Vision Foods - USA Ledger,mode=Summary,amountType=PTD,scenario=Original Budget&fields=LedgerName,PeriodName,Currency,DetailAccountCombination,Scenario,BeginningBalance,PeriodActivity,EndingBalance,AmountType,CurrencyType,ErrorDetail

Example Response Body

The following example shows the contents of the response body in JSON format:

{
    "items": [
        {
            "LedgerName": "Vision Foods - USA Ledger",
            "PeriodName": "N/A",
            "Currency": "USD",
            "DetailAccountCombination": "N/A",
            "Scenario": "Original Budget",
            "BeginningBalance": "#MISSING",
            "PeriodActivity": "-66034000.00",
            "EndingBalance": "-264136000.00",
            "AmountType": "PTD",
            "CurrencyType": "Total",
            "ErrorDetail": "N/A"
        }
    ],
    "count": 1,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/ledgerBalances",
            "name": "ledgerBalances",
            "kind": "collection"
        }
    ]
}

Example 6

The following example shows how to retrieve ledger balances for all the detail account combinations of a ledger set by submitting a GET request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourcecollection+json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/ledgerBalances?onlyData=true&finder=AccountBalanceFinder;accountCombination=3111-000-%-%-%-%-%-9999,accountingPeriod=2008,currency=USD,ledgerSetName=Vision Foods USA Ledger Set,amountType=YTD,currencyType=Entered,mode=Detail&fields=LedgerName,PeriodName,Currency,DetailAccountCombination,Scenario,BeginningBalance,PeriodActivity,EndingBalance,AmountType,CurrencyType,ErrorDetail

Example Response Body

The following example shows the contents of the response body in JSON format:

{
    "items": [
        {
            "LedgerName": "Vision Foods - USA Ledger",
            "PeriodName": "Oct-08",
            "Currency": "USD",
            "DetailAccountCombination": "3111-000-0000-0000-11010-0000-0000-0000",
            "Scenario": "N/A",
            "BeginningBalance": "7144420.91",
            "PeriodActivity": "233742.39",
            "EndingBalance": "7378163.30",
            "AmountType": "YTD",
            "CurrencyType": "Entered",
            "ErrorDetail": "N/A"
        },
        {
            "LedgerName": "Vision Foods - USA Ledger",
            "PeriodName": "Oct-08",
            "Currency": "USD",
            "DetailAccountCombination": "3111-000-0000-0000-11015-0000-0000-0000",
            "Scenario": "N/A",
            "BeginningBalance": "714440.87",
            "PeriodActivity": "23374.14",
            "EndingBalance": "737815.01",
            "AmountType": "YTD",
            "CurrencyType": "Entered",
            "ErrorDetail": "N/A"
        },
        ...
    ],
    "count": 25,
    "hasMore": true,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/ledgerBalances",
            "name": "ledgerBalances",
            "kind": "collection"
        }
    ]
}

Back to Top