---
title: "Retrieve a credit memo"
method: GET
path: "/v1/credit-memos/{creditMemoKey}"
tags: ["Credit Memos"]
---

# Retrieve a credit memo

`GET /v1/credit-memos/{creditMemoKey}`

**Note:** This operation is only available if you have [Invoice Settlement](https://docs.zuora.com?resourceId=billing-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](https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide) for more information. 

Retrieves the information about a specific credit memo.

For a use case of this operation, see [Get credit memo](https://developer.zuora.com/rest-api/general-concepts/authentication//#Get-credit-memo).

## Path parameters

- `creditMemoKey` string, required

## Headers

- `Accept-Encoding` string
- `Content-Encoding` string
- `Zuora-Track-Id` string
- `Zuora-Entity-Ids` string
- `Zuora-Org-Ids` string
- `Zuora-Version` string

## Response `200`

OK

- GETCreditMemoType — Container for custom fields of a Credit Memo object.
  - `accountId` string — The ID of the customer account associated with the credit memo.
  - `accountNumber` string — The number of the customer account associated with the credit memo.
  - `amount` number, double — The total amount of the credit memo.
  - `appliedAmount` number, double — The applied amount of the credit memo.
  - `autoApplyUponPosting` boolean — Whether the credit memo automatically applies to the invoice upon posting.
  - `billToContactId` string, 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](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes) feature disabled.
  - `billToContactSnapshotId` string, 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](https://docs.zuora.com?resourceId=billing-billing-rules-billing-document) is disabled.
  - `cancelledById` string, nullable — The ID of the Zuora user who cancelled the credit memo.
  - `cancelledOn` string, nullable — The date and time when the credit memo was cancelled, in `yyyy-mm-dd hh:mm:ss` format.
  - `comment` string, nullable — Comments about the credit memo.
  - `createdById` string — The ID of the Zuora user who created the credit memo.
  - `createdDate` string — 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.
  - `creditMemoDate` string, date — The date when the credit memo takes effect, in `yyyy-mm-dd` format. For example, 2017-05-20.
  - `currency` string, 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>.
  - `einvoiceErrorCode` string, 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.
  - `einvoiceErrorMessage` string, 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.
  - `einvoiceFileId` string, 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.
  - `excludeFromAutoApplyRules` boolean — Whether the credit memo is excluded from the rule of automatically applying credit memos to invoices.
  - `excludeItemBillingFromRevenueAccounting` boolean — 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.
  - `id` string — The unique ID of the credit memo.
  - `invoiceGroupNumber` string, 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](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes) feature disabled.
  - `latestPDFFileId` string, nullable — The ID of the latest PDF file generated for the credit memo.
  - `number` string — The unique identification number of the credit memo.
  - `organizationLabel` string — The organization that this object belongs to. Note: This field is available only when the Multi-Org feature is enabled.
  - `postedById` string, nullable — The ID of the Zuora user who posted the credit memo.
  - `postedOn` string, nullable — The date and time when the credit memo was posted, in `yyyy-mm-dd hh:mm:ss` format.
  - `reasonCode` string — A code identifying the reason for the transaction. The value must be an existing reason code or empty.
  - `referredInvoiceId` string, nullable — The ID of a referred invoice.
  - `refundAmount` number, 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.
  - `reversed` boolean — Whether the credit memo is reversed.
  - `sequenceSetId` string, 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](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes) feature disabled.
  - `communicationProfileId` string, 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.
  - `source` string — 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](https://developer.zuora.com/api-references/api/operation/POST_TransactionInvoicePayment) operation, or by calling the Orders, Order Line Items, or Fulfillments API operations. - `ApiSubscribe`: The credit memo is created by calling the [Create subscription](https://developer.zuora.com/api-references/api/operation/POST_Subscription) and [Create account](https://developer.zuora.com/api-references/api/operation/POST_Account) operation. - `ApiAmend`: The credit memo is created by calling the [Update subscription](https://developer.zuora.com/api-references/api/operation/PUT_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](https://developer.zuora.com/api-references/api/operation/POST_CreditMemoFromPrpc) 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](https://developer.zuora.com/api-references/api/operation/POST_CreditMemoFromInvoice) operation. You can create a credit memo by reversing an invoice through the Zuora UI or by calling the [Reverse invoice](https://developer.zuora.com/api-references/api/operation/PUT_ReverseInvoice) operation.
  - `sourceId` string, 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.
  - `success` boolean — Returns `true` if the request was processed successfully.
  - `targetDate` string, date, nullable — The target date for the credit memo, in `yyyy-mm-dd` format. For example, 2017-07-20.
  - `taxAmount` number, double — The amount of taxation.
  - `taxMessage` string, 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.
  - `totalTaxExemptAmount` number, 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.
  - `unappliedAmount` number, double — The unapplied amount of the credit memo.
  - `updatedById` string — The ID of the Zuora user who last updated the credit memo.
  - `updatedDate` string — 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__NS` string — ID of the corresponding object in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).
  - `IntegrationStatus__NS` string — Status of the credit memo's synchronization with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).
  - `Origin__NS` string — Origin of the corresponding object in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).
  - `SyncDate__NS` string — Date when the credit memo was synchronized with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).
  - `Transaction__NS` string — Related transaction in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).

## Other responses

- `500` — Internal Server Error
- `4XX` — Request Errors

---

[API](https://skmtc.dev/zuora/apis/api-reference.md) · [All operations](https://skmtc.dev/zuora/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/zuora/api-reference/revisions/d11e237f3e54/schema)