Adjustment

From API Documentation

Jump to: navigation, search

As of Septemeber 14, 2010, the Adjustment object has been removed from ALL versions of the API.  All previous Adjustments have been migated to the new InvoiceAdjustment object.  Please see InvoiceAdjustment for more information.

Please note that as of Version 23.0+ of the Z-Commerce API, the preferred approach for adjustments is to make line item adjustments (see InvoiceItemAdjustment). As of version 23.0+, you can create() line item adjustments via the API.

Name Required? Type Allowable Values Description
AccountId Yes zns: ID A valid account ID The account for which the adjustment is being made.
AccountingCode No string 80 characters This is for use if you have enabled integration of the Z-Commerce system with your accounting system. It is inherited from the product, if it exists there, or from the account/global level. If an accounting code isn't found in any of those places, it is left blank.
AdjustmentDate Yes dateTime A valid date and time The date on which the adjustment is to be applied to the invoice.
AdjustmentNumber No string (sequence) This is generated by the system This is the same as the invoice or payment number.
Amount Yes double (v1.0-18.0) / decimal (v19.0+) A valid currency amount The amount of the adjustment.
CreatedDate System generated, always exists dateTime This field is not editable. Available as of version 20.0 of the API. The Zuora system automatically generates this, and denotes when the objects was first created.
CreatedById System generated, always exists ZNS:Id This field is not editable. Available as of version 20.0 of the API. The Zuora system automatically generates this Id of the user who created the object.
CreatedBy Yes string This is generated by the system Now deprecated (available in versions 5.0-19.0). The identification of the person creating the adjustment.
CreatedOn Yes dateTime This is generated by the system Now deprecated (available in versions 5.0-19.0). The date on which the adjustment is created.
CustomerName Yes string This is inherited from the account The name of the customer for whom the adjustment is being made. This should match with the account (and the account should match with the invoice it is being applied to).
CustomerNumber Yes string See Account This is the same as the account number associated with the account for which this adjustment is being made. It must be unique.
LastUpdatedBy Yes string This is generated by the system Now deprecated (available in versions 5.0-19.0). The identification of the person by whom the adjustment was last updated.
LastUpdatedOn Yes dateTime This is generated by the system Now deprecated (available in versions 5.0-19.0). The date on which the adjustment was last updated.
Status Yes string Canceled, Processed The status of the adjustment.
Type Yes string Credit, Debit The type of adjustment, either a credit memo or a debit memo.
UpdatedDate System generated, always exists dateTime This field is not editable. Available as of version 20.0 of the API. The Zuora system automatically generates this, and denotes when the objects was last updated.
UpdatedById System generated, always exists ZNS:Id This field is not editable. Available as of version 20.0 of the API. The Zuora system automatically generates this Id of the user who last updated the object.