Get all federal GTAS accumulation balances
get
/fscmRestApi/resources/11.13.18.05/fedGTASAccumulationBalances
Request
Query Parameters
-
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 -
finder: string
Used as a predefined finder to search the collection.
Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables- PrimaryKey Finds the federal GTAS accumulation balance that matches the specified primary key criteria.
Finder Variables- TransactionBalanceId; integer; The unique identifier of the federal GTAS accumulation balances.
- PrimaryKey Finds the federal GTAS accumulation balance that matches the specified primary key criteria.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
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 -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- AccountCombination; string; Account combination of the federal GTAS accumulation balances.
- AgencyIdentifier; string; Agency identifier of the federal GTAS accumulation balances.
- AllocationTransferAgencyId; string; The unique identifier of allocation transfer agency of the federal GTAS accumulation balances.
- Amount; integer; Amount of the federal GTAS accumulation balances.
- ApportionmentCategoryBProgramCode; string; Apportionment category B program code of the federal GTAS accumulation balances.
- ApportionmentCategoryCode; string; Apportionment category code of the federal GTAS accumulation balances.
- AuthorityDurationCode; string; Authority duration code of the federal GTAS accumulation balances.
- AuthorityTypeCode; string; Authority type code of the federal GTAS accumulation balances.
- AvailabilityTimeIndicator; string; Availability time indicator of the federal GTAS accumulation balances.
- BEACategoryCode; string; BEA category code of the federal GTAS accumulation balances.
- BalanceType; string; Balance type of the federal GTAS accumulation balances.
- BeginningPeriodOfAvailability; string; Beginning period of availability of the federal GTAS accumulation balances.
- BorrowingSourceCode; string; Borrowing source code of the federal GTAS accumulation balances.
- BudgetObjectClass; string; Budget object class of the federal GTAS accumulation balances.
- BudgetaryImpactIndicator; string; Budgetary impact indicator of the federal GTAS accumulation balances.
- CreatedBy; string; The user who created the record.
- CreationDate; string; The date when the record was created.
- CreditCohortYear; string; Credit cohort year of the federal GTAS accumulation balances.
- CustodialOrNonCustodialCode; string; Custodial or noncustodial code of the federal GTAS accumulation balances.
- DebitCreditIndicator; string; Debit credit indicator of the federal GTAS accumulation balances.
- DisasterEmergencyFundCode; string; Disaster emergency fund code of the federal GTAS accumulation balances.
- EndingPeriodOfAvailability; string; Ending period of availability of the federal GTAS accumulation balances.
- ExchangeOrNonexchangeCode; string; Exchange or nonexchange code of the federal GTAS accumulation balances.
- FederalOrNonFederalCode; string; Federal or nonfederal code of the federal GTAS accumulation balances.
- LastUpdateDate; string; The date when the record was last updated.
- LastUpdatedBy; string; The session login associated with the user who last updated the record.
- Ledger; string; Ledger of the federal GTAS accumulation balances.
- MainAccountCode; string; Main account code of the federal GTAS accumulation balances.
- NormalBalance; string; Normal balance of the federal GTAS accumulation balances.
- Period; string; Period of the federal GTAS accumulation balances.
- PriorYearAdjustmentCode; string; Prior year adjustment code of the federal GTAS accumulation balances.
- ProgramReportCategoryCode; string; Program report category code of the federal GTAS accumulation balances.
- ReductionType; string; Reduction type of the federal GTAS accumulation balances.
- ReimbursableIndicator; string; Reimbursable indicator of the federal GTAS accumulation balances.
- SubAccountCode; string; Subaccount code of the federal GTAS accumulation balances.
- TradingPartnerAgencyIdentifier; string; Trading partner agency identifier of the federal GTAS accumulation balances.
- TradingPartnerMainAccountCode; string; Trading partner main account code of the federal GTAS accumulation balances.
- TransactionBalanceId; integer; The unique identifier of transaction balance of the federal GTAS accumulation balances.
- USSGLAccount; string; USSGL account of the federal GTAS accumulation balances.
- YearofBudgetAuthorityIndicator; string; Year of budget authority indicator of the federal GTAS accumulation balances.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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 : fedGTASAccumulationBalances
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : fedGTASAccumulationBalances-item-response
Type:
Show Source
object
-
AccountCombination: string
Title:
Account Combination
Read Only:true
Maximum Length:255
Account combination of the federal GTAS accumulation balances. -
AgencyIdentifier: string
Title:
Agency Identifier
Read Only:true
Agency identifier of the federal GTAS accumulation balances. -
AllocationTransferAgencyId: string
Title:
Allocation Transfer Agency Id
Read Only:true
Maximum Length:3
The unique identifier of allocation transfer agency of the federal GTAS accumulation balances. -
Amount: integer
(int64)
Title:
Amount
Read Only:true
Amount of the federal GTAS accumulation balances. -
ApportionmentCategoryBProgramCode: string
Title:
Apportionment Category B Program Code
Read Only:true
Maximum Length:255
Apportionment category B program code of the federal GTAS accumulation balances. -
ApportionmentCategoryCode: string
Title:
Apportionment Category Code
Read Only:true
Maximum Length:255
Apportionment category code of the federal GTAS accumulation balances. -
AuthorityDurationCode: string
Title:
Authority Duration Code
Read Only:true
Maximum Length:255
Authority duration code of the federal GTAS accumulation balances. -
AuthorityTypeCode: string
Title:
Authority Type Code
Read Only:true
Maximum Length:255
Authority type code of the federal GTAS accumulation balances. -
AvailabilityTimeIndicator: string
Title:
Availability Time Indicator
Read Only:true
Maximum Length:255
Availability time indicator of the federal GTAS accumulation balances. -
BalanceType: string
Title:
Balance Type
Read Only:true
Maximum Length:255
Balance type of the federal GTAS accumulation balances. -
BEACategoryCode: string
Title:
BEA Category Code
Read Only:true
Maximum Length:255
BEA category code of the federal GTAS accumulation balances. -
BeginningPeriodOfAvailability: string
Title:
Beginning Period of Availability
Read Only:true
Maximum Length:4
Beginning period of availability of the federal GTAS accumulation balances. -
BorrowingSourceCode: string
Title:
Borrowing Source Code
Read Only:true
Maximum Length:255
Borrowing source code of the federal GTAS accumulation balances. -
BudgetaryImpactIndicator: string
Title:
Budgetary Impact Indicator
Read Only:true
Maximum Length:255
Budgetary impact indicator of the federal GTAS accumulation balances. -
BudgetObjectClass: string
Title:
Budget Object Class
Read Only:true
Maximum Length:30
Budget object class of the federal GTAS accumulation balances. -
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. -
CreditCohortYear: string
Title:
Credit Cohort Year
Read Only:true
Maximum Length:25
Credit cohort year of the federal GTAS accumulation balances. -
CustodialOrNonCustodialCode: string
Title:
Custodial or NonCustodial Code
Read Only:true
Maximum Length:255
Custodial or noncustodial code of the federal GTAS accumulation balances. -
DebitCreditIndicator: string
Title:
Debit Credit Indicator
Read Only:true
Maximum Length:255
Debit credit indicator of the federal GTAS accumulation balances. -
DisasterEmergencyFundCode: string
Title:
Disaster Emergency Fund Code
Read Only:true
Maximum Length:255
Disaster emergency fund code of the federal GTAS accumulation balances. -
EndingPeriodOfAvailability: string
Title:
Ending Period of Availability
Read Only:true
Maximum Length:4
Ending period of availability of the federal GTAS accumulation balances. -
ExchangeOrNonexchangeCode: string
Title:
Exchange or NonExchange Code
Read Only:true
Maximum Length:255
Exchange or nonexchange code of the federal GTAS accumulation balances. -
FederalOrNonFederalCode: string
Title:
Federal or NonFederal Code
Read Only:true
Maximum Length:255
Federal or nonfederal code of the federal GTAS accumulation balances. -
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 session login associated with the user who last updated the record. -
Ledger: string
Title:
Ledger
Read Only:true
Maximum Length:255
Ledger of the federal GTAS accumulation balances. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MainAccountCode: string
Title:
Main Account Code
Read Only:true
Main account code of the federal GTAS accumulation balances. -
NormalBalance: string
Title:
Normal Balance
Read Only:true
Maximum Length:255
Normal balance of the federal GTAS accumulation balances. -
Period: string
Title:
Period
Read Only:true
Maximum Length:15
Period of the federal GTAS accumulation balances. -
PriorYearAdjustmentCode: string
Title:
Prior Year Adjustment Code
Read Only:true
Maximum Length:255
Prior year adjustment code of the federal GTAS accumulation balances. -
ProgramReportCategoryCode: string
Title:
Program Report Category Code
Read Only:true
Maximum Length:255
Program report category code of the federal GTAS accumulation balances. -
ReductionType: string
Title:
Reduction Type
Read Only:true
Maximum Length:255
Reduction type of the federal GTAS accumulation balances. -
ReimbursableIndicator: string
Title:
Reimbursable Indicator
Read Only:true
Maximum Length:255
Reimbursable indicator of the federal GTAS accumulation balances. -
SubAccountCode: string
Title:
SubAccount Code
Read Only:true
Maximum Length:30
Subaccount code of the federal GTAS accumulation balances. -
TradingPartnerAgencyIdentifier: string
Title:
Trading Partner Agency Identifier
Read Only:true
Maximum Length:3
Trading partner agency identifier of the federal GTAS accumulation balances. -
TradingPartnerMainAccountCode: string
Title:
Trading Partner Main Account Code
Read Only:true
Maximum Length:4
Trading partner main account code of the federal GTAS accumulation balances. -
TransactionBalanceId: integer
(int64)
Title:
Transaction Balance ID
Read Only:true
The unique identifier of transaction balance of the federal GTAS accumulation balances. -
USSGLAccount: string
Title:
USSGL Account
Read Only:true
Maximum Length:6
USSGL account of the federal GTAS accumulation balances. -
YearofBudgetAuthorityIndicator: string
Title:
Year of Budget Authority Indicator
Read Only:true
Maximum Length:255
Year of budget authority indicator of the federal GTAS accumulation balances.
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.
Examples
The following example shows how to retrieve all federal GTAS accumulation balances 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/fedGTASAccumulationBalances
Response Body Example
The following shows an example of the response body in JSON format.
{ "items": [ { "TransactionBalanceId": "100104536405438", "Ledger": "USFederal4 US", "USSGLAccount": "211000", "AccountCombination": "FED20240108DA-0-0-0-0-21100001-2023-2023-2023-0-0", "NormalBalance": null, "BalanceType": null, "Period": "15_Sep-23", "Amount": "6000", "ApportionmentCategoryBProgramCode": null, "ApportionmentCategoryCode": null, "AuthorityTypeCode": null, "AvailabilityTimeIndicator": null, "BEACategoryCode": null, "BorrowingSourceCode": null, "BudgetaryImpactIndicator": null, "BudgetObjectClass": null, "CreditCohortYear": null, "CustodialOrNonCustodialCode": "Non-Custodial", "DebitCreditIndicator": "Debit account type", "DisasterEmergencyFundCode": null, "ExchangeOrNonexchangeCode": null, "FederalOrNonFederalCode": null, "PriorYearAdjustmentCode": null, "ProgramReportCategoryCode": null, "ReductionType": null, "ReimbursableIndicator": null, "TradingPartnerAgencyIdentifier": "099", "TradingPartnerMainAccountCode": "0000", "YearofBudgetAuthorityIndicator": null, "AgencyIdentifier": null, "MainAccountCode": null, "SubAccountCode": "000", "AuthorityDurationCode": "Annual", "AllocationTransferAgencyId": "111", "BeginYearOfAvailability": "2024", "EndPeriodOfAvailability": "2024", "CreatedBy": "username", "CreationDate": "2023-12-27T10:24:41+00:00", "LastUpdatedBy": "username", "LastUpdateDate": "2023-12-27T10:24:41+00:00", "@context": { "key": "100104536405438", "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedGTASAccumulationBalances/100104536405438", "name": "fedGTASAccumulationBalances", "kind": "item" }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedGTASAccumulationBalances/100104536405438", "name": "fedGTASAccumulationBalances", "kind": "item" } ] } }, { "TransactionBalanceId": "100104536405440", "Ledger": "USFederal4 US", "USSGLAccount": "211000", "AccountCombination": "FED20240108DA-0-0-0-0-21100001-2024-2024-2024-0-0", "NormalBalance": null, "BalanceType": null, "Period": "15_Sep-23", "Amount": "22000", "ApportionmentCategoryBProgramCode": null, "ApportionmentCategoryCode": null, "AuthorityTypeCode": null, "AvailabilityTimeIndicator": null, "BEACategoryCode": null, "BorrowingSourceCode": null, "BudgetaryImpactIndicator": null, "BudgetObjectClass": null, "CreditCohortYear": null, "CustodialOrNonCustodialCode": "Non-Custodial", "DebitCreditIndicator": "Credit account type", "DisasterEmergencyFundCode": null, "ExchangeOrNonexchangeCode": null, "FederalOrNonFederalCode": null, "PriorYearAdjustmentCode": null, "ProgramReportCategoryCode": null, "ReductionType": null, "ReimbursableIndicator": null, "TradingPartnerAgencyIdentifier": "099", "TradingPartnerMainAccountCode": "0000", "YearofBudgetAuthorityIndicator": null, "AgencyIdentifier": null, "MainAccountCode": null, "SubAccountCode": "000", "AuthorityDurationCode": "Annual", "AllocationTransferAgencyId": "111", "BeginYearOfAvailability": "2024", "EndPeriodOfAvailability": "2024", "CreatedBy": "username", "CreationDate": "2023-12-27T10:24:41+00:00", "LastUpdatedBy": "username", "LastUpdateDate": "2023-12-27T10:24:41+00:00", "@context": { "key": "100104536405440", "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedGTASAccumulationBalances/100104536405440", "name": "fedGTASAccumulationBalances", "kind": "item" }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedGTASAccumulationBalances/100104536405440", "name": "fedGTASAccumulationBalances", "kind": "item" } ] } }, { "TransactionBalanceId": "100104536405434", "Ledger": "USFederal4 US", "USSGLAccount": "445000", "AccountCombination": "H075180118DA-0-111-0-0-44500001-2018-2018-2018-0-0", "NormalBalance": null, "BalanceType": null, "Period": "15_Sep-23", "Amount": "12400", "ApportionmentCategoryBProgramCode": null, "ApportionmentCategoryCode": null, "AuthorityTypeCode": null, "AvailabilityTimeIndicator": null, "BEACategoryCode": "Discretionary", "BorrowingSourceCode": null, "BudgetaryImpactIndicator": null, "BudgetObjectClass": null, "CreditCohortYear": "2018", "CustodialOrNonCustodialCode": null, "DebitCreditIndicator": "Credit account type", "DisasterEmergencyFundCode": null, "ExchangeOrNonexchangeCode": null, "FederalOrNonFederalCode": null, "PriorYearAdjustmentCode": "Adjustment to prior-year reporting - backdated", "ProgramReportCategoryCode": null, "ReductionType": null, "ReimbursableIndicator": "Reimbursable", "TradingPartnerAgencyIdentifier": null, "TradingPartnerMainAccountCode": null, "YearofBudgetAuthorityIndicator": null, "AgencyIdentifier": null, "MainAccountCode": null, "SubAccountCode": "000", "AuthorityDurationCode": "Multi-year", "AllocationTransferAgencyId": "123", "BeginYearOfAvailability": "2019", "EndPeriodOfAvailability": "2024", "CreatedBy": "username", "CreationDate": "2023-12-27T10:24:41+00:00", "LastUpdatedBy": "username", "LastUpdateDate": "2023-12-27T10:24:41+00:00", "@context": { "key": "100104536405434", "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedGTASAccumulationBalances/100104536405434", "name": "fedGTASAccumulationBalances", "kind": "item" }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedGTASAccumulationBalances/100104536405434", "name": "fedGTASAccumulationBalances", "kind": "item" } ] } } ], "count": 3, "hasMore": true, "limit": 3, "offset": 0, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedGTASAccumulationBalances", "name": "fedGTASAccumulationBalances", "kind": "collection" } ] }