Jump to

• Request
• Response
• Examples

Get a period status

get

/fscmRestApi/resources/11.13.18.05/accountingPeriodStatusLOV/{accountingPeriodStatusLOVUniqID}

Request

Path Parameters

• accountingPeriodStatusLOVUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- PeriodNameId, ApplicationId and LedgerId ---for the Accounting Period Status List of Values resource and used to uniquely identify an instance of Accounting Period Status List of Values. The client should not generate the hash key value. Instead, the client should query on the Accounting Period Status List of Values collection resource with a filter on the primary key values in order to navigate to a specific instance of Accounting Period Status List of Values.
  
  For example: accountingPeriodStatusLOV?q=PeriodNameId=<value1>;ApplicationId=<value2>;LedgerId=<value3>

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 Top

Response

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.

Body ()

Root Schema : accountingPeriodStatusLOV-item-response

Type: object

Show Source

• AdjustmentPeriodFlag: boolean
  Read Only: true

  Maximum Length: 1

  The indicator of the calendar adjustment period status.
• ApplicationId: integer (int64)
  Read Only: true

  The unique identifier of the application.
• ClosingStatus: string
  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.
• EffectivePeriodNumber: integer (int64)
  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.
• EndDate: string (date)
  Title: End Date

  Read Only: true

  The date when the accounting period ends.
• LedgerId: integer (int64)
  Read Only: true

  The unique identifier of the ledger.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PeriodNameId: string
  Title: Accounting Period

  Read Only: true

  Maximum Length: 15

  The accounting period name in a calendar.
• PeriodNumber: integer (int64)
  Title: Period Number

  Read Only: true

  An unique period number within the accounting calendar year.
• PeriodYear: integer (int64)
  Title: Year

  Read Only: true

  The accounting calendar year represented by a numerical value, such as 2019.
• StartDate: string (date)
  Title: Start Date

  Read Only: true

  The date when the accounting period begins.

{
    "type":"object",
    "properties":{
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the accounting period begins.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PeriodYear":{
            "title":"Year",
            "type":"integer",
            "description":"The accounting calendar year represented by a numerical value, such as 2019.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AdjustmentPeriodFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"The indicator of the calendar adjustment period status.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PeriodNumber":{
            "title":"Period Number",
            "type":"integer",
            "description":"An unique period number within the accounting calendar year.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LedgerId":{
            "type":"integer",
            "description":"The unique identifier of the ledger.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ApplicationId":{
            "type":"integer",
            "description":"The unique identifier of the application.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ClosingStatus":{
            "title":"Status",
            "maxLength":1,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the accounting period ends.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PeriodNameId":{
            "title":"Accounting Period",
            "maxLength":15,
            "type":"string",
            "description":"The accounting period name in a calendar.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EffectivePeriodNumber":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "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

The following example shows how to retrieve a period status by submitting a GET request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/accountingPeriodStatusLOV/0003000000064A756E2D31390000000EACED0005770800000000000027350000000EACED00057708000110F080AADDE3

Example Response Body

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

{
    "PeriodNameId": "Jun-19",
    "ApplicationId": 10037,
    "LedgerId": 300100113587683,
    "ClosingStatus": "N",
    "EndDate": "2019-06-30",
    "StartDate": "2019-06-01",
    "EffectivePeriodNumber": 20200003,
    "PeriodYear": 2020,
    "PeriodNumber": 3,
    "AdjustmentPeriodFlag": false,
    "links": [
        {
            "rel": "self",
            "href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/accountingPeriodStatusLOV/0003000000064A756E2D31390000000EACED0005770800000000000027350000000EACED00057708000110F080AADDE3",
            "name": "accountingPeriodStatusLOV",
            "kind": "item"
        },
        {
            "rel": "canonical",
            "href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/accountingPeriodStatusLOV/0003000000064A756E2D31390000000EACED0005770800000000000027350000000EACED00057708000110F080AADDE3",
            "name": "accountingPeriodStatusLOV",
            "kind": "item"
        }
    ]
}

Back to Top