Knowledge Center

Knowledge Center > API > SOAP API > SOAP API Object Reference > InvoiceSplit

InvoiceSplit

An invoice split is one of multiple invoices that together formed one original invoice. Splitting a single invoice into multiple invoices lets you offer flexible payment schedules, especially when the original invoice balance is a large sum.

Split invoices lets a customer spread out payments for a single invoice multiple invoices. For example, a customer has an invoice that totals $100,000. You agree to let the customer make four payments spread across multiple billing periods on the invoice. You can split that invoice into four separate invoices, each for a specific percentage of the original amount. These percentages can be any amount that you want to set, as long as the collection of split invoices total 100% of the original invoice. In this example, you can set the first split invoice to 40% ($40,000), then each successive split invoice to 30% ($30,000), 20% ($20,000), and 10% ($10,000).

Use the InvoiceSplit object to hold two or more InvoiceSplitItem objects, which each represent a single split invoice. In the example, if you split the original $100,000 invoice into four split invoices, each of those split invoices is an individual InvoiceSplitItem object, which in turn go inside a single InvoiceSplit object. When you are finished creating individual InvoiceSplitItem objects, you use a create() call to collect them into an InvoiceSplit object, then use an execute() call with the InvoiceSplit object to split the original Invoice object into multiple new Invoice objects.

This feature is in Limited Availability. If you wish to have access to the feature, submit a request at Zuora Global Support

Your WSDL version must be 43.0+ to use this object.

The Invoice must be in draft status before you can split the invoice into multiple invoices. You can't split a posted or canceled invoice.

Supported calls

You can use this object with the following call:

Walkthroughs and use cases

Here are some common ways to use this object:

  • Spread an invoice across multiple billing periods by splitting the invoice into multiple invoices
  • Resplit the invoice into a different set of invoices

To walk through these use cases, take a look at Splitting an invoice to use flexible payment terms.

Field Descriptions

All field names are case sensitive. Check enumerated values in descriptions to confirm capitalization and spacing. See Field Types for additional information.

Name

Req or Opt to Create

Allowed
Operations

Description

CreatedById optional

Query
Filter

The ID of the Zuora user who created the InvoiceSplit object.

Type: zns:ID
Character limit: 32
Version notes: WSDL 43.0
Values: automatically generated

CreatedDate optional

Query
Filter

The date when the InvoiceSplit object was created.

Type: dateTime
Character limit: 29
Version notes: WSDL 43.0
Values: automatically generated

Id optional Query
Filter

The ID of this object. Upon creation of this object, this field becomes InvoiceSplitId.

Type: zns:ID
Character limit: 32
Version notes: WSDL 43.0
Values: automatically generated

InvoiceId optional Create
Query
Filter

The ID of the original invoice that the InvoiceSplit object splits. This field becomes read-only after the InvoiceSplit object is created.

For allowed Operations, Query and Filter.

After the invoice split is executed, the original invoice ID will be deleted and you will no longer be able to query the original invoice ID.

Type: zns:ID
Character limit: 32
Version notes: WSDL 43.0
Values: a valid invoice ID

UpdatedById optional

Query
Filter

The ID of the Zuora user who last updated the invoice split.

Type: zns:ID
Character limit: 32
Version notes: WSDL 43.0
Values: automatically generated

UpdatedDate optional

Query
Filter

The date when the invoice split was last updated.

Type: dateTime
Character limit:
Version notes: WSDL 43.0
Values: automatically generated

Additional Field Detail

Id

The ID of this object. Every object has a unique identifier that Zuora automatically assigns upon creation. You use this ID later when you work with the object. For example, if you send an amend() call to modify an existing subscription, then you need to include the specific Subscription object's ID with the call.

The ID for the InvoiceSplit object is InvoiceSplit Id.

Last modified
17:09, 3 Nov 2016

Tags

Classifications

(not set)