Skip to content
Legacy API Reference
/
/
Execute

Execute

Request

Use the execute call to execute a process to split an invoice into multiple invoices. The original invoice must be in draft status. The resulting invoices are called split invoices.

To access this feature, see Enable Splitting Invoices for steps.

To split a draft invoice into multiple split invoices:

  1. Use the create call to create a single InvoiceSplit object to collect all of the InvoiceSplitItem objects.
  2. Use the create call to create a separate InvoiceSplitItem object for each split invoice that you want to create from the original draft invoice.
  3. Use the execute call to split the draft invoice into multiple split invoices.

You need to create InvoiceSplitItem objects and an InvoiceSplit object before you can use the execute call.

  • Supported objects: InvoiceSplit
  • Asynchronous process: yes
Query
rejectUnknownFieldsboolean

Specifies whether the call fails if the request body contains unknown fields. With rejectUnknownFields set to true, Zuora returns a 400 response if the request body contains unknown fields. The body of the 400 response is:

{
    "message": "Error - unrecognised fields"
}

By default, Zuora ignores unknown fields in the request body.

Default:false
Headers
Idempotency-Keystring, <= 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-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.

Authorizationstring

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

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 do not need to set this header.

Zuora-Track-Idstring, <= 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 (').

X-Zuora-WSDL-Versionstring

Zuora WSDL version number.

Default:79
Bodyapplication/jsonrequired
idsArray of stringsrequired

The ID of the object. Values: a valid InvoiceSplit object ID.

Example:
[
  "2c93808457d787030157e031d5844c53"
]
synchronousbooleanrequired

Indicates if the call is synchronous or asynchronous. Values: false

Example:false
typestringrequired

Specifies the type of executed item.

Value:"InvoiceSplit"
Example:"InvoiceSplit"
{
  "ids": [
    "2c93808457d787030157e031d5844c53"
  ],
  "synchronous": false,
  "type": "InvoiceSplit"
}

Responses

Headers
Content-Encodingstring

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-Limitstring

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

RateLimit-Remainingnumber

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

RateLimit-Resetnumber

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

Zuora-Request-Idstring, = 36 characters

The Zuora internal identifier of the API call. You cannot control the value of this header.

Zuora-Track-Idstring, <= 64 characters

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.

Bodyapplication/json
Array [
ErrorsArray of objects(ActionsErrorResponse)
Idstring

The ID of the object in the call. The value is the same as the value you provide in the ids field for the request.

Successboolean

Returns true if the call was processed successfully, otherwise false.

]
Response
[
  {
    "Success": true,
    "Id": "2c93808457d787030157e031d5844c53"
  }
]