Invoice Split Items

Use invoice split items to split the original invoice into multiple invoices.

Operations

CRUD: Retrieve an invoice split item

Request

Path

idstringrequired

Object id

Query

fieldsstring

Object fields to return

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 (').

cURL

curl -i -X GET \
  'https://rest.zuora.com/v1/object/invoice-split-item/{id}?fields=string' \
  -H 'Accept-Encoding: string' \
  -H 'Authorization: string' \
  -H 'Content-Encoding: string' \
  -H 'Zuora-Entity-Ids: string' \
  -H 'Zuora-Track-Id: string'

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

CreatedByIdstring

The ID of the Zuora user who created the InvoiceSplitItem object. Character limit: 32 Values: automatically generated

CreatedDatestring, (date-time)

The date when the InvoiceSplitItem was created. Values: automatically generated

Idstring

Object identifier.

InvoiceDatestring, (date)

The generation date of the new split invoice, in yyyy-mm-dd format. Character limit: 29

InvoiceIdstring

The new invoice after the split. Character limit: 32 Values: automatically generated

InvoiceSplitIdstring

The ID of the invoice split associated with the individual invoice split item. Character limit: 32 Values: a valid invoice split ID

PaymentTermstring

Indicates when the customer pays the split invoice. Values: a valid, active payment term

SplitPercentagenumber, (double)

Specifies the percentage of the original invoice that you want to be the balance of the split invoice. The total of the SplitPercentage field values for all of the InvoiceSplitItem objects in an InvoiceSplit object must equal 100. Values:

UpdatedByIdstring

The ID of the Zuora user who last updated the invoice split. Character limit: 32 Values: automatically generated

UpdatedDatestring, (date-time)

The date when the invoice split was last updated. Values: automatically generated

Response

{
  "InvoiceDate": "2011-01-20",
  "UpdatedById": "2c93808457d787030157e031bb3f4aa5",
  "CreatedById": "2c93808457d787030157e031bb3f4aa5",
  "CreatedDate": "2016-10-20T05:45:45.000+02:00",
  "UpdatedDate": "2016-10-20T05:45:45.000+02:00",
  "SplitPercentage": 50.9,
  "PaymentTerm": "Due Upon Receipt",
  "Id": "2c93808457d787030157e031d7214c55",
  "InvoiceSplitId": "2c93808457d787030157e031d5844c53"
}