Get the budget impacts of a budgetary control result
get
/fscmRestApi/resources/11.13.18.05/budgetaryControlResultsBudgetImpacts/{budgetaryControlResultsBudgetImpactsUniqID}
Request
Path Parameters
-
budgetaryControlResultsBudgetImpactsUniqID(required): string
This is the hash key of the attributes which make up the composite key--- BudgetCcid, ControlBudgetId and PeriodName ---for the Budgetary Control Results Budget Impacts for Labor Cost Management resource and used to uniquely identify an instance of Budgetary Control Results Budget Impacts for Labor Cost Management. The client should not generate the hash key value. Instead, the client should query on the Budgetary Control Results Budget Impacts for Labor Cost Management collection resource with a filter on the primary key values in order to navigate to a specific instance of Budgetary Control Results Budget Impacts for Labor Cost Management.
For example: budgetaryControlResultsBudgetImpacts?q=BudgetCcid=<value1>;ControlBudgetId=<value2>;PeriodName=<value3>
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 : budgetaryControlResultsBudgetImpacts-item-response
Type:
Show Source
object
-
AccountedPayablesAmount: number
Read Only:
true
Reserved payables expenditure amount. -
AccountedProjectAmount: number
Read Only:
true
Reserved project expenditure amount. -
AccountedReceiptsAmount: number
Read Only:
true
Reserved receipt expenditure amount. -
ActualAmount: number
Read Only:
true
Consumption amount spent and classified as an expenditure. -
AdditionalRequired: number
Amount needed beyond the remaining budget funds available to cover the cost of a specific transaction.
-
Amount: number
Read Only:
true
The transaction amount in the budget currency. -
ApprovedAuthorizationAmount: number
Read Only:
true
Reserved spend authorization amount. -
ApprovedCommitmentAmount: number
Read Only:
true
Reserved requisition amount. -
ApprovedObligationAmount: number
Read Only:
true
Reserved purchase order amount. -
BudgetAccount: string
The budget account for the transaction.
-
BudgetAdjustmentAmount: number
Read Only:
true
Changes made to the initial budget amount. -
BudgetAmount: number
Read Only:
true
The total budget balance amount. -
BudgetCcid: integer
(int64)
Read Only:
true
The budget account identifier for the transaction. -
BudgetManager: string
Read Only:
true
The budget manager who manages the control budget. -
CommitmentAmount: number
Read Only:
true
Consumption amount expected to be spent without a legal obligation. -
ControlBudgetId: integer
(int64)
Read Only:
true
The control budget identifier. -
CurrencyCode: string
Read Only:
true
Maximum Length:15
The currency of the control budget. -
DetailOtherAmount: number
Read Only:
true
Reserved encumbrance amount excluding commitments or obligations. -
EnteredAmount: number
Read Only:
true
The entered transaction amount in the transaction currency. -
FundsAvailableAmount: number
Read Only:
true
Funds available amount for consumption. -
FundsConsumed: number
The amount consumed from the control budget.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MiscExpendituresAmount: number
Read Only:
true
Reserved expenditure amount excluding payables, receipts and projects. -
Name: string
Read Only:
true
Maximum Length:100
The control budget name. -
ObligationAmount: number
Read Only:
true
Consumption amount with a legal obligation to pay in the future. -
OtherAmount: number
Read Only:
true
Consumption amount for encumbrances excluding commitments or obligations. -
PeriodName: string
Read Only:
true
Maximum Length:15
The name of the budget period. -
ResultCode: string
Read Only:
true
Maximum Length:30
The budgetary control validation status code for the transactions. -
Status: string
Read Only:
true
The budgetary control validation status for the transactions. -
TotalConsumption: number
Read Only:
true
Total budget consumption amount consisting of expenditure amounts incurred and amounts at different degrees of committed stages. -
TransactionNumber: string
Read Only:
true
Maximum Length:240
The transaction number. -
UnreleasedBudgetAmount: number
Read Only:
true
Budget amount that's not released for consumption.
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.
Examples
The following example shows how to retrieve the budget impacts of a budgetary control result by submitting a GET request on the REST resource using cURL.
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/budgetaryControlResultsBudgetImpacts?finder=resultsFinder;SourceHeaderId1=7689618,DraftFlag=N,TransactionTypeCode='PROJECT_EXPENDITURE'
Example Response Body
The following example shows the contents of the response body in JSON format:
{ "items": [ { "BudgetCcid": 41033, "ControlBudgetId": 300100083923266, "PeriodName": "Jan-15", "TransactionNumber": "7689618", "Amount": 715000, "EnteredAmount": 715000, "ResultCode": "P_TRACKING_ONLY", "CurrencyCode": "USD", "Name": "XCC_ST04_Project_TS05-06_Project", "AccountedProjectAmount": 418, "AccountedPayablesAmount": null, "AccountedReceiptsAmount": null, "ActualAmount": 418, "ApprovedAuthorizationAmount": null, "ApprovedCommitmentAmount": null, "ApprovedObligationAmount": null, "BudgetAdjustmentAmount": null, "BudgetAmount": 76120, "CommitmentAmount": null, "DetailOtherAmount": null, "FundsAvailableAmount": 75702, "MiscExpendituresAmount": null, "ObligationAmount": null, "OtherAmount": null, "UnreleasedBudgetAmount": 0, "TotalConsumption": 418, "BudgetAccount": "XCC_ST04_Project_TS05-06", "FundsConsumed": null, "Status": "Passed", "BudgetManager": "Pappu Sri", "AdditionalRequired": null, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/budgetaryControlResultsBudgetImpacts/00030000000EACED00057708000000000000A0490000000EACED00057708000110F07EE63942000000064A616E2D3135", "name": "budgetaryControlResultsBudgetImpacts", "kind": "item" }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/budgetaryControlResultsBudgetImpacts/00030000000EACED00057708000000000000A0490000000EACED00057708000110F07EE63942000000064A616E2D3135", "name": "budgetaryControlResultsBudgetImpacts", "kind": "item" } ] }, { "BudgetCcid": 41037, "ControlBudgetId": 300100083923268, "PeriodName": "Jan-15", "TransactionNumber": "7689618", "Amount": 715000, "EnteredAmount": 715000, "ResultCode": "P_TRACKING_ONLY", "CurrencyCode": "USD", "Name": "XCC_ST04_Project_TS05-06_Top_Resource", "AccountedProjectAmount": 286, "AccountedPayablesAmount": null, "AccountedReceiptsAmount": null, "ActualAmount": 286, "ApprovedAuthorizationAmount": null, "ApprovedCommitmentAmount": null, "ApprovedObligationAmount": null, "BudgetAdjustmentAmount": null, "BudgetAmount": 11440, "CommitmentAmount": null, "DetailOtherAmount": null, "FundsAvailableAmount": 11154, "MiscExpendituresAmount": null, "ObligationAmount": null, "OtherAmount": null, "UnreleasedBudgetAmount": 0, "TotalConsumption": 286, "BudgetAccount": "XCC_ST04_Project_TS05-06-XCC_ST04_Project_TS05 06:Sri, Pappu", "FundsConsumed": null, "Status": "Passed", "BudgetManager": "Pappu Sri", "AdditionalRequired": null, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/budgetaryControlResultsBudgetImpacts/00030000000EACED00057708000000000000A04D0000000EACED00057708000110F07EE63944000000064A616E2D3135", "name": "budgetaryControlResultsBudgetImpacts", "kind": "item" }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/budgetaryControlResultsBudgetImpacts/00030000000EACED00057708000000000000A04D0000000EACED00057708000110F07EE63944000000064A616E2D3135", "name": "budgetaryControlResultsBudgetImpacts", "kind": "item" } ] }, { "BudgetCcid": 41033, "ControlBudgetId": 300100083923272, "PeriodName": "PRD_01-01", "TransactionNumber": "7689618", "Amount": 715000, "EnteredAmount": 715000, "ResultCode": "P_PASSED", "CurrencyCode": "USD", "Name": "XCC_ST04_Project_TS05-06-SUM_Project", "AccountedProjectAmount": 418, "AccountedPayablesAmount": null, "AccountedReceiptsAmount": null, "ActualAmount": 418, "ApprovedAuthorizationAmount": null, "ApprovedCommitmentAmount": null, "ApprovedObligationAmount": null, "BudgetAdjustmentAmount": null, "BudgetAmount": 327800, "CommitmentAmount": null, "DetailOtherAmount": null, "FundsAvailableAmount": 327382, "MiscExpendituresAmount": null, "ObligationAmount": null, "OtherAmount": null, "UnreleasedBudgetAmount": 0, "TotalConsumption": 418, "BudgetAccount": "XCC_ST04_Project_TS05-06", "FundsConsumed": null, "Status": "Failed", "BudgetManager": "Pappu Sri", "AdditionalRequired": 387618, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/budgetaryControlResultsBudgetImpacts/00030000000EACED00057708000000000000A0490000000EACED00057708000110F07EE63948000000095052445F30312D3031", "name": "budgetaryControlResultsBudgetImpacts", "kind": "item" }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/budgetaryControlResultsBudgetImpacts/00030000000EACED00057708000000000000A0490000000EACED00057708000110F07EE63948000000095052445F30312D3031", "name": "budgetaryControlResultsBudgetImpacts", "kind": "item" } ] }, { "BudgetCcid": 41037, "ControlBudgetId": 300100083923274, "PeriodName": "PRD_01-01", "TransactionNumber": "7689618", "Amount": 715000, "EnteredAmount": 715000, "ResultCode": "F_FAILED", "CurrencyCode": "USD", "Name": "XCC_ST04_Project_TS05-06-SUM_Top_Resource", "AccountedProjectAmount": 286, "AccountedPayablesAmount": null, "AccountedReceiptsAmount": null, "ActualAmount": 286, "ApprovedAuthorizationAmount": null, "ApprovedCommitmentAmount": null, "ApprovedObligationAmount": null, "BudgetAdjustmentAmount": null, "BudgetAmount": 57200, "CommitmentAmount": null, "DetailOtherAmount": null, "FundsAvailableAmount": 56914, "MiscExpendituresAmount": null, "ObligationAmount": null, "OtherAmount": null, "UnreleasedBudgetAmount": 0, "TotalConsumption": 286, "BudgetAccount": "XCC_ST04_Project_TS05-06-XCC_ST04_Project_TS05 06:Sri, Pappu", "FundsConsumed": null, "Status": "Failed", "BudgetManager": "Pappu Sri", "AdditionalRequired": 658086, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/budgetaryControlResultsBudgetImpacts/00030000000EACED00057708000000000000A04D0000000EACED00057708000110F07EE6394A000000095052445F30312D3031", "name": "budgetaryControlResultsBudgetImpacts", "kind": "item" }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/budgetaryControlResultsBudgetImpacts/00030000000EACED00057708000000000000A04D0000000EACED00057708000110F07EE6394A000000095052445F30312D3031", "name": "budgetaryControlResultsBudgetImpacts", "kind": "item" } ] } ], "count": 4, "hasMore": false, "limit": 500, "offset": 0, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/budgetaryControlResultsBudgetImpacts", "name": "budgetaryControlResultsBudgetImpacts", "kind": "collection" } ] }