Get a ledger
get
/fscmRestApi/resources/11.13.18.05/publicSectorLedgers/{publicSectorLedgersUniqID}
Request
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>
Query Parameters
-
dependency: string
This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes 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 attributes 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 attributes. 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 attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes 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 attributes. 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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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.