# Bill Payments

AP bill payment management operations.
Bill payments record payments made to carriers and vendors.


## Filter bill payments

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

## Common Filters

- By carrier: { "filter": { "carrierId": { "equalTo": "uuid" } } }
- By vendor: { "filter": { "vendorId": { "equalTo": "uuid" } } }
- By factor: { "filter": { "carrierFactorId": { "equalTo": "uuid" } } }
- By date range: { "filter": { "paymentDate": { "gte": "2025-01-01", "lte": "2025-01-31" } } }
- By method: { "filter": { "paymentMethodType": { "equalTo": "check" } } }

## Create a bill payment

 - [POST /bill-payments](https://docs.mvmnt.io/apis/openapi/bill-payments/createbillpayment.md): Record a payment for one or more carrier/vendor bills.

## What happens

- PaymentGroup record is created
- Payment applications are created for each bill
- Bill open balances are reduced
- Load/service status updates to PAID when fully paid

## Carrier factor payments

To pay a carrier's factor instead of the carrier directly,
specify carrierFactorId in the request.

## Overpayments

If allowOverpayment is true and payment exceeds bill totals,
a credit memo is automatically created for the difference.

## Get a bill payment

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

The response includes all payment applications and their associated bills.

## Update a bill payment

 - [PATCH /bill-payments/{id}](https://docs.mvmnt.io/apis/openapi/bill-payments/updatebillpayment.md): Update bill payment fields.

## Constraints

- Cannot change carrier factor after creation
- Can add/remove/update payment applications

## Updating applications

In the applications array:
- Include id to update an existing application
- Omit id and include billId to add a new application
- Set delete: true with id to remove an application

## Delete a bill payment

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

## What happens

- PaymentGroup record is deleted
- All Payment applications are deleted
- Bill open balances are restored
- Load/service status may revert if payment made them PAID

## Get bill payment applications

 - [GET /bill-payments/{id}/applications](https://docs.mvmnt.io/apis/openapi/bill-payments/getbillpaymentapplications.md): List all bills paid by this payment group.

## Generate remittance advice

 - [GET /bill-payments/{id}/remittance-advice](https://docs.mvmnt.io/apis/openapi/bill-payments/getbillpaymentremittanceadvice.md): Generate a remittance advice document for a bill payment.

## Formats

- PDF (default): Set Accept header to application/pdf
- JSON: Set Accept header to application/json

## Send remittance advice email

 - [POST /bill-payments/{id}/send-remittance](https://docs.mvmnt.io/apis/openapi/bill-payments/sendbillpaymentremittance.md): Email the remittance advice to the carrier or vendor.

Uses the recipient's default email from their profile.