Create a credit memo from a charge

Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information.

Creates an ad-hoc credit memo from a product rate plan charge. Zuora supports the creation of credit memos from any type of product rate plan charge. The charges can also have any amount and any charge model, except for discout charge models.

When credit memos are created from product rate plan charges, the specified amount with decimal places is now validated based on the decimal places supported by each currency.

You can create a credit memo only if you have the user permission. See Billing Roles for more information.

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

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-Org-Ids
string

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.

zuora-version
string

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
Request Body schema: application/json
required
accountId
string

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.

accountNumber
string

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.

autoPost
boolean
Default: false

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.

Array of objects (charges) <= 1000 items

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

comment
string

Comments about the credit memo.

currency
string

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.

Array of objects (customRates) <= 2 items

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.

effectiveDate
string <date>

The date when the credit memo takes effect.

excludeFromAutoApplyRules
boolean
Default: false

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.

reasonCode
string

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.

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 memo's synchronization with NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

Origin__NS
string <= 255 characters

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

SyncDate__NS
string <= 255 characters

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

Transaction__NS
string <= 255 characters

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

property name*
additional property
any

Custom fields of the Credit Memo 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
post/v1/creditmemos
Request samples
application/json
{
  • "accountId": "402890555a7e9791015a7f15fe44001c",
  • "autoPost": false,
  • "charges": [
    ],
  • "comment": "the comment",
  • "currency": "USD",
  • "customRates": [
    ],
  • "effectiveDate": "2017-10-17",
  • "excludeFromAutoApplyRules": true,
  • "reasonCode": "Correcting invoice error"
}
Response samples
application/json
{
  • "accountId": "402890555a7e9791015a7f15fe44001c",
  • "accountNumber": "A00000001",
  • "amount": 2020,
  • "appliedAmount": 0,
  • "autoApplyUponPosting": false,
  • "billToContactId": null,
  • "billToContactSnapshotId": null,
  • "cancelledById": null,
  • "cancelledOn": null,
  • "comment": "the comment",
  • "createdById": "402881e522cf4f9b0122cf5d82860002",
  • "createdDate": "2017-03-01 15:31:10",
  • "creditMemoDate": "2017-10-17",
  • "currency": "USD",
  • "einvoiceErrorCode": null,
  • "einvoiceErrorMessage": null,
  • "einvoiceFileId": null,
  • "einvoiceStatus": null,
  • "excludeFromAutoApplyRules": false,
  • "excludeItemBillingFromRevenueAccounting": true,
  • "id": "402890555a87d7f5015a88c7a6830022",
  • "invoiceGroupNumber": "N-0001",
  • "latestPDFFileId": null,
  • "number": "CM00000015",
  • "postedById": null,
  • "postedOn": null,
  • "reasonCode": "Correcting invoice error",
  • "referredInvoiceId": null,
  • "refundAmount": 0,
  • "reversed": false,
  • "sequenceSetId": null,
  • "source": "AdhocFromPrpc",
  • "sourceId": null,
  • "sourceType": "Standalone",
  • "status": "Draft",
  • "success": true,
  • "targetDate": null,
  • "taxAmount": 0,
  • "taxMessage": null,
  • "taxStatus": null,
  • "totalTaxExemptAmount": 0,
  • "transferredToAccounting": "No",
  • "unappliedAmount": 2020,
  • "updatedById": "402881e522cf4f9b0122cf5d82860002",
  • "updatedDate": "2017-03-01 15:31:10"
}