Get a budget transaction type
get
/fscmRestApi/resources/11.13.18.05/fedBudgetTransactionTypes/{TransactionTypeId}
Request
Path Parameters
-
TransactionTypeId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
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 : fedBudgetTransactionTypes-item-response
Type:
Show Source
object
-
AnticipatedInCurrentFy: string
Title:
Anticipated
Maximum Length:255
Indicates that the transaction is expected or anticipated to occur in the current fiscal year. -
ApportionmentCategory: string
Title:
Apportionment Category Code
Maximum Length:255
Apportionment category code of the budget transaction type. -
BudgetLevel: string
Title:
Budget Level
Budget level of the budget transaction type. -
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. -
Description: string
Title:
Description
Maximum Length:240
Description of the budget transaction type. -
DirectOrReimbursable: string
Title:
Direct or Reimbursable Code
Maximum Length:255
The direct or reimbursable value of the budget transaction type. -
Enabled: string
Title:
Enabled
Indicates whether the budget transaction type is enabled or not. -
fedBudgetTransactionTypeAccounts: array
Federal Budget Transaction Type Accounts
Title:
Federal Budget Transaction Type Accounts
The budget transaction type accounts resource is used to query, create, and update budget transaction type accounts. -
fedBudgetTransactionTypeDFF: array
fedBudgetTransactionTypeDFF
-
FederalGroup: string
Title:
Federal Group
Federal group associated with the budget transaction type. -
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 last user login that was used to update the record. -
LedgerName: string
Title:
Ledger Name
Maximum Length:255
Ledger name used for the transaction type. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Title:
Transaction Type
Maximum Length:30
Name of the budget transaction type. -
TransactionTypeId: integer
(int64)
Title:
Transaction Type ID
The unique identifier of the transaction type associated with the budget transaction type.
Nested Schema : Federal Budget Transaction Type Accounts
Type:
array
Title:
Federal Budget Transaction Type Accounts
The budget transaction type accounts resource is used to query, create, and update budget transaction type accounts.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : fedBudgetTransactionTypes-fedBudgetTransactionTypeAccounts-item-response
Type:
Show Source
object
-
AccountAssignmentId: integer
(int64)
The unique identifier of the account assignment associated with the budget transaction type 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. -
CreditAccount: string
Title:
Credit
Maximum Length:25
Credit account of the budget transaction type account. -
CreditAccountDescription: string
Title:
Description
Description of the credit account associated with the budget transaction type account. -
DebitAccount: string
Title:
Debit
Maximum Length:25
Debit account of the budget transaction type account. -
DebitAccountDescription: string
Title:
Description
Description of the debit account associated with the budget transaction type account. -
fedBudgetTransactionAccountDFF: array
fedBudgetTransactionAccountDFF
-
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 last user login that was used to update the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : fedBudgetTransactionTypes-fedBudgetTransactionTypeAccounts-fedBudgetTransactionAccountDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:150
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
AccountAssignmentId: integer
(int64)
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
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 : fedBudgetTransactionTypes-fedBudgetTransactionTypeDFF-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. -
TransactionTypeId: integer
(int64)
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- fedBudgetTransactionTypeAccounts
-
Parameters:
- TransactionTypeId:
$request.path.TransactionTypeId
The budget transaction type accounts resource is used to query, create, and update budget transaction type accounts. - TransactionTypeId:
- fedBudgetTransactionTypeDFF
-
Parameters:
- TransactionTypeId:
$request.path.TransactionTypeId
- TransactionTypeId:
Examples
The following example shows how to retrieve a budget transaction type 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/fedBudgetTransactionTypes/300100543686962
Example Response Body
The following example shows the contents of the response body in JSON format:
{ "TransactionTypeId": 300100543686962, "Name": "Safety BTT", "FederalGroup": "Safety Group", "Description": "Safety Budget Transaction Types Description", "BudgetLevel": "Allocation", "AuthorityType": null, "CloseBudget": "No", "RequireTradingPartner": "No", "RequireReductionType": "No", "Enabled": "Yes", "CreatedBy": "FEDERAL", "CreationDate": "2021-07-19T10:19:52.003+00:00", "LastUpdatedBy": "FEDERAL", "LastUpdateDate": "2021-07-19T10:19:52.063+00:00", "LastUpdateLogin": "C5EC832E773A926AE053BB28F70A7FB0", "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedBudgetTransactionTypes/300100543686962", "name": "fedBudgetTransactionTypes", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedBudgetTransactionTypes/300100543686962", "name": "fedBudgetTransactionTypes", "kind": "item" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedBudgetTransactionTypes/300100543686962/child/fedBudgetTransactionTypeAccounts", "name": "fedBudgetTransactionTypeAccounts", "kind": "collection" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedBudgetTransactionTypes/300100543686962/child/fedBudgetTransactionTypeDFF", "name": "fedBudgetTransactionTypeDFF", "kind": "collection" } ] }