Skip to main content

ZAB Revenue Details

Depending on Revenue Configuration field summary selections, each Revenue Detail will represent a single Charge or group of Charges.

In this final stage, Charge data will be converted to Revenue Details, before data is transmitted to the ARM Revenue Element.

Custom fields may be added to the Revenue Detail record and populated by the Revenue Configuration. Standard fields are detailed below.

revenue_detail.png

Note: Environments utilizing Multi-book when running Update Revenue Details, will see Detail records created for each Accounting Book. Revenue Details will not be created for any Accounting book marked ‘Adjustment Only’.

Fields on the Revenue Detail record:

  • ID: This is the system generated ID assigned to the ZAB Revenue Detail.
  • Revenue Order: This field references the Revenue Order to which the Revenue Detail belongs. There can only be one Revenue Order per Revenue Detail.
  • Subscription: This field contains the Subscription to which the Revenue Detail belongs (sourced from the associated Charges).
  • Customer: The field contains the Customer (sourced from the associated Charges).
  • Bill To Customer: This field contains the Bill To Customer (sourced from the associated Charges). This entity will be who the Revenue Arrangements/Elements are created for – and will be the same entity that was billed (on a Sales Order / Invoice). The use of this field ensures that the Revenue transactions always match the same entity as the Billing transactions.
  • Subsidiary: This field contains the Subsidiary (sourced from the associated Charges).
  • Currency: This field contains the Currency (sourced from the associated Charges).
  • Exchange Rate: The Exchange Rate for a Revenue Detail is determined as of its Revenue Date. If no Revenue Date is populated on the Revenue Detail, the Exchange Rate will be determined as of the Revenue Order Date.
  • Plan Currency: For non-multibook environments, this will be the base currency of the Subsidiary. In multibook environments, this will be the base currency of the Subsidiary if the ZAB Revenue Detail is associated with the Primary Accounting Book. Otherwise, it will be the Base Currency of the associated Secondary Accounting Book.
  • Item: This field contains the Item (sourced from the associated Charges).
  • Quantity: If the associated Revenue Configuration does not define a different summary calculation, this field will be populated by the sum of all quantities from associated Charges.
  • Description: This field contains the Description (sourced from the associated Charges).
  • Sales Amount: Unless otherwise defined in the associated ZAB Revenue Configuration, this will be the sum of the Gross Amount from the associated Charges.
  • Discounted Sales Amount: This will be the sum of the Amount from the associated Charges.
  • Revenue Type: This field distinguishes whether this Revenue Detail record is used for Actual or Forecast revenue elements.
  • Arrangement Subgroup ID: Populate this field through Revenue Configuration Field Mapping to further segregate Revenue Details from the same Revenue Order into multiple Arrangements. This value should not contain any punctuation or special characters and should be under 20 characters in length.
  • Start Date: Unless otherwise defined in the associated ZAB Revenue Configuration, this will be the minimum Service Start Date of the associated Charges
  • End Date: Unless otherwise defined in the associated ZAB Revenue Configuration, this will be the maximum Service End Date of the associated Charges
  • Effective Start Date: This field is used in the case of ZAB Prospective Merge. It should not be populated by any other means.
  • Effective End Date: This field is used in the case of ZAB Prospective Merge. It should not be populated by any other means.
  • Revenue Arrangement: This is the Revenue Arrangement associated with the ZAB Revenue Detail.
  • Revenue Element: This is the Revenue Element for which the ZAB Revenue Detail is the source.
  • Revenue Event Type: This field is populated upon creation of the Revenue Detail record based on the Item setting of this same field. If this field is populated, ZAB Revenue will require a ZAB Revenue Event of the appropriate type (Quantity Based, Amount Based, or Percent Complete) to trigger revenue to be recognized.
  • Revenue Event Subscription Item: This field contains the Subscription Item (sourced from the associated Charges).
  • Department: The calculation of this field is typically defined by the ZAB Revenue Configuration (e.g., Group of Department from associated Charges).
  • Location: The calculation of this field is typically defined by the ZAB Revenue Configuration (e.g., Group of Location from associated Charges).
  • Class: The calculation of this field is typically defined by the ZAB Revenue Configuration (e.g., Group of Class from associated Charges).
  • Accounting Book: If Multibook is not enabled, this will always be the Primary Accounting Book. Otherwise, it will define a primary or secondary book assignment.
  • Status: This is the status of the Revenue Detail.
    • Pending Delete - Charges are no longer associated with this Revenue Detail and it can be purged from the system upon Update Revenue Details
    • Active - Revenue Details have been sent to ARM.
    • Inactive - Charges are no longer associated with this Revenue Detail (due to cancellation or change in data points relevant to the ZAB Revenue Configuration) but the associated Revenue Element remains. When a Revenue Detail changes to inactive, any revenue recognized on the associated Element’s Revenue Plan will attempt to be reversed.
    • Data not synced between ZoneBilling and ARM:
      • Not Started
      • Pending Kit Component Creation
      • Pending Event Update
  • Revenue Date: If populated, this date will be used to determine the exchange rate on the Revenue Detail.
  • Date Last Invoice Link Check: This is the timestamp of the last time updates were registered for invoices or credit memos associated with the Revenue Detail. Updates would be required upon creation or edit of those transactions.
  • System Generated: Do not modify the "Display Type" or "Show In List" settings for this field. This checkbox indicates this TCV Detail record was created automatically by the TCV scripts and will be updated automatically with changes to the parent Subscription. If any manual adjustments are made by an End User this checkbox will be False and the record will remain unchanged by updates to the Subscription.
  • Line Unique Key: Do not modify the "Display Type" or "Show In List" settings for this field. This value is system generated and is used in the Update Revenue Details process.
  • Reference ID: This is a system batch ID that is assigned at the time of ZAB Revenue detail creation.
  • Revenue Arrangement Merge Group ID: This is a system batch ID that is assigned at the time of Revenue Arrangement Merge.
  • Is Kit Item Type: If the Item associated on the Revenue Detail is of the type Kit, this box will be checked.
  • Member of: If the Item associated on the Revenue Detail is a component of a Kit, the Kit Item will be associated here.

 

Sublists:

  • Revenue Events > Revenue Recognition Event: These events define different revenue recognition events that are communicated to ARM. See Revenue Recognition Events for more information.
  • Revenue Events > Revenue Event: If your item has a Revenue Event Type populated, you can review/add/edit Revenue Events on this tab.
  • Components: Only relevant when leveraging Kits.
  • Related Charges: Charges associated with the Revenue Detail as defined by the Revenue Configuration will be listed on this tab.

 

Was this article helpful?