Get a budgetary control result
/fscmRestApi/resources/11.13.18.05/budgetaryControlResults/{budgetaryControlResultsUniqID}
Request
-
budgetaryControlResultsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Budgetary Control Results resource and used to uniquely identify an instance of Budgetary Control Results. The client should not generate the hash key value. Instead, the client should query on the Budgetary Control Results collection resource in order to navigate to a specific instance of Budgetary Control Results to get the hash key.
-
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
-
Amount: number
Read Only:
true
The transaction amount in the budget currency. -
BalanceType: string
Read Only:
true
The balance type of various amounts, such as obligation, commitment, other, and actual amounts. -
BudgetAccount: string
The budget account for the transaction.
-
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. -
ControlBudgetId: integer
(int64)
Read Only:
true
The control budget identifier. -
ConversionDate: string
(date)
Read Only:
true
The date on which a conversion rate is used to convert the transaction entered amount into the budget currency. -
ConversionRate: number
Read Only:
true
The currency conversion rate used to convert the entered transaction amount to the budget currency amount. -
CurrencyCode: string
Read Only:
true
Maximum Length:15
The currency of the control budget. -
DataSetId: integer
(int64)
Read Only:
true
The budgetary control validation processing data set identifier. -
DraftFlag: boolean
Read Only:
true
Maximum Length:1
The funds check versus funds reservation indicator. -
EnteredAmount: number
Read Only:
true
The entered transaction amount in the transaction currency. -
EnteredCurrency: string
Read Only:
true
Maximum Length:15
The transaction currency. -
FundsConsumed: string
The amount consumed from the control budget.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Read Only:
true
Maximum Length:100
The control budget name. -
PeriodName: string
Read Only:
true
Maximum Length:15
The name of the budget period. -
ProjectBurden: string
Read Only:
true
Indicates whether a line item listed in the budgetary control results represents a project overhead cost, such as fringe, overhead, and materials handling. -
ResultCode: string
Read Only:
true
Maximum Length:30
The budgetary control validation status code for the transactions. -
SourceHeaderId1: string
Maximum Length:
30
The source transaction identifier 1. -
SourceHeaderId2: string
Maximum Length:
30
The source transaction identifier 2. -
SourceLineId1: string
Read Only:
true
Maximum Length:30
The source transaction line identifier 1. -
SourceLineId2: string
Read Only:
true
Maximum Length:30
The source transaction line identifier 2. -
SourceLineId3: string
Read Only:
true
Maximum Length:30
The source transaction line identifier 3. -
SourceLineId4: string
Read Only:
true
Maximum Length:30
The source transaction line identifier 4. -
SourceLineId5: string
Read Only:
true
Maximum Length:30
The source transaction line identifier 5. -
Status: string
Read Only:
true
The budgetary control validation status for the transactions. -
TransactionNumber: string
Maximum Length:
240
The transaction number. -
TransactionTypeCode: string
Maximum Length:
30
The source transaction type code. -
UserConversionType: string
Title:
Conversion Rate Type
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 budgetary control validation information for a labor schedule for Labor Cost Management in Project Portfolio Management 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/budgetaryControlResults?finder=resultsFinder;SourceHeaderId1=7923232,DraftFlag=N,TransactionTypeCode=PROJECT_EXPENDITURE
Example Response Body
The following example shows the contents of the response body in JSON format:
{ "items": [ { "TransactionNumber": "7923232", "EnteredAmount": 1000, "EnteredCurrency": "USD", "Amount": 1000, "CurrencyCode": "USD", "ControlBudgetId": 300100541544542, "Name": "Element-receptors_Element-receptors_Top_Resource_Funding_Source_Track", "PeriodName": "YrStartOct-20", "BudgetCcid": 95084, "ConversionDate": "2020-12-01", "ConversionRate": 1, "UserConversionType": "User", "SourceHeaderId1": "7923232", "SourceHeaderId2": " ", "SourceLineId1": "7923232", "SourceLineId2": "1", "SourceLineId3": " ", "SourceLineId4": " ", "SourceLineId5": " ", "DataSetId": 668555, "TransactionTypeCode": "PROJECT_EXPENDITURE", "DraftFlag": false, "ResultCode": "P_TRACKING_ONLY", "BudgetAccount": "Element-receptors-Element-receptors-Element receptors:Salary-CDRM_70255", "FundsConsumed": "1000", "Status": "Track control level setting, transaction recorded", "BalanceType": "Expenditure", "ProjectBurden": "No", "BudgetManager": "Alice Parker", "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/budgetaryControlResults/00020000000E3636383535352B313133342B32300000000455736572", "name": "budgetaryControlResults", "kind": "item" }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/budgetaryControlResults/00020000000E3636383535352B313133342B32300000000455736572", "name": "budgetaryControlResults", "kind": "item" } ] }, { "TransactionNumber": "7923232", "EnteredAmount": 1000, "EnteredCurrency": "USD", "Amount": 1000, "CurrencyCode": "USD", "ControlBudgetId": 300100541544548, "Name": "Element-receptors_Element-receptors", "PeriodName": "PRD_01-01", "BudgetCcid": 95088, "ConversionDate": "2020-12-01", "ConversionRate": 1, "UserConversionType": "User", "SourceHeaderId1": "7923232", "SourceHeaderId2": " ", "SourceLineId1": "7923232", "SourceLineId2": "1", "SourceLineId3": " ", "SourceLineId4": " ", "SourceLineId5": " ", "DataSetId": 668555, "TransactionTypeCode": "PROJECT_EXPENDITURE", "DraftFlag": false, "ResultCode": "P_PASSED", "BudgetAccount": "Element-receptors-Element-receptors", "FundsConsumed": "1000", "Status": "Passed budgetary control validation", "BalanceType": "Expenditure", "ProjectBurden": "No", "BudgetManager": "Alice Parker", "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/budgetaryControlResults/00020000000E3636383535352B313133342B32300000000455736572", "name": "budgetaryControlResults", "kind": "item" }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/budgetaryControlResults/00020000000E3636383535352B313133342B32300000000455736572", "name": "budgetaryControlResults", "kind": "item" } ] }, { "TransactionNumber": "7923232", "EnteredAmount": 1000, "EnteredCurrency": "USD", "Amount": 1000, "CurrencyCode": "USD", "ControlBudgetId": 300100541544551, "Name": "Element-receptors_Element-receptors_Top_Resource", "PeriodName": "PRD_01-01", "BudgetCcid": 95089, "ConversionDate": "2020-12-01", "ConversionRate": 1, "UserConversionType": "User", "SourceHeaderId1": "7923232", "SourceHeaderId2": " ", "SourceLineId1": "7923232", "SourceLineId2": "1", "SourceLineId3": " ", "SourceLineId4": " ", "SourceLineId5": " ", "DataSetId": 668555, "TransactionTypeCode": "PROJECT_EXPENDITURE", "DraftFlag": false, "ResultCode": "P_PASSED", "BudgetAccount": "Element-receptors-Element-receptors-Element receptors:Salary", "FundsConsumed": "1000", "Status": "Passed budgetary control validation", "BalanceType": "Expenditure", "ProjectBurden": "No", "BudgetManager": "Alice Parker", "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/budgetaryControlResults/00020000000E3636383535352B313133342B32300000000455736572", "name": "budgetaryControlResults", "kind": "item" }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/budgetaryControlResults/00020000000E3636383535352B313133342B32300000000455736572", "name": "budgetaryControlResults", "kind": "item" } ] } ], "count": 3, "hasMore": false, "limit": 500, "offset": 0, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/budgetaryControlResults", "name": "budgetaryControlResults", "kind": "collection" } ] }
Example 2
The following example shows how to retrieve budgetary control validation information for a Requisition in Self Service Procurement 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/budgetaryControlResults?finder=resultsFinder;SourceHeaderId1=300100577124080,DraftFlag=Y,TransactionTypeCode=REQUISITION
Example Response Body
The following example shows the contents of the response body in JSON format:
{ "items": [ { "TransactionNumber": "389", "EnteredAmount": 1211, "EnteredCurrency": "USD", "Amount": 1211, "CurrencyCode": "USD", "ControlBudgetId": 300100036671848, "Name": "VCity Track only", "PeriodName": "May-12", "BudgetCcid": 300100036672002, "ConversionDate": "2012-05-01", "ConversionRate": 1, "UserConversionType": "User", "SourceHeaderId1": "300100577124080", "SourceHeaderId2": " ", "SourceLineId1": "300100577124081", "SourceLineId2": "300100577124082", "SourceLineId3": " ", "SourceLineId4": " ", "SourceLineId5": " ", "DataSetId": 820829, "TransactionTypeCode": "REQUISITION", "DraftFlag": true, "ResultCode": "P_TRACKING_ONLY", "BudgetAccount": "9501-3310", "FundsConsumed": null, "Status": "Track control level setting, transaction recorded", "BalanceType": "Commitment", "ProjectBurden": "No", "BudgetManager": "Sharmistha Roy", "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/budgetaryControlResults/0002000000093832303832392B2B310000000455736572", "name": "budgetaryControlResults", "kind": "item" }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/budgetaryControlResults/0002000000093832303832392B2B310000000455736572", "name": "budgetaryControlResults", "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/budgetaryControlResults", "name": "budgetaryControlResults", "kind": "collection" } ] }