Jump to

• Request
• Response

Create charges for a covered item

post

/fscmRestApi/resources/11.13.18.05/priceLists/{PriceListId}/child/items/{PriceListItemId}/child/coveredItems/{PriceListCoveredItemId}/child/coveredCharges

Request

Path Parameters

• PriceListCoveredItemId(required): integer(int64)
  Value that uniquely identifies the price list covered item.
• PriceListId(required): integer(int64)
  Value that uniquely identifies the price list.
• PriceListItemId(required): integer(int64)
  Value that uniquely identifies the price list item.

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.
• Upsert-Mode:
  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

Request Body - application/json ()

Root Schema : schema

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 do not allow manual adjustments. The default value is N.
• BasePrice: number
  Value of the base price of the covered item.
• CalculationAmount: number
  Title: Calculation Amount

  Value of the calculation amount.
• CalculationMethod: string
  Method of calculation applied to the price list covered item charges in the price list.
• CalculationMethodCode(required): string
  Maximum Length: 30

  Abbreviation that identifies the method of calculation applied to the price list covered item charges in the price list.
• ChargeLineNumber(required): integer (int32)
  Title: Line Number

  Line number of the component item charge.
• chargesDFF: array Flexfields for Price List Charges
  Title: Flexfields for Price List Charges

  The Flexfields for Price List Charges resource associates descriptive flexfield segments and its values with a price list charge.
• CoverageBasis: string
  Pricing basis for the covered item.
• CoverageBasisId: integer (int64)
  Title: Return Basis

  Value that uniquely identifies the pricing basis for the covered item.
• EndDate: string (date-time)
  Date when the charge becomes inactive.
• ParentEntityId(required): integer (int64)
  Value that uniquely identifies the covered item for the covered charge.
• PriceListChargeId: integer (int64)
  Value that uniquely identifies the charge of the price list covered 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(required): integer (int64)
  Value that uniquely identifies the pricing charge definition.
• StartDate(required): string (date-time)
  Date when the charge becomes active.

{
    "required":[
        "CalculationMethodCode",
        "ChargeLineNumber",
        "ParentEntityId",
        "PricingChargeDefinitionId",
        "StartDate"
    ],
    "type":"object",
    "properties":{
        "PricePeriodicityCode":{
            "maxLength":12,
            "type":"string",
            "description":"Abbreviation that identifies the price periodicity.",
            "nullable":true
        },
        "BasePrice":{
            "type":"number",
            "description":"Value of the base price of the covered item.",
            "nullable":true
        },
        "ParentEntityId":{
            "type":"integer",
            "description":"Value that uniquely identifies the covered item for the covered charge.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "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
        },
        "CalculationMethodCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the method of calculation applied to the price list covered item charges in the price list.",
            "nullable":false
        },
        "AllowManualAdjustment":{
            "maxLength":30,
            "type":"string",
            "description":"Contains one of the following values: Y or N. If Y, then allow manual adjustments. If N, then do not allow manual adjustments. The default value is N.",
            "nullable":true
        },
        "PricingChargeDefinitionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the pricing charge definition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "PriceListChargeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the charge of the price list covered item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "ChargeLineNumber":{
            "title":"Line Number",
            "type":"integer",
            "description":"Line number of the component item charge.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "EndDate":{
            "type":"string",
            "description":"Date when the charge becomes inactive.",
            "format":"date-time",
            "nullable":true
        },
        "StartDate":{
            "type":"string",
            "description":"Date when the charge becomes active.",
            "format":"date-time",
            "nullable":false
        },
        "PricePeriodicity":{
            "type":"string",
            "description":"Name of the price periodicity.",
            "nullable":true
        },
        "CalculationAmount":{
            "title":"Calculation Amount",
            "type":"number",
            "description":"Value of the calculation amount.",
            "nullable":true
        },
        "CalculationMethod":{
            "type":"string",
            "description":"Method of calculation applied to the price list covered item charges in the price list.",
            "nullable":true
        },
        "CoverageBasisId":{
            "title":"Return Basis",
            "type":"integer",
            "description":"Value that uniquely identifies the pricing basis for the covered item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "chargesDFF":{
            "title":"Flexfields for Price List Charges",
            "type":"array",
            "description":"The Flexfields for Price List Charges resource associates descriptive flexfield segments and its values with a price list charge.",
            "items":{
                "$ref":"#/components/schemas/priceLists-items-coveredItems-coveredCharges-chargesDFF-item-post-request"
            },
            "x-cardinality":"1"
        },
        "PriceListId":{
            "type":"integer",
            "description":"Value that uniquely identifies the price list.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "CoverageBasis":{
            "type":"string",
            "description":"Pricing basis for the covered item.",
            "nullable":true
        }
    }
}

Nested Schema : Flexfields for Price List Charges

Type: array

Title: Flexfields for Price List Charges

The Flexfields for Price List Charges resource associates descriptive flexfield segments and its values with a price list charge.

Show Source

• Array of: object priceLists-items-coveredItems-coveredCharges-chargesDFF-item-post-request

{
    "title":"Flexfields for Price List Charges",
    "type":"array",
    "description":"The Flexfields for Price List Charges resource associates descriptive flexfield segments and its values with a price list charge.",
    "items":{
        "$ref":"#/components/schemas/priceLists-items-coveredItems-coveredCharges-chargesDFF-item-post-request"
    },
    "x-cardinality":"1"
}

Nested Schema : priceLists-items-coveredItems-coveredCharges-chargesDFF-item-post-request

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Value

  Maximum Length: 150

  Descriptive flexfield context name for price list charges.
• __FLEX_Context_DisplayValue: string
  Title: Context Value
• PriceListChargeId: integer (int64)
  Value that uniquely identifies the charge of a price list item to which the descriptive flexfields belong.

{
    "type":"object",
    "properties":{
        "PriceListChargeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the charge of a price list item to which the descriptive flexfields belong.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Value",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "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"
                }
            }
        },
        "__FLEX_Context":{
            "title":"Context Value",
            "maxLength":150,
            "type":"string",
            "description":"Descriptive flexfield context name for price list charges.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":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"
                }
            }
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  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(required):
  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-coveredItems-coveredCharges-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 do not allow manual adjustments. The default value is N.
• BasePrice: number
  Value of the base price of the covered item.
• CalculationAmount: number
  Title: Calculation Amount

  Value of the calculation amount.
• CalculationMethod: string
  Method of calculation applied to the price list covered item charges in the price list.
• CalculationMethodCode: string
  Maximum Length: 30

  Abbreviation that identifies the method of calculation applied to the price list covered item charges in the price list.
• ChargeLineNumber: integer (int32)
  Title: Line Number

  Line number of the component item charge.
• chargesDFF: array Flexfields for Price List Charges
  Title: Flexfields for Price List Charges

  The Flexfields for Price List Charges resource associates descriptive flexfield segments and its values with a price list charge.
• CoverageBasis: string
  Pricing basis for the covered item.
• CoverageBasisId: integer (int64)
  Title: Return Basis

  Value that uniquely identifies the pricing basis for the covered item.
• 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.
• 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 covered item for the covered charge.
• PriceListChargeId: integer (int64)
  Value that uniquely identifies the charge of the price list covered 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":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated 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
        },
        "PricePeriodicityCode":{
            "maxLength":12,
            "type":"string",
            "description":"Abbreviation that identifies the price periodicity.",
            "nullable":true,
            "x-queryable":true
        },
        "BasePrice":{
            "type":"number",
            "description":"Value of the base price of the covered item.",
            "nullable":true,
            "x-queryable":true
        },
        "ParentEntityId":{
            "type":"integer",
            "description":"Value that uniquely identifies the covered item for the covered charge.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":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
        },
        "CalculationMethodCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the method of calculation applied to the price list covered item charges in the price list.",
            "nullable":false,
            "x-queryable":true
        },
        "AllowManualAdjustment":{
            "maxLength":30,
            "type":"string",
            "description":"Contains one of the following values: Y or N. If Y, then allow manual adjustments. If N, then do not allow manual adjustments. The default value is N.",
            "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
        },
        "PriceListChargeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the charge of the price list covered item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"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
        },
        "EndDate":{
            "type":"string",
            "description":"Date when the charge becomes inactive.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"Date when the charge becomes active.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "PricePeriodicity":{
            "type":"string",
            "description":"Name of the price periodicity.",
            "nullable":true,
            "x-queryable":true
        },
        "CalculationAmount":{
            "title":"Calculation Amount",
            "type":"number",
            "description":"Value of the calculation amount.",
            "nullable":true,
            "x-queryable":true
        },
        "CalculationMethod":{
            "type":"string",
            "description":"Method of calculation applied to the price list covered item charges in the price list.",
            "nullable":true,
            "x-queryable":true
        },
        "CoverageBasisId":{
            "title":"Return Basis",
            "type":"integer",
            "description":"Value that uniquely identifies the pricing basis for the covered item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "chargesDFF":{
            "title":"Flexfields for Price List Charges",
            "type":"array",
            "description":"The Flexfields for Price List Charges resource associates descriptive flexfield segments and its values with a price list charge.",
            "items":{
                "$ref":"#/components/schemas/priceLists-items-coveredItems-coveredCharges-chargesDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "PriceListId":{
            "type":"integer",
            "description":"Value that uniquely identifies the price list.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CoverageBasis":{
            "type":"string",
            "description":"Pricing basis for the covered item.",
            "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
        }
    }
}

Nested Schema : Flexfields for Price List Charges

Type: array

Title: Flexfields for Price List Charges

The Flexfields for Price List Charges resource associates descriptive flexfield segments and its values with a price list charge.

Show Source

• Array of: object priceLists-items-coveredItems-coveredCharges-chargesDFF-item-response

{
    "title":"Flexfields for Price List Charges",
    "type":"array",
    "description":"The Flexfields for Price List Charges resource associates descriptive flexfield segments and its values with a price list charge.",
    "items":{
        "$ref":"#/components/schemas/priceLists-items-coveredItems-coveredCharges-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-coveredItems-coveredCharges-chargesDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Value

  Maximum Length: 150

  Descriptive flexfield context name for price list charges.
• __FLEX_Context_DisplayValue: string
  Title: Context Value
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PriceListChargeId: integer (int64)
  Value that uniquely identifies the charge of a price list item to which the descriptive flexfields belong.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PriceListChargeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the charge of a price list item to which the descriptive flexfields belong.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Value",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "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
        },
        "__FLEX_Context":{
            "title":"Context Value",
            "maxLength":150,
            "type":"string",
            "description":"Descriptive flexfield context name for price list charges.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":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
        }
    }
}

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

ChargeDefinitionsVVO

Operation: /fscmRestApi/resources/11.13.18.05/chargeDefinitionsLOV

The following properties are defined on the LOV link relation:

• Source Attribute: PricingChargeDefinitionId; Target Attribute: PricingChargeDefinitionId
• Display Attribute: PricingChargeDefintion

chargesDFF

Operation: /fscmRestApi/resources/11.13.18.05/priceLists/{PriceListId}/child/items/{PriceListItemId}/child/coveredItems/{PriceListCoveredItemId}/child/coveredCharges/{PriceListChargeId}/child/chargesDFF

Parameters:

• PriceListChargeId5: $request.path.PriceListChargeId5
• PriceListCoveredItemId: $request.path.PriceListCoveredItemId
• PriceListId: $request.path.PriceListId
• PriceListItemId: $request.path.PriceListItemId

The Flexfields for Price List Charges resource associates descriptive flexfield segments and its values with a price list charge.

Back to Top