CRUD: Create a credit balance adjustment

Note: The Invoice Adjustments, Invoice Item Adjustments, and Credit Balance Adjustments features are approaching end of support on February 16, 2026. For more information, please refer to the Product and Feature End of Support page.

Request
query Parameters
rejectUnknownFields
boolean
Default: false

Specifies whether the call fails if the request body contains unknown fields. With rejectUnknownFields set to true, Zuora returns a 400 response if the request body contains unknown fields. The body of the 400 response is:

{
    "message": "Error - unrecognised fields"
}

By default, Zuora ignores unknown fields in the request body.

header Parameters
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 Accept-Encoding: gzip header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.

If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a Content-Encoding header with the compression algorithm so that your client can decompress it.

Content-Encoding
string

Include the Content-Encoding: gzip header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.

Authorization
string

The value is in the Bearer {token} format where {token} is a valid OAuth token generated by calling Create an OAuth token.

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 (:), semicolon (;), double quote ("), and quote (').

Request Body schema: application/json
required
AccountingCode
string <= 100 characters

An active accounting code in your Zuora Chart of Accounts.

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.

AdjustmentDate
string <date> [ 0 .. 29 ] characters

The date when the credit balance adjustment is applied.

With the Future Dated Credit Balance Adjustment feature enabled, you can use this field to specify when the credit balance adjustment is applied. If not specified, the value defaults to the latter date of the date when the API operation is called and the invoice date.

With the Future Dated Credit Balance Adjustment feature disabled, if no value is specified for this field, the value defaults to the date when the API operation is called. If you specify a value for this field, the value must be the date when the API operation is called.

Amount
required
number <double>

The amount of the adjustment.

Comment
string <= 255 characters

Your comments about the credit balance adjustment.

ReasonCode
string <= 32 characters

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.

ReferenceId
string <= 100 characters

The ID of the payment that the credit balance adjustment is for.

SourceTransactionId
string <= 32 characters

The ID of the object that the credit balance adjustment is applied to. You must specify a value for either the SourceTransactionId field or the SourceTransactionNumber field.

The value of this field must be an invoice ID.

SourceTransactionNumber
string <= 50 characters

The number of the object that the credit balance adjustment is applied to. You must specify a value for either the SourceTransactionId field or the SourceTransactionNumber field.

The value of this field must be an invoice number.

Type
required
string

Whether the credit balance adjustment increases or decrease the amount of the credit balance.

Enum: "Decrease" "Increase"
IntegrationId__NS
string <= 255 characters

ID of the corresponding object in NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

IntegrationStatus__NS
string <= 255 characters

Status of the credit balance adjustment's synchronization with NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

SyncDate__NS
string <= 255 characters

Date when the credit balance adjustment was sychronized with NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

property name*
additional property
any

Custom fields of the Credit Balance Adjustment object. The name of each custom field has the form customField__c. Custom field names are case sensitive. See Manage Custom Fields for more information.

Responses
200
400
401
post/v1/object/credit-balance-adjustment
Request samples
application/json
{
  • "Amount": 60,
  • "Comment": "Transfer $60.00 from a negative invoice to the account balance",
  • "SourceTransactionNumber": "INV00000420",
  • "Type": "Increase"
}
Response samples
application/json
{
  • "Success": true,
  • "Id": "2c92c0f96a531e4f016a5377af993d87"
}