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.
Request
query Parameters
onlyReSend
boolean

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.

reMigrate
boolean

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.

header Parameters
Idempotency-Key
string <= 255 characters

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-Encoding
string

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-Encoding
string

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.

Authorization
required
string

The value is in the Bearer {token} format where {token} is a valid OAuth token generated by calling Create an OAuth token.

Zuora-Track-Id
string <= 64 characters

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-Ids
string

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-Ids
string

Comma separated IDs. If you have Zuora Multi-Org 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.

If the header is not set, the operation is performed in scope of the user's accessible orgs.

Request Body schema: application/json
required
itemNumber
string

The item number.

orderLineItemId
string

The order line item ID.

orderNumber
string

The order number.

subscriptionId
string

The subscription ID.

subscriptionNumber
string

The subscription number.

subscriptionVersion
integer

The subscription version.

type
string

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

Enum: "Subscription" "OrderLineItem"
Responses
200
500

Internal Server Error

4XX

Request Errors

post/v1/uno-regenerate/booking-transaction
Request samples
application/json
{
  • "subscriptionName": "A-S00000001",
  • "subscriptionVersion": 1,
  • "type": "Subscription"
}
Response samples
application/json
{
  • "idList": [
    ],
  • "success": true
}