Get a budget entry transaction budgetary control result
/fscmRestApi/resources/11.13.18.05/budgetaryControlResultsBudgetTransactions/{TransactionNumber}
Request
-
TransactionNumber(required): string
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=
-
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).
-
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
- application/json
Default Response
-
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.
object
-
ActivityResult: string
Read Only:
true
Maximum Length:80
The budgetary control result for the control budget activity of the budget entry transaction line. -
ActivityStatus: string
Read Only:
true
Maximum Length:80
The budgetary control status for the control budget activity of the budget entry transaction line such as passed, warning, or failed. -
BatchFatalErrorMessage: string
Read Only:
true
Maximum Length:2000
The message of an unexpected error. -
BatchResult: string
Read Only:
true
Maximum Length:500
The budgetary control status code for the batch, such as success or failed. -
BudgetAccount: string
Read Only:
true
Maximum Length:4000
The combination of budget segment values. -
BudgetAdjustmentBalance: number
Read Only:
true
All changes made to the initial budget balance of the control budget. -
BudgetManager: string
Read Only:
true
Maximum Length:240
The budget manager who manages the control budget. -
BudgetTransactionType: string
Read Only:
true
Maximum Length:14
Indicates whether the budget entry transaction is an initial budget or a budget adjustment. -
ControlBudget: string
Read Only:
true
Maximum Length:100
The control budget name. -
ControlBudgetAmount: number
Read Only:
true
The budget entry transaction amount in the control budget currency. -
ControlBudgetCurrency: string
Read Only:
true
Maximum Length:15
The currency of the control budget. -
ControlBudgetPeriod: string
Read Only:
true
Maximum Length:15
The name of the budget period of the control budget. -
ConversionDate: string
(date)
Read Only:
true
The date when a conversion rate is used to convert the entered budget amount into the control budget currency. -
ConversionRate: number
Read Only:
true
The currency conversion rate used to convert the entered transaction amount to the control budget currency amount. -
FundsAction: string
Read Only:
true
Maximum Length:5
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. -
FundsAvailableBalance: number
Read Only:
true
Funds available amount for consumption. -
HeaderResult: string
Read Only:
true
The budgetary control result for the budget entry transaction. -
HeaderStatus: string
Read Only:
true
Maximum Length:80
The budgetary control status for a budget entry transaction, such as passed, warning, or failed. -
InitialBudgetBalance: number
Read Only:
true
Initial budget balance of the control budget. -
LineNumber: string
Read Only:
true
Maximum Length:40
The budget entry line number. -
LineResult: string
Read Only:
true
The budgetary control result for a budget entry transaction line. -
LineStatus: string
Read Only:
true
Maximum Length:80
The budgetary control status for a budget entry transaction line, such as passed, warning, or failed. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ReservedBudgetAmount: number
Read Only:
true
The amount that was updated to the budget balance of the control budget. -
TotalBudgetBalance: number
Read Only:
true
Total budget balance of the control budget. -
TotalConsumptionBalance: number
Read Only:
true
Total budget consumption amount consisting of expenditure amounts incurred and amounts at different degrees of committed stages. -
TransactionAmount: number
Read Only:
true
The transaction amount in the budget currency. -
TransactionCurrency: string
Read Only:
true
Maximum Length:15
The transaction currency. -
TransactionNumber: string
Read Only:
true
Maximum Length:240
The transaction number. -
UserConversionType: string
Read Only:
true
Maximum Length:30
The source of a currency conversion rate, such as, user defined or corporate, that's used to convert the transactions.
array
Links
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.
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Examples
Example 1:
The following example shows how to retrieve the budget entry transaction budgetary control result when the budget import failed by submitting a GET request on the REST resource using cURL with the transaction number and source budget as mandatory parameters.
curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourcecollection+json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/budgetaryControlResultsBudgetTransactions?finder=RowFinder;TransactionNumber=test222,SourceBudget=EPM1
Example Response Body
The following example shows the contents of the response body in JSON format:
{ "items": [ { "TransactionNumber": "test222", "LineNumber": "0", "ControlBudget": null, "ControlBudgetPeriod": null, "BudgetAccount": null, "TransactionAmount": null, "ControlBudgetAmount": null, "ReservedBudgetAmount": null, "BudgetTransactionType": null, "FundsAction": null, "BatchResult": "Failed", "BatchFatalErrorMessage": null, "HeaderStatus": "Failed", "HeaderResult": "The budget entry name must be unique for a given source budget type and source budget name.", "LineStatus": null, "LineResult": null, "ActivityStatus": null, "ActivityResult": null, "InitialBudgetBalance": null, "BudgetAdjustmentBalance": null, "TotalBudgetBalance": null, "TotalConsumptionBalance": null, "FundsAvailableBalance": null, "BudgetManager": null, "ControlBudgetCurrency": null, "TransactionCurrency": null, "ConversionDate": null, "ConversionRate": null, "UserConversionType": null, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/budgetaryControlResultsBudgetTransactions/0004000000064661696C6564FFFFFFFF0000000445504D310000000774657374323232", "name": "budgetaryControlResultsBudgetTransactions", "kind": "item" }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/budgetaryControlResultsBudgetTransactions/0004000000064661696C6564FFFFFFFF0000000445504D310000000774657374323232", "name": "budgetaryControlResultsBudgetTransactions", "kind": "item" } ] } ], "count": 1, "hasMore": false, "limit": 500, "offset": 0, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/budgetaryControlResultsBudgetTransactions", "name": "budgetaryControlResultsBudgetTransactions", "kind": "collection" } ] }
Example 2:
The following example shows how to retrieve the budget entry transaction budgetary control result when the budgetary control engine fails or passes funds check/reserve by submitting a GET request on the REST resource using cURL with the transaction number and source budget as mandatory parameters and the header status and line status as optional parameters.
curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourcecollection+json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/budgetaryControlResultsBudgetTransactions?finder=RowFinder;TransactionNumber=Transaction01,SourceBudget=EPM1,HeaderStatus=P,LineStatus=P
Example Response Body
The following example shows the contents of the response body in JSON format:
{ "items": [ { "TransactionNumber": "Transaction01", "LineNumber": "1", "ControlBudget": "EPM1", "ControlBudgetPeriod": "Jan-06", "BudgetAccount": "0014-1210-8121-0100-000000-1100", "TransactionAmount": 1000, "ControlBudgetAmount": 1000, "ReservedBudgetAmount": 1000, "BudgetTransactionType": "Initialize budget", "FundsAction": "Funds reserve", "BatchResult": "Success", "BatchFatalErrorMessage": null, "HeaderStatus": "Passed", "HeaderResult": "Reserved", "LineStatus": "Passed", "LineResult": "Reserved", "ActivityStatus": "Passed", "ActivityResult": "Increased funds available", "InitialBudgetBalance": 2000, "BudgetAdjustmentBalance": 0, "TotalBudgetBalance": 2000, "TotalConsumptionBalance": 0, "FundsAvailableBalance": 2000, "BudgetManager": "Sharmistha Roy", "ControlBudgetCurrency": "USD", "TransactionCurrency": "USD", "ConversionDate": "2006-01-01", "ConversionRate": 1, "UserConversionType": "User", "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/budgetaryControlResultsBudgetTransactions/000400000006506173736564000000065061737365640000000445504D310000000D5472616E73616374696F6E3031", "name": "budgetaryControlResultsBudgetTransactions", "kind": "item" }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/budgetaryControlResultsBudgetTransactions/000400000006506173736564000000065061737365640000000445504D310000000D5472616E73616374696F6E3031", "name": "budgetaryControlResultsBudgetTransactions", "kind": "item" } ] }, { "TransactionNumber": "Transaction01", "LineNumber": "2", "ControlBudget": "EPM1", "ControlBudgetPeriod": "Feb-06", "BudgetAccount": "0014-1210-8121-0100-000000-1100", "TransactionAmount": 1000, "ControlBudgetAmount": 1000, "ReservedBudgetAmount": 1000, "BudgetTransactionType": "Initialize budget", "FundsAction": "Funds reserve", "BatchResult": "Success", "BatchFatalErrorMessage": null, "HeaderStatus": "Passed", "HeaderResult": "Reserved", "LineStatus": "Passed", "LineResult": "Reserved", "ActivityStatus": "Passed", "ActivityResult": "Increased funds available", "InitialBudgetBalance": 2000, "BudgetAdjustmentBalance": 0, "TotalBudgetBalance": 2000, "TotalConsumptionBalance": 0, "FundsAvailableBalance": 2000, "BudgetManager": "Sharmistha Roy", "ControlBudgetCurrency": "USD", "TransactionCurrency": "USD", "ConversionDate": "2006-02-01", "ConversionRate": 1, "UserConversionType": "User", "links": [ { "rel": "self", "href": "servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/budgetaryControlResultsBudgetTransactions/000400000006506173736564000000065061737365640000000445504D310000000D5472616E73616374696F6E3031", "name": "budgetaryControlResultsBudgetTransactions", "kind": "item" }, { "rel": "canonical", "href": "servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/budgetaryControlResultsBudgetTransactions/000400000006506173736564000000065061737365640000000445504D310000000D5472616E73616374696F6E3031", "name": "budgetaryControlResultsBudgetTransactions", "kind": "item" } ] } ], "count": 2, "hasMore": false, "limit": 500, "offset": 0, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/budgetaryControlResultsBudgetTransactions", "name": "budgetaryControlResultsBudgetTransactions", "kind": "collection" } ] }