Sign in
Regenerate

Regenerate booking transactions

Use this operation to generate booking transactions. This call is useful in the following two use cases:

  • During customer onboarding, there is a common scenario when customers perform data backfill or data fixes. To synchronize these changes from Billing to Revenue, use this API operation to regenerate booking transaction objects.
  • Customers choose to experiment with their use cases in the Sandbox environment before implementing them in the Production environment. During this experimentation phase, customers not only interact with data but also use this API operation to regenerate booking transaction objects.
post/v1/uno-regenerate/booking-transaction

Query parameters

onlyReSendboolean

If onlyReSend is true, existing booking transactions in the database will not be overridden and sent into Revenue for re-collecting, i.e. regenerate_flag is Y.

If onlyReSend is false, existing booking transactions in the database will be overridden and sent into Revenue, no matter what is the value of reMigrate.

Note: If onlyReSend is true, the reMigrate can't be true.

reMigrateboolean

If reMigrate is true, existing booking transactions in the database will be overridden and sent into Revenue for re-collecting, i.e. regenerate_flag is Y.

If reMigrate is false, existing booking transactions in the database will be overridden and sent into Revenue with regenerate_flag as N.

Note: If onlyReSend is true, the reMigrate can't be true.

Headers

Idempotency-Keystring

Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types.

With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.

Accept-Encodingstring

Include the Accept-Encoding: gzip header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.

If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a Content-Encoding header with the compression algorithm so that your client can decompress it.

Content-Encodingstring

Include the Content-Encoding: gzip header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.

Zuora-Track-Idstring

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue.

The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Zuora-Entity-Idsstring

An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header.

Zuora-Org-Idsstring

Comma separated IDs. If you have <a href="https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org" target="_blank">Zuora Multi-Org</a> enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.

The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs.

Zuora-Versionstring

The minor API version.

For a list of available minor versions, see API upgrades.

Request body

itemNumberstring

The item number.

orderLineItemIdstring

The order line item ID.

orderNumberstring

The order number.

subscriptionIdstring

The subscription ID.

subscriptionNamestring

The subscription name.

subscriptionVersioninteger

The subscription version.

ratePlanChargeIdstring

The rate plan charge ID of dynamic usage charge.

chargeNumberstring

The charge number of dynamic usage charge.

type'Subscription' | 'OrderLineItem' | 'DynamicUsageCharge'

The type of business object for which you want to generate the transactions.

Example request

{
  "subscriptionName": "A-S00000001",
  "subscriptionVersion": 1,
  "type": "Subscription"
}

Response

OK

idListstring[]

A list of the IDs for the business objects for which you generate the transactions.

successboolean

Indicates whether the call succeeded.

Changes

No recorded changes to this endpoint across all 4 revisions of this API.