1. REST API for Oracle Fusion Cloud Financials
  2. Tasks
  3. List of Values
  4. Data Access Set Ledgers List of Values

Get all ledgers or ledger sets

get

/fscmRestApi/resources/11.13.18.05/dataAccessSetLedgersLOV

Request

Query Parameters
  • 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).
  • 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
  • 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:

    • KeywordFinder: Finds values when more than 500 rows are returned by applying server-side filtering using the specified search term.
      Finder Variables:
      • SearchTerm; string; A keyword that can be applied on the finder to facilitate server-side filtering.
    • PrimaryKey: Finds the ledgers or ledger sets that match the specified primary key criteria.
      Finder Variables:
      • AccessSetId; integer; The unique identifier of the data access set.
    • accessSetIdFinder: Finds the ledgers or ledger sets that match the specified data access set ID or search term or both.
      Finder Variables:
      • AccessSetIdVar; integer; The unique identifier of the data access set.
      • SearchTerm; string; A keyword that can be applied on the finder to facilitate server-side filtering.
    • ledgerIdAttrRowFinder: Finds the ledgers or ledger sets that match the specified data access set ID.
      Finder Variables:
      • LedgerId; integer; The unique identifier of the ledger.
      • SearchTerms; string.
    • ledgerSetIdsFinder: Finds the ledger sets that match the specified list of ledger set IDs.
      Finder Variables:
      • BindLedgerSetIds; string; The list of unique identifiers for the ledger sets.
    • objectCodeLookupTypFinder: Finds the ledgers or ledger sets that match any of the specified lookup types, ledger types, or search terms.
      Finder Variables:
      • BindLookupType; string; The user-defined look up type for a ledger type.
      • BindObjectTypeCode; string; The ledger type associated with the row with valid values including Ledger and Ledger Set.
      • SearchTerm; string; A keyword that can be applied on the finder to facilitate server-side filtering.
  • 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.
  • 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
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • 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
  • 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:
    • AccessSetId; integer; The unique identifier of the data access set.
    • AccountedPeriodType; string; The accounting period type.
    • BalSegColumnName; string; The balancing segment name for the ledger or ledger set.
    • ChartOfAccountsId; integer; The unique identifier of the key flexfield structure.
    • Description; string; The description associated to the ledger or ledger set definition.
    • EnableBudgetaryControlFlag; boolean; Indicates whether budgetary control is enabled for the ledger. Valid values include Y, N.
    • LedgerCategoryCode; string; Indicates the nature of the ledger. Valid values include Primary, Secondary and ALC, which represents the reporting currency.
    • LedgerId; integer; The unique identifier of the ledger or ledger set.
    • LedgerSetIds; string; The list of unique identifiers for the ledger sets.
    • LookupCode; string; The ledger category values defined as part of the lookup type GL_ASF_LEDGER_CATEGORY.
    • LookupType; string; The string identifier that groups certain codes together. The lookup type GL_ASF_LEDGER_CATEGORY groups lookup codes for ledger categories.
    • Meaning; string; The meaning of the lookup code defined in the lookup type.
    • Name; string; The name of the ledger or ledger set.
    • ObjectTypeCode; string; The ledger type associated with the row. Valid values are L, which represents ledger, and S, which represents ledger set.
    • PeriodSetName; string; The name of the accounting calendar.
    • ShortName; string; The user-defined unique short name for the ledger or ledger set.
  • 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
  • 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".
  • 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

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : dataAccessSetLedgersLOV
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : dataAccessSetLedgersLOV-item-response
Type: object
Show Source
  • Read Only: true
    The unique identifier of the data access set.
  • Read Only: true
    Maximum Length: 15
    The accounting period type.
  • Read Only: true
    Maximum Length: 25
    The balancing segment name for the ledger or ledger set.
  • Read Only: true
    The unique identifier of the key flexfield structure.
  • Title: Description
    Read Only: true
    Maximum Length: 240
    The description associated to the ledger or ledger set definition.
  • Read Only: true
    Maximum Length: 1
    Indicates whether budgetary control is enabled for the ledger. Valid values include Y, N.
  • Title: Ledger Category
    Read Only: true
    Maximum Length: 30
    Indicates the nature of the ledger. Valid values include Primary, Secondary and ALC, which represents the reporting currency.
  • Title: Ledger ID
    Read Only: true
    The unique identifier of the ledger or ledger set.
  • The list of unique identifiers for the ledger sets.
  • Links
  • Read Only: true
    Maximum Length: 30
    The ledger category values defined as part of the lookup type GL_ASF_LEDGER_CATEGORY.
  • Read Only: true
    Maximum Length: 30
    The string identifier that groups certain codes together. The lookup type GL_ASF_LEDGER_CATEGORY groups lookup codes for ledger categories.
  • Read Only: true
    Maximum Length: 80
    The meaning of the lookup code defined in the lookup type.
  • Title: Name
    Read Only: true
    Maximum Length: 30
    The name of the ledger or ledger set.
  • Title: Type
    Read Only: true
    Maximum Length: 1
    The ledger type associated with the row. Valid values are L, which represents ledger, and S, which represents ledger set.
  • Title: Accounting Calendar Name
    Read Only: true
    Maximum Length: 15
    The name of the accounting calendar.
  • Read Only: true
    Maximum Length: 20
    The user-defined unique short name for the ledger or ledger set.
Back to Top

Examples

The following example shows how to retrieve all the ledgers 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/dataAccessSetLedgersLOV

Example Response Body

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

{
    "items": [
        {
            "AccessSetId": 100000015123287,
            "LedgerId": 25123254,
            "AccountedPeriodType": "MONTH8798351490",
            "ChartOfAccountsId": 54604,
            "EnableBudgetaryControlFlag": false,
            "ObjectTypeCode": "L",
            "PeriodSetName": "Vision Foods US",
            "Name": " FINGL_E2E_QA_12_R2",
            "Description": null,
            "LedgerCategoryCode": "ALC",
            "BalSegColumnName": "SEGMENT1",
            "ShortName": "25123254",
            "LookupCode": "ALC",
            "LookupType": "GL_ASF_LEDGER_CATEGORY",
            "Meaning": "Reporting Currency",
            "links": [
                {
                    "rel": "self",
                    "href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/dataAccessSetLedgersLOV/00020000000EACED0005770800000000017F59B6FFFFFFFF",
                    "name": "dataAccessSetLedgersLOV",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/dataAccessSetLedgersLOV/00020000000EACED0005770800000000017F59B6FFFFFFFF",
                    "name": "dataAccessSetLedgersLOV",
                    "kind": "item"
                }
            ]
        },
        {
            "AccessSetId": 100000015123289,
            "LedgerId": 25123254,
            "AccountedPeriodType": "MONTH8798351490",
            "ChartOfAccountsId": 54604,
            "EnableBudgetaryControlFlag": false,
            "ObjectTypeCode": "L",
            "PeriodSetName": "Vision Foods US",
            "Name": " FINGL_E2E_QA_12_R2",
            "Description": null,
            "LedgerCategoryCode": "ALC",
            "BalSegColumnName": "SEGMENT1",
            "ShortName": "25123254",
            "LookupCode": "ALC",
            "LookupType": "GL_ASF_LEDGER_CATEGORY",
            "Meaning": "Reporting Currency",
            "links": [
                {
                    "rel": "self",
                    "href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/dataAccessSetLedgersLOV/00020000000EACED0005770800000000017F59B6FFFFFFFF",
                    "name": "dataAccessSetLedgersLOV",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/dataAccessSetLedgersLOV/00020000000EACED0005770800000000017F59B6FFFFFFFF",
                    "name": "dataAccessSetLedgersLOV",
                    "kind": "item"
                }
            ]
        },
        ...
    ],
    "count": 25,
    "hasMore": true,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/dataAccessSetLedgersLOV",
            "name": "dataAccessSetLedgersLOV",
            "kind": "collection"
        }
    ]
}
Back to Top