1. REST API for Oracle Fusion Cloud Financials
  2. Tasks
  3. Joint Venture Overhead Methods

Get a joint venture overhead method

get

/fscmRestApi/resources/11.13.18.05/jointVentureOverheadMethods/{overheadMethodId}

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 : jointVentureOverheadMethods-item-response
Type: object
Show Source
  • Title: Partner Account
    The combination of account segment values assigned to a partner's line in the receivables invoice.
  • Title: Adjustment Factor
    The name of the periodic adjustment factor associated with the overhead method.
  • Title: Basis Source
    The source of the overhead calculation amount.
  • Title: Calendar Type
    The type of calendar used by the overhead calculation when determining the period basis amount. Valid values are Fiscal calendar and Standard calendar.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the overhead method.
  • Title: Creation Date
    Read Only: true
    The date and time when the overhead method was created.
  • Title: Currency
    Read Only: true
    Maximum Length: 15
    The currency of the default primary ledger associated with the business unit assigned to the joint venture.
  • Title: Direct Billed Stakeholder
    The name of the stakeholder to be billed directly for the overhead transaction.
  • Title: Distribution Type
    The distribution type included on joint venture invoices for overhead transactions, which is used to assign the partner account to the invoice line.
  • Title: End Date
    The end date of the effective date range of the overhead method.
  • Title: Joint Venture
    The unique name of the joint venture.
  • Title: Joint Venture Description
    Read Only: true
    The description of the joint venture.
  • Title: Transaction Description
    Maximum Length: 240
    The description included on the joint venture invoices for the calculated overhead transactions.
  • Title: Last Processed Date
    Read Only: true
    The date when the adjustment factor was last applied to the overhead method.
  • Title: Last Factor Date
    Read Only: true
    The date of the last adjustment factor value that was applied to the overhead method.
  • Title: Last Factor Percentage
    Read Only: true
    The percentage of the last adjustment factor value that was applied to the overhead method.
  • Title: Last Updated Date
    Read Only: true
    The date and time when the overhead method was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the overhead method.
  • Links
  • Title: Maximum Amount
    Default Value: 0
    The maximum overhead amount allowed to be billed.
  • Overhead Measure Types
    Title: Overhead Measure Types
    The overhead measure types resource is used to view, create, or delete overhead measure types.
  • Title: Method
    Maximum Length: 30
    The unique name of the overhead method.
  • Title: Description
    Maximum Length: 240
    The description of the overhead method.
  • Title: Status
    The status of the overhead method.
  • Title: Type
    The method type used to determine how the overhead amount is calculated.
  • Title: Minimum Amount
    Default Value: 0
    The minimum debit amount for an overhead account receivable invoice when the calculated overhead amount is less than the minimum.
  • overheadMethodDFF
  • Title: Overhead Method ID
    Read Only: true
    The unique identifier of the overhead method.
  • Title: Ownership Definition
    Maximum Length: 30
    The unique name of the ownership definition assigned to the overhead method.
  • Title: Percentage
    The percentage used to calculate the overhead amount for methods based on a percentage.
  • Title: Period Basis
    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.
  • Title: Rate
    The rate used to calculate the overhead amount for methods based on a rate.
  • Title: Segment
    The segment in the chart of accounts used to select joint venture transactions for overhead calculations.
  • Title: Segment Value
    Maximum Length: 25
    A valid value for the account segment assigned to the overhead method and used to select joint venture transactions for overhead calculations.
  • Title: Description
    Read Only: true
    The description of the segment value assigned to the overhead method.
  • Title: Use Sliding Scale
    Maximum Length: 1
    Default Value: false
    Indicates whether a sliding scale is used for the overhead method.
  • Sliding Scale Thresholds
    Title: Sliding Scale Thresholds
    The sliding scale threshold resource is used to view, create, update, or delete sliding scale thresholds for an overhead method.
  • Title: Start Date
    The start date of the effective date range of the overhead method.
  • Title: Structure Instance Number
    The unique identifier of the chart of accounts assigned to the primary ledger of the business unit associated with the joint venture.
  • Title: Overhead Transactions Exist
    Read Only: true
    Indicates whether there are existing transactions generated from the overhead method.
  • Title: Transaction Source Account
    The formatted account combination for the account used to select general ledger and subledger transactions for the overhead calculation.
  • Title: Account Set
    The name of the account set used to select general ledger and subledger transactions for the overhead calculation.
  • Title: Transaction Source Ledger
    The name of the ledger used to select the transaction source account that identifies general ledger and subledger transactions for the overhead calculation.
  • Title: Transaction Source Structure Instance Number
    The unique identifier of the chart of accounts instance assigned to the selected ledger for the transaction source account.
Nested Schema : Overhead Measure Types
Type: array
Title: Overhead Measure Types
The overhead measure types resource is used to view, create, or delete overhead measure types.
Show Source
Nested Schema : overheadMethodDFF
Type: array
Show Source
Nested Schema : Sliding Scale Thresholds
Type: array
Title: Sliding Scale Thresholds
The sliding scale threshold resource is used to view, create, update, or delete sliding scale thresholds for an overhead method.
Show Source
Nested Schema : jointVentureOverheadMethods-measureTypes-item-response
Type: object
Show Source
Nested Schema : overheadMeasureTypeDFF
Type: array
Show Source
Nested Schema : jointVentureOverheadMethods-measureTypes-overheadMeasureTypeDFF-item-response
Type: object
Show Source
Nested Schema : jointVentureOverheadMethods-overheadMethodDFF-item-response
Type: object
Show Source
Nested Schema : jointVentureOverheadMethods-slidingScaleThresholds-item-response
Type: object
Show Source
Nested Schema : thresholdDFF
Type: array
Show Source
Nested Schema : jointVentureOverheadMethods-slidingScaleThresholds-thresholdDFF-item-response
Type: object
Show Source
Links
measureTypes
Parameters:
  • overheadMethodId: $request.path.overheadMethodId
The overhead measure types resource is used to view, create, or delete overhead measure types.
overheadMethodDFF
Parameters:
  • overheadMethodId: $request.path.overheadMethodId
slidingScaleThresholds
Parameters:
  • overheadMethodId: $request.path.overheadMethodId
The sliding scale threshold resource is used to view, create, update, or delete sliding scale thresholds for an overhead method.
Back to Top

Examples

The following example shows how to get a joint venture overhead method 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/jointVentureOverheadMethods/300100542726760"

Response Body Example

The following shows an example of the response body in JSON format.

{
    "overheadMethodId": 300100542726760,
    "method": "ALBERTAOPD",
    "methodDescription": "Alberta overhead based on percentage of costs",
    "methodType": "Percentage of cost",
    "jointVenture": "ALBERTA",
    "jointVentureDescription": "Alberta exploration project",
    "startDate": "2021-05-12",
    "endDate": "2199-12-31",
    "methodStatus": "Pending",
    "basisSource": "Joint venture billed transactions",
    "percentage": 0,
    "segment": null,
    "segmentValue": null,
    "segmentValueDescription": null,
    "ownershipDefinition": "ALBERTA",
    "distributionType": "Overhead",
    "minimumAmount": 0,
    "currencyCode": "USD",
    "journalDescription": null,
    "structureInstanceNumber": 46521,
    "account": "",
    "transactionsExistFlag": false,
    "createdBy": "username",
    "creationDate": "2021-05-12T19:02:17+00:00",
    "lastUpdatedBy": "username",
    "lastUpdateDate": "2021-05-18T06:59:54+00:00",
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureOverheadMethods/300100542726760",
            "name": "jointVentureOverheadMethods",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000378"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureOverheadMethods/300100542726760",
            "name": "jointVentureOverheadMethods",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureOverheadMethods/300100542726760/child/overheadMethodDFF",
            "name": "overheadMethodDFF",
            "kind": "collection"
        }
    ]
}
Back to Top