POST /v1/creditmemos

Default value: "application/json"

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.

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 (').

The minor version of the Zuora REST API. See Minor Version for information about REST API version control.

This header affects the availability of the following request fields:

• charges > amount
• charges > memoItemAmount
• charges > chargeId
• charges > productRatePlanChargeId
• charges > comment
• charges > description
• customRates > currency
• customRates > customFxRate
• customRates > rateDate

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

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.

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.

Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.

The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails.

If the header is not set, the operation is performed in scope of the user's accessible orgs.

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.

The date when the credit memo takes effect.

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

The ID of the account associated with the credit memo.

Note: When creating credit memos from product rate plan charges, you must specify accountNumber, accountId, or both in the request body. If both fields are specified, they must correspond to the same account.

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

Related transaction in NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

Whether the credit memo is excluded from the rule of automatically applying unapplied credit memos to invoices and debit memos during payment runs. If you set this field to true, a payment run does not pick up this credit memo or apply it to other invoices or debit memos.

Default value: false

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

A code identifying the reason for the transaction. The value must be an existing reason code or empty. If you do not specify a value, Zuora uses the default reason code.

The code of a currency as defined in Billing Settings through the Zuora UI.

If you do not specify a currency during credit memo creation, the default account currency is applied. The currency that you specify in the request must be configured and activated in Billing Settings. Note: This field is available only if you have the Multiple Currencies feature enabled.

The number of the customer account associated with the credit memo.

Note: When creating credit memos from product rate plan charges, you must specify accountNumber, accountId, or both in the request body. If both fields are specified, they must correspond to the same account.

Comments about the credit memo.

Date when the credit memo was synchronized with NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

Container for product rate plan charges. The maximum number of items is 1,000.

Comments about the product rate plan charge.

Note: This field is not available if you set the zuora-version request header to 257.0 or later available versions.

The flag to exclude the credit memo item from revenue accounting.

Note: This field is only available if you have the Billing - Revenue Integration feature enabled.

Default value: false

The service end date of the credit memo item. If not specified, the effective end date of the corresponding product rate plan will be used.

The description of the product rate plan charge.

Note: This field is only available if you set the zuora-version request header to 257.0 or later available versions.

The amount of the credit memo item.

Note: This field is not available if you set the zuora-version request header to 224.0 or later available versions.

The amount of the credit memo item.

Note: This field is only available if you set the zuora-version request header to 224.0 or later available versions.

The number of units for the credit memo item.

The service start date of the credit memo item. If not specified, the effective start date of the corresponding product rate plan will be used.

The ID of the product rate plan charge that the credit memo is created from.

Note: This field is only available if you set the zuora-version request header to 257.0 or later available versions.

Container for the finance information related to the product rate plan charge associated with the credit memo.

The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges.

The name of the revenue recognition rule governing the revenue schedule.

The accounting code that maps to an on account in your accounting system.

The accounting code for the deferred revenue, such as Monthly Recurring Liability.

The ID of the product rate plan charge that the credit memo is created from.

Note: This field is not available if you set the zuora-version request header to 257.0 or later available versions.

It contains Home currency and Reporting currency custom rates currencies. The maximum number of items is 2 (you can pass the Home currency item or Reporting currency item or both).

Note: The API custom rate feature is permission controlled.

The date on which a particular currency rate is fixed or obtained on.

Note: This field is only available if you set the zuora-version request header to 224.0 or later available versions.

The currency code for either Reporting or Home currency.

Note: This field is only available if you set the zuora-version request header to 224.0 or later available versions.

The Custom FX conversion rate between Home/Reporting and Transactional currency items.

Note: This field is only available if you set the zuora-version request header to 224.0 or later available versions.

Whether to automatically post the credit memo after it is created.

Setting this field to true, you do not need to separately call the Post a credit memo operation to post the credit memo.

Default value: false