# Payments

AR payment management operations.
Payments represent received customer payments applied to invoices.


## Filter payments

 - [POST /payments/filter](https://docs.mvmnt.io/apis/openapi/payments/filterpayments.md): Search for AR payments using filter criteria.

## Common Filters

- By customer: { "filter": { "customerId": { "equalTo": "uuid" } } }
- By invoice: { "filter": { "invoiceId": { "equalTo": "uuid" } } }
- By date range: { "filter": { "paymentDate": { "greaterThanOrEqualTo": "2025-01-01" } } }
- By method: { "filter": { "paymentMethodType": { "equalTo": "check" } } }

## Create a payment

 - [POST /payments](https://docs.mvmnt.io/apis/openapi/payments/createpayment.md): Record a customer payment applied to invoices.

## What happens

- Payment record is created
- Specified amounts are applied to invoices
- Invoice/order status updated to PAID when fully paid
- Overpayment creates a credit memo automatically

## Validations

- Payment date must be >= invoice date for all applied invoices
- Application amounts must not exceed invoice open balances
- Customer must match invoice customer

## Get a payment

 - [GET /payments/{id}](https://docs.mvmnt.io/apis/openapi/payments/getpayment.md): Retrieve a payment by ID.

The response includes all invoice applications and credit applications.

## Update a payment

 - [PATCH /payments/{id}](https://docs.mvmnt.io/apis/openapi/payments/updatepayment.md): Update payment details or reassign invoice applications.

## What happens

- Payment fields are updated
- Invoice applications are replaced if provided
- Order statuses are recalculated

## Note

Updating applications replaces all existing applications.
Include all desired applications in the request.

## Delete a payment

 - [DELETE /payments/{id}](https://docs.mvmnt.io/apis/openapi/payments/deletepayment.md): Delete a payment and remove all invoice applications.

## What happens

- Payment record is deleted
- Invoice applications are removed
- Order statuses revert if needed (PAID → UNPAID)

## Note

This action cannot be undone. Consider voiding instead
if you need to maintain a record.

## Get payment applications

 - [GET /payments/{id}/applications](https://docs.mvmnt.io/apis/openapi/payments/getpaymentapplications.md): List all invoice applications for a payment.