POST /v1/uno-regenerate/billing-transaction

Use this operation to generate billing 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 billing 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 transaction objects.

Servers

https://rest.test.zuora.com
https://rest.sandbox.na.zuora.com
https://rest.apisandbox.zuora.com
https://rest.na.zuora.com
https://rest.zuora.com
https://rest.test.eu.zuora.com
https://rest.sandbox.eu.zuora.com
https://rest.eu.zuora.com

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"
`Content-Encoding`	String	No	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-Id`	String	No	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 (`'`).
`Authorization`	String	Yes	The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling Create an OAuth token.
`Idempotency-Key`	String	No	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.
`Zuora-Entity-Ids`	String	No	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 do not need to set this header.
`Zuora-Org-Ids`	String	No	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.
`Accept-Encoding`	String	No	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.

Query parameters

Name Type Required Description

Name	Type	Required	Description
`reMigrate`	Boolean	No	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 not be overridden and sent into Revenue with regenerate_flag as N. Note: If `onlyReSend` is true, the `reMigrate` can't be true.
`onlyReSend`	Boolean	No	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, Whether existing booking transactions in the database will be overridden and sent into Revenue for re-collecting depends on 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 not be overridden and sent into Revenue with regenerate_flag as N.

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

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, Whether existing booking transactions in the database will be overridden and sent into Revenue for re-collecting depends on the value of reMigrate.

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

Request body fields

Name Type Required Description

Name	Type	Required	Description
`documentId`	String	No	Id of Invoice, CreditMemo, DebitMemo, or InvoiceItemAdjustment
`number`	String	No	Number of Invoice, CreditMemo, DebitMemo, or InvoiceItemAdjustment
`type`	String	No	The type of business object for which you want to generate the transactions. Possible values: `"Invoice"` `"CreditMemo"` `"InvoiceItemAdjustment"` `"DebitMemo"`

documentId

String

Id of Invoice, CreditMemo, DebitMemo, or InvoiceItemAdjustment

number

String

Number of Invoice, CreditMemo, DebitMemo, or InvoiceItemAdjustment

type

String

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

Possible values:

"Invoice"
"CreditMemo"
"InvoiceItemAdjustment"
"DebitMemo"

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.