Get a joint venture accounting header

get

/fscmRestApi/resources/11.13.18.05/jointVentureAccountingHeaders/{accountingHeaderId}

Request

Path Parameters
  • 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
  • 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>
  • 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).
  • 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
  • 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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
  • 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".
  • 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 Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : jointVentureAccountingHeaders-item-response
Type: object
Show Source
Nested Schema : accountingHeaderDFF
Type: array
Show Source
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 : 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: object
Show Source
Nested Schema : jointVentureAccountingHeaders-carriedInterestDistributions-item-response
Type: object
Show Source
  • Title: Carried Amount
    Read Only: true
    The distributed amount of the nonconsenting stakeholder's share assumed by the consenting stakeholder.
  • Title: Consenting Stakeholder
    Read Only: true
    Maximum Length: 30
    The name of the consenting stakeholder on the carried interest distribution.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the resource item.
  • Title: Creation Date
    Read Only: true
    The date and time when the resource item was created.
  • Title: Currency
    Read Only: true
    Maximum Length: 15
    The accounting currency of the source joint venture transaction.
  • Title: Distribution ID
    Read Only: true
    The unique identifier of the carried interest distribution.
  • 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.
  • Title: Last Updated Date
    Read Only: true
    The date and time when the resource item was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the resource item.
  • Links
  • Title: Nonconsenting Stakeholder
    Read Only: true
    Maximum Length: 30
    The name of the nonconsenting stakeholder on the carried interest distribution.
  • Title: Transaction Source
    Read Only: true
    Maximum Length: 255
    The source of the joint venture transaction that the distribution was created from.
  • Title: Transaction Date
    Read Only: true
    The transaction date of the carried interest distribution.
Nested Schema : jointVentureAccountingHeaders-contributionReferences-item-response
Type: object
Show Source
  • Title: Agreement Default Charge
    Read Only: true
    The amount charged to the partner when the partner contribution is closed.
  • 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.
  • Title: Description
    Read Only: true
    Maximum Length: 240
    The description of the partner contribution.
  • Title: Partner Contribution ID
    Read Only: true
    The unique identifier of the joint venture partner contribution.
  • Title: Contribution Reference ID
    Read Only: true
    The unique identifier of the partner contribution transaction reference.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the joint venture partner contribution.
  • Title: Creation Date
    Read Only: true
    The date and time when the joint venture partner contribution was created.
  • Title: Last Updated Date
    Read Only: true
    The date and time when the transaction reference for the partner contribution was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the transaction reference for partner contribution.
  • Links
  • Title: Joint Venture Partner Contribution Account
    Read Only: true
    Maximum Length: 255
    The combination of segment values for a joint venture partner contribution account.
  • Title: Refund Amount
    Read Only: true
    The amount to return to the partner when the partner contribution is closed.
  • Title: Structure Instance Number
    Read Only: true
    The chart of accounts instance number associated with the joint venture's business unit.
  • Title: Transaction Currency
    Read Only: true
    Maximum Length: 15
    The currency code of the partner contribution transaction.
  • Title: Transaction ID
    Read Only: true
    Default Value: 0
    The unique identifier of the transaction created to fund or close the partner contribution.
  • Title: Transaction Type
    Read Only: true
    Maximum Length: 80
    The type of transaction used to open the partner contribution.
Nested Schema : jointVentureAccountingHeaders-distributions-item-response
Type: object
Show Source
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the joint venture distribution.
  • Title: Creation Date
    Read Only: true
    The date and time when the joint venture distribution was created.
  • Title: Currency
    Read Only: true
    Maximum Length: 15
    The currency of the distribution amount.
  • Title: Distributed Accounted Credit
    Read Only: true
    The distributed credit amount for the stakeholder in accounting currency.
  • Title: Distributed Accounted Debit
    Read Only: true
    The distributed debit amount for the stakeholder in accounting currency.
  • Title: Distribution ID
    Read Only: true
    The unique identifier of the joint venture distribution.
  • Title: Distribution Line Type
    Read Only: true
    Maximum Length: 80
    The type of the distribution line for billing adjustments.
  • Title: Expenditure Type
    Read Only: true
    Maximum Length: 240
    The name identifying the expenditure classification.
  • Title: Last Updated Date
    Read Only: true
    The date and time when the joint venture distribution was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the joint venture distribution.
  • Title: Transaction Description
    Read Only: true
    Maximum Length: 255
    The line description of the original transaction.
  • Links
  • Title: Original Transaction Account
    Read Only: true
    Maximum Length: 255
    The account combination assigned to the original transaction transferred to the internal stakeholder.
  • Title: Ownership Definition
    Read Only: true
    Maximum Length: 30
    The name of the ownership definition.
  • Title: Ownership Percentage
    Read Only: true
    The percent of ownership a stakeholder has in a joint venture transaction.
  • Title: Project Name
    Read Only: true
    Maximum Length: 240
    The name of the project.
  • Title: Project Number
    Read Only: true
    Maximum Length: 25
    The unique number of the project.
  • Title: Task Name
    Read Only: true
    Maximum Length: 255
    The name of the task.
  • Title: Task Number
    Read Only: true
    Maximum Length: 100
    The unique number of the task.
  • 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.
  • Title: Transaction Source
    Read Only: true
    Maximum Length: 255
    The source of the joint venture transaction that the distribution was created from.
Nested Schema : jointVentureAccountingHeaders-operationalMeasures-item-response
Type: object
Show Source
  • Title: Accounting Header ID
    Read Only: true
    The unique identifier of the accounting header.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the operational measure.
  • Title: Creation Date
    Read Only: true
    The date and time when the operational measure was created.
  • Title: Document Number
    Read Only: true
    Maximum Length: 240
    The unique document reference for the joint venture accounting transaction.
  • Title: Joint Venture
    The unique name of the joint venture.
  • Title: Joint Venture Description
    Read Only: true
    Maximum Length: 240
    The description of the joint venture.
  • Title: Last Updated Date
    Read Only: true
    The date and time when the operational measure was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the operational measure.
  • Links
  • Title: Measure Date
    The date of the operational measure.
  • 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.
  • 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.
  • Title: Status
    The status of the operational measure for generating statistical journal entries.
  • Title: Measure Type
    The unique name of the measure type.
  • Title: Measure Type Description
    Read Only: true
    Maximum Length: 240
    The description of the measure type.
  • Title: Measure Value
    The value of the operational measure.
  • 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.
  • Title: Operational Measure ID
    Read Only: true
    The unique identifier of the operational measure.
  • 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.
  • Title: Reference
    Maximum Length: 64
    The reference associated with the operational measure.
  • 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.
  • Title: Primary Segment Value Description
    Read Only: true
    The description of the primary segment value.
  • Title: Unit of Measure
    Read Only: true
    Maximum Length: 80
    The unit of measure for the operational measure value.
Back to Top

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"
    }
  ]
}
Back to Top