Jump to

• Request
• Response
• Examples

Get all pricing charge definitions

get

/fscmRestApi/resources/11.13.18.05/chargeDefinitionsLOV

Request

Query Parameters

• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • PrimaryKey: Find pricing charge definitions according to the primary key.
    Finder Variables:
    • PricingChargeDefinitionId; integer; Value that uniquely identifies the pricing charge definition.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • Active; string; Contains one of the following values. Y: charge definition is active. N: charge definition is inactive. This attribute does not have a default value.
  • AppliesTo; string; Determines the application of the pricing charge definition. Valid values include Price, Return, or Shipping. A list of accepted values is defined in the lookup type ORA_QP_CHARGE_DEF_TYPES.
  • AppliesToCode; string; Abbreviation that identifies the applicability of the pricing charge definition.
  • CalculateMargin; string; Contains one of the following values. Y: margin calculation is enabled. N: margin calculation is not enabled. This attribute does not have a default value.
  • ChargeSubtype; string; Subtype of charge for the pricing charge definition. Valid values include Price, Fee, and so on. A list of accepted values is defined in the lookup type ORA_QP_CHARGE_SUBTYPES.
  • ChargeSubtypeCode; string; Abbreviation that identifies the charge subtype of the pricing charge definition.
  • ChargeType; string; Type of charge for the pricing charge definition. Valid values include Sale, Service, Restocking, and so on. A list of accepted values is defined in the lookup type ORA_QP_CHARGE_TYPES.
  • ChargeTypeCode; string; Abbreviation that identifies the charge type of the pricing charge definition.
  • CreatedBy; string; User who created the record.
  • CreationDate; string; Date and time when the record was created.
  • LastUpdateDate; string; Most recent date and time when the application updated the record.
  • LastUpdatedBy; string; User who most recently updated the record.
  • PricePeriodicityUOMClass; string; Unit of measure class for the price periodicity.
  • PriceType; string; Type of price for the pricing charge definition. Valid values include One time and Recurring. A list of accepted values is defined in the lookup type ORA_QP_PRICE_TYPES.
  • PriceTypeCode; string; Abbreviation that identifies the price type of the pricing charge definition.
  • PricingChargeDefinitionCode; string; Abbreviation that identifies the pricing charge definition.
  • PricingChargeDefinitionDescription; string; Description of the pricing charge definition.
  • PricingChargeDefinitionId; integer; Value that uniquely identifies the pricing charge definition.
  • PricingChargeDefintion; string; Name of the pricing charge definition.
  • Refundable; string; Contains one of the following values. Y: charge is refundable. N: charge is non refundable. This attribute does not have a default value.
  • SetupEnabled; string; Contains one of the following values. Y: charge setup is enabled. N : charge setup is not enabled. This attribute does not have a default value.
  • TaxChargeType; string; Type of tax charge for the pricing charge definition. Valid values include Freight charge, Insurance charge, and so on. A list of accepted values is defined in the lookup type ZX_CHARGE_TYPE.
  • TaxChargeTypeCode; string; Abbreviation that identifies the tax charge type of the pricing charge definition.
  • UsageUOMClass; string; Unit of measure class for the usage. This attribute is applicable for charge definitions where Applies To is Price and Price Type is Usage.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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.

There's no request body for this operation.

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 : chargeDefinitionsLOV

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/chargeDefinitionsLOV-item-response"
            }
        }
    },
    "x-hints":{
        "subgroup":"OrderManagement",
        "usage":"LOV",
        "group":"SCM"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object chargeDefinitionsLOV-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/chargeDefinitionsLOV-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 : chargeDefinitionsLOV-item-response

Type: object

Show Source

• Active: string
  Title: Active

  Read Only: true

  Maximum Length: 30

  Contains one of the following values. Y: charge definition is active. N: charge definition is inactive. This attribute does not have a default value.
• AppliesTo: string
  Read Only: true

  Determines the application of the pricing charge definition. Valid values include Price, Return, or Shipping. A list of accepted values is defined in the lookup type ORA_QP_CHARGE_DEF_TYPES.
• AppliesToCode: string
  Title: Applies To

  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the applicability of the pricing charge definition.
• CalculateMargin: string
  Title: Calculate margin

  Read Only: true

  Maximum Length: 30

  Contains one of the following values. Y: margin calculation is enabled. N: margin calculation is not enabled. This attribute does not have a default value.
• ChargeSubtype: string
  Read Only: true

  Subtype of charge for the pricing charge definition. Valid values include Price, Fee, and so on. A list of accepted values is defined in the lookup type ORA_QP_CHARGE_SUBTYPES.
• ChargeSubtypeCode: string
  Title: Charge Subtype

  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the charge subtype of the pricing charge definition.
• ChargeType: string
  Read Only: true

  Type of charge for the pricing charge definition. Valid values include Sale, Service, Restocking, and so on. A list of accepted values is defined in the lookup type ORA_QP_CHARGE_TYPES.
• ChargeTypeCode: string
  Title: Charge Type

  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the charge type of the pricing charge definition.
• 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

  Most recent date and time when the application 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.
• PricePeriodicityUOMClass: string
  Title: Price Periodicity UOM Class

  Read Only: true

  Maximum Length: 10

  Unit of measure class for the price periodicity.
• PriceType: string
  Read Only: true

  Type of price for the pricing charge definition. Valid values include One time and Recurring. A list of accepted values is defined in the lookup type ORA_QP_PRICE_TYPES.
• PriceTypeCode: string
  Title: Price Type

  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the price type of the pricing charge definition.
• PricingChargeDefinitionCode: string
  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the pricing charge definition.
• PricingChargeDefinitionDescription: string
  Title: Description

  Read Only: true

  Maximum Length: 100

  Description of the pricing charge definition.
• PricingChargeDefinitionId: integer (int64)
  Read Only: true

  Value that uniquely identifies the pricing charge definition.
• PricingChargeDefintion: string
  Title: Name

  Read Only: true

  Maximum Length: 80

  Name of the pricing charge definition.
• Refundable: string
  Title: Refundable

  Read Only: true

  Maximum Length: 30

  Contains one of the following values. Y: charge is refundable. N: charge is non refundable. This attribute does not have a default value.
• SetupEnabled: string
  Title: Setup enabled

  Read Only: true

  Maximum Length: 30

  Contains one of the following values. Y: charge setup is enabled. N : charge setup is not enabled. This attribute does not have a default value.
• TaxChargeType: string
  Read Only: true

  Type of tax charge for the pricing charge definition. Valid values include Freight charge, Insurance charge, and so on. A list of accepted values is defined in the lookup type ZX_CHARGE_TYPE.
• TaxChargeTypeCode: string
  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the tax charge type of the pricing charge definition.
• UsageUOMClass: string
  Title: Usage UOM Class

  Read Only: true

  Maximum Length: 10

  Unit of measure class for the usage. This attribute is applicable for charge definitions where Applies To is Price and Price Type is Usage.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PricingChargeDefintion":{
            "title":"Name",
            "maxLength":"80",
            "type":"string",
            "description":"Name of the pricing charge definition.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PricingChargeDefinitionCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the pricing charge definition.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargeTypeCode":{
            "title":"Charge Type",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the charge type of the pricing charge definition.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SetupEnabled":{
            "title":"Setup enabled",
            "maxLength":"30",
            "type":"string",
            "description":"Contains one of the following values. Y: charge setup is enabled. N : charge setup is not enabled. This attribute does not have a default value.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PricingChargeDefinitionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the pricing charge definition.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PriceTypeCode":{
            "title":"Price Type",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the price type of the pricing charge definition.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UsageUOMClass":{
            "title":"Usage UOM Class",
            "maxLength":"10",
            "type":"string",
            "description":"Unit of measure class for the usage. This attribute is applicable for charge definitions where Applies To is Price and Price Type is Usage.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TaxChargeTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the tax charge type of the pricing charge definition.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargeSubtype":{
            "type":"string",
            "description":"Subtype of charge for the pricing charge definition. Valid values include Price, Fee, and so on. A list of accepted values is defined in the lookup type ORA_QP_CHARGE_SUBTYPES.",
            "nullable":true,
            "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
        },
        "PricePeriodicityUOMClass":{
            "title":"Price Periodicity UOM Class",
            "maxLength":"10",
            "type":"string",
            "description":"Unit of measure class for the price periodicity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TaxChargeType":{
            "type":"string",
            "description":"Type of tax charge for the pricing charge definition. Valid values include Freight charge, Insurance charge, and so on. A list of accepted values is defined in the lookup type ZX_CHARGE_TYPE.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AppliesTo":{
            "type":"string",
            "description":"Determines the application of the pricing charge definition. Valid values include Price, Return, or Shipping. A list of accepted values is defined in the lookup type ORA_QP_CHARGE_DEF_TYPES.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Refundable":{
            "title":"Refundable",
            "maxLength":"30",
            "type":"string",
            "description":"Contains one of the following values. Y: charge is refundable. N: charge is non refundable. This attribute does not have a default value.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargeSubtypeCode":{
            "title":"Charge Subtype",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the charge subtype of the pricing charge definition.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Active":{
            "title":"Active",
            "maxLength":"30",
            "type":"string",
            "description":"Contains one of the following values. Y: charge definition is active. N: charge definition is inactive. This attribute does not have a default value.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargeType":{
            "type":"string",
            "description":"Type of charge for the pricing charge definition. Valid values include Sale, Service, Restocking, and so on. A list of accepted values is defined in the lookup type ORA_QP_CHARGE_TYPES.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CalculateMargin":{
            "title":"Calculate margin",
            "maxLength":"30",
            "type":"string",
            "description":"Contains one of the following values. Y: margin calculation is enabled. N: margin calculation is not enabled. This attribute does not have a default value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AppliesToCode":{
            "title":"Applies To",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the applicability of the pricing charge definition.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PricingChargeDefinitionDescription":{
            "title":"Description",
            "maxLength":"100",
            "type":"string",
            "description":"Description of the pricing charge definition.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PriceType":{
            "type":"string",
            "description":"Type of price for the pricing charge definition. Valid values include One time and Recurring. A list of accepted values is defined in the lookup type ORA_QP_PRICE_TYPES.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Most recent date and time when the application updated the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "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."
        }
    }
}

Back to Top

Examples

This example describes how to get all pricing charge definitions.

Example cURL Command

Use the following cURL command to submit a request on the REST resource:

curl -u username:password "https://servername/fscmRestApi/resources/version/chargeDefinitionsLOV"

Example Response Body

The following shows an example of the response body in JSON format.

{
"PricingChargeDefintion": "Service Price",
"PricingChargeDefinitionCode": "SERVICE_PRICE",
"PricingChargeDefinitionId": 4,
"PricingChargeDefinitionDescription": "Service Price",
"AppliesTo": "Price",
"AppliesToCode": "PRICE",
"PriceType": "One time",
"PriceTypeCode": "ONE_TIME",
"ChargeType": "Service",
"ChargeTypeCode": "ORA_SERVICE",
"ChargeSubtype": "Price",
"ChargeSubtypeCode": "ORA_PRICE",
"PricePeriodicityUOMClass": null,
"TaxChargeType": "Miscellaneous charge",
"TaxChargeTypeCode": "MISCELLANEOUS",
"Refundable": "Y",
"SetupEnabled": "Y",
"Active": "Y",
"CalculateMargin": "Y",
"CreationDate": "2015-12-08T06:21:33+00:00",
"CreatedBy": "Pricing Setup Manager",
"LastUpdateDate": "2015-12-08T06:23:11.414+00:00",
"LastUpdatedBy": "Pricing Setup Manager"
}
...
{..
..}

Back to Top