Get a distribution for a joint venture generated transaction
get
/fscmRestApi/resources/11.13.18.05/jointVentureBasicGeneratedDistributions/{distributionId}
Request
Path Parameters
-
distributionId(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 : jointVentureBasicGeneratedDistributions-item-response
Type:
Show Source
object
-
accountingPeriod: string
Title:
Accounting Period
Read Only:true
Maximum Length:15
The name of the fiscal period that the source transaction is associated with. -
agreement: string
Title:
Carried Interest Agreement
Read Only:true
Maximum Length:30
The name of the agreement of the carried interest distribution. -
agreementDescription: string
Title:
Description
Read Only:true
Maximum Length:240
The description of the agreement of the carried interest distribution. -
basisSource: string
Title:
Basis Source
Read Only:true
Maximum Length:80
The source of the overhead calculation amount. -
businessUnit: string
Title:
Business Unit
Read Only:true
Maximum Length:240
The name of the business unit associated with the joint venture. -
changeReason: string
Title:
Change Reason
Maximum Length:80
The reason the joint venture distribution was canceled. -
changeReasonDetails: string
Title:
Change Reason Details
Maximum Length:240
Additional text to describe the reason the joint venture distribution line was canceled -
contributionId: integer
(int64)
Title:
Partner Contribution ID
Read Only:true
The unique identifier of the partner contribution assigned to the joint venture distribution and drawn from. -
createdBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the joint venture distribution. -
creationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the joint venture distribution was created. -
directBilledStakeholder: string
Title:
Direct Billed Stakeholder
Read Only:true
Maximum Length:30
The name of the direct billed stakeholder assigned to the joint venture transaction that the distribution was created from. -
distributedCredit: number
Title:
Distributed Credit
Read Only:true
The distributed credit amount for the stakeholder in accounting currency. -
distributedDebit: number
Title:
Distributed Debit
Read Only:true
The distributed debit amount for the stakeholder in accounting currency. -
distributionDFF: array
distributionDFF
-
distributionId: integer
(int64)
Title:
Distribution ID
Read Only:true
The unique identifier of the joint venture distribution. -
distributionOnlyFlag: boolean
Title:
Distribution Only
Maximum Length:1
Indicates whether the joint venture stakeholder is only participating in the transaction distribution and not being invoiced. -
distributionType: string
Title:
Distribution Type
Read Only:true
Maximum Length:80
Indicates the type of transaction the distribution represents, such as expense, revenue, and so forth. -
expenditureType: string
Title:
Expenditure Type
Read Only:true
Maximum Length:240
The name identifying the expenditure classification. -
expenditureTypeDescription: string
Title:
Expenditure Type Description
Read Only:true
Maximum Length:2000
The description of the expenditure type. -
invoiceTransactionType: string
Title:
Invoice Type
Read Only:true
Indicates the type of invoice transaction generated for the joint venture distribution, such as receivable invoice and credit memo. -
jointVenture: string
Title:
Joint Venture
Read Only:true
Maximum Length:30
The name of the joint venture of the source transaction. -
jointVentureDescription: string
Title:
Description
Read Only:true
Maximum Length:240
The description of the joint venture. -
lastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the joint venture distribution was last updated. -
lastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the joint venture distribution. -
ledger: string
Title:
Ledger
Read Only:true
Maximum Length:30
The name of the ledger. -
lineNumber: integer
(int32)
Title:
Distribution Line Number
Read Only:true
The line number of a joint venture distribution and any associated lines created for billing adjustments and partner contribution draws. -
lineType: string
Title:
Distribution Line Type
Read Only:true
Maximum Length:80
The type of the distribution line for billing adjustments. -
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. -
notes: string
Title:
Notes
Read Only:true
Maximum Length:240
Additional details about the joint venture source transaction. -
originalDistributedCredit: number
Title:
Original Distributed Credit
Read Only:true
The original credit amount of the joint venture distribution in the accounting currency. This is the amount prior to being split by partner contributions. -
originalDistributedDebit: number
Title:
Original Distributed Debit
Read Only:true
The original debit amount of the joint venture distribution in the accounting currency. This is the amount prior to being split by partner contributions. -
originalDistributedEnteredCredit: number
Title:
Original Distributed Entered Credit
Read Only:true
The original credit amount of the joint venture distribution in the entered currency. This is the amount prior to being split by partner contributions. -
originalDistributedEnteredDebit: number
Title:
Original Distributed Entered Debit
Read Only:true
The original debit amount of the joint venture distribution in the entered currency. This is the amount prior to being split by partner contributions. -
originalStakeholder: string
Title:
Original Stakeholder
Read Only:true
Maximum Length:30
The name of the stakeholder that was originally associated with the joint venture distribution. -
ownershipDefinition: string
Title:
Ownership Definition
Read Only:true
Maximum Length:30
The name of the ownership definition used to process the distribution. -
ownershipDefinitionEndDate: string
(date)
Title:
End Date
Read Only:true
Effective end date of the ownership definition that was used to distribute the joint venture transaction. -
ownershipDefinitionStartDate: string
(date)
Title:
Start Date
Read Only:true
Effective start date of the ownership definition that was used to distribute the joint venture transaction. -
percentageOfInterest: number
Title:
Ownership Percentage
Read Only:true
The percentage of ownership a stakeholder has in a joint venture transaction. -
project: string
Title:
Project Name
Read Only:true
Maximum Length:240
The name of the project. -
projectCostingStatus: string
Title:
Project Costing Status
Read Only:true
Maximum Length:80
The status of the joint venture accounting entries exported to the Project Costing system. -
projectNumber: string
Title:
Project Number
Read Only:true
Maximum Length:25
The unique identifier of the project. -
reassignedStakeholder: string
Title:
Reassigned Stakeholder
Maximum Length:30
The name of the stakeholder that's reassigned to the joint venture distribution. -
roundAmountFlag: boolean
Title:
Rounding Applied
Read Only:true
Maximum Length:1
An indicator that rounding was applied to the distribution amount. -
stakeholder: string
Title:
Stakeholder
Read Only:true
Maximum Length:30
The name of the distribution stakeholder. -
status: string
Title:
Distribution Status
Maximum Length:80
The status of the distribution of the joint venture transaction. -
task: string
Title:
Task Name
Read Only:true
Maximum Length:255
The name of the project task representing a subdivision of work. -
taskNumber: string
Title:
Task Number
Read Only:true
Maximum Length:100
The unique number of the project task. -
transactionCredit: number
Title:
Transaction Credit
Read Only:true
The credit amount of the joint venture source transaction. -
transactionCurrency: string
Title:
Currency
Read Only:true
Maximum Length:15
The currency of the transaction amount. -
transactionDate: string
(date)
Title:
Transaction Date
Read Only:true
Indicates the default effective date for journal entries or the transaction date for subledger entries. -
transactionDebit: number
Title:
Transaction Debit
Read Only:true
The debit amount of the joint venture source transaction. -
transactionDescription: string
Title:
Transaction Description
Read Only:true
Maximum Length:240
A description that's passed into the joint venture invoice for the joint venture source transaction. -
transactionId: integer
(int64)
Title:
Transaction ID
Read Only:true
The unique identifier for the joint venture transaction that the distribution was created from. -
transactionType: string
Title:
Type
Read Only:true
Maximum Length:80
The type of the joint venture source transaction. -
trxDate: string
(date)
Title:
Invoice Date
Read Only:true
The date of the invoice transaction generated for the joint venture distribution. -
trxNumber: string
Title:
Invoice Number
Read Only:true
Maximum Length:20
A unique value that identifies the invoice generated for the joint venture distribution.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : jointVentureBasicGeneratedDistributions-distributionDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:150
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
DistributionId: integer
(int64)
Title:
Distribution ID
Read Only:true
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
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.
Links
- distributionDFF
-
Parameters:
- distributionId:
$request.path.distributionId
- distributionId:
Examples
The following example shows how to retrieve a distribution for a joint venture generated 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/jointVentureBasicGeneratedDistributions/100105348630646"
Response Body Example
The following shows an example of the response body in JSON format.
{ "distributionId": 100105348630646, "status": "Process complete", "distributionType": "Overhead", "lineType": "Original", "lineNumber": 1, "transactionDate": "2017-02-02", "transactionId": 100105348630257, "jointVenture": "APOLLOBASIN", "jointVentureDescription": "Oklahoma panhandle project", "businessUnit": "HEPP Petroleum USA BU1", "ownershipDefinition": "CIOPD", "ownershipDefinitionStartDate": "2017-01-01", "ownershipDefinitionEndDate": "2017-12-31", "stakeholder": "GOILMEX_ASH6", "originalStakeholder": null, "reassignedStakeholder": GOILMEX_ASH6, "directBilledStakeholder": null, "percentageOfInterest": 22, "roundAmountFlag": false, "distributionOnlyFlag": false, "changeReason": null, "changeReasonDetails": null, "accountingPeriod": "Feb-17", "transactionType": "Overhead", "method": "OH_APOLLO0505212350", "methodDescription": "Overhead for APOLLO", "basisSource": "Joint venture billed transactions", "transactionDescription": "OH_BA0505212350", "distributedDebit": 198, "distributedCredit": null, "originalDistributedDebit": 198, "originalDistributedCredit": null, "originalDistributedEnteredDebit": null, "originalDistributedEnteredCredit": null, "transactionDebit": 900, "transactionCredit": null, "transactionCurrency": "USD", "ledger": "HEPPLedger US", "trxNumber": "44003", "trxDate": "2024-02-19", "invoiceTransactionType": "Receivables Invoice", "contributionId": null, "agreement": "CIA2", "agreementDescription": null, "projectCostingStatus": "Not applicable", "project": null, "projectNumber": null, "task": null, "taskNumber": null, "expenditureType": null, "expenditureTypeDescription": null, "createdBy": "username", "creationDate": "2024-02-19T07:16:15+00:00", "lastUpdatedBy": "username", "lastUpdateDate": "2024-02-19T15:42:50.431+00:00", "notes": null, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureBasicGeneratedDistributions/100105348630646", "name": "jointVentureBasicGeneratedDistributions", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureBasicGeneratedDistributions/100105348630646", "name": "jointVentureBasicGeneratedDistributions", "kind": "item" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureBasicGeneratedDistributions/100105348630646/child/distributionDFF", "name": "distributionDFF", "kind": "collection" } ] }