Update a joint venture overhead method
patch
/fscmRestApi/resources/11.13.18.05/jointVentureOverheadMethods/{overheadMethodId}
Request
Path Parameters
-
overheadMethodId(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=
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
account: string
Title:
Partner Account
The combination of account segment values assigned to a partner's line in the receivables invoice. -
adjustmentFactor: string
Title:
Adjustment Factor
The name of the periodic adjustment factor associated with the overhead method. -
basisSource: string
Title:
Basis Source
The source of the overhead calculation amount. -
calendarType: string
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. -
directBilledStakeholder: string
Title:
Direct Billed Stakeholder
The name of the stakeholder to be billed directly for the overhead transaction. -
distributionType: string
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. -
endDate: string
(date)
Title:
End Date
The end date of the effective date range of the overhead method. -
fixedAmount: number
Title:
Amount
Default Value:0
The fixed amount applied to the joint venture as overhead. -
jointVenture: string
Title:
Joint Venture
The unique name of the joint venture. -
journalDescription: string
Title:
Transaction Description
Maximum Length:240
The description included on the joint venture invoices for the calculated overhead transactions. -
maximumAmount: number
Title:
Maximum Amount
Default Value:0
The maximum overhead amount allowed to be billed. -
measureTypes: array
Overhead Measure Types
Title:
Overhead Measure Types
The overhead measure types resource is used to view, create, or delete overhead measure types. -
method: string
Title:
Method
Maximum Length:30
The unique name of the overhead method. -
methodDescription: string
Title:
Description
Maximum Length:240
The description of the overhead method. -
methodStatus: string
Title:
Status
The status of the overhead method. -
methodType: string
Title:
Type
The method type used to determine how the overhead amount is calculated. -
minimumAmount: number
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: array
overheadMethodDFF
-
ownershipDefinition: string
Title:
Ownership Definition
Maximum Length:30
The unique name of the ownership definition assigned to the overhead method. -
percentage: number
Title:
Percentage
The percentage used to calculate the overhead amount for methods based on a percentage. -
periodBasis: string
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. -
rate: number
Title:
Rate
The rate used to calculate the overhead amount for methods based on a rate. -
segment: string
Title:
Segment
The segment in the chart of accounts used to select joint venture transactions for overhead calculations. -
segmentValue: string
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. -
slidingScaleFlag: boolean
Title:
Use Sliding Scale
Maximum Length:1
Default Value:false
Indicates whether a sliding scale is used for the overhead method. -
slidingScaleThresholds: array
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. -
startDate: string
(date)
Title:
Start Date
The start date of the effective date range of the overhead method. -
structureInstanceNumber: integer
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. -
transactionSourceAccount: string
Title:
Transaction Source Account
The formatted account combination for the account used to select general ledger and subledger transactions for the overhead calculation. -
transactionSourceAccountSet: string
Title:
Account Set
The name of the account set used to select general ledger and subledger transactions for the overhead calculation. -
transactionSourceLedger: string
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. -
transactionSourceStructureInstanceNumber: integer
(int64)
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 : 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-patch-request
Type:
Show Source
object
Nested Schema : schema
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
Nested Schema : schema
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:32
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
Nested Schema : schema
Type:
Show Source
object
-
amount: number
Title:
Threshold Amount
The amount up to which the threshold percentage is applied to calculate a portion of the overhead amount. -
percentage: number
Title:
Threshold Percentage
The threshold percentage used to calculate the portion of the overhead amount up to the threshold amount. -
rate: number
Title:
Threshold Rate
The threshold rate used to calculate the portion of the overhead amount up to the threshold amount. -
thresholdDFF: array
thresholdDFF
Nested Schema : schema
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
Response
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 : jointVentureOverheadMethods-item-response
Type:
Show Source
object
-
account: string
Title:
Partner Account
The combination of account segment values assigned to a partner's line in the receivables invoice. -
adjustmentFactor: string
Title:
Adjustment Factor
The name of the periodic adjustment factor associated with the overhead method. -
basisSource: string
Title:
Basis Source
The source of the overhead calculation amount. -
calendarType: string
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. -
createdBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the overhead method. -
creationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the overhead method was created. -
currencyCode: string
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. -
directBilledStakeholder: string
Title:
Direct Billed Stakeholder
The name of the stakeholder to be billed directly for the overhead transaction. -
distributionType: string
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. -
endDate: string
(date)
Title:
End Date
The end date of the effective date range of the overhead method. -
fixedAmount: number
Title:
Amount
Default Value:0
The fixed amount applied to the joint venture as overhead. -
jointVenture: string
Title:
Joint Venture
The unique name of the joint venture. -
jointVentureDescription: string
Title:
Joint Venture Description
Read Only:true
The description of the joint venture. -
journalDescription: string
Title:
Transaction Description
Maximum Length:240
The description included on the joint venture invoices for the calculated overhead transactions. -
lastAdjustmentDate: string
(date)
Title:
Last Processed Date
Read Only:true
The date when the adjustment factor was last applied to the overhead method. -
lastFactorValueDate: string
(date)
Title:
Last Factor Date
Read Only:true
The date of the last adjustment factor value that was applied to the overhead method. -
lastFactorValuePercentage: number
Title:
Last Factor Percentage
Read Only:true
The percentage of the last adjustment factor value that was applied to the overhead method. -
lastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the overhead method was last updated. -
lastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the overhead method. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
maximumAmount: number
Title:
Maximum Amount
Default Value:0
The maximum overhead amount allowed to be billed. -
measureTypes: array
Overhead Measure Types
Title:
Overhead Measure Types
The overhead measure types resource is used to view, create, or delete overhead measure types. -
method: string
Title:
Method
Maximum Length:30
The unique name of the overhead method. -
methodDescription: string
Title:
Description
Maximum Length:240
The description of the overhead method. -
methodStatus: string
Title:
Status
The status of the overhead method. -
methodType: string
Title:
Type
The method type used to determine how the overhead amount is calculated. -
minimumAmount: number
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: array
overheadMethodDFF
-
overheadMethodId: integer
(int64)
Title:
Overhead Method ID
Read Only:true
The unique identifier of the overhead method. -
ownershipDefinition: string
Title:
Ownership Definition
Maximum Length:30
The unique name of the ownership definition assigned to the overhead method. -
percentage: number
Title:
Percentage
The percentage used to calculate the overhead amount for methods based on a percentage. -
periodBasis: string
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. -
rate: number
Title:
Rate
The rate used to calculate the overhead amount for methods based on a rate. -
segment: string
Title:
Segment
The segment in the chart of accounts used to select joint venture transactions for overhead calculations. -
segmentValue: string
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. -
segmentValueDescription: string
Title:
Description
Read Only:true
The description of the segment value assigned to the overhead method. -
slidingScaleFlag: boolean
Title:
Use Sliding Scale
Maximum Length:1
Default Value:false
Indicates whether a sliding scale is used for the overhead method. -
slidingScaleThresholds: array
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. -
startDate: string
(date)
Title:
Start Date
The start date of the effective date range of the overhead method. -
structureInstanceNumber: integer
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. -
transactionsExistFlag: boolean
Title:
Overhead Transactions Exist
Read Only:true
Indicates whether there are existing transactions generated from the overhead method. -
transactionSourceAccount: string
Title:
Transaction Source Account
The formatted account combination for the account used to select general ledger and subledger transactions for the overhead calculation. -
transactionSourceAccountSet: string
Title:
Account Set
The name of the account set used to select general ledger and subledger transactions for the overhead calculation. -
transactionSourceLedger: string
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. -
transactionSourceStructureInstanceNumber: integer
(int64)
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
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 : 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 : 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 : jointVentureOverheadMethods-measureTypes-item-response
Type:
Show Source
object
-
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. -
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. -
measureType: string
Title:
Measure Type
The unique name of the operational measure type. -
overheadMeasureTypeDFF: array
overheadMeasureTypeDFF
-
overheadMeasureTypeId: integer
(int64)
Title:
Overhead Measure Type ID
Read Only:true
The unique identifier of the overhead measure type.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : jointVentureOverheadMethods-measureTypes-overheadMeasureTypeDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OverheadMeasureTypeId: integer
(int64)
Title:
Overhead Measure Type ID
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : jointVentureOverheadMethods-overheadMethodDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:32
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OverheadMethodId: integer
(int64)
Title:
Overhead Method ID
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : jointVentureOverheadMethods-slidingScaleThresholds-item-response
Type:
Show Source
object
-
amount: number
Title:
Threshold Amount
The amount up to which the threshold percentage is applied to calculate a portion of the overhead amount. -
createdBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the sliding scale threshold. -
creationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the sliding scale threshold was created. -
lastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the sliding scale threshold was last updated. -
lastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the sliding scale threshold. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
percentage: number
Title:
Threshold Percentage
The threshold percentage used to calculate the portion of the overhead amount up to the threshold amount. -
rate: number
Title:
Threshold Rate
The threshold rate used to calculate the portion of the overhead amount up to the threshold amount. -
thresholdDFF: array
thresholdDFF
-
thresholdId: integer
(int64)
Title:
Threshold ID
Read Only:true
The unique identifier of the sliding scale threshold.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : jointVentureOverheadMethods-slidingScaleThresholds-thresholdDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ThresholdId: integer
(int64)
Title:
Threshold ID
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- measureTypes
-
Operation: /fscmRestApi/resources/11.13.18.05/jointVentureOverheadMethods/{overheadMethodId}/child/measureTypesParameters:
- overheadMethodId:
$request.path.overheadMethodId
The overhead measure types resource is used to view, create, or delete overhead measure types. - overheadMethodId:
- overheadMethodDFF
-
Parameters:
- overheadMethodId:
$request.path.overheadMethodId
- 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. - overheadMethodId:
Examples
The following example shows how to update a joint venture overhead method by submitting a PATCH request on the REST resource using cURL.
curl -i -u "username:password" -H "Content-type: application/json" -X PATCH -d <payload> "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureOverheadMethods/300100543121798"
Request Body Example
The following shows an example of the request body in JSON format.
{ "account": "", "distributionType": "Overhead", "endDate": "2021-05-26", "jointVenture": "ALBERTA", "journalDescription": null, "method": "ALBERTAOVERHEAD", "methodDescription": "Overhead based on percentage of costs", "methodStatus": "Pending", "minimumAmount": 0, "overheadMethodId": 300100543121798, "ownershipDefinition": "ALBERTA", "percentage": 0, "segment": null, "segmentValue": null, "startDate": "2021-05-19" }
Response Body Example
The following shows an example of the response body in JSON format.
{ "overheadMethodId" : 300100543121798, "method" : "ALBERTAOVERHEAD", "methodDescription" : "Overhead based on percentage of costs", "methodType" : "Percentage of cost", "jointVenture" : "ALBERTA", "jointVentureDescription" : "Alberta exploration project", "startDate" : "2021-05-19", "endDate" : "2021-05-26", "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-19T05:11:40+00:00", "lastUpdatedBy" : "username", "lastUpdateDate" : "2021-05-19T05:47:48+00:00", "links" : [ { "rel" : "self", "href" : "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureOverheadMethods/300100543121798", "name" : "jointVentureOverheadMethods", "kind" : "item", "properties" : { "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278" } }, { "rel" : "canonical", "href" : "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureOverheadMethods/300100543121798", "name" : "jointVentureOverheadMethods", "kind" : "item" }, { "rel" : "child", "href" : "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureOverheadMethods/300100543121798/child/overheadMethodDFF", "name" : "overheadMethodDFF", "kind" : "collection" } ] }