Create cost lists
post
/fscmRestApi/resources/11.13.18.05/costLists
Request
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.
-
Upsert-Mode: string
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
accessSets: array
Access Sets
Title:
Access Sets
An association of access sets for a cost list. -
BusinessUnit: string
Maximum Length:
255
Name of the business unit. -
BusinessUnitId(required): integer
(int64)
Title:
Business Unit
Value that uniquely identifies the business unit. -
ChargeDefinition: string
Maximum Length:
255
Name of the pricing charge definition. -
ChargeDefinitionCode: string
Maximum Length:
255
Abbreviation that identifies the pricing charge definition of the cost list. -
ChargeDefinitionId: integer
(int64)
Value that uniquely identifies the pricing charge definition.
-
CostElement: string
Maximum Length:
255
Name of the cost element. -
CostElementCode: string
Maximum Length:
30
Abbreviation that identifies the cost element for the cost list. -
CostListDescription: string
Title:
Description
Maximum Length:1000
Description of the cost list. -
CostListId: integer
(int64)
Value that uniquely identifies the cost list.
-
CostListName(required): string
Title:
Name
Maximum Length:80
Name of the cost list. -
Currency: string
Maximum Length:
255
Currency of the cost list. -
CurrencyCode(required): string
Title:
Currency
Maximum Length:15
Abbreviation that identifies the currency of the cost list. -
EndDate: string
(date-time)
Title:
End Date
Date when the record becomes inactive. -
headerDFF: array
headerDFF
-
items: array
Items
Title:
Items
An item and its associated cost charges. -
StartDate(required): string
(date-time)
Title:
Start Date
Date when the record becomes effective.. -
Status: string
Maximum Length:
255
Status of the cost list. -
StatusCode: string
Title:
Status
Maximum Length:30
Default Value:IN_PROGRESS
Abbreviation for the status of the cost list.
Nested Schema : Access Sets
Type:
array
Title:
Access Sets
An association of access sets for a cost list.
Show Source
Nested Schema : costLists-accessSets-item-post-request
Type:
Show Source
object
-
AccessSetCode: string
Maximum Length:
255
Abbreviation that identifies the access set. -
AccessSetDescription: string
Maximum Length:
255
Description of the access set. -
AccessSetId: integer
(int64)
Value that uniquely identifies the access set.
-
AccessSetName: string
Maximum Length:
255
Name of the access set. -
CostListId: integer
(int64)
Value that uniquely identifies the cost list.
-
CostListSetId: integer
(int64)
Value that uniquely identifies the cost list set.
Nested Schema : costLists-headerDFF-item-post-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 -
CostListId: integer
(int64)
Nested Schema : schema
Type:
Show Source
object
-
charges: array
Charges
Title:
Charges
A collection of charges for cost lists. -
CostListId: integer
(int64)
Value that uniquely identifies the cost list.
-
CostListItemId: integer
(int64)
Value that uniquely identifies the cost list item.
-
CostListName: string
Name of the cost list.
-
EndDate: string
(date-time)
Date when the record becomes inactive.
-
InventoryOrgId: string
Value that identifies the inventory organization or the validation organization.
-
ItemId: integer
(int64)
Title:
Item
Value that uniquely identifies the item. -
ItemLevelCode(required): string
Maximum Length:
30
Abbreviation that identifies the item level. -
itemsDFF: array
itemsDFF
-
LineTypeCode: string
Title:
Line Type
Maximum Length:30
Default Value:ORA_BUY
Abbreviation that identifies the line type. -
PricingUOMCode: string
Title:
Pricing UOM
Maximum Length:3
Abbreviation that uniquely identifies the unit of measure. -
ServiceDuration: number
Title:
Service Duration
Identifies the service duration of the item. -
ServiceDurationPeriodCode: string
Title:
Service Duration Period
Maximum Length:3
Abbreviation that uniquely identifies the service duration. -
StartDate: string
(date-time)
Date when the record becomes effective.
Nested Schema : Charges
Type:
array
Title:
Charges
A collection of charges for cost lists.
Show Source
Nested Schema : costLists-items-charges-item-post-request
Type:
Show Source
object
-
ChargeDefinitionId(required): integer
(int64)
Value that uniquely identifies the charge definition.
-
ChargeLineNumber(required): integer
(int32)
Number of the charge line.
-
chargesDFF: array
chargesDFF
-
ChargeTypeCode: string
Title:
Charge Type
Abbreviation that identifies the charge type. -
CostAmount(required): 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(required): string
Title:
Cost Calculation Type
Maximum Length:30
Abbreviation that identifies the type of cost calculation. -
CostElementCode(required): 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. -
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. -
ParentEntityId(required): integer
(int64)
Value that uniquely identifies the parent entity.
-
ParentEntityTypeCode(required): 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(required): 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 : schema
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)
Nested Schema : costLists-items-itemsDFF-item-post-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 -
CostListItemId: 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-item-response
Type:
Show Source
object
-
accessSets: array
Access Sets
Title:
Access Sets
An association of access sets for a cost list. -
BusinessUnit: string
Maximum Length:
255
Name of the business unit. -
BusinessUnitId: integer
(int64)
Title:
Business Unit
Value that uniquely identifies the business unit. -
ChargeDefinition: string
Maximum Length:
255
Name of the pricing charge definition. -
ChargeDefinitionCode: string
Maximum Length:
255
Abbreviation that identifies the pricing charge definition of the cost list. -
ChargeDefinitionId: integer
(int64)
Value that uniquely identifies the pricing charge definition.
-
CostElement: string
Maximum Length:
255
Name of the cost element. -
CostElementCode: string
Maximum Length:
30
Abbreviation that identifies the cost element for the cost list. -
CostListDescription: string
Title:
Description
Maximum Length:1000
Description of the cost list. -
CostListId: integer
(int64)
Value that uniquely identifies the cost list.
-
CostListName: string
Title:
Name
Maximum Length:80
Name of the cost list. -
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. -
Currency: string
Maximum Length:
255
Currency of the cost list. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
Abbreviation that identifies the currency of the cost list. -
EndDate: string
(date-time)
Title:
End Date
Date when the record becomes inactive. -
headerDFF: array
headerDFF
-
items: array
Items
Title:
Items
An item and its associated cost charges. -
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. -
StartDate: string
(date-time)
Title:
Start Date
Date when the record becomes effective.. -
Status: string
Maximum Length:
255
Status of the cost list. -
StatusCode: string
Title:
Status
Maximum Length:30
Default Value:IN_PROGRESS
Abbreviation for the status of the cost list.
Nested Schema : Access Sets
Type:
array
Title:
Access Sets
An association of access sets for a cost list.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : costLists-accessSets-item-response
Type:
Show Source
object
-
AccessSetCode: string
Maximum Length:
255
Abbreviation that identifies the access set. -
AccessSetDescription: string
Maximum Length:
255
Description of the access set. -
AccessSetId: integer
(int64)
Value that uniquely identifies the access set.
-
AccessSetName: string
Maximum Length:
255
Name of the access set. -
CostListId: integer
(int64)
Value that uniquely identifies the cost list.
-
CostListSetId: integer
(int64)
Value that uniquely identifies the cost list set.
-
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. -
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. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Indicates the session sign in associated with the user who last updated the row. -
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 : costLists-headerDFF-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 -
CostListId: 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 : costLists-items-item-response
Type:
Show Source
object
-
charges: array
Charges
Title:
Charges
A collection of charges for cost lists. -
CostListId: integer
(int64)
Value that uniquely identifies the cost list.
-
CostListItemId: integer
(int64)
Value that uniquely identifies the cost list item.
-
CostListName: string
Name of the cost list.
-
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)
Date when the record becomes inactive.
-
InventoryOrgId: string
Value that identifies the inventory organization or the validation organization.
-
ItemId: integer
(int64)
Title:
Item
Value that uniquely identifies the item. -
ItemLevelCode: string
Maximum Length:
30
Abbreviation that identifies the item level. -
itemsDFF: array
itemsDFF
-
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. -
LineTypeCode: string
Title:
Line Type
Maximum Length:30
Default Value:ORA_BUY
Abbreviation that identifies the line type. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PricingUOMCode: string
Title:
Pricing UOM
Maximum Length:3
Abbreviation that uniquely identifies the unit of measure. -
ServiceDuration: number
Title:
Service Duration
Identifies the service duration of the item. -
ServiceDurationPeriodCode: string
Title:
Service Duration Period
Maximum Length:3
Abbreviation that uniquely identifies the service duration. -
StartDate: string
(date-time)
Date when the record becomes effective.
Nested Schema : Charges
Type:
array
Title:
Charges
A collection of charges for cost lists.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested 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 : costLists-items-itemsDFF-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 -
CostListItemId: 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
Links
- accessSets
-
Parameters:
- CostListId:
$request.path.CostListId
An association of access sets for a cost list. - CostListId:
- headerDFF
-
Parameters:
- CostListId:
$request.path.CostListId
- CostListId:
- items
-
Parameters:
- CostListId:
$request.path.CostListId
An item and its associated cost charges. - CostListId:
- populateChargeAndCostElement
-
Operation: /fscmRestApi/resources/11.13.18.05/costLists/{CostListId}/action/populateChargeAndCostElementParameters:
- CostListId:
$request.path.CostListId
Populates a charge and cost element in a cost list. - CostListId:
Examples
This example describes how to create cost lists.
Example cURL Command
Use the following cURL command to submit a request on the REST resource.
curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/costLists"
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 creates.
{ "ChargeDefinitionId": "300100070841552", "CostElementCode": "QP_COST", "CostListName": "QP_CL", "BusinessUnit": "Vision Operations", "CurrencyCode": "USD", "StartDate": "2025-08-01T00:00:00+00:00" }
Example Response Body
The following example includes the contents of the response body in JSON format:
{ "CostListName" : "QP_CL", "CostListId" : "300100680360720", "CostListDescription" : null, "BusinessUnit" : "Vision Operations", "BusinessUnitId" : "204", "Currency" : "US Dollar", "CurrencyCode" : "USD", "Status" : "In progress", "StatusCode" : "IN_PROGRESS", "ChargeDefinition" : "Sale Price", "ChargeDefinitionCode" : "QP_SALE_PRICE", "ChargeDefinitionId" : "300100070841552", "CostElement" : "Cost", "CostElementCode" : "QP_COST", "StartDate" : "2025-08-01T00:00:00+00:00", "EndDate" : null, "CreationDate" : "2025-08-07T11:21:09+00:00", "CreatedBy" : "PRICING_MGR_OPERATIONS", "LastUpdateDate" : "2025-08-07T11:21:09.699+00:00", "LastUpdatedBy" : "PRICING_MGR_OPERATIONS" }