---
title: "Prepare to apply a payment to an invoice. AI suggests the match, human confirms."
method: POST
path: "/api/v1/ar-prepare-apply-payment"
---

# Prepare to apply a payment to an invoice. AI suggests the match, human confirms.

`POST /api/v1/ar-prepare-apply-payment`

## Request

- Base URL: `https://app.ledgerbeaver.com` (the document declares no server; this is the origin it was published from)
- URL: `https://app.ledgerbeaver.com/api/v1/ar-prepare-apply-payment`
- Auth: API key in header `X-API-Key`

## Request body

- object
  - `companyId` string, required
  - `payment_id` string, required
  - `invoice_id` string, required
  - `amount` number, required
  - `payment_plan_id` string, required
  - `installment_id` string, required

## Response `200`

Successful response

- object
  - `content` object[]
    - `type` string
    - `text` string

## Other responses

- `401`: Unauthorized
- `429`: Rate limit exceeded

---

[API](https://skmtc.dev/ledgerbeaver/apis/ledgerbeaver-ai-api.md) · [All operations](https://skmtc.dev/ledgerbeaver/apis/ledgerbeaver-ai-api/llms.txt) · [OpenAPI document](https://skmtc.dev/ledgerbeaver/apis/ledgerbeaver-ai-api/revisions/cfd673927c46?raw)