CreditBalanceAdjustment
If you have the Invoice Settlement feature enabled, this object is deprecated and only available for backward compatibility.
A credit balance adjustment is an adjustment to change a customer's credit balance. When a refund isn't appropriate, you can use a credit balance adjustment to track overpayments.
The CreditBalanceAdjustment object applies adjustments to credit balances on billing accounts. This includes applying credit balance to invoices and transferring an invoice to a credit balance.
Credit Balance is an advanced feature recommended for customers who use Z-Billing as a subledger with summarized integration to the accounting system (summarizing transactions by Accounting Code to create journal entries). This feature is not recommended for users that are performing transaction-level integration to their Accounting System.
Submit a request at Zuora Global Support to enable this feature or service.
Once enabled, you must assign the Z-Payments Create Credit Balance Adjustment permission and Cancel Credit Balance Adjustment permission to your user roles. See Managing User Roles for more information.
You must have WSDL version 22.0+. Any WSDL downloaded before enabling this feature and assigning permissions will not show this object.
Field Descriptions
All field names are case sensitive. Check enumerated values in descriptions to confirm capitalization and spacing. See Field Types for additional information.
| Name | Required to Create? |
Allowed Operations | Description |
|---|---|---|---|
| AccountId | N/A |
Query |
The account ID of the credit balance's account. Zuora generates this value from the source transaction. Type: zns:ID Character limit: 32 Version notes: WSDL 22.0+ Values: automatically generated from:
|
| AccountingCode | Not Required |
Create |
The accounting code for the credit balance adjustment. Typically, an accounting code for a credit balance adjustment maps to a bank account in your accounting system. Type: string Character limit: 100 Version notes: WSDL 22.0+ Values: an active accounting code in your Zuora Chart of Accounts |
| AdjustmentDate | N/A |
Query |
The date when the credit balance adjustment is applied. Type:
Character limit: 29 Version notes: WSDL 22.0+ Values: automatically generated |
| Amount | Required | Create Query Filter |
The amount of the adjustment. Type: decimal (currency) Character limit: 16 Version notes: WSDL 22.0+ Values: a valid currency amount |
| CancelledOn | N/A | Query Filter |
The date when the credit balance adjustment was canceled. Type: dateTime Character limit: 29 Version notes: -- Values: automatically generated |
| Comment | Not Required | Create Query Filter |
Use this field to record comments about the credit balance adjustment. Type: string Character limit: 255 Version notes: WSDL 22.0+ Values: a string of 255 characters or fewer |
| CreatedById | N/A |
Query |
The user ID of the person who created the credit balance adjustment. Type: zns:ID Character limit: 32 Version notes: WSDL 22.0+ Values: automatically generated |
| CreatedDate | N/A |
Query |
The date when the credit balance adjustmentwas generated. Type: dateTime |
| Id | N/A | Query Filter |
The ID of this object. Upon creation of this object, this field becomes Type: zns:ID Character limit: 32 Version notes: -- Values: automatically generated |
| Number | N/A |
Query |
A unique identifier for the credit balance adjustment. Zuora generates this number in the format, CBA-xxxxxxxx, such as CBA-00375919. Type: string Character limit: 255 Version notes: WSDL 22.0+ Values: automatically generated |
| ReasonCode | optional | Create Query Update Filter |
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. Type: string Character limit: 32 Version notes: WSDL 47.0+ Values: a valid reason code |
| ReferenceId | Not Required | Create Query Filter |
The ID of the payment that the credit balance adjustment is for. Type: string Character limit: 32 Version notes: WSDL 22.0+ Values: a string of 60 characters or fewer |
| SourceTransactionId | Not Required | Create Query Filter |
The ID of the object that the credit balance adjustment is applied to. You must specify a value for either the Type: zns:ID Character limit: 32 Version notes: WSDL 22.0+ Values: one of the following:
|
| SourceTransactionNumber | Not Required | Create Query Filter |
The number of the object that the credit balance adjustment is applied to. You must specify a value for either the Type: string Character limit: 50 Version notes: WSDL 22.0+ Values: one of the following:
|
| SourceTransactionType | N/A |
Query |
The source of the credit balance adjustment. Type: string (enum) Character limit: Version notes: WSDL 22.0+ Values: automatically generated; one of the following:
|
| Status | N/A |
Query |
The status of the credit balance adjustment. Type: string (enum) Character limit: 9 Version notes: WSDL 22.0+ Values: automatically generated; one of the following:
|
| TransferredToAccounting | N/A |
Query |
Indicates the status of the credit balance adjustment's transfer to an external accounting system, such as NetSuite. Type: string (enum) Character limit: Version notes: WSDL 26.0+ Values: one of the following:
|
| Type | Required | Create Query Filter |
Specifies if the credit balance adjustment increases or decrease the amount of the credit balance. Type: string (enum) Character limit: 8 Version notes: WSDL 22.0+ Values: |
| UpdatedById | N/A |
Query |
The ID of the user who last updated the credit balance adjustment. Type: zns:ID Character limit: 32 Version notes: WSDL 22.0+ Values: automatically generated |
| UpdatedDate | N/A |
Query |
The date when the credit balance adjustment was last updated. Type: dateTime Character limit: 29 Version notes: WSDL 22.0+ Values: automatically generated |
Additional Field Detail
Id
The ID of this object. Upon creation of this object, this field becomes CreditBalanceAdjustmentId. Every object has a unique identifier that Zuora automatically assigns upon creation. You use this ID later when you work with the object. For example, if you send an amend() call to modify an existing subscription, then you need to include the specific Subscriptionobject's ID with the call.
The ID for the CreditBalanceAdjustment object is CreditBalanceAdjustmentId