Pricing Templates
Log in Sign up
Integrations / Zuora / ...

PUT /v1/creditmemos/{creditMemoKey}

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.

Updates the basic and finance information about a credit memo. Currently, Zuora supports updating tax-exclusive memo items, but does not support updating tax-inclusive memo items.

If the amount of a memo item is updated, the tax will be recalculated in the following conditions:

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

Servers

Path parameters

Name Type Required Description
creditMemoKey String Yes

The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001.

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"
Content-Encoding String No

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.
Zuora-Track-Id String No

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

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 No

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 No

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.
Accept-Encoding String No

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.

Request body fields

Name Type Required Description
comment String No

Comments about the credit memo.
effectiveDate String No

The date when the credit memo takes effect.
IntegrationStatus__NS String No

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

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

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

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

Whether the credit memo automatically applies to the invoice upon posting.
excludeFromAutoApplyRules Boolean No

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.
items[] Array No

Container for credit memo items.
items[].id String Yes

The ID of the credit memo item.
items[].comment String No

Comments about the credit memo item.
items[].excludeItemBillingFromRevenueAccounting Boolean No

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
items[].serviceEndDate String No

The service end date of the credit memo item.
items[].skuName String No

The name of the SKU.
items[].amount Number No

The amount of the credit memo item. For tax-inclusive credit memo items, the amount indicates the credit memo item amount including tax. For tax-exclusive credit memo items, the amount indicates the credit memo item amount excluding tax
items[].quantity Number No

The number of units for the credit memo item.
items[].serviceStartDate String No

The service start date of the credit memo item.
items[].financeInformation Object No

Container for the finance information related to the credit memo item.
items[].financeInformation.recognizedRevenueAccountingCode String No

The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges.
items[].financeInformation.revenueRecognitionRuleName String No

The name of the revenue recognition rule governing the revenue schedule.
items[].financeInformation.onAccountAccountingCode String No

The accounting code that maps to an on account in your accounting system.
items[].financeInformation.deferredRevenueAccountingCode String No

The accounting code for the deferred revenue, such as Monthly Recurring Liability.
items[].taxItems[] Array No

Container for credit memo taxation items.
items[].taxItems[].locationCode String No

The identifier for the location based on the value of the taxCode field.
items[].taxItems[].taxCodeDescription String No

The description of the tax code.
items[].taxItems[].financeInformation Object No

Container for the finance information related to the taxation item in the credit memo item.
items[].taxItems[].financeInformation.salesTaxPayableAccountingCode String No

The accounting code for the sales taxes payable.
items[].taxItems[].financeInformation.onAccountAccountingCode String No

The accounting code that maps to an on account in your accounting system.
items[].taxItems[].id String Yes

The ID of the taxation item in the credit memo item.
items[].taxItems[].jurisdiction String No

The jurisdiction that applies the tax or VAT. This value is typically a state, province, county, or city.
items[].taxItems[].taxName String No

The name of taxation.
items[].taxItems[].taxRateType String No

The type of the tax rate applied to the credit memo.

Possible values:

  • "FlatFee"
  • "Percentage"
items[].taxItems[].amount Number No

The amount of the taxation item in the credit memo item.
items[].taxItems[].taxCode String No

The tax code identifies which tax rules and tax rates to apply to a specific credit memo.
items[].taxItems[].taxDate String No

The date that the tax is applied to the credit memo, in yyyy-mm-dd format.
items[].taxItems[].taxRate Number No

The tax rate applied to the credit memo.
items[].taxItems[].taxRateDescription String No

The description of the tax rate.
items[].taxItems[].taxExemptAmount Number No

The calculated tax amount excluded due to the exemption.
items[].unitOfMeasure String No

The definable unit that you measure when determining charges.
Origin__NS String No

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

Whether the credit memo is transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite.

Possible values:

  • "Processing"
  • "Error"
  • "Yes"
  • "Ignore"
  • "No"
reasonCode String No

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.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.
All third party trademarks (including logos and icons) are the property of their respective owners, which do not sponsor, authorize, or endorse this website.
Pricing Templates Integrations Blog Contact Us Help
© 2025 SimWorkflow
Terms of Service Privacy Policy