POST /v1/invoices/batch

Default value: "application/json"

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.

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

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

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.

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.

Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.

The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails.

If the header is not set, the operation is performed in scope of the user's accessible orgs.

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.

Whether a batch request is handled with a single transaction.

• true indicates that a batch request will be handled with a single transaction.
• false indicates that the standalone invoices to be created in a batch request will be handled with separated transactions.

If the field is set to false, a failure in the batch request will not cause the whole request to fail, so you have to retry the whole batch request.

Container for standalone invoices.

Status of the invoice's synchronization with NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

Whether the sold-to contact and bill-to contact are the same entity. This field is mutually exclusive with the soldToContact and soldToContactId fields.

The created invoice has the same bill-to contact and sold-to contact entity only when all the following conditions are met in the request body:

• This field is set to true.
• A bill-to contact or bill-to contact ID is specified.
• Neither sold-to contact nor sold-to contact ID is specified.

Note: If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body.

Default value: false

The ID of the account associated with the invoice.

You must specify either accountNumber or accountId for a customer account. If both of them are specified, they must refer to the same customer account.

ID of the corresponding object in NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

A customized invoice number with the following format requirements:

• Max length: 32 characters
• Acceptable characters: a-z,A-Z,0-9,-,_,

Purely numerical prefixes or prefixes ending with a number are supported for standalone invoices. For example, you can use 202310000300, 2003, INV202310000300, or 2023-09-100009785 as invoice numbers.

The value must be unique in the system, otherwise it may cause issues with bill runs and subscribe/amend. Check out things to note and troubleshooting steps.

The date that appears on the invoice being created, in yyyy-mm-dd format. The value cannot fall in a closed accounting period.

Container for invoice items. The maximum number of invoice items is 1,000.

Note: For the "Create a standalone invoice" and "Create standalone invoices" operations, note the following:

• If tax has been calculated by an external tax engine, you need to create a standalone invoice with both invoiceItems and taxItems. The taxItems corresponds to the tax information processed by this external tax engine. In this case, you should not specify the taxMode and taxCode nested fields of the invoiceItems field. Instead, you need to specify the taxMode and taxCode nested fields of the taxItems field. You need to specify the taxMode field as TaxExclusive.
• If tax has not been calculated by an external tax engine, you can create a standalone invoice only with invoiceItems, and decide whether Zuora includes the tax in the quoted charge price and invoice item by specifying the taxMode nested field of the invoiceItems field as either TaxExclusive or TaxInclusive. Meanwhile, you need to specify the taxCode field, indicating the charge price and invoice item are taxable.

The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges.

Note: This field is only available if you have Zuora Finance enabled.

The service end date of the invoice item.

The booking reference of the invoice item.

The description of the invoice item.

The revenue recognition code.

The accounting code for adjustment revenue.

Note: This field is only available if you have the Billing - Revenue Integration feature enabled.

The date when the invoice item is charged, in yyyy-mm-dd hh:mm:ss format.

The unit of measure.

The type of the invoice item.

Container for taxation items. The maximum number of taxation items is 5.

Note: This field is only available only if you have Taxation enabled.

The calculated tax amount excluded due to the exemption.

The jurisdiction that applies the tax or VAT. This value is typically a state, province, county, or city.

The name of taxation.

The type of the tax rate applied to the invoice item.

Possible values:

• "FlatFee"
• "Percentage"

The amount of the taxation item in the invoice item.

The identifier for the location based on the value of the taxCode field.

The tax code identifies which tax rules and tax rates to apply to a specific invoice item.

The date that the tax is applied to the invoice item, in yyyy-mm-dd format.

The tax rate applied to the invoice item.

The description of the tax code.

The tax mode of the invoice item, indicating whether the amount of the invoice item includes tax.

Possible values:

• "TaxExclusive"
• "TaxInclusive"

The description of the tax rate.

The flag to exclude the invoice item from revenue accounting.

Note: This field is only available if you have the Billing - Revenue Integration feature enabled.

Date when the invoice item was synchronized with NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

The date when revenue recognition is triggered.

Possible values:

• "ServiceActivationDate"
• "ContractEffectiveDate"
• "CustomerAcceptanceDate"

The SKU of the invoice item. The SKU of the invoice item must be different from the SKU of any existing product.

The accounting code associated with the invoice item.

The accounting code for contract asset.

Note: This field is only available if you have the Billing - Revenue Integration feature enabled.

The accounting code for unbilled receivables.

Note: This field is only available if you have the Billing - Revenue Integration feature enabled.

The name of the charge associated with the invoice item.

This field is required if the productRatePlanChargeId field is not specified in the request.

The accounting code for the deferred revenue, such as Monthly Recurring Liability.

Note: This field is only available if you have Zuora Finance enabled.

The per-unit price of the invoice item. To pass Level 3 data to the gateway, this field is required and must be greater than zero.

Status of the invoice item's synchronization with NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

ID of the corresponding object in NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

The number of units for the invoice item.

Default value: "1"

The name of the revenue recognition rule governing the revenue schedule.

Note: This field is only available if you have Zuora Finance enabled.

Container for discount items. The maximum number of discount items is 10.

The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges. Note: This field is only available if you have Zuora Finance enabled.

The booking reference of the discount item.

The description of the discount item.

The revenue recognition code.

The accounting code for adjustment revenue. Note: This field is only available if you have the Billing - Revenue Integration feature enabled.

The date when the discount item is charged, in yyyy-mm-dd hh:mm:ss format.

The type of the discount item.

Container for taxation items. The maximum number of taxation items is 5.

Note: This field is only available only if you have Taxation enabled.

The calculated tax amount excluded due to the exemption.

The jurisdiction that applies the tax or VAT. This value is typically a state, province, county, or city.

The name of taxation.

The type of the tax rate applied to the invoice item.

Possible values:

• "FlatFee"
• "Percentage"

The amount of the taxation item in the invoice item.

The identifier for the location based on the value of the taxCode field.

The tax code identifies which tax rules and tax rates to apply to a specific invoice item.

The date that the tax is applied to the invoice item, in yyyy-mm-dd format.

The tax rate applied to the invoice item.

The description of the tax code.

The tax mode of the invoice item, indicating whether the amount of the invoice item includes tax.

Possible values:

• "TaxExclusive"
• "TaxInclusive"

The description of the tax rate.

Date when the invoice item was synchronized with NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

The date when revenue recognition is triggered.

Possible values:

• "ServiceActivationDate"
• "ContractEffectiveDate"
• "CustomerAcceptanceDate"

The SKU of the invoice item. The SKU of the discount item must be different from the SKU of any existing product.

The accounting code associated with the discount item.

The accounting code for contract asset. Note: This field is only available if you have the Billing - Revenue Integration feature enabled.

The accounting code for unbilled receivables. Note: This field is only available if you have the Billing - Revenue Integration feature enabled.

The name of the charge associated with the discount item. This field is required if the productRatePlanChargeId field is not specified in the request body.

The accounting code for the deferred revenue, such as Monthly Recurring Liability. Note: This field is only available if you have Zuora Finance enabled.

The per-unit price of the discount item. If the discount charge associated with the discount item uses the percentage model, the unit price will display as a percentage amount in PDF. For example: if unit price is 5.00, it will display as 5.00% in PDF.

Status of the invoice item's synchronization with NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

The accounting code for accounts receivable.

ID of the corresponding object in NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

The name of the revenue recognition rule governing the revenue schedule. Note: This field is only available if you have Zuora Finance enabled.

The purchase order number associated with the discount item.

The accounting code for adjustment liability. Note: This field is only available if you have the Billing - Revenue Integration feature enabled.

The amount of the discount item.

• Should be a negative number. For example, -10.
• Always a fixed amount no matter whether the discount charge associated with the discount item uses the fixed-amount model or percentage model.
• For tax-exclusive discount items, this amount indicates the discount item amount excluding tax.
• For tax-inclusive discount items, this amount indicates the discount item amount including tax.

The accounting code for contract recognized revenue. Note: This field is only available if you have the Billing - Revenue Integration feature enabled.

The ID of the product rate plan charge that the discount item is created from.

If you specify a value for the productRatePlanChargeId field in the request, Zuora directly copies the values of the following fields from the corresponding product rate plan charge, regardless of the values specified in the request body:

• chargeName
• sku

If you specify a value for the productRatePlanChargeId field in the request, Zuora directly copies the values of the following fields from the corresponding discount charge that uses discount specific accounting codes, rule and segment to manage revenue, regardless of the values specified in the request body:

• accountingCode
• deferredRevenueAccountingCode
• recognizedRevenueAccountingCode

If you specify a value for the productRatePlanChargeId field in the request, Zuora directly copies the values of the following fields from the corresponding invoice item charge if the discount charge DOES NOT use discount specific accounting codes, rule and segment to manage revenue, regardless of the values specified in the request body:

• accountingCode
• deferredRevenueAccountingCode
• recognizedRevenueAccountingCode

The accounting code for contract liability. Note: This field is only available if you have the Billing - Revenue Integration feature enabled.

The purchase order number associated with the invoice item.

The accounting code for adjustment liability.

Note: This field is only available if you have the Billing - Revenue Integration feature enabled.

The amount of the invoice item.

• For tax-inclusive invoice items, the amount indicates the invoice item amount including tax.
• For tax-exclusive invoice items, the amount indicates the invoice item amount excluding tax.

The service start date of the invoice item.

The tax code identifies which tax rules and tax rates to apply to the invoice item.

Note: This field is only available only if you have Taxation enabled.

The accounting code for contract recognized revenue.

Note: This field is only available if you have the Billing - Revenue Integration feature enabled.

The ID of the product rate plan charge that the invoice item is created from.

If you specify a value for the productRatePlanChargeId field in the request, Zuora directly copies the values of the following fields from the corresponding product rate plan charge, regardless of the values specified in the request body:

• chargeName
• sku
• uom
• taxCode
• taxMode
• accountingCode
• deferredRevenueAccountingCode
• recognizedRevenueAccountingCode

The tax mode of the invoice item, indicating whether the amount of the invoice item includes tax.

Note: This field is only available only if you have Taxation enabled.

Possible values:

• "TaxExclusive"
• "TaxInclusive"

The accounting code for contract liability.

Note: This field is only available if you have the Billing - Revenue Integration feature enabled.

The ID or name of the payment term associated with the invoice. For example, Net 30. The payment term determines the due dates of invoices.

Note: If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body.

The status of invoice. By default, the invoice status is Draft.

When creating an invoice, if you set this field to Posted, the invoice is created and posted directly.

Possible values:

• "Draft"
• "Posted"

Default value: "Draft"

The ID of the bill-to contact associated with the invoice. This field is mutually exclusive with the billToContact field.

Note: If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body.

The code of a currency as defined in Billing Settings through the Zuora UI.

If you do not specify a currency during standalone invoice creation, the default account currency is applied. The currency that you specify in the request must be configured and activated in Billing Settings. Note: This field is available only if you have the Multiple Currencies feature enabled.

The Number of the account associated with the invoice. You must specify either accountNumber or accountId for a customer account. If both of them are specified, they must refer to the same customer account.

The date by which the payment for this invoice is due, in yyyy-mm-dd format.

Date when the invoice was synchronized with NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

The ID of the invoice template associated with the invoice.

Note: If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body.

Whether invoices are automatically picked up for processing in the corresponding payment run.

Default value: false

The ID or name of the sequence set associated with the invoice.

Note: If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body.

The ID of the sold-to contact associated with the invoice. This field is mutually exclusive with the soldToContact field.

Note: If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body.

It contains Home currency and Reporting currency custom rates currencies. The maximum number of items is 2 (you can pass the Home currency item or Reporting currency item or both).

Note: The API custom rate feature is permission controlled.

The date on which a particular currency rate is fixed or obtained on.

Note: This field is only available if you set the zuora-version request header to 224.0 or later available versions.

The currency code for either Reporting or Home currency.

Note: This field is only available if you set the zuora-version request header to 224.0 or later available versions.

The Custom FX conversion rate between Home/Reporting and Transactional currency items.

Note: This field is only available if you set the zuora-version request header to 224.0 or later available versions.

Possible values:

• "Processing"
• "Error"
• "Yes"
• "Ignore"
• "No"

Comments about the invoice.