‘Update Revenue Details’ Sub-scripts – ZoneBilling Knowledge Base

A ZAB Process record is created each time a process has been initiated through an Automation or Suitelet. When the ‘Update Revenue Details’ process is executed, the ZAB Process record will display 4 related sub-scripts. These sub-scripts make up the ‘Update Revenue Details’ process, each performing key operations:

Process: Update Revenue Details
- Sub-script: ZAB Revenue Order Processing
Process: Update Revenue Event Details
- Sub-script: ZAB Revenue Event Processing
Process: Update Revenue Links
- Sub-script: ZAB Revenue Link Linking
Process: Update Revenue Billing Events
- Sub-script: ZAB Revenue Billing Event Processing

Columns ‘Quantity to Process’ and ‘Quantity Processed’ will vary depending on the number of Subscriptions selected to process, as well as the data points that are available to update.

Each ZAB Process record displays a text link titled ‘Script Link’. In the event that an error is returned on a related sub-script, this text link will take you to the script associated with the process and share further details, see example:

Additional Notes:

The Revenue Order and Revenue Details only register a full update when the Start Date, End Date, Quantity, Amount, Discounted Sales Amount have changed OR if billing of Charges has occurred. If a full resync of all data is required, clear the Date Last Detail Sync on the Revenue Order before triggering ‘Update Revenue Details’.
The Revenue Detail Status will remain in Not Started until Update Revenue Arrangements has been run and an Element and Arrangement have been associated with the Revenue Detail.
If the environment has multi-book accounting enabled you should expect one Revenue Detail per accounting book per the Revenue Configuration.
All relevant data (e.g., Class, Department, Location, custom fields) needs to be present on the Revenue Detail upon creation of the Element, as only Quantity, Amount, Discounted Sales Amount, Start Date and End Date fields are updated going forward.
If the item type is a Kit/Package, Revenue Details will be created for both the parent kit item and its component items. Kits should be set up to “Display Components on Transactions”.

Update Revenue Event Details: Sub-script ZAB Revenue Event Processing

During the ‘Update Revenue Event Details’ process, the script ZAB Revenue Event Processing will also run on the selected population.

update_revenue_details_zab_process_update_rev_event_details.png

ZAB Revenue Event Processing script will create:

Two ZAB RA Creation revenue recognition events (one Forecast, one Actual) in the amount of the Revenue Detail Sales Amount.

update_revenue_details_zab_process_update_rev_event_details_ra_create.png

ZAB Billing revenue recognition events will be created per transaction for Charges that have been billed through to a posting transaction (e.g., Credit Memo, Invoice).

update_revenue_details_zab_process_update_rev_event_details_billing.png

Note: Revenue Recognition Events for ZAB Amount Based, ZAB Quantity Based and ZAB Percent Complete do not require Update Revenue Details for creation. Instead, entering the Revenue Event in the UI directly on the Revenue Detail or via Suitelet, as well as importing with scripts and workflows set to trigger will create the associated custom Revenue Recognition Event.

update_revenue_details_zab_process_update_rev_event_sublist.png

update_revenue_details_zab_process_update_rev_event_details_zab_amount_based.png

Update Revenue Links: Sub-script ZAB Revenue Link Linking

During the ‘Update Revenue Event Details’ process, the script ZAB Revenue Link Linking will run on the selected population.

update_revenue_details_zab_process_update_rev_links.png

ZAB Revenue Link linking will create Revenue Links on the transaction associated with the billed Charges. This record links data from the Revenue Detail, Charges, and ZAB-created transaction.

update_revenue_details_zab_process_update_so_rev_links.png

Update Revenue Billing Events: Sub-script ZAB Revenue Billing Event Processing

During the ‘Update Revenue Event Details’ process, sub-script ZAB Revenue Billing Event Processing will run on the entire population.

update_revenue_details_zab_process_update_rev_billing_events.png

ZAB Revenue Billing Event Processing will create the Revenue Transaction Links on the ZAB-created transaction and the posting transaction associated with the ZAB-created transaction if there is one.
E.g., if the ZAB-created transaction is a Sales Order, Revenue Transaction Links will be created for the Sales Order and associated Invoice. However, if the ZAB-created transaction is a Invoice or Credit memo, the Revenue Transaction Links will only be created on the Invoice and Credit Memo.

Note: For high volume accounts, this process often times out. As such, you may need a Script Override configuration to manage the amount of data being sent through at any given time. Contact Product for more information.

Additional scripted actions

There are additional scripts that run in parallel to the ‘Update Revenue Details’ process:

ZAB Revenue Arrangement Merge
ZAB Arrangement Split
ZAB Revenue Arrangement Merge Inactives

These additional scripts run in case there are Elements to process, regardless if there’s a Revenue Arrangement Merge Profile or Revenue Arrangement Split Profile present on the ZAB Preference record. These additional scripts do not have an associated ZAB Process record.

ZAB Revenue Arrangement Merge

If you have a Revenue Arrangement Merge Profile set up in ZAB Preferences, this script will merge Elements from different Arrangements into a new Arrangement per the specified criteria.

The Revenue Arrangement Merge Profile script submits data to the native NetSuite Merge Revenue Arrangements from Linked Sources page, so even though the script has finished, merging may not be done. The status page for Merge Revenue Arrangements from Linked sources is the indicator of process status (Transactions > Financial > Merge Revenue Arrangements for Linked Sources > Status).

Note: To have specifics on the Revenue Arrangement Merge profile go into effect, the Arrangement records must have been generated previously via 'Update Revenue Details' and 'Update Revenue Arrangements’.

ZAB Revenue Arrangement Split

If you have a Revenue Arrangement Split Profile set up in ZAB Preferences, this script will split Elements from the same Arrangement into new Arrangements per the specified criteria.

Note:

The Arrangement needs to be pre-existing. This means ‘Update Revenue Details” and 'Update Revenue Arrangements’ must have run previously before this process takes place.
ZAB Revenue Arrangement Split submits data to the native NetSuite Merge Revenue Arrangements from Linked Sources page, so even though the script has finished merging may not be done. The status page for Merge Revenue Arrangements from Linked sources is the indicator of process status (Transactions > Financial > Merge Revenue Arrangements for Linked Sources > Status).

ZAB Revenue Arrangement Merge Inactives

By design, a Revenue Detail record will have a status of Inactive if:

The data points used in the Revenue Configuration have changed and have made the Revenue Detail no longer viable. This happens frequently with the summary type of Group on the Revenue Configuration Field Map.
The Subscription Item has gone through a cancellation process where all Charges are removed. When a Revenue Detail is classified as Inactive, the Sales Amount and Discounted Sales Amount will drop to zero. A new Active or Not Started Revenue Detail will be created in its place.

ZAB Revenue Arrangement Merge Inactives will take those inactive details and merge them away to a new Revenue Arrangement with a Transaction Total of 0.00. Any previously recognized revenue will be reversed and re-planned on the Revenue Plan associated with the replacement Revenue Detail.