Update one charge
patch
/fscmRestApi/resources/11.13.18.05/costLists/{CostListId}/child/items/{CostListItemId}/child/charges/{CostListChargeId}
Request
Path Parameters
-
CostListChargeId(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=
-
CostListId(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=
-
CostListItemId(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: string
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: string
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
-
chargesDFF: array
chargesDFF
-
ChargeTypeCode: string
Title:
Charge Type
Abbreviation that identifies the charge type. -
CostAmount: number
Title:
Cost Amount
Value of the cost amount. -
CostBasisElementCode: string
Title:
Cost Basis Element
Maximum Length:30
Abbreviation that identifies the cost basis element. -
CostCalculationTypeCode: string
Title:
Cost Calculation Type
Maximum Length:30
Abbreviation that identifies the type of cost calculation. -
CostListChargeId: integer
(int64)
Value that uniquely identifies the charge.
-
CostMatrixId: integer
(int64)
Value that uniquely identifies the cost matrix.
-
CostMethodCode: string
Title:
Cost Method
Maximum Length:30
Abbreviation that identifies the cost method. -
CostPlusPricingFlag: boolean
Title:
Cost plus pricing
Maximum Length:30
Default Value:false
Contains one of the following values: Y or N. If Y, then the cost of the charge is used for cost plus pricing calculations. If N, then the cost of the charge isn't used for cost plus pricing calculations. The default value is N. -
CostTypeCode: string
Title:
Cost Type
Maximum Length:30
Default Value:STATIC
Abbreviation that identifies the type of cost. -
EndDate: string
(date-time)
Title:
End Date
Date when the record becomes inactive. -
KindOfCostCode: string
Maximum Length:
30
Abbreviation that identifies the kind of cost. -
PriceTypeCode: string
Title:
Price Type
Abbreviation that identifies the price type. -
StartDate: string
(date-time)
Title:
Start Date
Date when the record becomes effective.
Nested Schema : costLists-items-charges-chargesDFF-item-patch-request
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:150
Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context Value
Context Value -
CostListChargeId: integer
(int64)
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 : costLists-items-charges-item-response
Type:
Show Source
object
-
ChargeDefinitionId: integer
(int64)
Value that uniquely identifies the charge definition.
-
ChargeLineNumber: integer
(int32)
Number of the charge line.
-
chargesDFF: array
chargesDFF
-
ChargeTypeCode: string
Title:
Charge Type
Abbreviation that identifies the charge type. -
CostAmount: number
Title:
Cost Amount
Value of the cost amount. -
CostBasisElementCode: string
Title:
Cost Basis Element
Maximum Length:30
Abbreviation that identifies the cost basis element. -
CostCalculationTypeCode: string
Title:
Cost Calculation Type
Maximum Length:30
Abbreviation that identifies the type of cost calculation. -
CostElementCode: string
Title:
Cost Element
Maximum Length:30
Abbreviation that identifies the cost element. -
CostListChargeId: integer
(int64)
Value that uniquely identifies the charge.
-
CostMatrixId: integer
(int64)
Value that uniquely identifies the cost matrix.
-
CostMethodCode: string
Title:
Cost Method
Maximum Length:30
Abbreviation that identifies the cost method. -
CostPlusPricingFlag: boolean
Title:
Cost plus pricing
Maximum Length:30
Default Value:false
Contains one of the following values: Y or N. If Y, then the cost of the charge is used for cost plus pricing calculations. If N, then the cost of the charge isn't used for cost plus pricing calculations. The default value is N. -
CostTypeCode: string
Title:
Cost Type
Maximum Length:30
Default Value:STATIC
Abbreviation that identifies the type of cost. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the record. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the record was created. -
EndDate: string
(date-time)
Title:
End Date
Date when the record becomes inactive. -
KindOfCostCode: string
Maximum Length:
30
Abbreviation that identifies the kind of cost. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the application most recently updated the record. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ParentEntityId: integer
(int64)
Value that uniquely identifies the parent entity.
-
ParentEntityTypeCode: string
Maximum Length:
30
Abbreviation that identifies the type of parent entity. -
PricePeriodicityCode: string
Title:
Price Periodicity
Maximum Length:3
Abbreviation that identifies the price periodicity. -
PriceTypeCode: string
Title:
Price Type
Abbreviation that identifies the price type. -
StartDate: string
(date-time)
Title:
Start Date
Date when the record becomes effective. -
UsageUOMCode: string
Title:
Usage UOM
Maximum Length:3
Abbreviation that identifies the unit of measure of the charge usage.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : costLists-items-charges-chargesDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:150
Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context Value
Context Value -
CostListChargeId: integer
(int64)
-
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
- chargesDFF
-
Parameters:
- CostListChargeId:
$request.path.CostListChargeId
- CostListId:
$request.path.CostListId
- CostListItemId:
$request.path.CostListItemId
- CostListChargeId:
- validateDateOverlap
-
Parameters:
- CostListChargeId:
$request.path.CostListChargeId
- CostListId:
$request.path.CostListId
- CostListItemId:
$request.path.CostListItemId
Validates the action for a single cost list charge. - CostListChargeId:
Examples
This example describes how to update one charge.
Example cURL Command
Use the following cURL command to submit a request on the REST resource.
curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/costLists/CostListId/child/items/CostListItemId/child/charges/CostListChargeId"
Example Request Body
The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates.
{ "CostAmount": 50, "StartDate": "2025-09-01T00:00:00+00:00", "EndDate": null }
Example Response Body
The following example includes the contents of the response
body in JSON format:
{ "CostListChargeId" : "300100680367715", "ParentEntityId" : "300100680360747", "ParentEntityTypeCode" : "COST_LIST_ITEM", "PriceTypeCode" : "ONE_TIME", "PricePeriodicityCode" : null, "CostBasisElementCode" : null, "UsageUOMCode" : null, "CostElementCode" : "QP_COST", "CostTypeCode" : "STATIC", "CostMethodCode" : null, "CostAmount": 50, "CostMatrixId" : null, "ChargeDefinitionId" : "300100070841552", "CostCalculationTypeCode" : "FIXED", "ChargeTypeCode" : "ORA_SALE", "KindOfCostCode" : null, "StartDate": "2025-09-01T00:00:00+00:00", "EndDate" : null, "ChargeLineNumber" : 1, "CostPlusPricingFlag" : false, "CreationDate" : "2025-08-07T11:49:52+00:00", "CreatedBy" : "PRICING_MGR_OPERATIONS", "LastUpdateDate" : "2025-08-07T11:49:52.077+00:00", "LastUpdatedBy" : "PRICING_MGR_OPERATIONS" }