InvoiceAdjustment

From API Documentation

Please note that of September 14, 2010, the old InvoiceAdjustment and Adjustment object are removed from the Z-Commerce API completely. All previously created Adjustments and InvoiceAdjustment are merged into the new InvoiceAdjustment object.

This means the following:

• All previous Adjustments and (old) InvoiceAdjustments objects/data are accessible in the new InvoiceAdjustment object in version 24.0 and greater.
• Any attempt to access Adjustment via query() will fail, regardless of API version.
• Any attempt to access InvoiceAdjustment in versions less than 24.0 will fail.
• YOU MUST USE VERSION 24.0 OR GREATER TO QUERY ADJUSTMENT RELATED INFORMATION.

This object specified an adjustment made to that invoice.

Fields

In addition to the following fields, zObject contributes additional fields. For information on the field types, see Field Types.

Name	Required?	Type	Allowed Operations: ● Yes ○ No	Allowable Values	Description
AccountId	No, system generated, and available for query only. Not specified for create().	ZNS:Id	○ Create ● Query ○ Update ○ Delete ● Filter	Valid Account Id.	The Id of the Account/owner of invoice.
AccountingCode	No	string	● Create ● Query ○ Update ○ Delete ● Filter	Valid accounting code entered in Z-Billing administration. 100 characters maximum.	This can be used to enter your accounting code for the adjustment.
AdjustmentDate	No	dateTime	● Create ● Query ○ Update ○ Delete ● Filter	A valid dateTime object, must be greater to or equal to invoice date	The date the adjustment is applied.default value is current date.
AdjustmentNumber	No, system generated, and available for query only. Not specified for create().	String	○ Create ● Query ○ Update ○ Delete ● Filter	A valid adjustment number, 50 characters maximum.	The number/identifider for the Adjustment. Useful for when working with InvoiceAdjustment in the Z-Billing web application.
Amount	Yes	decimal	● Create ● Query ○ Update ○ Delete ● Filter	Valid currency amount	The amount of the adjustment.
CancelledById	System generated, exists if InvoiceAdjustment has been canceled.	ZNS:Id	○ Create ● Query ○ Update ○ Delete ● Filter	This field is not editable. 32 characters maximum.	This read-only field is the Id of the user who canceled the adjustment (if applicable).
CancelledOn	System generated, exists if InvoiceAdjustment has been canceled.	dateTime	○ Create ● Query ○ Update ○ Delete ● Filter	This is automatically generated.	This read-only field is the date when adjustment was canceled (if applicable).
Comments	No	String	● Create ● Query ○ Update ○ Delete ● Filter	255 characters	An additional, free form comments field for the  adjustment.
CreatedById	System generated, always exists	ZNS:Id	○ Create ● Query ○ Update ○ Delete ● Filter	This field is not editable. 32 characters maximum.	The Zuora system automatically generates this Id of the user who created the object.
CreatedDate	System generated, always exists	dateTime	○ Create ● Query ○ Update ○ Delete ● Filter	This field is not editable.	The Zuora system automatically generates this, and denotes when the objects was first created.
CustomerName	No, for query() only. Not specified for create().	string	○ Create ● Query ○ Update ○ Delete ● Filter	50 characters maximum	The name of the customer account.
CustomerNumber	No, for query() only. Not specified for create().	string	○ Create ● Query ○ Update ○ Delete ● Filter	A customer number. 70 characters maximum.	The customer account number (Account:AccountNumber).
ImpactAmount	No	decimal	○ Create ● Query ○ Update ○ Delete ● Filter	Valid currency amount	The read-only field  is the amount that impact to balance of Invoice
InvoiceId	Yes, if InvoiceNumber is not specified. InvoiceId or InvoiceNumber must be specified for the create() call.	zns: ID	● Create ● Query ○ Update ○ Delete ● Filter	A valid invoice ID	The ID of the invoice that this adjustment applies to.
InvoiceNumber	Yes, if InvoiceId is not specified. InvoiceId or InvoiceNumber must be specified for the create() call.	String	● Create ● Query ○ Update ○ Delete ● Filter	A valid Invoice Number for an existing Invoice. 255 characters maximum.	The InvoiceNumber of the invoice that this adjustment applies to.
ReferenceId	No	string	● Create ● Query ○ Update ○ Delete ● Filter	A valid code. 60 characters maximum.	Use this as a reference to an external (non-Zuora) object. For example, you could use this to reference a case number in an external system.
Status	No, system generated	string	○ Create ● Query ● Update ○ Delete ● Filter	Canceled, Processed	Provides the status of the InvoiceAdjustment.
TransferredToAccounting	No	string	○ Create ● Query ● Update ○ Delete ● Filter	Processing, Yes, Error, Ignore	Available in version 26.0 and greater. Specifies whether or not the object has been transferred to an external accounting system. Used for integrations with accounting systems such as NetSuite.
Type	Yes	String	● Create ● Query ○ Update ○ Delete ● Filter	Credit or Charge	The type of adjustment to be made.
UpdatedById	System generated, always exists	ZNS:Id	○ Create ● Query ○ Update ○ Delete ● Filter	This field is not editable. 32 characters maximum.	The Zuora system automatically generates this Id of the user who last updated the object.
UpdatedDate	System generated, always exists	dateTime	○ Create ● Query ○ Update ○ Delete ● Filter	This field is not editable.	The Zuora system automatically generates this, and denotes when the objects was last updated.