Get an overhead transaction
get
/fscmRestApi/resources/11.13.18.05/jointVentureOverheadTransactions/{transactionId}
Request
Path Parameters
-
transactionId(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=
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 : jointVentureOverheadTransactions-item-response
Type:
Show Source
object
-
basisSource: string
Title:
Basis Source
Read Only:true
The source of the overhead calculation amount. -
carriedInterestAgreement: string
Title:
Agreement
Read Only:true
Maximum Length:30
The name of the carried interest agreement associated with the joint venture transaction. -
carriedInterestAgreementDescription: string
Title:
Description
Read Only:true
Maximum Length:240
The description of the carried interest agreement associated with the joint venture transaction. -
carriedInterestSourceOwnerDefinition: string
Title:
Source Ownership Definition
Read Only:true
Maximum Length:30
The name of the ownership definition used as the basis for creating the carried interest ownership definition assigned to the transaction. -
changeReason: string
Title:
Change Reason
Maximum Length:80
The reason for the manual change to the joint venture transaction. -
changeReasonDetails: string
Title:
Change Reason Details
Maximum Length:240
Additional text to describe the reason the joint venture transaction was manually changed. -
createdBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the joint venture transaction. -
creationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the joint venture transaction was created. -
creditAmount: number
Title:
Credit
Read Only:true
The credit amount of the joint venture source transaction. -
currencyCode: string
Title:
Currency
Read Only:true
Maximum Length:15
The currency of the transaction amount. -
debitAmount: number
Title:
Debit
Read Only:true
The debit amount of the joint venture source transaction. -
distributionOnlyFlag: boolean
Title:
Distribution Only
Maximum Length:1
Default Value:false
Indicates whether the transaction is for distribution only, not for invoicing. -
headerId: integer
(int64)
Title:
Header ID
Read Only:true
The unique identifier for the joint venture source transaction header. -
jointVenture: string
Title:
Joint Venture
Read Only:true
Maximum Length:30
The unique name of the joint venture. -
jointVentureDescription: string
Title:
Joint Venture Description
Read Only:true
Maximum Length:240
The description of the joint venture. -
journalDescription: string
Title:
Transaction Description
Read Only:true
Maximum Length:240
The description to include on the joint venture invoices for the calculated overhead transactions. -
lastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the joint venture transaction was last updated. -
lastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the joint venture transaction. -
ledger: string
Title:
Ledger Name
Read Only:true
Maximum Length:30
The name of the ledger. -
lineNumber: integer
(int64)
Title:
Line Number
Read Only:true
The accounting line for the joint venture source transaction. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
method: string
Title:
Method
Read Only:true
Maximum Length:30
The unique name of the overhead method. -
methodDescription: string
Title:
Description
Read Only:true
Maximum Length:240
The description of the overhead method. -
methodType: string
Title:
Type
Read Only:true
Maximum Length:80
The method type used to determine how the overhead amount is calculated. -
originalOwnershipDefinition: string
Title:
Original Ownership Definition
Read Only:true
Maximum Length:20
The original ownership definition assigned to the joint venture transaction. -
originalStakeholder: string
Title:
Original Direct Billed Stakeholder
Read Only:true
Maximum Length:30
The name of the original direct billed stakeholder assigned to the joint venture transaction. -
originalStakeholderDescription: string
Title:
Original Direct Billed Stakeholder Description
Read Only:true
Maximum Length:255
The description of the original direct billed stakeholder. -
ownershipDefinition: string
Title:
Ownership Definition
Maximum Length:30
The name of the ownership definition assigned to the transaction, which can be overridden. -
partnerOffsetAccount: string
Title:
Partner Account
Read Only:true
The combination of account segment values assigned to a partner's line in the receivables invoice. -
periodBasis: string
Title:
Period Basis
Read Only:true
Maximum Length:80
The value that determines how the period basis is derived for the overhead calculation. Valid values are: Period, Year to period, and Inception to period. -
stakeholder: string
Title:
Direct Billed Stakeholder
The name of the direct billed stakeholder assigned to the joint venture transaction. -
stakeholderDescription: string
Title:
Direct Billed Stakeholder Description
Read Only:true
The description of the direct billed stakeholder. -
transactionChanges: array
Joint Venture Transaction Changes
Title:
Joint Venture Transaction Changes
The joint venture transaction changes resource is used to view the history of manual changes to joint venture transactions. -
transactionChangesExistFlag: boolean
Title:
Transaction Changes Exist
Read Only:true
Maximum Length:255
Indicates whether manual changes have been made to a transaction. -
transactionDate: string
(date)
Title:
Transaction Date
The date when the transaction occurred, which may be different from the joint venture source transaction date. -
transactionDFF: array
transactionDFF
-
transactionId: integer
(int64)
Title:
Transaction ID
Read Only:true
The unique identifier of the joint venture transaction. -
transactionStatus: string
Title:
Transaction Status
Maximum Length:80
The status of the joint venture transaction. -
transactionType: string
Title:
Type
Read Only:true
Maximum Length:80
The type of the joint venture source transaction.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Joint Venture Transaction Changes
Type:
array
Title:
Joint Venture Transaction Changes
The joint venture transaction changes resource is used to view the history of manual changes to joint venture transactions.
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.
Nested Schema : jointVentureOverheadTransactions-transactionChanges-item-response
Type:
Show Source
object
-
afterAssignmentRule: string
Title:
After Assignment Rule
Read Only:true
Maximum Length:30
The new ownership definition assignment rule assigned to the transaction. -
afterDistributionOnlyFlag: boolean
Title:
After Distribution Only
Read Only:true
Maximum Length:1
The new distribution only value assigned to the transaction. -
afterOwnershipDefinition: string
Title:
After Ownership Definition
Read Only:true
Maximum Length:30
The new ownership definition assigned to the transaction. -
afterStakeholder: string
Title:
After Direct Billed Stakeholder
Read Only:true
Maximum Length:30
The new name of the direct billed stakeholder assigned to the transaction. -
afterStakeholderDescription: string
Title:
After Direct Billed Stakeholder Description
Read Only:true
Maximum Length:240
The new description of the direct billed stakeholder assigned to the transaction. -
afterStatus: string
Title:
After Status
Read Only:true
Maximum Length:80
The new status assigned to the transaction. -
afterTransactionDate: string
(date)
Title:
After Transaction Date
Read Only:true
The new transaction date assigned to the transaction. -
beforeAssignmentRule: string
Title:
Before Assignment Rule
Read Only:true
Maximum Length:30
The previous ownership definition assignment rule assigned to the transaction. -
beforeDistributionOnlyFlag: boolean
Title:
Before Distribution Only
Read Only:true
Maximum Length:1
The previous distribution only value assigned to the transaction. -
beforeOwnershipDefinition: string
Title:
Before Ownership Definition
Read Only:true
Maximum Length:30
The previous ownership definition assigned to the transaction. -
beforeStakeholder: string
Title:
Before Direct Billed Stakeholder
Read Only:true
Maximum Length:30
The previous name of the direct billed stakeholder assigned to the transaction. -
beforeStakeholderDescription: string
Title:
Before Direct Billed Stakeholder Description
Read Only:true
Maximum Length:240
The previous description of the direct billed stakeholder assigned to the transaction. -
beforeStatus: string
Title:
Before Status
Read Only:true
Maximum Length:80
The previous status assigned to the transaction. -
beforeTransactionDate: string
(date)
Title:
Before Transaction Date
Read Only:true
The previous transaction date assigned to the transaction. -
changeReason: string
Title:
Change Reason
Read Only:true
Maximum Length:80
The reason for the manual change to the joint venture transaction. -
changeReasonDetails: string
Title:
Change Reason Details
Read Only:true
Maximum Length:240
Additional text to describe the reason the joint venture transaction was manually changed. -
createdBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the joint venture transaction change. -
creationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the joint venture transaction change was created. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
transactionChangeId: integer
(int64)
Title:
Transaction Change ID
Read Only:true
The unique identifier of the joint venture transaction change.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : jointVentureOverheadTransactions-transactionDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:150
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
TransactionId: integer
(int64)
Title:
Transaction ID
Read Only:true
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- transactionChanges
-
Parameters:
- transactionId:
$request.path.transactionId
The joint venture transaction changes resource is used to view the history of manual changes to joint venture transactions. - transactionId:
- transactionDFF
-
Parameters:
- transactionId:
$request.path.transactionId
- transactionId:
Examples
The following example shows how to get an overhead transaction by submitting a GET request on the REST resource using cURL.
curl -i -u "username:password" -H "Content-type: application/json" -X GET "https://servername.fa.us2.oraclecloud.com /fscmRestApi/resources/11.13.18.05/jointVentureOverheadTransactions/100100266235466"
Response Body Example
The following shows an example of the response body in JSON format.
{ "transactionId": 100100266235466, "headerId": 100100266251969, "lineNumber": 1, "transactionStatus": "Available to process", "transactionDate": "2017-01-01", "transactionType": "Overhead", "basisSource": "Joint venture billed transactions", "jointVenture": "APOLLOBASIN", "jointVentureDescription": "Oklahoma panhandle project", "method": "OH_APOLLOGLOBAL1805210359", "methodDescription": "Overhead for APOLLOGLOBAL", "journalDescription": "OH_BA1805210359", "ledger": "HEPPLedger US", "ownershipDefinition": "APOLLOGLOBAL_OH1805210359", "originalOwnershipDefinition": "APOLLOGLOBAL_OH1805210359", "debitAmount": 1200, "creditAmount": null, "currencyCode": "USD", "partnerOffsetAccount": "11-1001-11010-11-0001", "createdBy": "username", "creationDate": "2021-05-20T04:26:32.201+00:00", "lastUpdatedBy": "username", "lastUpdateDate": "2021-05-20T04:26:32.201+00:00", "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureOverheadTransactions/100100266235466", "name": "jointVentureOverheadTransactions", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureOverheadTransactions/100100266235466", "name": "jointVentureOverheadTransactions", "kind": "item" } ] }