Pricing Templates
Log in Sign up
Integrations / Zuora / ...

PUT /v1/invoices/{invoiceKey}

Updates a specific invoice.

Servers

Path parameters

Name Type Required Description
invoiceKey String Yes

The ID or number of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001.

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"
Content-Encoding String No

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.
Zuora-Track-Id String No

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

The value is in the Bearer {token} format where {token} is a valid OAuth token generated by calling Create an OAuth token.
Zuora-Entity-Ids String No

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-Org-Ids String No

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.
Accept-Encoding String No

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.

Request body fields

Name Type Required Description
dueDate String No

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

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

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

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

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.
invoiceDate String No

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.
invoiceItems[] Array No

Container for invoice items, The maximum number of items is 1,000.
invoiceItems[].recognizedRevenueAccountingCode String No

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.
invoiceItems[].serviceEndDate String No

The service end date of the invoice item.
invoiceItems[].description String No

The description of the invoice item.
invoiceItems[].revRecCode String No

The revenue recognition code.
invoiceItems[].adjustmentRevenueAccountingCode String No

The accounting code for adjustment revenue.

Note: This field is only available if you have the Billing - Revenue Integration feature enabled.
invoiceItems[].chargeDate String No

The date when the invoice item is charged, in yyyy-mm-dd hh:mm:ss format.
invoiceItems[].uom String No

The unit of measure.
invoiceItems[].itemType String No

The type of the invoice item.
invoiceItems[].id String No

The unique ID of the invoice item.
invoiceItems[].excludeItemBillingFromRevenueAccounting Boolean No

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
invoiceItems[].SyncDate__NS String No

Date when the invoice item was synchronized with NetSuite. Only available if you have installed the Zuora Connector for NetSuite.
invoiceItems[].revRecTriggerCondition String No

The date when revenue recognition is triggered.

Possible values:

  • "ServiceActivationDate"
  • "ContractEffectiveDate"
  • "CustomerAcceptanceDate"
invoiceItems[].sku String No

The SKU of the invoice item. The SKU of the invoice item must be different from the SKU of any existing product.
invoiceItems[].accountingCode String No

The accounting code associated with the invoice item.
invoiceItems[].contractAssetAccountingCode String No

The accounting code for contract asset.

Note: This field is only available if you have the Billing - Revenue Integration feature enabled.
invoiceItems[].unbilledReceivablesAccountingCode String No

The accounting code for unbilled receivables.

Note: This field is only available if you have the Billing - Revenue Integration feature enabled.
invoiceItems[].chargeName String No

The name of the charge associated with the invoice item.

This field is required if the productRatePlanChargeId field is not specified in the request.
invoiceItems[].deferredRevenueAccountingCode String No

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

Note: This field is only available if you have Zuora Finance enabled.
invoiceItems[].unitPrice String No

The per-unit price of the invoice item.
invoiceItems[].IntegrationStatus__NS String No

Status of the invoice item's synchronization with NetSuite. Only available if you have installed the Zuora Connector for NetSuite.
invoiceItems[].IntegrationId__NS String No

ID of the corresponding object in NetSuite. Only available if you have installed the Zuora Connector for NetSuite.
invoiceItems[].quantity String No

The number of units for the invoice item.
invoiceItems[].revenueRecognitionRuleName String No

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

Note: This field is only available if you have Zuora Finance enabled.
invoiceItems[].discountItems[] Array No

Container for discount items. The maximum number of discount items is 10.
invoiceItems[].discountItems[].recognizedRevenueAccountingCode String No

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.
invoiceItems[].discountItems[].bookingReference String No

The booking reference of the discount item.
invoiceItems[].discountItems[].description String No

The description of the discount item.
invoiceItems[].discountItems[].revRecCode String No

The revenue recognition code.
invoiceItems[].discountItems[].adjustmentRevenueAccountingCode String No

The accounting code for adjustment revenue. Note: This field is only available if you have the Billing - Revenue Integration feature enabled.
invoiceItems[].discountItems[].chargeDate String No

The date when the discount item is charged, in yyyy-mm-dd hh:mm:ss format.
invoiceItems[].discountItems[].itemType String No

The type of the discount item.
invoiceItems[].discountItems[].id String No

The unique ID of the discount item.
invoiceItems[].discountItems[].SyncDate__NS String No

Date when the invoice item was synchronized with NetSuite. Only available if you have installed the Zuora Connector for NetSuite.
invoiceItems[].discountItems[].revRecTriggerCondition String No

The date when revenue recognition is triggered.

Possible values:

  • "ServiceActivationDate"
  • "ContractEffectiveDate"
  • "CustomerAcceptanceDate"
invoiceItems[].discountItems[].sku String No

The SKU of the invoice item. The SKU of the discount item must be different from the SKU of any existing product.
invoiceItems[].discountItems[].accountingCode String No

The accounting code associated with the discount item.
invoiceItems[].discountItems[].contractAssetAccountingCode String No

The accounting code for contract asset. Note: This field is only available if you have the Billing - Revenue Integration feature enabled.
invoiceItems[].discountItems[].unbilledReceivablesAccountingCode String No

The accounting code for unbilled receivables. Note: This field is only available if you have the Billing - Revenue Integration feature enabled.
invoiceItems[].discountItems[].chargeName String No

The name of the charge associated with the discount item. This field is required if the productRatePlanChargeId field is not specified in the request.
invoiceItems[].discountItems[].deferredRevenueAccountingCode String No

The accounting code for the deferred revenue, such as Monthly Recurring Liability. Note: This field is only available if you have Zuora Finance enabled.
invoiceItems[].discountItems[].unitPrice String No

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.
invoiceItems[].discountItems[].IntegrationStatus__NS String No

Status of the invoice item's synchronization with NetSuite. Only available if you have installed the Zuora Connector for NetSuite.
invoiceItems[].discountItems[].IntegrationId__NS String No

ID of the corresponding object in NetSuite. Only available if you have installed the Zuora Connector for NetSuite.
invoiceItems[].discountItems[].revenueRecognitionRuleName String No

The name of the revenue recognition rule governing the revenue schedule. Note: This field is only available if you have Zuora Finance enabled.
invoiceItems[].discountItems[].purchaseOrderNumber String No

The purchase order number associated with the discount item.
invoiceItems[].discountItems[].adjustmentLiabilityAccountingCode String No

The accounting code for adjustment liability. Note: This field is only available if you have the Billing - Revenue Integration feature enabled.
invoiceItems[].discountItems[].amount String Yes

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.
invoiceItems[].discountItems[].contractRecognizedRevenueAccountingCode String No

The accounting code for contract recognized revenue. Note: This field is only available if you have the Billing - Revenue Integration feature enabled.
invoiceItems[].discountItems[].contractLiabilityAccountingCode String No

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

The purchase order number associated the invoice item.
invoiceItems[].adjustmentLiabilityAccountingCode String No

The accounting code for adjustment liability.

Note: This field is only available if you have the Billing - Revenue Integration feature enabled.
invoiceItems[].amount String No

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.
invoiceItems[].serviceStartDate String No

The service start date of the invoice item.
invoiceItems[].taxCode String No

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.
invoiceItems[].contractRecognizedRevenueAccountingCode String No

The accounting code for contract recognized revenue.

Note: This field is only available if you have the Billing - Revenue Integration feature enabled.
invoiceItems[].taxMode String No

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"
invoiceItems[].contractLiabilityAccountingCode String No

The accounting code for contract liability.

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

Whether the invoice was transferred to an external accounting system.

Possible values:

  • "Processing"
  • "Error"
  • "Yes"
  • "Ignore"
comments String No

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

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.
All third party trademarks (including logos and icons) are the property of their respective owners, which do not sponsor, authorize, or endorse this website.
Pricing Templates Integrations Blog Contact Us Help
© 2025 SimWorkflow
Terms of Service Privacy Policy