Update a ledger
patch
/fscmRestApi/resources/11.13.18.05/publicSectorLedgers/{publicSectorLedgersUniqID}
Request
Path Parameters
-
publicSectorLedgersUniqID(required): string
This is the hash key of the attributes which make up the composite key--- AgencyId and LedgerId ---for the Ledgers resource and used to uniquely identify an instance of Ledgers. The client should not generate the hash key value. Instead, the client should query on the Ledgers collection resource with a filter on the primary key values in order to navigate to a specific instance of Ledgers.
For example: publicSectorLedgers?q=AgencyId=<value1>;LedgerId=<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
-
BaseCurrency: string
Title:
Currency
Maximum Length:3
Functional currency of the ledger. Value is mandatory and is set programmatically to USD which is currently the only supported currency. -
EnabledFlag: boolean
Title:
Enabled
Maximum Length:1
Indicates whether or not journals may be assigned to the ledger. Accepted values are Y (Yes) or N (No). The default value is Y. -
LedgerDescription: string
Title:
Description
Maximum Length:240
The description of the ledger. -
LedgerType: string
Title:
Type
Maximum Length:1
The type of data stored in the ledger. Value is mandatory and is set programmatically to A (Actuals) which is currently the only supported ledger type.
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 : publicSectorLedgers-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The unique identifier of the agency associated with the ledger. Value is mandatory and is set programmatically based on the user's login. -
BaseCurrency: string
Title:
Currency
Maximum Length:3
Functional currency of the ledger. Value is mandatory and is set programmatically to USD which is currently the only supported currency. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the ledger. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time the ledger was created. -
EnabledFlag: boolean
Title:
Enabled
Maximum Length:1
Indicates whether or not journals may be assigned to the ledger. Accepted values are Y (Yes) or N (No). The default value is Y. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time the ledger was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the ledger. -
LedgerDescription: string
Title:
Description
Maximum Length:240
The description of the ledger. -
LedgerId: string
Title:
Ledger
Maximum Length:30
The unique identifier of the ledger. Identifies the accounting treatment of the journals associated with the ledger. Value is mandatory and is defined by the user during a create action. -
LedgerType: string
Title:
Type
Maximum Length:1
The type of data stored in the ledger. Value is mandatory and is set programmatically to A (Actuals) which is currently the only supported ledger type. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
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.