Bookshelf Home | Contents | Index | Search | PDF

Siebel Order Management Guide Addendum for Industry Applications > Business Service Methods Reference > Product Manipulation Toolkit Business Service Methods >

Quote To Revenue

---

This is one of the Product Manipulation Toolkit Business Service Methods.

It generates revenue line items for each line item in a quote that matches the criteria specified by the input conditions. The line items are associated with the opportunity from which the quote was created.

Arguments

SiebelMessage

[in] Contains a product instance hierarchy.

RootItemId

[in] Root item ID.

ConditionFieldNames

[in] Names of fields whose value must equal that specified by ConditionValues. In these cases, the quote line item will be converted to a revenue line item. In the SIS OM Update Revenue workflow, the condition fields are action code, price type and extended amount.

ConditionValues

[in] Values that fields must have to satisfy the condition. In the SIS OM Update Revenue workflow, the action code must be Add or Update, price type must be One-Time or Recurring, and extended amount must be non-zero.

ExcludedFieldsUserPropertyTag

[in] User properties tag identifying fields that should not be copied from the quote line item to the revenue line item.

Returns

Revenue line items.

Remarks

The following discussions list user properties associated with this method. They also indicate how the method adds revenue and determines: revenue amount, revenue dates, number of revenue items, frequency of revenue line items, annually recurring charges, quarterly recurring charges, monthly recurring charges, weekly recurring charges, and daily recurring charges.

User Properties

This method used the following user properties:

Quote To Revenue.Quote Item.Due Date Field. Quote Line Item business component field that determine the first date on which revenue will be added. Out of the box, this the quote line item is due date.
Quote To Revenue.Quote Item.Amount Field. Quote Line Item business component field used as the revenue amount. Out of the box this is the extended amount.
Quote To Revenue.Quote Item.Item Price Field. Quote Line Item business component field containing the item price.
Quote To Revenue.Quote Item.Price Type Field. Quote Line Item business component field containing the price type.
Quote To Revenue.Quote Item.Unit of Measure Field. Quote Line Item business component containing the unit of measure.
Quote To Revenue.Quote Item.Occurence Field. Quote Line Item business component field containing the number of revenue occurrences.
Quote To Revenue.Quote Item.Extended Quantity Field. Quote Line Item business component field containing the extended quantity.
Quote To Revenue.Quote Item.Description Field. Quote Line Item business component field containing the description.
Quote To Revenue.Quote Item.Product Id Field. Quote Line Item business component field containing the product Id.
Quote To Revenue.Revenue.Quantity Field. Revenue business component field containing the quantity.
Quote To Revenue.Revenue.Quotable Field. Revenue business component field indicating whether the revenue is quotable.
Quote To Revenue.Revenue.Date Field. Revenue business component field containing the revenue date.
Quote To Revenue.Revenue.Price Field. Revenue business component field containing the product price.
Quote To Revenue.Revenue.Revenue Field. Revenue business component field containing the revenue.
Quote To Revenue.Revenue.Description Field. Revenue business component field containing the description.
Quote To Revenue.Revenue.Product Id Field. Revenue business component field containing the product Id.

Adding Revenue

This method:

Adds revenue only for quote line items with an Add or Update action code. Quote line items `-', and Deleted action codes are ignored.
Adds revenue only for quote line items that have an extended amount not equal to zero.

Negative extended amounts are added to revenue.

Adds revenue only for price types that are one-time and recurring. It is not calculated for usage.
Adds revenue on a per product component basis (per quote line item).

Determining Revenue Amount

This method:

Uses a user property to define the Quote Item business component field that is used for the revenue amount. The default is the Extended Amount field.
Uses the value of this field as the revenue amount for all periods.

Determining Revenue Dates

This method:

Uses a user property to define the Quote Item business component field that, in turn, is used to calculate the first revenue date. The default is the Due Date field.

Determining Number of Revenue Items

The forecast number of revenue occurrences for a product is defined in product administration. When a quote line item is created the number of forecast revenue occurrences is copied from the product into the quote line item. There, it can be overridden through the UI or by configuration.

This method:

Adds revenue for products with one time price types once on the due date of the quote line item, regardless of the number of occurrences defined.
Adds revenue for products with recurring price types as many times as the number of occurrences.

Determining Frequency of Revenue Line Items

This method:

Adds revenue as it occurs (weekly, monthly, quarterly or annually) instead of grouping it into monthly totals.
Adds the first revenue, for any quote line item, on the due date plus one UoM.

The following UoMs that are allowed: Per Year, Per Month, Per Quarter, Per Week, and Per Day.

Determining Annually Recurring Charges

This method:

Adds revenue on the same day every year, starting on the end date of the first period. For example, if the due date is 7/11/01, the default date of the first billing cycle is 7/11/02 and revenue is added for 7/11/02, 7/11/03 and so on, for as many occurrences as the quote line item specifies.

If the end date of the first period falls on the 2/29, the revenue date for non-leap years is 2/28.

Determining Quarterly Recurring Charges

This method:

Adds revenue on the same day every three months, starting on the date of the first billing cycle, the default value of which is 3 months after the quote line item due date. For example, if the due date is 7/11/01, revenue is added for 10/11/01, 1/11/02, 4/11/02, 7/11/01 and so on, for as many occurrences as product specifies.

If the end date of the first period falls on the 29th, 30th or 31st of a month, the revenue date for months that have fewer days is the last day of the same month.

Determining Monthly Recurring Charges

This method:

Adds revenue on the same day every month, starting on the date of the first billing cycle which defaults to one month after the quote line item due date. For example, if the due date is 7/11/01, revenue is added for 8/11/01, 9/11/01 and so on, for as many occurrences as the product specifies.

If the due date falls on the 29th, 30th or 31st of a month, the revenue date for months with fewer days is the last day of the same month.

Determining Weekly Recurring Charges

This method:

Adds revenue every 7 days starting on the date of the first billing cycle which defaults to 7 days after the quote line item due date. For example, if the due date is 7/11/01, revenue is added for 7/18/01, 7/25/01, 8/1/01 and so on, for as many occurrences as the product specifies.

Determining Daily Recurring Charges

The method:

Adds revenue every day, starting on the date of the first billing cycle which defaults to one day after the quote line item due date. For example, if the due date is 7/11/01, revenue is added for 7/12/01, 7/13/01, 7/14/01 and so on, for as many occurrences as the product specifies.

Bookshelf Home | Contents | Index | Search | PDF