PATCH action not supported
patch
/fscmRestApi/resources/11.13.18.05/budgetaryControlBudgetTransactions/{budgetaryControlBudgetTransactionsUniqID}
Request
Path Parameters
-
budgetaryControlBudgetTransactionsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Budgetary Control for Enterprise Performance Management Budget Transactions resource and used to uniquely identify an instance of Budgetary Control for Enterprise Performance Management Budget Transactions. The client should not generate the hash key value. Instead, the client should query on the Budgetary Control for Enterprise Performance Management Budget Transactions collection resource in order to navigate to a specific instance of Budgetary Control for Enterprise Performance Management Budget Transactions to get the hash key.
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
-
ApprovalComments: string
Maximum Length:
2000
Approval comments from the approver for the budget entry transaction. -
ApprovedBy: string
Maximum Length:
64
Person who approved the budget entry transaction. -
ApprovedDate: string
(date-time)
Date and time when the budget entry transaction was approved.
-
AttachmentURL: string
Maximum Length:
4000
Supporting document attached at the budget entry transaction header level. -
AttributeCategory: string
Maximum Length:
15
Descriptive flexfield context name for the Budget Line Descriptions descriptive flexfield. -
AttributeChar1: string
Maximum Length:
255
Segment for the Budget Line Descriptions descriptive flexfield. -
AttributeChar10: string
Maximum Length:
255
Segment for the Budget Line Descriptions descriptive flexfield. -
AttributeChar2: string
Maximum Length:
255
Segment for the Budget Line Descriptions descriptive flexfield. -
AttributeChar3: string
Maximum Length:
255
Segment for the Budget Line Descriptions descriptive flexfield. -
AttributeChar4: string
Maximum Length:
255
Segment for the Budget Line Descriptions descriptive flexfield. -
AttributeChar5: string
Maximum Length:
255
Segment for the Budget Line Descriptions descriptive flexfield. -
AttributeChar6: string
Maximum Length:
255
Segment for the Budget Line Descriptions descriptive flexfield. -
AttributeChar7: string
Maximum Length:
255
Segment for the Budget Line Descriptions descriptive flexfield. -
AttributeChar8: string
Maximum Length:
255
Segment for the Budget Line Descriptions descriptive flexfield. -
AttributeChar9: string
Maximum Length:
255
Segment for the Budget Line Descriptions descriptive flexfield. -
BatchFatalErrorMessage: string
Maximum Length:
2000
The message of an unexpected error. -
BatchFundsAction: string
Maximum Length:
30
Indicates whether funds check or funds reservation is performed for the budget entry transaction. Funds check doesn't update budget balances. Funds reservation updates budget balances when budgetary control validation doesn't fail. -
BatchResultCode: string
Maximum Length:
30
The budgetary control status code for the batch, such as success or failed. -
BudgetAmountsMode: string
Maximum Length:
30
Indicates whether the amounts from the budget entry transactions should overwrite or be added to the existing budget balances. -
BudgetTransactionPayload: string
(byte)
Main content of a budget entry transaction line, such as its budget account, budget period, and budget amount, encoded in JSON format.
-
BudgetTransactionType: string
Maximum Length:
30
Indicates whether the budget entry transaction is an initial budget or a budget adjustment. -
JustificationText: string
Maximum Length:
1000
Justification provided at the budget entry transaction header level by the budget preparer for the budget approver. -
ProcessId: integer
(int64)
The budgetary control process identifier.
-
RevisionDescription: string
Maximum Length:
255
Description for the budget entry transaction. -
SourceBudget: string
Maximum Length:
100
Source control budget name of the budget entry transaction line. -
TransactionNumber: string
Maximum Length:
500
Budget entry transaction number from Enterprise Performance Management.
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 : budgetaryControlBudgetTransactions-item-response
Type:
Show Source
object
-
ApprovalComments: string
Maximum Length:
2000
Approval comments from the approver for the budget entry transaction. -
ApprovedBy: string
Maximum Length:
64
Person who approved the budget entry transaction. -
ApprovedDate: string
(date-time)
Date and time when the budget entry transaction was approved.
-
AttachmentURL: string
Maximum Length:
4000
Supporting document attached at the budget entry transaction header level. -
AttributeCategory: string
Maximum Length:
15
Descriptive flexfield context name for the Budget Line Descriptions descriptive flexfield. -
AttributeChar1: string
Maximum Length:
255
Segment for the Budget Line Descriptions descriptive flexfield. -
AttributeChar10: string
Maximum Length:
255
Segment for the Budget Line Descriptions descriptive flexfield. -
AttributeChar2: string
Maximum Length:
255
Segment for the Budget Line Descriptions descriptive flexfield. -
AttributeChar3: string
Maximum Length:
255
Segment for the Budget Line Descriptions descriptive flexfield. -
AttributeChar4: string
Maximum Length:
255
Segment for the Budget Line Descriptions descriptive flexfield. -
AttributeChar5: string
Maximum Length:
255
Segment for the Budget Line Descriptions descriptive flexfield. -
AttributeChar6: string
Maximum Length:
255
Segment for the Budget Line Descriptions descriptive flexfield. -
AttributeChar7: string
Maximum Length:
255
Segment for the Budget Line Descriptions descriptive flexfield. -
AttributeChar8: string
Maximum Length:
255
Segment for the Budget Line Descriptions descriptive flexfield. -
AttributeChar9: string
Maximum Length:
255
Segment for the Budget Line Descriptions descriptive flexfield. -
BatchFatalErrorMessage: string
Maximum Length:
2000
The message of an unexpected error. -
BatchFundsAction: string
Maximum Length:
30
Indicates whether funds check or funds reservation is performed for the budget entry transaction. Funds check doesn't update budget balances. Funds reservation updates budget balances when budgetary control validation doesn't fail. -
BatchResultCode: string
Maximum Length:
30
The budgetary control status code for the batch, such as success or failed. -
BudgetAmountsMode: string
Maximum Length:
30
Indicates whether the amounts from the budget entry transactions should overwrite or be added to the existing budget balances. -
BudgetTransactionPayload: string
(byte)
Main content of a budget entry transaction line, such as its budget account, budget period, and budget amount, encoded in JSON format.
-
BudgetTransactionType: string
Maximum Length:
30
Indicates whether the budget entry transaction is an initial budget or a budget adjustment. -
JustificationText: string
Maximum Length:
1000
Justification provided at the budget entry transaction header level by the budget preparer for the budget approver. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ProcessId: integer
(int64)
The budgetary control process identifier.
-
RevisionDescription: string
Maximum Length:
255
Description for the budget entry transaction. -
SourceBudget: string
Maximum Length:
100
Source control budget name of the budget entry transaction line. -
TransactionNumber: string
Maximum Length:
500
Budget entry transaction number from Enterprise Performance Management.
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.