Get a joint venture accounting header
get
/fscmRestApi/resources/11.13.18.05/jointVentureAccountingHeaders/{accountingHeaderId}
Request
Path Parameters
-
accountingHeaderId(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 : jointVentureAccountingHeaders-item-response
Type:
Show Source
object
-
accountingDate: string
(date)
Title:
Accounting Date
Read Only:true
The date used to determine the accounting period for the joint venture accounting transaction. -
accountingHeaderDFF: array
accountingHeaderDFF
-
accountingHeaderId: integer
(int64)
Title:
Accounting Header ID
Read Only:true
The unique identifier of the accounting header. -
accountingStatus: string
Title:
Accounting Status
Read Only:true
Maximum Length:80
The status of the accounting transaction. -
accountingType: string
Title:
Accounting Type
Read Only:true
Maximum Length:80
The transaction type of the joint venture accounting transaction. -
agreement: string
Title:
Agreement
Read Only:true
Maximum Length:30
The name of the carried interest agreement. -
businessUnit: string
Title:
Business Unit
Read Only:true
Maximum Length:240
The name of the business unit associated with the joint venture. -
carriedInterestDistributions: array
Carried Interest Distributions
Title:
Carried Interest Distributions
The carried interest distributions resource is used to view carried interest distributions for a joint venture journal. -
contributionId: integer
(int64)
Title:
Partner Contribution ID
Read Only:true
The unique identifier of the joint venture partner contribution. -
contributionReferences: array
Partner Contribution References
Title:
Partner Contribution References
The contribution references resource is used to view, update, or delete the transaction references required to fund or close partner contributions. -
costCenter: string
Title:
Cost Center
Read Only:true
Maximum Length:25
The cost center segment value associated with the distributed stakeholder. -
createdBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the joint venture accounting header. -
creationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the joint venture accounting header was created. -
distributions: array
Joint Venture Distributions
Title:
Joint Venture Distributions
The distributions resource is used to view joint venture distributions for a joint venture journal. -
documentNumber: string
Title:
Document Number
Read Only:true
Maximum Length:240
The unique document reference for the joint venture accounting transaction. -
eventId: integer
(int64)
Title:
Event ID
Read Only:true
The unique identifier of the accounting event. -
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. -
lastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the joint venture accounting header was last updated. -
lastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the joint venture accounting header. -
ledger: string
Title:
Ledger
Read Only:true
Maximum Length:30
The name of the ledger. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
operationalMeasures: array
Joint Venture Operational Measures
Title:
Joint Venture Operational Measures
The operational measures resource is used to view or reverse the operational measures for a joint venture journal. -
stakeholder: string
Title:
Stakeholder
Read Only:true
Maximum Length:30
The unique name of the joint venture stakeholder. -
subledgerHeaderId: integer
(int64)
Title:
Subledger Header ID
Read Only:true
The unique identifier of the subledger journal.
Nested Schema : Carried Interest Distributions
Type:
array
Title:
Carried Interest Distributions
The carried interest distributions resource is used to view carried interest distributions for a joint venture journal.
Show Source
Nested Schema : Partner Contribution References
Type:
array
Title:
Partner Contribution References
The contribution references resource is used to view, update, or delete the transaction references required to fund or close partner contributions.
Show Source
Nested Schema : Joint Venture Distributions
Type:
array
Title:
Joint Venture Distributions
The distributions resource is used to view joint venture distributions for a joint venture journal.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Joint Venture Operational Measures
Type:
array
Title:
Joint Venture Operational Measures
The operational measures resource is used to view or reverse the operational measures for a joint venture journal.
Show Source
Nested Schema : jointVentureAccountingHeaders-accountingHeaderDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:150
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
AccountingHeaderId: integer
(int64)
Title:
Accounting Header ID
-
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.
Nested Schema : jointVentureAccountingHeaders-carriedInterestDistributions-item-response
Type:
Show Source
object
-
carriedAmount: number
Title:
Carried Amount
Read Only:true
The distributed amount of the nonconsenting stakeholder's share assumed by the consenting stakeholder. -
consentingStakeholder: string
Title:
Consenting Stakeholder
Read Only:true
Maximum Length:30
The name of the consenting stakeholder on the carried interest distribution. -
createdBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the resource item. -
creationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the resource item was created. -
currency: string
Title:
Currency
Read Only:true
Maximum Length:15
The accounting currency of the source joint venture transaction. -
distributionId: integer
(int64)
Title:
Distribution ID
Read Only:true
The unique identifier of the carried interest distribution. -
distributionLineType: string
Title:
Distribution Line Type
Read Only:true
Maximum Length:80
The type of carried interest distribution line, such as original, canceled, reversed, and so forth. -
lastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the resource item was last updated. -
lastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the resource item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
nonConsentingStakeholder: string
Title:
Nonconsenting Stakeholder
Read Only:true
Maximum Length:30
The name of the nonconsenting stakeholder on the carried interest distribution. -
source: string
Title:
Transaction Source
Read Only:true
Maximum Length:255
The source of the joint venture transaction that the distribution was created from. -
transactionDate: string
(date)
Title:
Transaction Date
Read Only:true
The transaction date of the carried interest distribution.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : jointVentureAccountingHeaders-contributionReferences-item-response
Type:
Show Source
object
-
agreementDefaultCharge: number
Title:
Agreement Default Charge
Read Only:true
The amount charged to the partner when the partner contribution is closed. -
agreementDefaultChargeAccount: string
Title:
Agreement Default Charge Account
Read Only:true
Maximum Length:255
The account used to record the agreement default charge when closing a partner contribution. -
contributionDescription: string
Title:
Description
Read Only:true
Maximum Length:240
The description of the partner contribution. -
contributionId: integer
(int64)
Title:
Partner Contribution ID
Read Only:true
The unique identifier of the joint venture partner contribution. -
contributionReferenceId: integer
(int64)
Title:
Contribution Reference ID
Read Only:true
The unique identifier of the partner contribution transaction reference. -
createdBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the joint venture partner contribution. -
creationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the joint venture partner contribution was created. -
lastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the transaction reference for the partner contribution was last updated. -
lastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the transaction reference for partner contribution. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
partnerAccount: string
Title:
Joint Venture Partner Contribution Account
Read Only:true
Maximum Length:255
The combination of segment values for a joint venture partner contribution account. -
refundAmount: number
Title:
Refund Amount
Read Only:true
The amount to refund to the partner when the partner contribution is closed. - relatedContributionId: integer (int64)
-
structureInstanceNumber: integer
(int64)
Title:
Structure Instance Number
Read Only:true
The chart of accounts instance number associated with the joint venture's business unit. -
transactionAmount: number
Title:
Transaction Amount
Read Only:true
The amount to return to the partner when closing the partner contribution or the open amount to transfer to another partner contribution. -
transactionCurrencyCode: string
Title:
Transaction Currency
Read Only:true
Maximum Length:15
The currency code of the partner contribution transaction. -
transactionId: integer
(int64)
Title:
Transaction ID
Read Only:true
Default Value:0
The unique identifier of the transaction created for the partner contribution. -
transactionType: string
Title:
Transaction Type
Read Only:true
Maximum Length:80
The type of transaction used to open the partner contribution.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : jointVentureAccountingHeaders-distributions-item-response
Type:
Show Source
object
-
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. -
currencyCode: string
Title:
Currency
Read Only:true
Maximum Length:15
The currency of the distribution amount. -
distributedCreditAmount: number
Title:
Distributed Accounted Credit
Read Only:true
The distributed credit amount for the stakeholder in accounting currency. -
distributedDebitAmount: number
Title:
Distributed Accounted Debit
Read Only:true
The distributed debit amount for the stakeholder in accounting currency. -
distributionId: integer
(int64)
Title:
Distribution ID
Read Only:true
The unique identifier of the joint venture distribution. -
distributionLineType: string
Title:
Distribution Line Type
Read Only:true
Maximum Length:80
The type of the distribution line for billing adjustments. -
expenditureType: string
Title:
Expenditure Type
Read Only:true
Maximum Length:240
The name identifying the expenditure classification. -
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. -
lineDescription: string
Title:
Transaction Description
Read Only:true
Maximum Length:255
The line description of the original transaction. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
originalTransactionAccount: string
Title:
Original Transaction Account
Read Only:true
Maximum Length:255
The account combination assigned to the original transaction transferred to the internal stakeholder. -
ownershipDefinition: string
Title:
Ownership Definition
Read Only:true
Maximum Length:30
The name of the ownership definition. -
percentageOfInterest: number
Title:
Ownership Percentage
Read Only:true
The percent 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. -
projectNumber: string
Title:
Project Number
Read Only:true
Maximum Length:25
The unique number of the project. -
task: string
Title:
Task Name
Read Only:true
Maximum Length:255
The name of the task. -
taskNumber: string
Title:
Task Number
Read Only:true
Maximum Length:100
The unique number of the task. -
transactionDate: string
(date)
Title:
Transaction Date
Read Only:true
The date when the transaction occurred, which may be different from the journal entry effective date or subledger accounting date. -
transactionSource: string
Title:
Transaction Source
Read Only:true
Maximum Length:255
The source of the joint venture transaction that the distribution was created from.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : jointVentureAccountingHeaders-operationalMeasures-item-response
Type:
Show Source
object
-
accountingHeaderId: integer
(int64)
Title:
Accounting Header ID
Read Only:true
The unique identifier of the accounting header. -
createdBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the operational measure. -
creationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the operational measure was created. -
documentNumber: string
Title:
Document Number
Read Only:true
Maximum Length:240
The unique document reference for the joint venture accounting transaction. -
jointVenture: string
Title:
Joint Venture
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. -
lastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the operational measure was last updated. -
lastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the operational measure. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
measureDate: string
(date)
Title:
Measure Date
The date of the operational measure. -
measureLineNumber: integer
(int32)
Title:
Line Number
Read Only:true
The line number of the operational measure that's incremented when processing reversals and corrections of statistical journal entries. -
measureLineType: string
Title:
Line Type
Read Only:true
Maximum Length:80
The type of the operational measure line for processing reversals and corrections of statistical journal entries. Valid values are Original, Canceled, and Reversed. -
measureStatus: string
Title:
Status
The status of the operational measure for generating statistical journal entries. -
measureType: string
Title:
Measure Type
The unique name of the measure type. -
measureTypeDescription: string
Title:
Measure Type Description
Read Only:true
Maximum Length:240
The description of the measure type. -
measureValue: number
Title:
Measure Value
The value of the operational measure. -
measureValueType: string
Title:
Value Type
Read Only:true
Maximum Length:80
The value type used to identify the operational measure value as a number or a percent. -
operationalMeasureId: integer
(int64)
Title:
Operational Measure ID
Read Only:true
The unique identifier of the operational measure. -
primarySegment: string
Title:
Primary Segment
Read Only:true
Maximum Length:255
The name of the account segment labeled as the primary segment in the chart of accounts instance associated with the joint venture. -
reference: string
Title:
Reference
Maximum Length:64
The reference associated with the operational measure. -
segmentValue: string
Title:
Primary Segment Value
Maximum Length:25
A valid value defined for the segment labeled as the primary segment within the chart of accounts instance associated with the joint venture. -
segmentValueDescription: string
Title:
Primary Segment Value Description
Read Only:true
The description of the primary segment value. -
unitOfMeasure: string
Title:
Unit of Measure
Read Only:true
Maximum Length:80
The unit of measure for the operational measure value.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- accountingHeaderDFF
-
Parameters:
- accountingHeaderId:
$request.path.accountingHeaderId
- accountingHeaderId:
- carriedInterestDistributions
-
Parameters:
- accountingHeaderId:
$request.path.accountingHeaderId
The carried interest distributions resource is used to view carried interest distributions for a joint venture journal. - accountingHeaderId:
- contributionReferences
-
Parameters:
- accountingHeaderId:
$request.path.accountingHeaderId
The contribution references resource is used to view, update, or delete the transaction references required to fund or close partner contributions. - accountingHeaderId:
- distributions
-
Parameters:
- accountingHeaderId:
$request.path.accountingHeaderId
The distributions resource is used to view joint venture distributions for a joint venture journal. - accountingHeaderId:
- operationalMeasures
-
Parameters:
- accountingHeaderId:
$request.path.accountingHeaderId
The operational measures resource is used to view or reverse the operational measures for a joint venture journal. - accountingHeaderId:
Examples
The following example shows how to retrieve a joint venture accounting header 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/jointVentureAccountingHeaders/100101431295249"
Example Response Body
The following shows an example of the response body in JSON format.
{ "accountingHeaderId": 100101431295249, "documentNumber": "COST_TRANSFER:ALBERTA:ALBERTA_1002:06-02-2023:06:11:33", "eventId": 2544960, "accountingDate": "2017-01-06", "accountingStatus": "Unprocessed", "accountingType": "Internal transfer", "jointVenture": "ALBERTA", "jointVentureDescription": "Alberta exploration project", "stakeholder": "ALBERTA_1002", "costCenter": "1002", "businessUnit": "HEPP Petroleum USA BU2", "ledger": "HEPPLedger US", "createdBy": "username", "creationDate": "2023-02-06T18:11:34.284+00:00", "lastUpdatedBy": "username", "lastUpdateDate": "2023-02-06T18:11:34.284+00:00", "agreement": null, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureAccountingHeaders/100101431295249", "name": "jointVentureAccountingHeaders", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureAccountingHeaders/100101431295249", "name": "jointVentureAccountingHeaders", "kind": "item" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureAccountingHeaders/100101431295249/child/accountingHeaderDFF", "name": "accountingHeaderDFF", "kind": "collection" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureAccountingHeaders/100101431295249/child/carriedInterestDistributions", "name": "carriedInterestDistributions", "kind": "collection" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureAccountingHeaders/100101431295249/child/distributions", "name": "distributions", "kind": "collection" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureAccountingHeaders/100101431295249/child/operationalMeasures", "name": "operationalMeasures", "kind": "collection" } ] }