Overview of Booking Transactions

Last updated
Save as PDF

The Booking Transaction object is available in the data source and data query. Booking transactions capture important changes, custom field direct updates, and the delta values on Rate Plan Charge, Order Line Item, and related objects when a subscription is created or amended in Zuora Billing.

Booking transactions for subscriptions

When a subscription is created or amended, booking transactions are generated on the segment level if one of the following conditions is met:

The new segment is a discount, and the new segment's quantity is not the same as the previous segment.
The new segment is not a discount, and the new segment's Extended List Price (ELP) value is not the same as the previous segment.
The new segment's effective start date is not the same as the previous segment.
The new segment's effective end date value is not the same as the previous segment.
The Charge Contract Value (CCV) of the new segment is not the same as the previous segment.
When a charge is created, a new segment is created and a booking transaction is generated for the new segment.
When a charge is updated, a new segment is created and a booking transaction is generated for the segment.
When an owner transfer occurs to a subscription and the subscription owner gets changed, all the segments that belong to the new version subscription generate booking transactions.
If the current segment is a discount charge and the applied to charge segment is changed, a booking transaction is generated for the discount line.

In the following table, you can see how booking transactions get generated for amendments or order actions:

Amendment Types	Order Actions	Booking Transaction Object
	Create Subscription	Records all charge segments
Add product	Add product	Records the new charge segment created
Update product	Update product	Record the new and old impacted segment
Remove Product	Remove Product	Record all impacted charge segments
Renew Subscription	Renew Subscription	Record the new renewed charge segments
Cancel Subscription	Cancel Subscription	Record all impacted charge segments
Subscription Owner Transfer	Subscription Owner Transfer	Record all charge segments
Suspend and resume	Suspend and resume	Record all impacted charge segments
Terms and Conditions	Terms and Conditions	Record all impacted charge segments
	Change Plan	Record all impacted charge segments
	Component	Record all impacted charge segments
Pending to Active	Pending to Active	Record all impacted charge segments
	Revert Order (Only supported with a single version subscription)	Record all impacted charge segments

There are more than 50 fields in the Booking Transaction object. For more information, see Booking Transaction object fields and Data Query.

Regenerate booking transaction on subscription

If you have a subscription booking that needs to be regenerated, do the following:

Click on Subscriptions.
Click on the three dots next to the Create Order button.
Select the option Regenerate Booking Transaction.

The Regenerate Result screen will appear and display the regenerated bookings with their Sales Order Line ID and related information.

Note that the Regenerate Booking Transaction option will be available only to the users who have been provided access.

Enable regenerate booking transaction option

To make the Regenerate Booking Transaction button available to a user, you have to enable the ‘Manage OTR transaction regeneration permission’ in the ‘Manage Roles’ section. To enable the setting,

Click your username at the top right and navigate to Settings > Administration > Manage User Roles.
On the Manage Roles page, select Billing from the View Role List of list.
Click the role name or view to manage permissions assigned to the selected role. The screen will display the selected role's Basic Information and Billing Permissions.
Click the Edit button on the Billing Permissions section.
Scroll down the screen and go to the Admin section.
Click to select the Manage OTR Transactions Regeneration option.
Click Save.

The user will be now able to see the Regenerate Booking Transaction option.

Booking transactions for order line items

When an order line item is created or updated, booking transactions are generated if one of the following conditions is met:

The itemState field is set to Booked, SentToBilling, or Complete when creating the order line item
The itemState field is transitioned from Executing to Booked, SentToBilling, or Complete.

Limitations

The booking transactions are not generated for the following conditions:

Draft subscriptions
Deleting a subscription (including deleting an order or deleting an amendment). The deleting operations are not recommended. For more information, see Required configurations and best practices for using Order to Revenue.