1. REST API for Oracle Fusion Cloud Financials
  2. Tasks
  3. List of Values
  4. Accounting Period Status List of Values

Get all period statuses

get

/fscmRestApi/resources/11.13.18.05/accountingPeriodStatusLOV

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:

    • AttrRowFinder: Finds the period status that matches the specified attributes.
      Finder Variables:
      • ApplicationId; integer; The unique identifier of the application.
      • LedgerId; integer; The unique identifier of the ledger.
      • PeriodNameId; string; The accounting period name in a calendar.
      • SearchTerms; string; A keyword that can be applied on the finder to facilitate server-side filtering.
    • BuAppldAdjflagFinder: Finds all periods that match the specified adjustment flag and application ID for the internally derived ledger ID of the specified business unit ID.
      Finder Variables:
      • BindAdjFlag; string; Indicates whether a period is an adjustment period.
      • BindApplicationId; integer; The unique identifier of the application.
      • BuIdVar; integer; The unique identifier of the business unit.
    • BuPrjAdjflagFinder: Finds all periods that match the specified adjustment flag for internally derived ledger ID of the specified organisation ID.
      Finder Variables:
      • BindAdjFlag; string; Indicates whether a period is an adjustment period.
      • BuIdVar; integer; The unique identifier of the business unit.
    • 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.
    • LedgerAndApplicationRowFinder: Finds all the period statuses that match the specified ledger ID and application ID.
      Finder Variables:
      • BindApplicationId; integer; The unique identifier of the application.
      • BindLedgerId; integer; The unique identifier of the ledger.
    • LedgerIdAppIdPeriodNumRowFinder: Finds all periods that are on or after the specified accounting period number for a ledger or application.
      Finder Variables:
      • BindApplicationId; integer; The unique identifier of the application.
      • BindEffectivePeriodNum; integer; The internally derived denormalized period number used to identify a period name.
      • LedgerIdVar; integer; The unique identifier of the ledger.
    • LedgerIdAppldDateRowFinder: Finds the period that has the specified accounting date in the date range for the ledger and application.
      Finder Variables:
      • BindAccountingDate; string; The internally derived accounting date used to identify a period name.
      • BindApplicationId; integer; The unique identifier of the application.
      • BindLedgerId; integer; The unique identifier of the ledger.
    • PrimaryKey: Finds the period status that matches the primary key criteria specified.
      Finder Variables:
      • ApplicationId; integer; The unique identifier of the application.
      • LedgerId; integer; The unique identifier of the ledger.
      • PeriodNameId; string; The accounting period name in a calendar.
    • ReversalPeriodActualRowFinder: Finds all reversal periods in an open or future enterable status that are on or after the specified accounting period for a ledger.
      Finder Variables:
      • BindEffectivePeriodNum; integer; The internally derived denormalized period number used to identify a period name.
      • LedgerIdVar; integer; The unique identifier of the ledger.
      • SearchTerm; string; A keyword that can be applied on the finder to facilitate server-side filtering.
    • ReversalPeriodEncumRowFinder: Finds all applicable reversal periods in an open encumbrance year that are on or after the specified accounting period for a ledger.
      Finder Variables:
      • BindEffectivePeriodNum; integer; The internally derived denormalized period number used to identify a period name.
      • LedgerIdVar; integer; The unique identifier of the ledger.
      • SearchTerm; string; A keyword that can be applied on the finder to facilitate server-side filtering.
    • applicationIdFinder: Finds the period status that matches the specified application ID.
      Finder Variables:
      • BindApplicationId; integer; The unique identifier of the application.
      • SearchTerm; string; A keyword that can be applied on the finder to facilitate server-side filtering.
    • ledgerIdFinder: Finds the period status that matches the specified Ledger ID.
      Finder Variables:
      • BindLedgerId; integer; The unique identifier of the ledger.
      • 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:
    • AdjustmentPeriodFlag; boolean; The indicator of the calendar adjustment period status.
    • ApplicationId; integer; The unique identifier of the application.
    • ClosingStatus; string; The indicator of the closing status of an accounting period, whether the period is open or closed. Valid values include O for Open, C for Closed, F for Future Enterable, N for Never Opened, P for Permanently Closed and W for Close Pending.
    • EffectivePeriodNumber; integer; The internally derived denormalized period number used to identify a period name. The effective period number for the accounting period name can be derived as (PERIOD_YEAR*10000 + PERIOD_NUM). For example, the effective period number for the first month of the year 2019 would be (2019*10000+1) = 20190001.
    • EndDate; string; The date when the accounting period ends.
    • LedgerId; integer; The unique identifier of the ledger.
    • PeriodNameId; string; The accounting period name in a calendar.
    • PeriodNumber; integer; An unique period number within the accounting calendar year.
    • PeriodYear; integer; The accounting calendar year represented by a numerical value, such as 2019.
    • StartDate; string; The date when the accounting period begins.
  • 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 : accountingPeriodStatusLOV
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : accountingPeriodStatusLOV-item-response
Type: object
Show Source
  • Read Only: true
    Maximum Length: 1
    The indicator of the calendar adjustment period status.
  • Read Only: true
    The unique identifier of the application.
  • Title: Status
    Read Only: true
    Maximum Length: 1
    The indicator of the closing status of an accounting period, whether the period is open or closed. Valid values include O for Open, C for Closed, F for Future Enterable, N for Never Opened, P for Permanently Closed and W for Close Pending.
  • Read Only: true
    The internally derived denormalized period number used to identify a period name. The effective period number for the accounting period name can be derived as (PERIOD_YEAR*10000 + PERIOD_NUM). For example, the effective period number for the first month of the year 2019 would be (2019*10000+1) = 20190001.
  • Title: End Date
    Read Only: true
    The date when the accounting period ends.
  • Read Only: true
    The unique identifier of the ledger.
  • Links
  • Title: Accounting Period
    Read Only: true
    Maximum Length: 15
    The accounting period name in a calendar.
  • Title: Period Number
    Read Only: true
    An unique period number within the accounting calendar year.
  • Title: Year
    Read Only: true
    The accounting calendar year represented by a numerical value, such as 2019.
  • Title: Start Date
    Read Only: true
    The date when the accounting period begins.
Back to Top

Examples

The following example shows how to retrieve all the period statuses 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/accountingPeriodStatusLOV

Example Response Body

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

{
    "items": [
        {
            "PeriodNameId": "16_Mar-36",
            "ApplicationId": 101,
            "LedgerId": 300100121051553,
            "ClosingStatus": "N",
            "EndDate": "2036-03-31",
            "StartDate": "2036-03-31",
            "EffectivePeriodNumber": 20360016,
            "PeriodYear": 2036,
            "PeriodNumber": 16,
            "AdjustmentPeriodFlag": true,
            "links": [
                {
                    "rel": "self",
                    "href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/accountingPeriodStatusLOV/00030000000931365F4D61722D33360000000EACED0005770800000000000000650000000EACED00057708000110F0811CC1A1",
                    "name": "accountingPeriodStatusLOV",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/accountingPeriodStatusLOV/00030000000931365F4D61722D33360000000EACED0005770800000000000000650000000EACED00057708000110F0811CC1A1",
                    "name": "accountingPeriodStatusLOV",
                    "kind": "item"
                }
            ]
        },
        {
            "PeriodNameId": "16_Mar-36",
            "ApplicationId": 10455,
            "LedgerId": 300100121051553,
            "ClosingStatus": "N",
            "EndDate": "2036-03-31",
            "StartDate": "2036-03-31",
            "EffectivePeriodNumber": 20360016,
            "PeriodYear": 2036,
            "PeriodNumber": 16,
            "AdjustmentPeriodFlag": true,
            "links": [
                {
                    "rel": "self",
                    "href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/accountingPeriodStatusLOV/00030000000931365F4D61722D33360000000EACED0005770800000000000028D70000000EACED00057708000110F0811CC1A1",
                    "name": "accountingPeriodStatusLOV",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/accountingPeriodStatusLOV/00030000000931365F4D61722D33360000000EACED0005770800000000000028D70000000EACED00057708000110F0811CC1A1",
                    "name": "accountingPeriodStatusLOV",
                    "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/accountingPeriodStatusLOV",
            "name": "accountingPeriodStatusLOV",
            "kind": "collection"
        }
    ]
}
Back to Top