# Credit memo partially applied

Endpoint: POST credit-memo-partially-applied
Version: latest
Security: SecretApiKey, JWT

## Request fields (application/json):

  - `creditMemoId` (string)
    ID of the credit memo.
    Example: "crmm_0YVCNN22TWC3G8H82QNPNVZCHG"

  - `eventType` (string)
    Rebilly webhooks event type.
    Enum: "credit-memo-applied", "credit-memo-created", "credit-memo-modified", "credit-memo-partially-applied", "credit-memo-voided"

  - `_embedded` (object)
    Embedded objects.

  - `_embedded.creditMemo` (object)
    Credit memo object.

  - `_embedded.creditMemo.allocations` (object)
    Allocations reduce the unused amount of a credit memo.

  - `_embedded.creditMemo.allocations.transactions` (array)
    List of transactions (typically refunds, credits, and chargebacks) that are allocated to reduce the unused amount of a credit memo.

  - To delete transaction allocations, send an empty transaction allocation array in the request.
  - To modify transaction allocations, send a modified transaction allocation array in the request.
  - If you do not want to modify or delete transaction allocations, do not send a transaction allocation array in the request.

  - `_embedded.creditMemo.allocations.transactions.transactionId` (string)
    ID of the transaction to which the credit memo is allocated.

  - `_embedded.creditMemo.allocations.transactions.amount` (number)
    Amount of credit that is allocated from the credit memo to the transaction.
If the  value is not supplied or exceeds the unused amount of the credit memo or the transaction amount, the lesser of the following two values is used:
- The unused amount of the credit memo.
- The transaction amount.

  - `_embedded.creditMemo.allocations.invoices` (array)
    List of invoices that the credit memo is allocated to.

- To delete invoice allocations, send an empty invoice allocation array in the request.
  Only , , and  invoices can be deleted.
- To modify invoice allocations, send a modified invoice allocation array in the request.
  Only , , and  invoices can be modified.
- If you do not want to modify or delete invoice allocations, do not send an invoice allocation array in the request.

  - `_embedded.creditMemo.allocations.invoices.invoiceId` (string)
    ID of invoice to which the credit memo is allocated.
    Example: "in_0YVF9605RKC62BP14NE2R7V2XT"

  - `_embedded.creditMemo.allocations.invoices.amount` (number)
    Amount of credit that is allocated from the credit memo to the invoice.
If the  value is not supplied or exceeds the unused amount of the credit memo or the invoice due amount, the lesser of the following two values is used:
- The unused amount of the credit memo.
- The invoice due amount.

  - `_embedded.creditMemo.items` (array)
    Items of the credit memo.

  - `_embedded.creditMemo.items.invoiceItemId` (string,null)
    ID of the invoice item to which the credit item is referenced.
    Example: "ii_0YVFDEQS2KCFTBN9HXWJFY55GV"

  - `_embedded.creditMemo.items.description` (string)
    Description of the credit memo item.

  - `_embedded.creditMemo.items.unitPrice` (number, required)
    Price of the credit memo item.

  - `_embedded.creditMemo.items.quantity` (integer, required)
    Quantity of the credit memo item.

  - `_embedded.creditMemo.items.productId` (string,null)
    ID of the related product.
    Example: "prod_0YV7DES3WPC5J8JD8QTVNZBZNZ"

  - `_embedded.creditMemo.items.planId` (string,null)
    ID of the related plan.
    Example: "plan_0YV7DENSVGDBW9S71XZNNYYQ0X"

  - `_embedded.creditMemo.items.tax` (any)
    Credit memo item tax.

  - `_embedded.creditMemo.reason` (string)
    Reason for the credit memo.
    Enum: "return", "product-unsatisfactory", "order-change", "order-cancellation", "chargeback", "write-off", "waiver", "customer-credit", "other"

  - `_embedded.creditMemo.description` (string)
    Public description, that is visible to customers, which describes the purpose of the credit memo.

  - `_embedded.creditMemo.shippingAmount` (number)
    Shipping amount of an invoice to credit.

  - `_embedded.creditMemo.customerId` (string, required)
    ID of the customer resource.

  - `_embedded.creditMemo.currency` (string, required)
    Currency code in ISO 4217 format.

  - `_embedded.creditMemo.invoiceId` (string,null)
    ID of the invoice to which the credit memo is issued.
    Example: "in_0YVF9605RKC62BP14NE2R7V2XT"

  - `_links` (array)
    Related links.

  - `_links.href` (string)
    Link URL.

  - `_links.rel` (string)
    Type of link.
    Enum: "creditMemo"