An invoice adjustment modifies an existing invoice. You use an invoice adjustment to change the entire invoice. For example, you can apply a late fee to the invoice balance.
An invoice adjustment differs from an invoice item adjustment. An invoice item adjustment affects an individual charge or line item on an invoice. An invoice adjustment affects the invoice at the header-level.
Note: Invoice Adjustment is deprecated on Production in WSDL version 64.0. Zuora recommends that you use the Invoice Item Adjustment to adjust invoices. If you have the Invoice Settlement feature enabled, this object is deprecated and only available for backward compatibility.
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.
Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types.
With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.
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.
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.
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 ID of the account that owns the invoice. Character limit: 32 Values: inherited from Account.ID for the invoice owner
The date when the invoice adjustment is applied. This date must be the same as the invoice's date or later. Character limit: 29 Values: Leave null to automatically generate the current date
A unique string to identify an individual invoice adjustment. Character limit: 255 Values: automatically generated
The amount of the invoice adjustment. Character limit: 16 Values: a valid currency amount
Use this field to record comments about the invoice adjustment. Character limit: 255 Values: a string of 255 characters or fewer
The name of the account that owns the associated invoice. Character limit: 50 Values: inherited from Account.Name
The unique account number of the customer's account. Character limit: 70 Values: inherited from Account.AccountNumber
The amount that changes the balance of the associated invoice. Character limit: 16 Values: automatically calculated
The ID of the invoice associated with the adjustment. This field is only required if you don't specify a value for the InvoiceNumber field. Character limit: 32 Values: a valid invoice ID
The unique identification number for the associated invoice. This field is only required if you don't specify a value for the InvoiceId field. Character limit: 32 Values: a valid invoice number
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
A code to reference an object external to Zuora. For example, you can use this field to reference a case number in an external system. Character limit: 100 Values: a string of 100 characters or fewer
The status of the invoice adjustment. This field is only required in the Query call, but is automatically generated in other calls. Character limit: 9 Values: Canceled, Processed
Indicates whether the adjustment credits or debits the invoice amount. Character limit: 6 Values: Credit, Charge
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.
- https://rest.zuora.comhttps://rest.zuora.com/v1/object/invoice-adjustment
{ "AccountingCode": "Accounts Receivable", "AdjustmentDate": "2016-10-20", "Amount": 1.2, "Comments": "this is comments", "InvoiceId": "2c93808457d787030157e030d10f3f64", "InvoiceNumber": "INV00000001", "ReferenceId": "refid-1476935078657", "Type": "Credit" }
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/jsonapplication/xmltext/htmltext/csvtext/plain
The request limit quota for the time window closest to exhaustion. See rate limits for more information.
The number of requests remaining in the time window closest to quota exhaustion. See rate limits for more information.
The number of seconds until the quota resets for the time window closest to quota exhaustion. See rate limits for more information.
The Zuora internal identifier of the API call. You cannot control the value of this header.
{ "Success": true, "Id": "2c93808457d787030157e030d3043f79" }