Sign in
Credit Memos

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.

post/v1/credit-memos

Headers

Idempotency-Keystring

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-Encodingstring

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-Encodingstring

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-Idstring

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-Idsstring

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 should not set this header.

Zuora-Org-Idsstring

Comma separated IDs. If you have <a href="https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org" target="_blank">Zuora Multi-Org</a> 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. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs.

Zuora-Versionstring

The minor API version.

For a list of available minor versions, see API upgrades.

Request body

accountIdstring

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.

accountNumberstring

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.

autoPostboolean

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.

commentstring

Comments about the credit memo.

currencystring

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 <a href="https://docs.zuora.com?resourceId=billing-multiple-currencies-overview" target="_blank">Multiple Currencies</a> feature enabled.

effectiveDatestring date

The date when the credit memo takes effect.

excludeFromAutoApplyRulesboolean

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.

numberstring

A customized credit memo number with the following format requirements:

  • Max length: 32 characters
  • Acceptable characters: a-z,A-Z,0-9,-,_

The value must be unique in the system, otherwise it may cause issues with bill runs and subscriptions.

If not provided, Zuora will generate a unique number per the sequence set on the account level. If the account-level sequence set is not specified, the system default sequence set is used. For more information, see <a href="https://docs.zuora.com?resourceId=billing-config-of-prefix-and-number-for-billing-docs" target="_blank">Configure prefix and numbering for billing documents</a>.

reasonCodestring

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__NSstring

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

IntegrationStatus__NSstring

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

Origin__NSstring

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

SyncDate__NSstring

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

Transaction__NSstring

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

Example request

{
  "accountId": "8ad09be48db5aba7018db604776d4854",
  "charges": [
    {
      "amount": 10,
      "productRatePlanChargeId": "8ad097b4909708e001909b41bb085d38"
    }
  ]
}

Response

OK

accountIdstring

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

accountNumberstring

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

amountnumber double

The total amount of the credit memo.

appliedAmountnumber double

The applied amount of the credit memo.

autoApplyUponPostingboolean

Whether the credit memo automatically applies to the invoice upon posting.

billToContactIdstring nullable

The ID of the bill-to contact associated with the credit memo.

The value of this field is null if you have the Flexible Billing Attributes feature disabled.

billToContactSnapshotIdstring nullable

The ID of the bill-to contact snapshot associated with the credit memo.

The value of this field is null if the bill rule Preserve snapshot of bill-to and sold-to contacts when billing documents are posted is disabled.

cancelledByIdstring nullable

The ID of the Zuora user who cancelled the credit memo.

cancelledOnstring nullable

The date and time when the credit memo was cancelled, in yyyy-mm-dd hh:mm:ss format.

commentstring nullable

Comments about the credit memo.

createdByIdstring

The ID of the Zuora user who created the credit memo.

createdDatestring

The date and time when the credit memo was created, in yyyy-mm-dd hh:mm:ss format. For example, 2017-03-01 15:31:10.

creditMemoDatestring date

The date when the credit memo takes effect, in yyyy-mm-dd format. For example, 2017-05-20.

currencystring nullable

The currency of the credit memo.

Note: By default, the currency on a billing document matches the default currency set on the associated account. However, Zuora now offers a Multiple Currencies feature to support different currencies for billing documents, allowing flexibility beyond the account-level currency. For more information, see <a href="https://docs.zuora.com?resourceId=billing-multiple-currencies-overview" target="_blank">Multiple Currency</a>.

einvoiceErrorCodestring nullable

The error code returned when the e-invoice file status is Failed. This code can either be a Zuora-generated error code or one returned by a third-party e-invoicing service provider.

Note: This field is available only if you have the <a href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview" target="_blank">E-Invoicing</a> feature in Early Adopter phase enabled.

einvoiceErrorMessagestring nullable

The error message returned when the e-invoice file status is Failed. This message can either be a Zuora-generated error message or one returned by a third-party e-invoicing service provider.

Note: This field is available only if you have the <a href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview" target="_blank">E-Invoicing</a> feature in Early Adopter phase enabled.

einvoiceFileIdstring nullable

The ID of the e-invoice file generated for the credit memo.

Note: This field is available only if you have the <a href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview" target="_blank">E-Invoicing</a> feature in Early Adopter phase enabled.

einvoiceStatus'Processing' | 'RetrieveTimeOut' | 'Generated' | 'Success' | 'Failed' | 'ConditionalSuccess' | 'ApprovedByAuthority' | 'Rejected' nullable

The status of the e-invoice file generation for the credit memo.

  • If e-invoice file generation succeeds, this field is either Generated or Success, and both the error code and message are empty, and the eInvoiceFileId field stores the ID of the generated e-invoice file.

  • If the responses from tax vendors such as Sovos or Avalara are taking too long, this field becomes RetrieveTimeOut. Once the vendor responds successfully, you can use the 'Resync E-Invoice Status' action to update the status automatically. You can view these updates in System Health telemetry.

  • If a failure occurs during e-invoice file generation, this field is Failed and an error code and an error message are returned respectively in the einvoiceErrorCode and einvoiceErrorMessage fields.

  • If e-invoice file generation conditionally succeeds, this field is ConditionalSuccess and an error code and an error message are returned respectively in the einvoiceErrorCode and einvoiceErrorMessage fields.

  • If the e-invoice file has been approved by the tax authority, this field is ApprovedByAuthority. The next status will be either Success or Rejected.

  • If the e-invoice file has been rejected by the government, this field is Rejected. You cannot resend this e-invoice; you must create a new invoice instead.

    Note: This field is available only if you have the <a href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview" target="_blank">E-Invoicing</a> feature in Early Adopter phase enabled.

excludeFromAutoApplyRulesboolean

Whether the credit memo is excluded from the rule of automatically applying credit memos to invoices.

excludeItemBillingFromRevenueAccountingboolean

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.

idstring

The unique ID of the credit memo.

invoiceGroupNumberstring nullable

The number of the invoice group associated with the credit memo.

The value of this field is null if you have the Flexible Billing Attributes feature disabled.

latestPDFFileIdstring nullable

The ID of the latest PDF file generated for the credit memo.

numberstring

The unique identification number of the credit memo.

organizationLabelstring

The organization that this object belongs to.

Note: This field is available only when the Multi-Org feature is enabled.

postedByIdstring nullable

The ID of the Zuora user who posted the credit memo.

postedOnstring nullable

The date and time when the credit memo was posted, in yyyy-mm-dd hh:mm:ss format.

reasonCodestring

A code identifying the reason for the transaction. The value must be an existing reason code or empty.

referredInvoiceIdstring nullable

The ID of a referred invoice.

refundAmountnumber double

The amount of the refund on the credit memo.

revenueImpacting'Yes' | 'No'

Indicates whether this write off operation impacts the revenue. If revenueImpacting = Yes, the deferred revenue accounting code will be automatically selected from the associated invoice

If revenueImpacting = No, users can select an accounting code such as bad-debt expense accounting code for the write off operation.

reversedboolean

Whether the credit memo is reversed.

sequenceSetIdstring nullable

The ID of the sequence set associated with the credit memo.

The value of this field is null if you have the Flexible Billing Attributes feature disabled.

communicationProfileIdstring nullable

The ID of the communication profile associated with the credit memo.

Note: This field is available in the request body only if you have the <a href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes" target="_blank">Flexible Billing Attributes</a> feature turned on. The value is null in the response body without this feature turned on.

sourcestring

The source of the credit memo.

Possible values:

  • BillRun: The credit memo is generated by a bill run.
  • API: The credit memo is created by calling the Invoice and collect operation, or by calling the Orders, Order Line Items, or Fulfillments API operations.
  • ApiSubscribe: The credit memo is created by calling the Create subscription and Create account operation.
  • ApiAmend: The credit memo is created by calling the Update subscription operation.
  • AdhocFromPrpc: The credit memo is created from a product rate plan charge through the Zuora UI or by calling the Create a credit memo from a charge operation.
  • AdhocFromInvoice: The credit memo is created from an invoice or created by reversing an invoice. You can create a credit memo from an invoice through the Zuora UI or by calling the Create credit memo from invoice operation. You can create a credit memo by reversing an invoice through the Zuora UI or by calling the Reverse invoice operation.
sourceIdstring nullable

The ID of the credit memo source.

If a credit memo is generated from a bill run, the value is the number of the corresponding bill run. Otherwise, the value is null.

sourceType'Subscription' | 'Standalone' | 'Invoice' | 'Order' | 'CreditMemo' | 'Consolidation'

The type of the credit memo source.

status'Draft' | 'Posted' | 'Canceled' | 'Error' | 'PendingForTax' | 'Generating' | 'CancelInProgress'

The status of the credit memo.

successboolean

Returns true if the request was processed successfully.

targetDatestring date nullable

The target date for the credit memo, in yyyy-mm-dd format. For example, 2017-07-20.

taxAmountnumber double

The amount of taxation.

taxMessagestring nullable

The message about the status of tax calculation related to the credit memo. If tax calculation fails in one credit memo, this field displays the reason for the failure.

taxStatus'Complete' | 'Error' | 'UnknownError' | 'DuplicateDoc' | 'InvalidRequest' | 'InvalidResponse' | 'TaxEngineError' | 'ConcurrentModify' | 'InternalServerError' | 'TaxCodeTemplateError' | 'Voided' nullable

The status of tax calculation related to the credit memo.

Note: This field is only applicable to tax calculation by third-party tax engines. Also, the Voided status indicates that the tax transaction is successfully canceled on the tax vendor's side. If a tax transaction was successfully committed to the third-party tax engine but the invoice failed to post, Zuora automatically detects the issue and voids the tax transaction on the vendor's side.

totalTaxExemptAmountnumber double

The calculated tax amount excluded due to the exemption.

transferredToAccounting'Processing' | 'Yes' | 'No' | 'Error' | 'Ignore'

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

unappliedAmountnumber double

The unapplied amount of the credit memo.

updatedByIdstring

The ID of the Zuora user who last updated the credit memo.

updatedDatestring

The date and time when the credit memo was last updated, in yyyy-mm-dd hh:mm:ss format. For example, 2017-03-01 15:36:10.

IntegrationId__NSstring

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

IntegrationStatus__NSstring

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

Origin__NSstring

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

SyncDate__NSstring

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

Transaction__NSstring

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

Changes