Update a budget transaction type
patch
/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=
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object-
AnticipatedInCurrentFy: string
Title:
AnticipatedMaximum Length:255Indicates that the transaction is expected or anticipated to occur in the current fiscal year. -
ApportionmentCategory: string
Title:
Apportionment Category CodeMaximum Length:255Apportionment category code of the budget transaction type. -
BudgetLevel: string
Title:
Budget LevelBudget level of the budget transaction type. -
Description: string
Title:
DescriptionMaximum Length:240Description of the budget transaction type. -
DirectOrReimbursable: string
Title:
Direct or Reimbursable CodeMaximum Length:255The direct or reimbursable value of the budget transaction type. -
Enabled: string
Title:
EnabledIndicates whether the budget transaction type is enabled or not. -
fedBudgetTransactionTypeAccounts: array
Federal Budget Transaction Type Accounts
Title:
Federal Budget Transaction Type AccountsThe budget transaction type accounts resource is used to query, create, and update budget transaction type accounts. -
fedBudgetTransactionTypeDFF: array
fedBudgetTransactionTypeDFF
-
FederalGroup: string
Title:
Federal GroupFederal group associated with the budget transaction type. -
LedgerName: string
Title:
Ledger NameMaximum Length:255Ledger name used for the transaction type. -
Name: string
Title:
Transaction TypeMaximum Length:30Name of the budget transaction type.
Nested Schema : Federal Budget Transaction Type Accounts
Type:
arrayTitle:
Federal Budget Transaction Type AccountsThe budget transaction type accounts resource is used to query, create, and update budget transaction type accounts.
Show Source
Nested Schema : fedBudgetTransactionTypes-fedBudgetTransactionTypeAccounts-item-patch-request
Type:
Show Source
object-
CreditAccount: string
Title:
CreditMaximum Length:25Credit account of the budget transaction type account. -
CreditAccountDescription: string
Title:
DescriptionDescription of the credit account associated with the budget transaction type account. -
DebitAccount: string
Title:
DebitMaximum Length:25Debit account of the budget transaction type account. -
DebitAccountDescription: string
Title:
DescriptionDescription of the debit account associated with the budget transaction type account. -
fedBudgetTransactionAccountDFF: array
fedBudgetTransactionAccountDFF
Nested Schema : fedBudgetTransactionTypes-fedBudgetTransactionTypeAccounts-fedBudgetTransactionAccountDFF-item-patch-request
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:150 -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
Nested Schema : schema
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:150 -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
Response
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:
AnticipatedMaximum Length:255Indicates that the transaction is expected or anticipated to occur in the current fiscal year. -
ApportionmentCategory: string
Title:
Apportionment Category CodeMaximum Length:255Apportionment category code of the budget transaction type. -
BudgetLevel: string
Title:
Budget LevelBudget level of the budget transaction type. -
CreatedBy: string
Read Only:
trueMaximum Length:64The user who created the record. -
CreationDate: string
(date-time)
Read Only:
trueThe date when the record was created. -
Description: string
Title:
DescriptionMaximum Length:240Description of the budget transaction type. -
DirectOrReimbursable: string
Title:
Direct or Reimbursable CodeMaximum Length:255The direct or reimbursable value of the budget transaction type. -
Enabled: string
Title:
EnabledIndicates whether the budget transaction type is enabled or not. -
fedBudgetTransactionTypeAccounts: array
Federal Budget Transaction Type Accounts
Title:
Federal Budget Transaction Type AccountsThe budget transaction type accounts resource is used to query, create, and update budget transaction type accounts. -
fedBudgetTransactionTypeDFF: array
fedBudgetTransactionTypeDFF
-
FederalGroup: string
Title:
Federal GroupFederal group associated with the budget transaction type. -
LastUpdateDate: string
(date-time)
Read Only:
trueThe date when the record was last updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64The user who last updated the record. -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32The last user login that was used to update the record. -
LedgerName: string
Title:
Ledger NameMaximum Length:255Ledger name used for the transaction type. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
Name: string
Title:
Transaction TypeMaximum Length:30Name of the budget transaction type. -
TransactionTypeId: integer
(int64)
Title:
Transaction Type IDThe unique identifier of the transaction type associated with the budget transaction type.
Nested Schema : Federal Budget Transaction Type Accounts
Type:
arrayTitle:
Federal Budget Transaction Type AccountsThe budget transaction type accounts resource is used to query, create, and update budget transaction type accounts.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe 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:
trueMaximum Length:64The user who created the record. -
CreationDate: string
(date-time)
Read Only:
trueThe date when the record was created. -
CreditAccount: string
Title:
CreditMaximum Length:25Credit account of the budget transaction type account. -
CreditAccountDescription: string
Title:
DescriptionDescription of the credit account associated with the budget transaction type account. -
DebitAccount: string
Title:
DebitMaximum Length:25Debit account of the budget transaction type account. -
DebitAccountDescription: string
Title:
DescriptionDescription of the debit account associated with the budget transaction type account. -
fedBudgetTransactionAccountDFF: array
fedBudgetTransactionAccountDFF
-
LastUpdateDate: string
(date-time)
Read Only:
trueThe date when the record was last updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64The user who last updated the record. -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32The last user login that was used to update the record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
Nested Schema : Links
Type:
arrayTitle:
LinksThe 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 SegmentMaximum Length:150 -
__FLEX_Context_DisplayValue: string
Title:
Context Segment -
AccountAssignmentId: integer
(int64)
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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 SegmentMaximum Length:150 -
__FLEX_Context_DisplayValue: string
Title:
Context Segment -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
TransactionTypeId: integer
(int64)
Nested Schema : Links
Type:
arrayTitle:
LinksThe 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 update the budget transaction type by submitting a PATCH request on the REST resource using cURL.
curl -i -u "<username>:<password>" -H "Content-Type: application/json" -X PATCH -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedBudgetTransactionTypes/300100543686962
Example Request Payload
The following example shows the contents of the request body in JSON format:
{
"CloseBudget": "Yes"
}
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": "Yes",
"RequireTradingPartner": "No",
"RequireReductionType": "No",
"Enabled": "Yes",
"CreatedBy": "FEDERAL",
"CreationDate": "2021-07-19T10:19:52.003+00:00",
"LastUpdatedBy": "FEDERAL",
"LastUpdateDate": "2021-07-19T10:35:00+00:00",
"LastUpdateLogin": "C5ECAAED0A48927AE053BB28F70A65FC",
"links": [
{
"rel": "self",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedBudgetTransactionTypes/300100543686962",
"name": "fedBudgetTransactionTypes",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000478"
}
},
{
"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"
}
]
}