InvoiceSplitItem
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.
Splitting invoices lets a customer spread out payments for a single invoice across 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 InvoiceSplitItem object to split an original Invoice object into multiple Invoice objects. Each InvoiceSplitItem object represents 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.
Use a create() call to create each InvoiceSplitItem object that you need to create multiple invoices from the original invoice. 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.
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.
WSDL version 43.0+ is required to use this object.
Supported calls
When theinvoiceSplit field is set to false, which is the default value, the following call is supported:
When theinvoiceSplit field is set to true, the following calls are supported:
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 |
Required to Create? |
Allowed |
Description |
|---|---|---|---|
|
CreatedById |
optional |
Query |
The ID of the Zuora user who created the InvoiceSplitItem Type: zns:ID |
|
CreatedDate |
optional |
Query |
The date when the InvoiceSplitItem was created. Type: dateTime |
|
Id |
optional |
Query |
The ID of this object. Upon creation of this object, this field becomes Type: zns:ID |
|
InvoiceDate |
required |
Create |
The generation date of the new split invoice. Type:
Character limit: 29 |
|
InvoiceId |
optional |
Query |
The new invoice after the split. Type: zns:ID |
|
InvoiceSplitId |
required |
Create |
The ID of the invoice split associated with the individual invoice split item. Type: zns:ID |
|
PaymentTerm |
optional |
Create |
Indicates when the customer pays the split invoice. Type: string |
|
SplitPercentage |
required |
Create |
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. Type:
Character limit: --
|
|
UpdatedById |
optional |
Query |
The ID of the Zuora user who last updated the invoice split. Type: zns:ID |
|
UpdatedDate |
optional |
Query |
The date when the invoice split was last updated. Type: dateTime |
Additional Field Detail
Here's more information we think you might like to have about some of these fields. Use the Comments form at the bottom of this page if you have more questions.
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 InvoiceSplitItem object is InvoiceSplitItemId.
PaymentTerm
Indicates when the customer pays the split invoice. The field values are defined in the web-based UI on the Define Payment Terms page. Common payment terms are Due Upon Receipt and Net 60, but your specific values depend on your own configuration.