Skip to navigation
Order to RevenueData Backfill

Create a data backfill job

View as Markdown

Use this operation to perform the following types of data backfill actions. Also, you need to upload a corresponding file to perform a data backfill action.

  • Update Product Rate Plan Charge
  • Update Rate Plan Charge
  • Update Invoice Item
  • Update Credit Memo Detail
  • Update Debit Memo Detail
  • Update Invoice Item Adjustment

For more information, see Perform data backfill.

Authentication

AuthorizationBearer

Use Bearer {{token}} in the Authorization header for authentication.

Headers

Zuora-VersionstringOptional

The minor API version.

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

Request

This endpoint expects a multipart form containing a file.
typeobjectRequired
filefileRequired

A file containing the data about the fields that you want to backfill. This file must be a .csv file or a zipped .csv file. The maximum file size is 4 MB. The data in the file must be formatted according to the data backfill action type that you want to perform.

You can download a file template to view all fields supported for your data backfill. For more information, see Perform data backfill.

checksumstringOptional=32 characters
An MD5 checksum that is used to validate the integrity of the uploaded file.

Response headers

Content-EncodingstringOptional

This header is returned if you specify the Accept-Encoding: gzip request header and the response contains over 1000 bytes of data.

Note that only the following MIME types support gzipped responses:

  • application/json
  • application/xml
  • text/html
  • text/csv
  • text/plain
RateLimit-LimitstringOptional

The request limit quota for the time window closest to exhaustion. See rate limits for more information.

RateLimit-Remainingdouble

The number of requests remaining in the time window closest to quota exhaustion. See rate limits for more information.

RateLimit-Resetdouble

The number of seconds until the quota resets for the time window closest to quota exhaustion. See rate limits for more information.

Zuora-Request-IdstringOptional
The Zuora internal identifier of the API call. You cannot control the value of this header.
Zuora-Track-IdstringOptional
A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.
Concurrency-Limit-TypestringOptional

The type of the concurrency limit, which can be Default, High-volume transactions, or Object Query.

For more information, see Concurrent request limits.

Concurrency-Limit-Limitinteger

The total number of the permitted concurrent requests.

For more information, see Concurrent request limits.

Concurrency-Limit-Remaininginteger

The remaining number of the permitted concurrent requests.

For more information, see Concurrent request limits.

Response

OK
processIdstringOptional
The ID of the process that handles the operation.
reasonslist of objectsOptional

The container of the error code and message. This field is available only if the success field is false.

requestIdstringOptionalformat: "uuid"=36 characters
Unique identifier of the request.
successbooleanOptional
Indicates whether the call succeeded.
jobIdstringOptional
String of 32 characters that identifies the data backfill job. The id is generated before the job is processed. You can use the id to retrieve the data backfill job result.

Errors

4XX
Client Request Error
500
Internal Server Error