Charge Information in Fulfillment System Response
Details about charges that the fulfillment system sends in the context of the fulfillment transaction.
QName: {http://xmlns.oracle.com/apps/scm/doo/taskLayer/commonService/}Charge
Relationships
The following table describes how this service data object is related to other service data objects or business object services.
Relationship Type | Object or Service |
---|---|
Contains |
|
Contains |
|
Contained by |
|
Handled by |
Attributes
The following table describes attributes in the service data object.
Name | Type | Description |
---|---|---|
ApplyTo |
string |
Indicates whether a charge is applied to Product, Shipping, or Return. |
AverageUnitSellingPrice |
{http://xmlns.oracle.com/adf/svc/types/}AmountType |
Average unit selling price for an item. NOTE: DO NOT map the currencyCode attribute since this amount is always expressed in the transactional currency of the order. If currencyCode is populated, it will be ignored. |
BlockAllowance |
decimal |
Value that indicates the block allowance for a non-tiered consumption charge. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features. |
BlockSize |
decimal |
Number that represents the size of the block for charge calculation for a tier. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features. |
CanAdjustFlag |
boolean |
Contains one of the following values: true or false. If true, the charge is eligible for an adjustment. If false, the charge isn't eligible for an adjustment. |
ChargeComponent |
Breakup of charges that the fulfillment system sends in the context of the fulfillment transaction. |
|
ChargeCurrencyName |
string |
Name of the currency that was used for the charge. E.g., US Dollar. |
ChargeDefinition |
string |
A charge definition is a combination of Price Type, Charge Type, Charge Sub Type. |
ChargeDefinitionCode |
string |
Code of the charge definition entity. A charge definition defines the price type, charge type, and charge subtype, which are denormalized onto this entity. |
ChargeInterfaceKey |
string |
Unique internal identifier of the charge as assigned by the system that captured the transaction. |
ChargeSubtype |
string |
Subtype of a given charge type. Examples are, within Shipping Related Charges: Freight Charge, Shipping Insurance, within Special Charges: Suspend Charge, Resumption Charge |
ChargeSubtypeCode |
string |
Code of the subtype of a given charge. Defined for this configuration for aggregation of totals. |
ChargeTier |
Charge tier to support subscription management integration. This attribute is not currently used. |
|
ChargeType |
string |
Defines the type of charge. Examples are Goods Sale, Service Sale, Financing, Shipping-related Charges, Restocking Penalties, Special Charges, etc. |
ChargeTypeCode |
string |
Code of a given charge type. Charge types could include goods sale, service sale, financing or lease, shipping-related charges, restocking penalties, or special charges. |
GSAUnitPrice |
{http://xmlns.oracle.com/adf/svc/types/}AmountType |
GSA Unit Price |
PricePeriodicityCode |
string |
Code of the periodicity for both recurring price type and recurring usage price type. Month, Year, Quarter. |
PriceType |
string |
Price type of a given charge. Examples are One-time, Recurring, Usage, etc. |
PriceTypeCode |
string |
Code of the price type of a given charge. One-time, Recurring. |
PricedQuantity |
{http://xmlns.oracle.com/adf/svc/types/}MeasureType |
Ordered quantity. |
PricedQuantityUOM |
string |
Meaning of the unit of measure code in which the priced quantity is expressed. |
PrimaryFlag |
boolean |
Indicates whether this charge is the primary charge. |
RollupFlag |
boolean |
Marks a charge as a rollup or aggregate charge. |
SequenceNumber |
int |
Sequence number of the charge. |
TierAppliesTo |
string |
Value that identifies whether the applicability of the tier is for all tiers or the highest tier. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features. |
TierAppliesToCode |
string |
Abbreviation that identifies the applicability of the tier whether all tiers or the highest tier. A list of accepted values is defined in the lookup type ORA_QP_TIER_GRADUATED_TYPES. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features. |
UsagePriceLockFlag |
boolean |
Contains one of the following values: true or false. If true, then the usage pricing is used. If false, then the usage pricing isn't used. This attribute does not have a default value. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features. |