CreditBalanceAdjustment
From API Documentation
The CreditBalanceAdjustment is an adjustment that can add or subtract to the customer's credit balance. This is helpful tracking overpayments and credits where refunds are not appropriate.
Please note that this is only available in version 22.0 of the API and greater.
Using the CreditBalanceAdjustment Object
Use this object to create adjustments that are applied to the credit balance (as opposed to an invoice).
Fields
| Name | Required? | Type | Allowed Operations: ● Yes ○ No | Allowable Values | Description |
|---|---|---|---|---|---|
| AccountId | No. Do not specify when creating the CreditBalanceAdjustment. Zuora will auto-populate this, getting the Account Id from the source transaction. | ZNS:Id | ○ Create
● Query | A valid Account Id | The ID of the Account that is having its credit balance adjusted. |
| AccountingCode | No | String | ● Create
● Query | A valid Accounting code, 100 characters maximum | The accounting code for the adjustment. |
| AdjustmentDate | No, cannot be specified by in the create() call, Zuora will auto-populate it for you. | dateTime | ○ Create
● Query | A valid datetime | Date when the adjustment is created applied. |
| Amount | Yes | decimal | ● Create
● Query | The amount of the adjustment. | |
| Comment | No | string | ● Create
● Query | 255 characters | A freeform text field for comments and notes. |
| CreatedById | No. System generated. | ZNS:Id | ○ Create
● Query | Valid user ID. 32 characters maximum. | ID of Zuora user that created the object |
| CreatedDate | No. System generated. | dateTime | ○ Create
● Query | Valid datetime | Datetime when object was created |
| Number | System generated | string | ○ Create
● Query | 255 characters | Identifier for the adjustment |
| ReferenceId | No | string | ● Create
● Query | 60 characters | ID of payment that the adjustment is for. |
| SourceTransactionId | Yes, if creating a credit balance adjustment and SourceTransactionNumber is not specified. | zns: ID | ● Create
● Query | Invoice ID. 32 characters maximum. | The ID of the invoice, payment, invoice adjustment or invoice item adjustment that the credit balance is being applied to. |
| SourceTransactionNumber | Yes, if creating a CreditBalanceAdjustment and SourceTransactionId is not specified. | string | ● Create
● Query | 50 characters | The number of the invoice, payment, invoice adjustment or invoice item adjustment that the credit balance is being applied to. |
| SourceTransactionType | No, read only. | string | ○ Create
● Query | Invoice, Payment, Refund, Adjustment | Specifies if the source of the credit balance adjustment is from an invoice, a payment, invoice adjustment, or invoice item adjustment. |
| Status | System generated | string | ○ Create
● Query | Processed, Canceled | |
| TransferredToAccounting | No | String | ○ Create
● Query | 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. Must specify whether you are increase or decreasing the credit balance when creating the credit balance adjustment. | string | ● Create
● Query | Increase, Decrease | |
| UpdatedById | No. System generated. | ZNS:Id | ○ Create
● Query | Valid user ID. 32 characters maximum. | ID of Zuora user that last updated the object |
| UpdatedDate | No. System generated. | dateTime | ○ Create
● Query | Valid datetime | Datetime when object was last updated. |
