| Idempotency-Key | string <= 255 characters 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. |
| Accept-Encoding | string Include the If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a |
| Content-Encoding | string Include the |
| Authorization | string The value is in the |
| 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 ( |
| AccountingCode | string The accounting code for the invoice item. Accounting codes group transactions that contain similar accounting attributes.
Character limit: 100 Values: inherited from |
| AdjustmentDate required | string <date> The date when the invoice item adjustment is applied, in |
| AdjustmentNumber | string A unique string to identify an individual invoice item adjustment. Character limit: 255 Values: automatically generated |
| Amount required | number <double> The amount of the invoice item adjustment. The value of Amount must be positive. Use the required parameter Type to either credit or charge (debit) this amount on the invoice. Character limit: 16 Values: a valid currency amount |
| Comment | string Use this field to record comments about the invoice item adjustment. Character limit: 255 Values: a string of 255 characters or fewer |
| CreatedById | string The user ID of the person who created the invoice item. Character limit: 32 Values: automatically generated |
| DeferredRevenueAccount | string Records the deferred accounting code in the finance system. This field is in Limited Availability. If you want to have access to the feature, submit a request at Zuora Global Support. Character limit: 100 Version notes: WSDL 63.0+ Values: If this field is not passed in, a value from InvoiceItem will be used. |
| ExcludeItemBillingFromRevenueAccounting | boolean Default: false The flag to exclude Order Line Item related invoice items, invoice item adjustments, credit memo items, and debit memo items that are generate for the rate plan charge from revenue accounting. Set this field to Character limit: 100 Version notes: WSDL 117.0+ Values: a boolean value Note: This field is only available if you have the Billing - Revenue Integration feature enabled. |
| InvoiceId required | string The ID of the invoice associated with the adjustment. The adjustment invoice item is in this invoice. This field is optional if you specify a value for the |
| InvoiceNumber required | string The unique identification number for the invoice that contains the invoice item. This field is optional if you specify a value for the |
| 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 Values: a valid reason code |
| RecognizedRevenueAccount | string Records the recognized accounting code in the finance system. This field is in Limited Availability. If you want to have access to the feature, submit a request at Zuora Global Support. Character limit: 100 Version notes: WSDL 63.0+ Values: If this field is not passed in, a value from InvoiceItem will be used. |
| ReferenceId | string 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: 60 Values: a string of 60 characters or fewer |
| SourceId required | string The ID of the item specified in the SourceType field. Character limit: 32 Values: a valid invoice item ID or taxation item ID |
| SourceType required | string The type of adjustment. Character limit: 13 Values: InvoiceDetail, Tax |
| Type required | string Indicates whether the adjustment credits or debits the invoice item amount. |
| InvoiceItemAdjustment.IntegrationId__NS | string <= 255 characters ID of the corresponding object in NetSuite. Only available if you have installed the Zuora Connector for NetSuite. |
| InvoiceItemAdjustment.IntegrationStatus__NS | string <= 255 characters Status of the invoice item adjustment's synchronization with NetSuite. Only available if you have installed the Zuora Connector for NetSuite. |
| InvoiceItemAdjustment.SyncDate__NS | string <= 255 characters Date when the invoice item adjustment 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 Item Adjustment object. The name of each custom field has the form |
{- "AdjustmentDate": "2021-02-05",
- "Amount": 1,
- "Comments": "this is comments",
- "InvoiceNumber": "INV00046254",
- "SourceId": "8a9092747e5b9fd0017e5c9a9ece127f",
- "SourceType": "InvoiceDetail",
- "Type": "Credit"
}{- "Success": true,
- "Id": "8a90da067e5bae89017e5c9aa3f70d1d"
}