Update a ledger
patch
/fscmRestApi/resources/11.13.18.05/publicSectorLedgers/{publicSectorLedgersUniqID}
Request
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Path Parameters
-
publicSectorLedgersUniqID: integer
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>
The following table describes the body parameters in the request for this task.
Root Schema : publicSectorLedgers-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
Title:
Agency ID
The unique identifier of the agency associated with the ledger. Value is mandatory and is set programmatically based on the user's login. -
BaseCurrency(optional):
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(optional):
string
Title:
Created By
Maximum Length:64
The user who created the ledger. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date and time the ledger was created. -
EnabledFlag(optional):
boolean
Title:
Enabled
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(optional):
string(date-time)
Title:
Last Updated Date
The date and time the ledger was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The user who last updated the ledger. -
LedgerDescription(optional):
string
Title:
Description
Maximum Length:240
The description of the ledger. -
LedgerId(optional):
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(optional):
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(optional):
array Items
Title:
Items
Link Relations
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 : publicSectorLedgers-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
Title:
Agency ID
The unique identifier of the agency associated with the ledger. Value is mandatory and is set programmatically based on the user's login. -
BaseCurrency(optional):
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(optional):
string
Title:
Created By
Maximum Length:64
The user who created the ledger. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date and time the ledger was created. -
EnabledFlag(optional):
boolean
Title:
Enabled
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(optional):
string(date-time)
Title:
Last Updated Date
The date and time the ledger was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The user who last updated the ledger. -
LedgerDescription(optional):
string
Title:
Description
Maximum Length:240
The description of the ledger. -
LedgerId(optional):
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(optional):
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(optional):
array Items
Title:
Items
Link Relations
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.