---
title: "Apply a credit memo aysnchronously"
method: PUT
path: "/v1/credit-memos/{creditMemoKey}/apply-async"
tags: ["Credit Memos"]
---

# Apply a credit memo aysnchronously

`PUT /v1/credit-memos/{creditMemoKey}/apply-async`

**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.

  Asynchronously applies a posted credit memo to one or more invoices
  You can apply a credit memo to an invoice only if you have the user permission. See [Billing Roles](https://docs.zuora.com?resourceId=platform-billing-roles) for more information.
  When you apply a credit memo, the total number of credit memo items and the items that credit memo items to be applied to must be less than or equal to 300,000.
  The maximum number of invoices that you can specify in the request is 1,000
  If the Proration application rule is used, when applying credit memos, the following quantity must be less than or equal to 10,000: 

(number of invoice items) * number of credit memo items

Otherwise, the First In First Out rule will be used instead of the Proration rule.

## Path parameters

- `creditMemoKey` string, required

## Headers

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

## Request body

- AsyncApplyCreditMemoRequest
  - `effectiveDate` string, date — The date when the credit memo is applied.
  - `invoices` AsyncApplyCreditMemoToInvoice[] — Container for invoices that the credit memo is applied to. The maximum number of invoices is 1,000.
    - `amount` number, required — The credit memo amount to be applied to the invoice.
    - `invoiceId` string, required — The unique ID of the invoice that the credit memo is applied to.

## Response `200`

- InvoiceSettlementAsyncJobResponse
  - `processId` string — The ID of the process that handles the operation.
  - `reasons` object[] — The container of the error code and message. This field is available only if the `success` field is `false`.
    - `code` string — The error code of response.
    - `message` string — The detail information of the error response
  - `requestId` string, uuid — Unique identifier of the request.
  - `success` boolean — Indicates whether the call succeeded.
  - `id` string — The ID of the operation job.
  - `status` 'Pending' | 'Processing' | 'Processed' | 'Error' — Job status of the Invoice Settlement async job.
  - `operationType` 'AsyncCreditMemoApply' | 'AsyncCreditMemoUnapply' — Operation type of the Invoice Settlement async job.
  - `referenceId` string — The ID of the business object which is being operated.
  - `referenceType` 'CreditMemo' — Reference type of the Invoice Settlement async job.
  - `error` string, nullable — The error message if the operation error out.

## Other responses

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