Get all treasury account symbols
get
/fscmRestApi/resources/11.13.18.05/fedTreasuryAccountSymbols
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 treasury account symbol that matches the primary key specified.
Finder Variables- TreasuryAccountSymbolId; integer; Unique identifier for the treasury account symbol.
- PrimaryKey Finds the treasury account symbol that matches the primary key specified.
-
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:- AgencyIdentifier; string; Agency identifier of the treasury account symbol.
- AgencyType; string; Agency type of the treasury account symbol.
- AllocationTransferAgency; string; Allocation transfer agency of the treasury account symbol.
- AllowPriorYearAccounting; string; Indicates whether the prior year accounting will happen for the treasury account symbol.
- AuthorityDuration; string; Authority duration of the treasury account symbol.
- AvailabilityType; string; Availability type of the treasury account symbol.
- BeginYearOfAvailability; string; Beginning year of availability of the treasury account symbol.
- CancellationDate; string; Cancellation date of the treasury account symbol.
- CopyTAS; string; Indicates whether the TAS information of the treasury account symbol will be copied to the next year.
- CreatedBy; string; The user who created the record.
- CreationDate; string; The date when the record was created.
- EndDate; string; End date of the treasury account symbol.
- EndingPeriodOfAvailability; string; Ending period of availability of the treasury account symbol.
- ExpirationDate; string; Expiration date of the treasury account symbol.
- FedAccountSymbolId; integer; Unique code of federal account symbol.
- FederalAccountSymbol; string; Federal account symbol of the treasury account symbol.
- FinancingAccount; string; Financing account of the treasury account symbol.
- FundType; string; Fund type of the treasury account symbol.
- LastUpdateDate; string; The date when the record was last updated.
- LastUpdateLogin; string; The last user login that was used to update the record.
- LastUpdatedBy; string; The user who last updated the record.
- MainAccountCode; string; Main account code of the treasury account symbol.
- ReportingType; string; Reporting type of the treasury account symbol.
- StartDate; string; Start date of the treasury account symbol.
- SubAccountCode; string; Subaccount code of the treasury account symbol.
- SubLevelPrefixCode; string; Sublevel prefix code of the treasury account symbol.
- TreasuryAccountSymbol; string; Name of the treasury account symbol.
- TreasuryAccountSymbolId; integer; Unique identifier for the treasury account symbol.
-
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 : fedTreasuryAccountSymbols
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 : fedTreasuryAccountSymbols-item-response
Type:
Show Source
object
-
AgencyIdentifier: string
Title:
Agency Identifier
Agency identifier of the treasury account symbol. -
AgencyType: string
Title:
Agency Type
Read Only:true
Agency type of the treasury account symbol. -
AllocationTransferAgency: string
Title:
Allocation Transfer Agency Identifier
Maximum Length:3
Allocation transfer agency of the treasury account symbol. -
AllowPriorYearAccounting: string
Title:
Allow Prior Year Accounting
Indicates whether the prior year accounting will happen for the treasury account symbol. -
AuthorityDuration: string
Title:
Authority Duration Code
Authority duration of the treasury account symbol. -
AvailabilityType: string
Title:
Availability Type Code
Read Only:true
Availability type of the treasury account symbol. -
BeginYearOfAvailability: string
Title:
Beginning Period of Availability
Maximum Length:4
Beginning year of availability of the treasury account symbol. -
CancellationDate: string
(date)
Title:
Cancellation Date
Cancellation date of the treasury account symbol. -
CopyTAS: string
Title:
Copy TAS to next year
Indicates whether the TAS information of the treasury account symbol will be copied to the next year. -
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. -
EndDate: string
(date)
Title:
End Date
End date of the treasury account symbol. -
EndingPeriodOfAvailability: string
Title:
Ending Period of Availability
Maximum Length:4
Ending period of availability of the treasury account symbol. -
ExpirationDate: string
(date)
Title:
Expiration Date
Expiration date of the treasury account symbol. -
FedAccountSymbolId: integer
(int64)
Title:
Federal Account Symbol ID
Unique code of federal account symbol. -
FederalAccountSymbol: string
Title:
Federal Account Symbol
Federal account symbol of the treasury account symbol. -
fedTASBusinessEventTypeCodes: array
Federal Treasury Account Symbols Business Event Type Codes
Title:
Federal Treasury Account Symbols Business Event Type Codes
The federal treasury account symbols business event type codes resource manages the business event type code references, or BETC references, for a treasury account symbol, or TAS. -
fedTreasuryAccountSymbolDFF: array
fedTreasuryAccountSymbolDFF
-
FinancingAccount: string
Title:
Financing Account Code
Financing account of the treasury account symbol. -
FundType: string
Title:
Fund Type
Fund type of the treasury account symbol. -
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. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The last user login that was used to update the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MainAccountCode: string
Title:
Main Account Code
Main account code of the treasury account symbol. -
ReportingType: string
Title:
Reporting
Reporting type of the treasury account symbol. -
StartDate: string
(date)
Title:
Start Date
Start date of the treasury account symbol. -
SubAccountCode: string
Title:
Sub-Account Code
Maximum Length:3
Default Value:000
Subaccount code of the treasury account symbol. -
SubLevelPrefixCode: string
Title:
Sub-Level Prefix
Maximum Length:2
Sublevel prefix code of the treasury account symbol. -
TreasuryAccountSymbol: string
Title:
Treasury Account Symbol
Maximum Length:35
Default Value:Name of the treasury account symbol. -
TreasuryAccountSymbolId: integer
(int64)
Title:
Treasury Account Symbol ID
Unique identifier for the treasury account symbol.
Nested Schema : Federal Treasury Account Symbols Business Event Type Codes
Type:
array
Title:
Federal Treasury Account Symbols Business Event Type Codes
The federal treasury account symbols business event type codes resource manages the business event type code references, or BETC references, for a treasury account symbol, or TAS.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : fedTreasuryAccountSymbols-fedTASBusinessEventTypeCodes-item-response
Type:
Show Source
object
-
AdjustmentBETC: string
Title:
Adjustment BETC
Read Only:true
Maximum Length:8
Adjustment BETC of the treasury account symbol business event type code. -
BusinessEventTypeCode: string
Title:
Business Event Type Codes
Maximum Length:8
Code of the treasury account symbol business event type code. -
BusinessEventTypeName: string
Title:
Business Event Type Name
Read Only:true
Maximum Length:100
Name of the treasury account symbol business event type code. -
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. -
fedTASBusinessEventTypeCodeDFF: array
fedTASBusinessEventTypeCodeDFF
-
FundingDerivationType: string
Title:
Funding Derivation Type
Read Only:true
Type of funding derivation associated with the adjustment business event type codes list of values. The valid values are Derived from General Fund, Not Derived from General Fund. -
IsDefault: string
Title:
Default
Indicates whether the treasury account symbol business event type code is default. -
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. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The last user login that was used to update the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PaymentOrCollection: string
Title:
Payment or Collection
Read Only:true
Maximum Length:255
Indicates whether the treasury account symbol BETC is a payment or collection type. -
TasBetcMapId: integer
(int64)
Title:
TAS BETC Map ID
Identifies the TAS BETC mapping of the treasury account symbol business event type code. -
TreasuryAccountSymbolId: integer
(int64)
Title:
Treasury Account Symbol ID
Read Only:true
Unique identifier for the treasury account symbol business event type code.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : fedTreasuryAccountSymbols-fedTASBusinessEventTypeCodes-fedTASBusinessEventTypeCodeDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:150
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
TasBetcMapId: integer
(int64)
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 : fedTreasuryAccountSymbols-fedTreasuryAccountSymbolDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:150
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
TreasuryAccountSymbolId: integer
(int64)
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source