Get a USSGL account
get
/fscmRestApi/resources/11.13.18.05/fedUSSGLAccounts/{AccountId}
Request
Path Parameters
-
AccountId(required): integer(int64)
Unique identifier for the U.S. Standard General Ledger account.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields 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 fields 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 fields. 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 fields. Only the specified fields are returned, which means that if no fields are specified, no fields 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 fields. 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 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
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.
Root Schema : fedUSSGLAccounts-item-response
Type:
Show Source
object
-
Account: string
Title:
Account
Maximum Length:6
A six-digit number used to identify a specific U.S. Standard General Ledger account. The U.S. Standard General Ledger account must be in the U.S. Standard General Ledger chart of accounts. -
AccountDescription: string
Title:
Description
Maximum Length:240
Description of the U.S. Standard General Ledger account. -
AccountId: integer
(int64)
Unique identifier for the U.S. Standard General Ledger account.
-
AccountType: string
Title:
Budget Spending Type
Maximum Length:80
Identifies whether a U.S. Standard General Ledger account is commitment, obligation, or expenditure account. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Read Only:
true
The date when the record was created. -
DataActReporting: string
Title:
DATA Act Reporting
Maximum Length:80
Identifies a U.S. Standard General Ledger account as Data Act reportable. -
Enabled: string
Title:
Enabled
Maximum Length:80
Indicates whether an account is active or inactive. -
fedUSSGLAccountAttributes: array
Federal USSGL Account Attributes
Title:
Federal USSGL Account Attributes
The federal USSGL account attributes enables users to define and manage the federal USSGL account attributes. -
fedUSSGLAccountDFF: array
Federal USSGL Accounts Descriptive Flexfields
Title:
Federal USSGL Accounts Descriptive Flexfields
The federal USSGL accounts descriptive flexfields resource manages details about the descriptive flexfield references for a USSGL account. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The session login associated with the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NormalBalance: string
Title:
Normal Balance
Maximum Length:80
Identifies the normal balance of a U.S. Standard General Ledger account as a debit or credit.
Nested Schema : Federal USSGL Account Attributes
Type:
array
Title:
Federal USSGL Account Attributes
The federal USSGL account attributes enables users to define and manage the federal USSGL account attributes.
Show Source
Nested Schema : Federal USSGL Accounts Descriptive Flexfields
Type:
array
Title:
Federal USSGL Accounts Descriptive Flexfields
The federal USSGL accounts descriptive flexfields resource manages details about the descriptive flexfield references for a USSGL account.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : fedUSSGLAccounts-fedUSSGLAccountAttributes-item-response
Type:
Show Source
object
-
Account: string
Title:
Account
Maximum Length:255
The account of the federal USSGL account attribute. -
AccountAttributeValueCodeEight: string
Title:
Account Attribute Value 8
Maximum Length:30
The eighth account attribute value code of the federal USSGL account attribute. -
AccountAttributeValueCodeEighteen: string
Title:
Account Attribute Value 18
Maximum Length:30
The 18th account attribute value code of the federal USSGL account attribute. -
AccountAttributeValueCodeEleven: string
Title:
Account Attribute Value 11
Maximum Length:30
The 11th account attribute value code of the federal USSGL account attribute. -
AccountAttributeValueCodeFifteen: string
Title:
Account Attribute Value 15
Maximum Length:30
The 15th account attribute value code of the federal USSGL account attribute. -
AccountAttributeValueCodeFive: string
Title:
Account Attribute Value 5
Maximum Length:30
The fifth account attribute value code of the federal USSGL account attribute. -
AccountAttributeValueCodeFour: string
Title:
Account Attribute Value 4
Maximum Length:30
The fourth account attribute value code of the federal USSGL account attribute. -
AccountAttributeValueCodeFourteen: string
Title:
Account AttributeValue14
Maximum Length:30
The 14th account attribute value code of the federal USSGL account attribute. -
AccountAttributeValueCodeNine: string
Title:
Account Attribute Value 9
Maximum Length:30
The ninth account attribute value code of the federal USSGL account attribute. -
AccountAttributeValueCodeNineteen: string
Title:
Account Attribute Value 19
Maximum Length:30
The 19th account attribute value code of the federal USSGL account attribute. -
AccountAttributeValueCodeOne: string
Title:
Account Attribute Value 1
Maximum Length:30
The first account attribute value code of the federal USSGL account attribute. -
AccountAttributeValueCodeSeven: string
Title:
Account Attribute Value 7
Maximum Length:30
The seventh account attribute value code of the federal USSGL account attribute. -
AccountAttributeValueCodeSeventeen: string
Title:
Account Attribute Value 17
Maximum Length:30
The 17th account attribute value code of the federal USSGL account attribute. -
AccountAttributeValueCodeSix: string
Title:
Account Attribute Value 6
Maximum Length:30
The sixth account attribute value code of the federal USSGL account attribute. -
AccountAttributeValueCodeSixteen: string
Title:
Account Attribute Value16
Maximum Length:30
The 16th account attribute value code of the federal USSGL account attribute. -
AccountAttributeValueCodeTen: string
Title:
Account Attribute Value 10
Maximum Length:30
The 10th account attribute value code of the federal USSGL account attribute. -
AccountAttributeValueCodeThirteen: string
Title:
Account Attribute Value 13
Maximum Length:30
The 13th account attribute value code of the federal USSGL account attribute. -
AccountAttributeValueCodeThree: string
Title:
Account Attribute Value 3
Maximum Length:30
The third account attribute value code of the federal USSGL account attribute. -
AccountAttributeValueCodeTwelve: string
Title:
Account Attribute Value 12
Maximum Length:30
The 12th account attribute value code of the federal USSGL account attribute. -
AccountAttributeValueCodeTwenty: string
Title:
Account Attribute Value 20
Maximum Length:30
The 20th account attribute value code of the federal USSGL account attribute. -
AccountAttributeValueCodeTwo: string
Title:
Account Attribute Value 2
Maximum Length:30
The second account attribute value code of the federal USSGL account attribute. -
AttributeName: string
Title:
Attribute Name
Maximum Length:255
Attribute name of the federal USSGL account attribute. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
USSGLAccountAttributeId: integer
(int64)
Title:
USSGL Account Attribute ID
Unique identifier of the federal USSGL account attribute.
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.
Nested Schema : fedUSSGLAccounts-fedUSSGLAccountDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context
Maximum Length:150
Descriptive flexfield context. -
__FLEX_Context_DisplayValue: string
Title:
Context
Descriptive flexfield context display value. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
UssglAccountId: integer
(int64)
Unique identifier for the U.S. Standard General Ledger account.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- fedUSSGLAccountAttributes
-
Operation: /fscmRestApi/resources/11.13.18.05/fedUSSGLAccounts/{AccountId}/child/fedUSSGLAccountAttributesParameters:
- AccountId:
$request.path.AccountId
The federal USSGL account attributes enables users to define and manage the federal USSGL account attributes. - AccountId:
- fedUSSGLAccountDFF
-
Parameters:
- AccountId:
$request.path.AccountId
The federal USSGL accounts descriptive flexfields resource manages details about the descriptive flexfield references for a USSGL account. - AccountId:
Examples
The following example shows how to retrieve a USSGL account by submitting a GET request on the REST resource using cURL.
curl -i -u "<username>:<password>" -H "Content-Type: application/json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedUSSGLAccounts/300100181825407
Example Response Body
The following example shows the contents of the response body in JSON format:
{ "AccountId": 300100181825407, "Account": "929999", "AccountDescription": "USSGL test", "NormalBalance": "Debit SGL account type", "AccountType": "Obligations", "DataActReporting": "A Appropriations, B Object Program, C Award", "Enabled": "Yes", "CreatedBy": "FIN_USER1", "CreationDate": "2019-11-24T22:22:26.002+00:00", "LastUpdatedBy": "FIN_USER1", "LastUpdateDate": "2019-11-24T22:22:26.111+00:00", "LastUpdateLogin": "982665196B8168D8E053A732C40A0B08", "links": [ { "rel": "self", "href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedUSSGLAccounts/300100181825407", "name": "fedUSSGLAccounts", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedUSSGLAccounts/300100181825407", "name": "fedUSSGLAccounts", "kind": "item" }, { "rel": "child", "href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedUSSGLAccounts/300100181825407/child/fedUSSGLAccountDFF", "name": "fedUSSGLAccountDFF", "kind": "collection" } ] }