PUT /v1/invoices

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.

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.

Container for invoice update details.

The ID of the invoice to be updated.

The date by which the payment for this invoice is due.

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

Date when the invoice was synchronized 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.

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

By default, invoices are automatically picked up for processing in the corresponding payment run.

The new invoice date of the invoice. The new invoice date cannot fall in a closed accounting period.

You can only specify invoiceDate or dueDate in one request. Otherwise, an error occurs.

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

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

The unique ID of the invoice item.

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.

Default value: false

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.

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.

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.

The unique ID of the discount item.

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.

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.

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 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 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 if you have Taxation enabled.
• If the values of both taxCode and taxMode fields are changed to null when updating a standalone invoice, the corresponding invoiceItems > taxItems field and its nested fields specified in the creation request will be removed.

The accounting code for contract recognized revenue.

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

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

Note:

• This field is only available if you have Taxation enabled.
• If the values of both taxCode and taxMode fields are changed to null when updating a standalone invoice, the corresponding invoiceItems > taxItems field and its nested fields specified in the creation request will be removed.

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.

Whether the invoice was transferred to an external accounting system.

Possible values:

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

Additional information related to the invoice that a Zuora user added to the invoice.