# Credit Memos

AR credit memo management operations.
Credit memos represent customer credits that can be applied to invoices.


## Filter credit memos

 - [POST /credit-memos/filter](https://docs.mvmnt.io/apis/openapi/credit-memos/filtercreditmemos.md): Search for credit memos using filter criteria.

## Common Filters

- By customer: { "filter": { "customerId": { "equalTo": "uuid" } } }
- With balance: { "filter": { "hasRemainingBalance": true } }
- Open credits: { "filter": { "status": { "in": ["OPEN", "PARTIALLY_APPLIED"] } } }

## Create a credit memo

 - [POST /credit-memos](https://docs.mvmnt.io/apis/openapi/credit-memos/createcreditmemo.md): Create a new credit memo for a customer.

## Use cases

- Customer refunds
- Service adjustments
- Promotional credits
- Manual corrections

## Note

Credit memos from overpayments are created automatically
when a payment exceeds invoice totals.

## Get a credit memo

 - [GET /credit-memos/{id}](https://docs.mvmnt.io/apis/openapi/credit-memos/getcreditmemo.md): Retrieve a credit memo by ID.

The response includes all applications showing how the credit has been used.

## Update a credit memo

 - [PATCH /credit-memos/{id}](https://docs.mvmnt.io/apis/openapi/credit-memos/updatecreditmemo.md): Update credit memo fields.

## Constraints

- Amount cannot be changed if any applications exist
- Customer cannot be changed once created

## Void a credit memo

 - [POST /credit-memos/{id}/void](https://docs.mvmnt.io/apis/openapi/credit-memos/voidcreditmemo.md): Void/cancel a credit memo.

## Prerequisites

- Credit memo must have no applications (full balance remaining)
- Must unapply all applications before voiding

## What happens

- Credit memo status changes to VOIDED
- Credit is no longer available for application
- QBO sync will delete the credit memo

## Apply credit to invoice

 - [POST /credit-memos/{id}/apply](https://docs.mvmnt.io/apis/openapi/credit-memos/applycreditmemo.md): Apply credit memo amount to an invoice.

## What happens

- Creates credit application record
- Reduces credit memo remaining balance
- Reduces invoice open balance
- Updates order status if invoice is fully paid

## Constraints

- Amount must not exceed remaining balance
- Invoice must belong to same customer
- Invoice must have outstanding balance
- Currency must match

## Get credit applications

 - [GET /credit-memos/{id}/applications](https://docs.mvmnt.io/apis/openapi/credit-memos/getcreditmemoapplications.md): List all invoice applications for a credit memo.

## Unapply credit from invoice

 - [DELETE /credit-memos/{creditMemoId}/applications/{applicationId}](https://docs.mvmnt.io/apis/openapi/credit-memos/unapplycreditmemo.md): Remove a credit application from an invoice.

## What happens

- Application record is deleted
- Credit memo remaining balance increases
- Invoice open balance increases
- Order status may revert if invoice becomes unpaid