Update a period
patch
/fscmRestApi/resources/11.13.18.05/publicSectorCalendars/{publicSectorCalendarsUniqID}
Request
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Path Parameters
-
publicSectorCalendarsUniqID: integer
This is the hash key of the attributes which make up the composite key--- AgencyId and AccountingPeriod ---for the Calendars resource and used to uniquely identify an instance of Calendars. The client should not generate the hash key value. Instead, the client should query on the Calendars collection resource with a filter on the primary key values in order to navigate to a specific instance of Calendars.
For example: publicSectorCalendars?q=AgencyId=<value1>;AccountingPeriod=<value2>
The following table describes the body parameters in the request for this task.
Root Schema : publicSectorCalendars-item
Type:
Show Source
object
-
AccountingPeriod(optional):
string
Title:
Period
Maximum Length:8
The unique identifier of the calendar year and month assigned to an accounting journal by the Generate Accounting process. -
AgencyId(optional):
integer(int32)
Title:
Agency ID
The unique identifier of the agency associated with the calendar. Value is mandatory and is set programmatically based on the user's login. -
CreatedBy(optional):
string
Title:
Created By
Maximum Length:64
The user who created the accounting period using the Create Periods button on the Monthly Accounting Calendar page. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date and time the accounting period was created. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date and time the accounting period was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The user who last updated the accounting period. -
links(optional):
array Items
Title:
Items
Link Relations -
OpenCloseFlag(optional):
string
Title:
Status
Maximum Length:1
Indicates whether the period is open or closed for posting accounting journals. Accepted values are O (Open) and C (Closed). The default value is C. -
PeriodEndDate(optional):
string(date-time)
Title:
End Date
The last day of the accounting period. -
PeriodStartDate(optional):
string(date-time)
Title:
Start Date
The first day of the accounting period.
Nested Schema : link
Type:
Show Source
object
-
href(optional):
string
Title:
hyperlink reference
The URI to the related resource. -
rel(optional):
string
Title:
relation
The name of the relation to the resource instance. Example: self.
Response
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorCalendars-item
Type:
Show Source
object
-
AccountingPeriod(optional):
string
Title:
Period
Maximum Length:8
The unique identifier of the calendar year and month assigned to an accounting journal by the Generate Accounting process. -
AgencyId(optional):
integer(int32)
Title:
Agency ID
The unique identifier of the agency associated with the calendar. Value is mandatory and is set programmatically based on the user's login. -
CreatedBy(optional):
string
Title:
Created By
Maximum Length:64
The user who created the accounting period using the Create Periods button on the Monthly Accounting Calendar page. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date and time the accounting period was created. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date and time the accounting period was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The user who last updated the accounting period. -
links(optional):
array Items
Title:
Items
Link Relations -
OpenCloseFlag(optional):
string
Title:
Status
Maximum Length:1
Indicates whether the period is open or closed for posting accounting journals. Accepted values are O (Open) and C (Closed). The default value is C. -
PeriodEndDate(optional):
string(date-time)
Title:
End Date
The last day of the accounting period. -
PeriodStartDate(optional):
string(date-time)
Title:
Start Date
The first day of the accounting period.
Nested Schema : link
Type:
Show Source
object
-
href(optional):
string
Title:
hyperlink reference
The URI to the related resource. -
rel(optional):
string
Title:
relation
The name of the relation to the resource instance. Example: self.