Update a period
patch
/fscmRestApi/resources/11.13.18.05/publicSectorCalendars/{publicSectorCalendarsUniqID}
Request
Path Parameters
-
publicSectorCalendarsUniqID(required): string
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>
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AccountingPeriod: 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: 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. -
OpenCloseFlag: 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: string
(date-time)
Title:
End Date
The last day of the accounting period. -
PeriodStartDate: string
(date-time)
Title:
Start Date
The first day of the accounting period.
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.
Root Schema : publicSectorCalendars-item-response
Type:
Show Source
object
-
AccountingPeriod: 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: 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: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the accounting period using the Create Periods button on the Monthly Accounting Calendar page. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time the accounting period was created. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time the accounting period was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the accounting period. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OpenCloseFlag: 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: string
(date-time)
Title:
End Date
The last day of the accounting period. -
PeriodStartDate: string
(date-time)
Title:
Start Date
The first day of the accounting period.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.