Update an invoice

Updates a specific invoice.

Request
path Parameters
invoiceKey
required
string

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

header Parameters
Accept-Encoding
string

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.

Content-Encoding
string

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.

Authorization
string

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

Zuora-Track-Id
string <= 64 characters

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

Zuora-Entity-Ids
string

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 should not set this header.

Zuora-Org-Ids
string

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.

Request Body schema: application/json
required
autoPay
boolean

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.

comments
string <= 255 characters

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

dueDate
string <date>

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

invoiceDate
string <date>

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.

Array of objects (PutInvoiceItemType)

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

transferredToAccounting
string

Whether the invoice was transferred to an external accounting system.

Enum: "Processing" "Yes" "Error" "Ignore"
IntegrationId__NS
string <= 255 characters

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

IntegrationStatus__NS
string <= 255 characters

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

SyncDate__NS
string <= 255 characters

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

property name*
additional property
any

Custom fields of the Invoice object. The name of each custom field has the form customField__c. Custom field names are case sensitive. See Manage Custom Fields for more information.

Responses
200
500

Internal Server Error

4XX

Request Errors

put/v1/invoices/{invoiceKey}
Request samples
application/json
{
  • "accountId": "2c9890207863df710178642433c407a5",
  • "autoPay": false,
  • "comments": "comments",
  • "id": "2c9890207863df710178642433c307ab",
  • "invoiceDate": "2017-02-20",
  • "invoiceItems": [
    ],
  • "transferredToAccounting": "Yes"
}
Response samples
application/json
{
  • "accountId": "40288ae9600808280160081db1533506",
  • "amount": 100,
  • "autoPay": false,
  • "balance": 100,
  • "cancelledById": "null,",
  • "cancelledOn": "null,",
  • "comment": "",
  • "createdById": "40288ae9600808280160081d833a311a",
  • "createdDate": "2017-11-29 22:10:58",
  • "creditBalanceAdjustmentAmount": 0,
  • "currency": "USD",
  • "discount": 0,
  • "dueDate": "2017-12-18",
  • "id": "40288ae9600808280160081dc9c13f15",
  • "invoiceDate": "2017-11-29",
  • "number": "INV00000090",
  • "postedById": null,
  • "postedOn": null,
  • "status": "Draft",
  • "success": true,
  • "targetDate": "2017-11-29",
  • "taxAmount": 0,
  • "totalTaxExemptAmount": 0,
  • "transferredToAccounting": "No",
  • "updatedById": "40288ae9600808280160081d833a311a",
  • "updatedDate": "2017-11-30 13:47:52"
}