---
title: "Retrieve a credit memo application"
method: GET
path: "/object-query/credit-memo-applications/{key}"
tags: ["Object Queries"]
---

# Retrieve a credit memo application

`GET /object-query/credit-memo-applications/{key}`

Retrieve the details of a specific Credit Memo Application object.

## Path parameters

- `key` string, required

## Query parameters

- `pageSize` integer
- `cursor` string
- `sort[]` string[]
- `expand[]` string[]
- `filter[]` string[]
- `fields[]` string[]
- `includeNullFields` boolean

## Headers

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

## Response `200`

OK

- ExpandedCreditMemoApplication
  - `id` string — The unique identifier of the credit memo application.
  - `createdById` string — The unique identifier of the user who created the credit memo application.
  - `createdDate` string, date-time — The date and time when the credit memo application was created.
  - `updatedById` string — The unique identifier of the user who last updated the credit memo application.
  - `updatedDate` string, date-time — The date and time when the credit memo application was last updated.
  - `amount` number, double — The application amount of the credit memo.
  - `effectiveDate` string, date — The date when the credit memo application becomes effective.
  - `creditMemoId` string — The ID of the credit memo associated with the credit memo application.
  - `accountId` string — The ID of the customer account associated with the credit memo.
  - `applicationGroupId` string — The ID of the application group to which this credit memo application belongs.
  - `debitMemoId` string — The ID of the debit memo to which the credit memo is applied.
  - `invoiceId` string — The ID of the invoice to which the credit memo is applied.
  - `creditMemo` NestedCreditMemoOnExpand
    - `id` string — The unique identifier of the credit memo.
    - `createdById` string — The unique identifier of the user who created the credit memo.
    - `createdDate` string, date-time — The date and time when the credit memo was created.
    - `updatedById` string — The unique identifier of the user who last updated the credit memo.
    - `updatedDate` string, date-time — The date and time when the credit memo was last updated.
    - `appliedAmount` number, double — The applied amount of the credit memo.
    - `balance` number — The remaining balance of credit memo.
    - `billToContactId` string — 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 — 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, date-time, 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.
    - `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>.
    - `discountAmount` number — The amount of the discount on the credit memo.
    - `einvoiceErrorCode` string — 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 — 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 — 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' | 'Generated' | 'Success' | 'Failed' | 'ConditionalSuccess' | 'ApprovedByAuthority' | 'Rejected' — 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 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.
    - `exchangeRateDate` string, date — The date of the exchange rate used. The date is in `yyyy-mm-dd` format. Corresponds to the value specified in the Provider Exchange Rate Date column in the Import Foreign Exchange Rates template when you uploaded the rates through the Mass Updater.
    - `autoApplyUponPosting` boolean — Whether the credit memo automatically applies to the invoice upon posting.
    - `memoDate` string, date — The date when the credit memo takes effect, in `yyyy-mm-dd` format. For example, `2024-01-01`.
    - `memoNumber` string — The unique identification number of the credit memo.
    - `postedById` string — The ID of the Zuora user who posted the credit memo.
    - `postedOn` string, date-time — 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.
    - `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.
    - `source` 'BillRun' | 'API' | 'ApiSubscribe' | 'ApiAmend' | 'AdhocFromPrpc' | 'AdhocFromInvoice' — 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 — 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.
    - `targetDate` string, date — The target date for the credit memo, in `yyyy-mm-dd` format. For example, `2024-01-01`.
    - `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' — 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.
    - `shipToContactSnapshotId` string — The ID of the ship-to contact snapshot associated with the credit memo. **Note**: If you have the Flexible Billing Attributes feature disabled, the value of this field is `null`.
    - `soldToContactSnapshotId` string — The ID of the sold-to contact snapshot associated with the credit memo. **Note**: If you have the Flexible Billing Attributes feature disabled, the value of this field is `null`.
    - `taxAutoCalculation` boolean — Whether to automatically calculate taxes in the credit memo.
    - `totalAmount` number, double — The total amount of the credit memo, including taxes.
    - `totalAmountWithoutTax` number, double — The total amount of the credit memo, excluding taxes.
    - `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. This field is used for integration with accounting systems such as NetSuite.
    - `invoiceId` string — The ID of a referred invoice.
    - `accountId` string — The ID of the customer account associated with the credit memo.
    - `account` object — The account associated with the credit memo.
    - `billToContact` object — The bill-to contact on the account.
    - `creditMemoItems` object[] — The credit memo items on the current credit memo.
    - `creditMemoApplications` object[] — The credit memo applications associated with the current credit memo.

## Other responses

- `500` — Internal server error
- `4XX` — Invalid input

---

[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)