Update an invoice

PUT

/v1/invoices/:invoiceKey

PUT

/v1/invoices/:invoiceKey

from zuora import ZuoraClient, PutInvoiceItemType
client = ZuoraClient(
    token="YOUR_TOKEN_HERE",
)
client.invoices.put_update_invoice(
    invoice_key="invoiceKey",
    invoice_items=[
        PutInvoiceItemType(
            amount=105,
            id="8ad084db909fae930190a121c87f5800",
        )
    ],
)

{
  "accountId": "8ad09be48db5aba7018db604776d4854",
  "amount": 105,
  "autoPay": false,
  "balance": 105,
  "cancelledById": null,
  "cancelledOn": null,
  "comment": null,
  "createdById": "b243314d594646d3b2651aeedd4be47e",
  "createdDate": "2024-07-11 02:31:04",
  "creditBalanceAdjustmentAmount": 0,
  "currency": "USD",
  "discount": 0,
  "dueDate": "2024-08-29",
  "id": "8ad084db909fae930190a121c84957ff",
  "invoiceDate": "2024-07-30",
  "number": "INV00000155",
  "postedById": null,
  "postedOn": null,
  "status": "Draft",
  "success": true,
  "targetDate": null,
  "taxAmount": 0,
  "totalTaxExemptAmount": 0,
  "transferredToAccounting": "Processing",
  "updatedById": "b243314d594646d3b2651aeedd4be47e",
  "updatedDate": "2024-07-11 02:43:45"
}

Updates a specific invoice. The following tutorials demonstrate how to use this operation:

<a href=“https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_both_subscription_and_non-subscription_transactions/Unified_Invoicing/D_Add_and_delete_invoice_items_of_draft_standalone_invoices” target=“_blank”>Add and delete invoice items of draft standalone invoices</a>
<a href=“https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_both_subscription_and_non-subscription_transactions/Unified_Invoicing/Edit_due_dates_of_draft_standalone_invoices” target=“_blank”>Edit due dates of draft standalone invoices</a>
<a href=“https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_both_subscription_and_non-subscription_transactions/Unified_Invoicing/Edit_invoice_item_prices_and_custom_fields_of_draft_standalone_invoices” target=“_blank”>Edit invoice item prices and custom fields of draft standalone invoices</a>

Authentication

AuthorizationBearer

Use Bearer {{token}} in the Authorization header for authentication.

Path parameters

invoiceKeystringRequired

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

Headers

Content-EncodingstringOptional

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-Org-IdsstringOptional

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. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user’s accessible orgs.

Request

This endpoint expects an object.

autoPaybooleanOptional

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.

commentsstringOptional<=255 characters

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

dueDatedateOptional

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

invoiceDatedateOptional

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.

invoiceItemslist of objectsOptional

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

transferredToAccountingenumOptional

Whether the invoice was transferred to an external accounting system.

Allowed values:

templateIdstringOptional

The ID of the invoice template associated with the invoice.

Note: This field is only available if you have the Flexible Billing Attributes feature enabled.

IntegrationId__NSstringOptional<=255 characters

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

IntegrationStatus__NSstringOptional<=255 characters

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

SyncDate__NSstringOptional<=255 characters

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

Response headers

Content-EncodingstringOptional

This header is returned if you specify the Accept-Encoding: gzip request header and the response contains over 1000 bytes of data.

Note that only the following MIME types support gzipped responses:

application/json
application/xml
text/html
text/csv
text/plain

RateLimit-LimitstringOptional

The request limit quota for the time window closest to exhaustion. See rate limits for more information.

RateLimit-Remainingdouble

The number of requests remaining in the time window closest to quota exhaustion. See rate limits for more information.

RateLimit-Resetdouble

The number of seconds until the quota resets for the time window closest to quota exhaustion. See rate limits for more information.

Zuora-Request-IdstringOptional

The Zuora internal identifier of the API call. You cannot control the value of this header.

Zuora-Track-IdstringOptional

A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.

Concurrency-Limit-TypestringOptional

The type of the concurrency limit, which can be Default, High-volume transactions, or Object Query.

For more information, see Concurrent request limits.

Concurrency-Limit-Limitinteger

The total number of the permitted concurrent requests.

For more information, see Concurrent request limits.

Concurrency-Limit-Remaininginteger

The remaining number of the permitted concurrent requests.

For more information, see Concurrent request limits.

Response

accountIdstringOptional

The ID of the customer account associated with the invoice.

amountdoubleOptional

The total amount of the invoice.

autoPaybooleanOptional

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

balancedoubleOptional

The balance of the invoice.

cancelledByIdstring or nullOptional

The ID of the Zuora user who cancelled the invoice.

cancelledOnstring or nullOptional

The date and time when the invoice was cancelled, in yyyy-mm-dd hh:mm:ss format.

commentstringOptional

Comments about the invoice.

createdByIdstringOptional

The ID of the Zuora user who created the invoice.

createdDatestringOptional

The date and time when the invoice was created, in yyyy-mm-dd hh:mm:ss format. For example, 2017-03-01 15:31:10.

creditBalanceAdjustmentAmountdoubleOptional

Note: This filed is only available if you have the Credit Balance feature enabled and the Invoice Settlement feature disabled. The currency amount of the adjustment applied to the customer’s credit balance.

currencystringOptional

A currency defined in the web-based UI administrative settings.

discountdoubleOptional

The discount of the invoice.

dueDatedateOptional

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

idstringOptional

The unique ID of the invoice.

invoiceDatedateOptional

The date on which to generate the invoice.

numberstringOptional

The unique identification number of the invoice.

postedByIdstringOptional

The ID of the Zuora user who posted the invoice.

postedOnstringOptional

The date and time when the invoice was posted, in yyyy-mm-dd hh:mm:ss format.

statusenumOptional

The status of the invoice.

Note:

The Split status is applicable only when you use Split Invoice feature.
When an invoice is split, its status changes from Draft to Split, and the newly created invoices retain a reference to the original invoice.

Allowed values:

successbooleanOptional

Returns true if the request was processed successfully.

targetDatedateOptional

The target date for the invoice, in yyyy-mm-dd format. For example, 2017-07-20.

taxAmountdoubleOptional

The amount of taxation.

templateIdstringOptional

The ID of the invoice template associated with the invoice.

totalTaxExemptAmountdoubleOptional

The calculated tax amount excluded due to the exemption.

transferredToAccountingenumOptional

Whether the invoice was transferred to an external accounting system.

Allowed values:

updatedByIdstringOptional

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

updatedDatestringOptional

The date and time when the invoice was last updated, in yyyy-mm-dd hh:mm:ss format. For example, 2017-03-02 15:36:10.

IntegrationId__NSstringOptional<=255 characters

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

IntegrationStatus__NSstringOptional<=255 characters

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

SyncDate__NSstringOptional<=255 characters

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

Errors

4XX

Client Request Error

500

Internal Server Error