CRUD: Update an invoice adjustment

Note: The Invoice Adjustments, Invoice Item Adjustments, and Credit Balance Adjustments features are approaching end of support on February 16, 2026. For more information, please refer to the Product and Feature End of Support page.

Request
path Parameters
id
required
string

Object id

query Parameters
rejectUnknownFields
boolean
Default: false

Specifies whether the call fails if the request body contains unknown fields. With rejectUnknownFields set to true, Zuora returns a 400 response if the request body contains unknown fields. The body of the 400 response is:

{
    "message": "Error - unrecognised fields"
}

By default, Zuora ignores unknown fields in the request body.

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-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 do not need to set this header.

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

Request Body schema: application/json
required
ReasonCode
string

A code identifying the reason for the transaction. Must be an existing reason code or empty. If you do not specify a value, Zuora uses the default reason code. Character limit: 32 V****alues: a valid reason code

Status
string

The status of the invoice adjustment. This field is required in the Query call, but is automatically generated in other calls. Character limit: 9 Values: Canceled, Processed

TransferredToAccounting
string

Indicates the status of the adjustment's transfer to an external accounting system, such as NetSuite.

Enum: "Processing" "Yes" "No" "Error" "Ignore"
property name*
additional property
any

Custom fields of the Invoice Adjustment 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
401
put/v1/object/invoice-adjustment/{id}
Request samples
application/json
{
  • "ReasonCode": "string",
  • "Status": "string",
  • "TransferredToAccounting": "Processing",
  • "property1": null,
  • "property2": null
}
Response samples
application/json
{
  • "Id": "string",
  • "Success": true
}