Jump to

• Request
• Response

Update one component item

patch

/fscmRestApi/resources/11.13.18.05/priceLists/{PriceListId}/child/items/{PriceListItemId}/child/componentItems/{PriceListComponentItemId}

Request

Path Parameters

• PriceListComponentItemId(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=
• PriceListId(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=
• PriceListItemId(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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ChangeTypeCode: string
  Maximum Length: 30

  Code that specifies the type of change for the component items for the approval flow.
• componentCharges: array Price List Charges
  Title: Price List Charges

  The Price List Charges resource manages the charges of items in a price list.
• ComponentIdPath: string (byte)
  Hierarchy of the component item unique values from the configuration model.
• COMPPath: string (byte)
  Hierarchy of the values of the component item from the configuration model.
• EntityApprovalStatusCode: string
  Maximum Length: 30

  Code for the approval status of the component items when the approval flow is enabled. This status will be null if the feature opt in is set to No.

{
    "type":"object",
    "properties":{
        "COMPPath":{
            "type":"string",
            "description":"Hierarchy of the values of the component item from the configuration model.",
            "format":"byte",
            "nullable":false,
            "x-queryable":false
        },
        "ChangeTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code that specifies the type of change for the component items for the approval flow.",
            "nullable":true
        },
        "ComponentIdPath":{
            "type":"string",
            "description":"Hierarchy of the component item unique values from the configuration model.",
            "format":"byte",
            "nullable":false,
            "x-queryable":false
        },
        "EntityApprovalStatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code for the approval status of the component items when the approval flow is enabled. This status will be null if the feature opt in is set to No.",
            "nullable":true
        },
        "componentCharges":{
            "title":"Price List Charges",
            "type":"array",
            "description":"The Price List Charges resource manages the charges of items in a price list.",
            "items":{
                "$ref":"#/components/schemas/priceLists-items-componentItems-componentCharges-item-patch-request"
            }
        }
    }
}

Nested Schema : Price List Charges

Type: array

Title: Price List Charges

The Price List Charges resource manages the charges of items in a price list.

Show Source

• Array of: object priceLists-items-componentItems-componentCharges-item-patch-request

{
    "title":"Price List Charges",
    "type":"array",
    "description":"The Price List Charges resource manages the charges of items in a price list.",
    "items":{
        "$ref":"#/components/schemas/priceLists-items-componentItems-componentCharges-item-patch-request"
    }
}

Nested Schema : priceLists-items-componentItems-componentCharges-item-patch-request

Type: object

Show Source

• AllowManualAdjustment: string
  Maximum Length: 30

  Contains one of the following values: Y or N. If Y, then allow manual adjustments. If N, then don't allow manual adjustments. The default value is N.
• BasePrice: number
  Value of the base price of the item.
• CalculationMethod: string
  Method of calculation applied to the price list item charges in the price list. Valid values include Price, Cost, Source document cost, Covered item price percent. A list of accepted values is defined in the lookup type ORA_QP_PRCLT_CALC_METHODS.
• CalculationMethodCode: string
  Maximum Length: 30

  Abbreviation that identifies the method of calculation applied to the price list item charges in the price list.
• CalculationType: string
  Type of calculation applied to the price list item charges in the price list. Valid values include Discount percent, Markup percent, and so on. A list of accepted values is defined in the lookup type ORA_QP_COST_CALC_TYPES.
• CalculationTypeCode: string
  Maximum Length: 30

  Abbreviation that identifies the type of calculation applied to the price list item charges in the price list.
• ChangeTypeCode: string
  Maximum Length: 30

  Code that specifies the type of change for the charges for the approval flow.
• chargesDFF: array chargesDFF
• CostCalculationAmount: number
  Title: Cost Calculation Amount

  Value of the cost calculation amount.
• EndDate: string (date-time)
  Date when the charge becomes inactive.
• EntityApprovalStatusCode: string
  Maximum Length: 30

  Code for the charge's approval status when the approval flow is enabled. This will be null if the Opt-In for the feature is No.
• PricePeriodicity: string
  Name of the price periodicity.
• PricingChargeDefinition: string
  Name of the pricing charge definition.
• PricingChargeDefinitionCode: string
  Abbreviation that identifies the pricing charge definition.
• StartDate: string (date-time)
  Date when the charge becomes active.

{
    "type":"object",
    "properties":{
        "AllowManualAdjustment":{
            "maxLength":30,
            "type":"string",
            "description":"Contains one of the following values: Y or N. If Y, then allow manual adjustments. If N, then don't allow manual adjustments. The default value is N.",
            "nullable":true
        },
        "BasePrice":{
            "type":"number",
            "description":"Value of the base price of the item.",
            "nullable":true
        },
        "CalculationMethod":{
            "type":"string",
            "description":"Method of calculation applied to the price list item charges in the price list. Valid values include Price, Cost, Source document cost, Covered item price percent. A list of accepted values is defined in the lookup type ORA_QP_PRCLT_CALC_METHODS.",
            "nullable":true
        },
        "CalculationMethodCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the method of calculation applied to the price list item charges in the price list.",
            "nullable":false
        },
        "CalculationType":{
            "type":"string",
            "description":"Type of calculation applied to the price list item charges in the price list. Valid values include Discount percent, Markup percent, and so on. A list of accepted values is defined in the lookup type ORA_QP_COST_CALC_TYPES.",
            "nullable":true
        },
        "CalculationTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the type of calculation applied to the price list item charges in the price list.",
            "nullable":true
        },
        "ChangeTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code that specifies the type of change for the charges for the approval flow.",
            "nullable":true
        },
        "CostCalculationAmount":{
            "title":"Cost Calculation Amount",
            "type":"number",
            "description":"Value of the cost calculation amount.",
            "nullable":true
        },
        "EndDate":{
            "type":"string",
            "description":"Date when the charge becomes inactive.",
            "format":"date-time",
            "nullable":true
        },
        "EntityApprovalStatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code for the charge's approval status when the approval flow is enabled. This will be null if the Opt-In for the feature is No.",
            "nullable":true
        },
        "PricePeriodicity":{
            "type":"string",
            "description":"Name of the price periodicity.",
            "nullable":true
        },
        "PricingChargeDefinition":{
            "type":"string",
            "description":"Name of the pricing charge definition.",
            "nullable":true
        },
        "PricingChargeDefinitionCode":{
            "type":"string",
            "description":"Abbreviation that identifies the pricing charge definition.",
            "nullable":true
        },
        "StartDate":{
            "type":"string",
            "description":"Date when the charge becomes active.",
            "format":"date-time",
            "nullable":false
        },
        "chargesDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/priceLists-items-componentItems-componentCharges-chargesDFF-item-patch-request"
            },
            "x-cardinality":"1"
        }
    }
}

Nested Schema : chargesDFF

Type: array

Show Source

• Array of: object priceLists-items-componentItems-componentCharges-chargesDFF-item-patch-request

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/priceLists-items-componentItems-componentCharges-chargesDFF-item-patch-request"
    },
    "x-cardinality":"1"
}

Nested Schema : priceLists-items-componentItems-componentCharges-chargesDFF-item-patch-request

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Value

  Maximum Length: 150

  Context Value
• __FLEX_Context_DisplayValue: string
  Title: Context Value

  Context Value

{
    "type":"object",
    "properties":{
        "__FLEX_Context":{
            "title":"Context Value",
            "maxLength":150,
            "type":"string",
            "description":"Context Value",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Context Value"
                },
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Value",
            "type":"string",
            "description":"Context Value",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "help":{
                    "instruction":"Context Value"
                },
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        }
    }
}

Back to Top

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.

Body ()

Root Schema : priceLists-items-componentItems-item-response

Type: object

Show Source

• ChangeType: string
  Read Only: true

  Maximum Length: 255

  Change type for the component items in the approval flow.
• ChangeTypeCode: string
  Maximum Length: 30

  Code that specifies the type of change for the component items for the approval flow.
• componentCharges: array Price List Charges
  Title: Price List Charges

  The Price List Charges resource manages the charges of items in a price list.
• ComponentIdPath: string (byte)
  Hierarchy of the component item unique values from the configuration model.
• ComponentItem: string
  Name of the component item.
• ComponentItemDescription: string
  Description of the component item.
• ComponentItemId: integer (int64)
  Value that uniquely identifies the component item.
• ComponentPath: string
  Hierarchy of the component item from the configuration model.
• ComponentPathId: string
  Value that uniquely identifies the hierarchy of the values of the component item from the configuration model.
• COMPPath: string (byte)
  Hierarchy of the values of the component item from the configuration model.
• 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.
• EntityApprovalStatus: string
  Read Only: true

  Maximum Length: 255

  Approval status of the component items when the approval flow is enabled. This status will be null if the feature opt in is set to No.
• EntityApprovalStatusCode: string
  Maximum Length: 30

  Code for the approval status of the component items when the approval flow is enabled. This status will be null if the feature opt in is set to No.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the record was most recently updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the record.
• LineType: string
  Type of line applied to the price list component items in the price list. Valid values include Buy, Return, and so on. A list of accepted values is defined in the lookup type ORA_QP_ORDER_LINE_TYPES.
• LineTypeCode: string
  Maximum Length: 30

  Default Value: ORA_BUY

  Abbreviation that identifies the type of line applied to the price list component items in the price list.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PriceListComponentItemId: integer (int64)
  Value that uniquely identifies the price list component item.
• PriceListId: integer (int64)
  Value that uniquely identifies the price list to which the component items belong.
• PriceListItemId: integer (int64)
  Value that uniquely identifies the price list item.
• PricingUOM: string
  Unit of measure for pricing.
• PricingUOMCode: string
  Maximum Length: 3

  Abbreviation that identifies the unit of measure for pricing.

{
    "type":"object",
    "properties":{
        "COMPPath":{
            "type":"string",
            "description":"Hierarchy of the values of the component item from the configuration model.",
            "format":"byte",
            "nullable":false,
            "x-queryable":false
        },
        "ChangeType":{
            "maxLength":255,
            "type":"string",
            "description":"Change type for the component items in the approval flow.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ChangeTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code that specifies the type of change for the component items for the approval flow.",
            "nullable":true,
            "x-queryable":true
        },
        "ComponentIdPath":{
            "type":"string",
            "description":"Hierarchy of the component item unique values from the configuration model.",
            "format":"byte",
            "nullable":false,
            "x-queryable":false
        },
        "ComponentItem":{
            "type":"string",
            "description":"Name of the component item.",
            "nullable":true,
            "x-queryable":true
        },
        "ComponentItemDescription":{
            "type":"string",
            "description":"Description of the component item.",
            "nullable":true,
            "x-queryable":true
        },
        "ComponentItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the component item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ComponentPath":{
            "type":"string",
            "description":"Hierarchy of the component item from the configuration model.",
            "nullable":true,
            "x-queryable":true
        },
        "ComponentPathId":{
            "type":"string",
            "description":"Value that uniquely identifies the hierarchy of the values of the component item from the configuration model.",
            "nullable":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EntityApprovalStatus":{
            "maxLength":255,
            "type":"string",
            "description":"Approval status of the component items when the approval flow is enabled. This status will be null if the feature opt in is set to No.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EntityApprovalStatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code for the approval status of the component items when the approval flow is enabled. This status will be null if the feature opt in is set to No.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the record was most recently updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LineType":{
            "type":"string",
            "description":"Type of line applied to the price list component items in the price list. Valid values include Buy, Return, and so on. A list of accepted values is defined in the lookup type ORA_QP_ORDER_LINE_TYPES.",
            "nullable":true,
            "x-queryable":true
        },
        "LineTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the type of line applied to the price list component items in the price list.",
            "nullable":false,
            "default":"ORA_BUY",
            "x-queryable":true
        },
        "PriceListComponentItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the price list component item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "PriceListId":{
            "type":"integer",
            "description":"Value that uniquely identifies the price list to which the component items belong.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PriceListItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the price list item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PricingUOM":{
            "type":"string",
            "description":"Unit of measure for pricing.",
            "nullable":true,
            "x-queryable":true
        },
        "PricingUOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure for pricing.",
            "nullable":false,
            "x-queryable":true
        },
        "componentCharges":{
            "title":"Price List Charges",
            "type":"array",
            "description":"The Price List Charges resource manages the charges of items in a price list.",
            "items":{
                "$ref":"#/components/schemas/priceLists-items-componentItems-componentCharges-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Price List Charges

Type: array

Title: Price List Charges

The Price List Charges resource manages the charges of items in a price list.

Show Source

• Array of: object priceLists-items-componentItems-componentCharges-item-response

{
    "title":"Price List Charges",
    "type":"array",
    "description":"The Price List Charges resource manages the charges of items in a price list.",
    "items":{
        "$ref":"#/components/schemas/priceLists-items-componentItems-componentCharges-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : priceLists-items-componentItems-componentCharges-item-response

Type: object

Show Source

• AllowManualAdjustment: string
  Maximum Length: 30

  Contains one of the following values: Y or N. If Y, then allow manual adjustments. If N, then don't allow manual adjustments. The default value is N.
• BasePrice: number
  Value of the base price of the item.
• CalculationMethod: string
  Method of calculation applied to the price list item charges in the price list. Valid values include Price, Cost, Source document cost, Covered item price percent. A list of accepted values is defined in the lookup type ORA_QP_PRCLT_CALC_METHODS.
• CalculationMethodCode: string
  Maximum Length: 30

  Abbreviation that identifies the method of calculation applied to the price list item charges in the price list.
• CalculationType: string
  Type of calculation applied to the price list item charges in the price list. Valid values include Discount percent, Markup percent, and so on. A list of accepted values is defined in the lookup type ORA_QP_COST_CALC_TYPES.
• CalculationTypeCode: string
  Maximum Length: 30

  Abbreviation that identifies the type of calculation applied to the price list item charges in the price list.
• ChangeType: string
  Read Only: true

  Maximum Length: 255

  Change type for the charges in the approval flow.
• ChangeTypeCode: string
  Maximum Length: 30

  Code that specifies the type of change for the charges for the approval flow.
• ChargeLineNumber: integer (int32)
  Title: Line Number

  Line number of the component item charge.
• chargesDFF: array chargesDFF
• CostCalculationAmount: number
  Title: Cost Calculation Amount

  Value of the cost calculation amount.
• 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 charge becomes inactive.
• EntityApprovalStatus: string
  Read Only: true

  Maximum Length: 255

  Charge's approval status when the approval flow is enabled. It's null if the feature opt in is No.
• EntityApprovalStatusCode: string
  Maximum Length: 30

  Code for the charge's approval status when the approval flow is enabled. This will be null if the Opt-In for the feature is No.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the record was most recently updated.
• 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 item for the charge.
• PriceListChargeId: integer (int64)
  Value that uniquely identifies the charge of the price list item.
• PriceListId: integer (int64)
  Value that uniquely identifies the price list.
• PricePeriodicity: string
  Name of the price periodicity.
• PricePeriodicityCode: string
  Maximum Length: 12

  Abbreviation that identifies the price periodicity.
• PricingChargeDefinition: string
  Name of the pricing charge definition.
• PricingChargeDefinitionCode: string
  Abbreviation that identifies the pricing charge definition.
• PricingChargeDefinitionId: integer (int64)
  Value that uniquely identifies the pricing charge definition.
• StartDate: string (date-time)
  Date when the charge becomes active.

{
    "type":"object",
    "properties":{
        "AllowManualAdjustment":{
            "maxLength":30,
            "type":"string",
            "description":"Contains one of the following values: Y or N. If Y, then allow manual adjustments. If N, then don't allow manual adjustments. The default value is N.",
            "nullable":true,
            "x-queryable":true
        },
        "BasePrice":{
            "type":"number",
            "description":"Value of the base price of the item.",
            "nullable":true,
            "x-queryable":true
        },
        "CalculationMethod":{
            "type":"string",
            "description":"Method of calculation applied to the price list item charges in the price list. Valid values include Price, Cost, Source document cost, Covered item price percent. A list of accepted values is defined in the lookup type ORA_QP_PRCLT_CALC_METHODS.",
            "nullable":true,
            "x-queryable":true
        },
        "CalculationMethodCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the method of calculation applied to the price list item charges in the price list.",
            "nullable":false,
            "x-queryable":true
        },
        "CalculationType":{
            "type":"string",
            "description":"Type of calculation applied to the price list item charges in the price list. Valid values include Discount percent, Markup percent, and so on. A list of accepted values is defined in the lookup type ORA_QP_COST_CALC_TYPES.",
            "nullable":true,
            "x-queryable":true
        },
        "CalculationTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the type of calculation applied to the price list item charges in the price list.",
            "nullable":true,
            "x-queryable":true
        },
        "ChangeType":{
            "maxLength":255,
            "type":"string",
            "description":"Change type for the charges in the approval flow.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ChangeTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code that specifies the type of change for the charges for the approval flow.",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeLineNumber":{
            "title":"Line Number",
            "type":"integer",
            "description":"Line number of the component item charge.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "CostCalculationAmount":{
            "title":"Cost Calculation Amount",
            "type":"number",
            "description":"Value of the cost calculation amount.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDate":{
            "type":"string",
            "description":"Date when the charge becomes inactive.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "EntityApprovalStatus":{
            "maxLength":255,
            "type":"string",
            "description":"Charge's approval status when the approval flow is enabled. It's null if the feature opt in is No.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "EntityApprovalStatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code for the charge's approval status when the approval flow is enabled. This will be null if the Opt-In for the feature is No.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the record was most recently updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentEntityId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item for the charge.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PriceListChargeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the charge of the price list item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "PriceListId":{
            "type":"integer",
            "description":"Value that uniquely identifies the price list.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PricePeriodicity":{
            "type":"string",
            "description":"Name of the price periodicity.",
            "nullable":true,
            "x-queryable":true
        },
        "PricePeriodicityCode":{
            "maxLength":12,
            "type":"string",
            "description":"Abbreviation that identifies the price periodicity.",
            "nullable":true,
            "x-queryable":true
        },
        "PricingChargeDefinition":{
            "type":"string",
            "description":"Name of the pricing charge definition.",
            "nullable":true,
            "x-queryable":true
        },
        "PricingChargeDefinitionCode":{
            "type":"string",
            "description":"Abbreviation that identifies the pricing charge definition.",
            "nullable":true,
            "x-queryable":true
        },
        "PricingChargeDefinitionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the pricing charge definition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"Date when the charge becomes active.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "chargesDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/priceLists-items-componentItems-componentCharges-chargesDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : chargesDFF

Type: array

Show Source

• Array of: object priceLists-items-componentItems-componentCharges-chargesDFF-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/priceLists-items-componentItems-componentCharges-chargesDFF-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : priceLists-items-componentItems-componentCharges-chargesDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Value

  Maximum Length: 150

  Context Value
• __FLEX_Context_DisplayValue: string
  Title: Context Value

  Context Value
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PriceListChargeId: integer (int64)

{
    "type":"object",
    "properties":{
        "PriceListChargeId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Value",
            "maxLength":150,
            "type":"string",
            "description":"Context Value",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Context Value"
                },
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Value",
            "type":"string",
            "description":"Context Value",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "help":{
                    "instruction":"Context Value"
                },
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

componentCharges

Operation: /fscmRestApi/resources/11.13.18.05/priceLists/{PriceListId}/child/items/{PriceListItemId}/child/componentItems/{PriceListComponentItemId}/child/componentCharges

Parameters:

• PriceListComponentItemId: $request.path.PriceListComponentItemId
• PriceListId: $request.path.PriceListId
• PriceListItemId: $request.path.PriceListItemId

The Price List Charges resource manages the charges of items in a price list.

Back to Top