Skip to main content

Revenue Detail to Revenue Element Data Flow

Core Revenue Detail and Element Fields

In ZoneBilling Revenue, data is sent from the Revenue Detail to native Revenue Element and Revenue Arrangement fields via the Revenue Management Third Party Plugin and are maintained for subsequent updates.

If one of the following fields has been changed or a charge has been billed (which was not previously), then the next time Update Revenue Details is run, it will trigger a full update of the associated Revenue Detail & Revenue Order. The next time the Update Revenue Arrangements process is run, the Revenue Element(s) will be updated.

  • Quantity
  • Sales Amount
  • Discounted Sales Amount

On the ZAB Preferences page, you can also choose to include ‘Start Date’, ‘End Date’, ‘Forecast Start’, and ‘Forecast End Date’ as fields to keep in sync between the Revenue Detail and the Revenue Element records.

Note: The ‘Start Date’ and ‘Forecast Start Date’ are only able to update when the Revenue Plan is in a ‘Not Started’ status. Additionally, errors will be received when trying to create Revenue Elements and Arrangements if the ‘End Date’ is prior to the ‘Start Date’.

The fields Quantity, Amount, Discounted Sales Amount, and Exchange Rate are automatically applied and kept in sync between the records.

 

Custom Revenue Element Fields

Custom fields on the Revenue Element and Revenue Arrangement are only set on the creation of the record. Any data changes for these fields will not be passed through to ARM once the Revenue Element has been created.

If a full resync of all data is required prior to the Revenue Element being created, clear the Date Last Detail Sync on the Revenue Order before triggering Update Revenue Details.

Example: A custom field for ‘Region’ is not populated on the Revenue Detail because it had not been set on the Subscription Item when the Revenue Detail was first created. The ‘Region’ field is then populated on the Subscription Item.

  1. If the Revenue Element has not been created yet:
    • Since one of the core fields has not been changed, clearing out the ‘Date Last Detail Sync’ and then re-running the Update Revenue Details Process should allow “Region” to populate on the Revenue Detail.
  2. If the Revenue Element has been created already:
    • In this case, ‘Region’ would need to be populated manually in the UI by editing the Revenue Arrangement.

 

Revenue Element Fields that Cannot be Changed

Note: some fields, such as Department, Location, and Class, can not be edited. In these scenarios, it is important to ensure all necessary data points are populated on the underlying records properly before creating the Revenue Element.

 

Configuring and Testing ZoneBilling Revenue

When configuring and testing ZoneBilling Revenue, it is important to review data at each stage of the process due to how data may not be able to be updated on Revenue Elements, Revenue Arrangements, or Revenue Plans at certain points in time.

Below are examples (but not a comprehensive list) of fields that do not need to be mapped with Revenue Management Detail Maps:

  • Item
  • Quantity
  • Sales Amount
  • Discounted Sales Amount
  • Start Date
  • End Date
  • Revenue Recognition Rule
  • Rev Rec Forecast Rule
  • Customer
  • Subsidiary
  • Create Revenue Plans On
  • Allocation Type
  • Department
  • Location
  • Class

It is recommended to follow the steps below:

  1. Confirm that the expected number of Revenue Detail records were generated based on the Revenue Configuration.
    • If not, review your Revenue Configuration, make the appropriate changes, and then run the Update Revenue Details process.
    • Tip: It is best practice to create a ZAB Charge saved search that mimics the groupings and fields on the Revenue Configuration prior to running the Update Revenue Details process.
      • This allows a preview of the expected results and can help prevent the creation and inactivation of numerous Revenue Details as you cycle through testing.
  2. Once the proper number of Revenue Details have been created, review that all necessary data points are reflected accurately on the Revenue Detail records.
    • If not, review the underlying Charge Records and/or custom Revenue Detail fields to ensure data is populated.
    • Clear out the ‘Last Sync Date’ on the Revenue Order and re-run the Update Revenue Details process.
  3. Once all Revenue Details have been generated correctly, run the Update Revenue Elements and Arrangements process.
  4. Confirm that all Revenue Elements and Arrangements are created successfully with expected data points populated.
    • If not, review the ZAB Revenue Management Detail Map to ensure a mapping is not missing.
    • Since custom field data is only pushed on create of the Revenue Element, a new subscription may be needed for testing again.

 

Was this article helpful?