> ## Documentation Index
> Fetch the complete documentation index at: https://exsited.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Purchase payments

> Record, update, delete and read payments to suppliers, with their notes, files and the purchase credit notes they raise.

A purchase payment records money paid to a supplier against purchase invoices. These endpoints record, update, delete and read purchase payments, list the purchase credit notes a payment raised, and manage payment notes and their files. This area has 15 endpoints, each available in all seven SDKs.

> [!WARNING]
>
> **Deleting a purchase payment or a note cannot be undone.**

## At a glance

| Endpoint | Method | Path | What it does |
| - | - | - | - |
| [List purchase payments](https://exsited.mintlify.site/api-reference/purchase-payments/list-purchase-payments.md) | GET | `/purchase_payments` | Returns one page of purchase payments. |
| [Create a purchase payment](https://exsited.mintlify.site/api-reference/purchase-payments/create-a-purchase-payment.md) | POST | `/purchase_payments` | Records a payment to a supplier and returns it under `purchase_payment`. |
| [Delete a purchase payment](https://exsited.mintlify.site/api-reference/purchase-payments/delete-a-purchase-payment.md) | DELETE | `/purchase_payments/{purchase_payment_id}` | Deletes a purchase payment. Nothing comes back. |
| [Retrieve a purchase payment](https://exsited.mintlify.site/api-reference/purchase-payments/retrieve-a-purchase-payment.md) | GET | `/purchase_payments/{purchase_payment_id}` | Returns one purchase payment under `purchase_payment`. |
| [Update a purchase payment](https://exsited.mintlify.site/api-reference/purchase-payments/update-a-purchase-payment.md) | PATCH | `/purchase_payments/{purchase_payment_id}` | Changes fields of a purchase payment and returns it under `purchase_payment`. |
| [Create a purchase payment for a purchase invoice](https://exsited.mintlify.site/api-reference/purchase-payments/create-a-purchase-payment-for-a-purchase-invoice.md) | POST | `/purchase_invoices/{purchase_invoice_id}/purchase_payments` | Records a payment against one purchase invoice and returns it under `purchase_payment`. |
| [List a purchase payment's notes](https://exsited.mintlify.site/api-reference/purchase-payments/list-a-purchase-payments-notes.md) | GET | `/purchase_payments/{purchase_payment_id}/notes` | Returns one page of the notes on a purchase payment. |
| [Create a purchase payment note](https://exsited.mintlify.site/api-reference/purchase-payments/create-a-purchase-payment-note.md) | POST | `/purchase_payments/{purchase_payment_id}/notes` | Adds a note, with an optional file, to a purchase payment and returns it under `note`. |
| [Retrieve a purchase payment note](https://exsited.mintlify.site/api-reference/purchase-payments/retrieve-a-purchase-payment-note.md) | GET | `/purchase_payments/{purchase_payment_id}/notes/{pp_note_id}` | Returns one note of a purchase payment under `note`. |
| [Delete a purchase payment note](https://exsited.mintlify.site/api-reference/purchase-payments/delete-a-purchase-payment-note.md) | DELETE | `/purchase_payments/{purchase_payment_id}/notes/{pp_note_id}` | Deletes a note from a purchase payment. Nothing comes back. |
| [List a purchase payment note's files](https://exsited.mintlify.site/api-reference/purchase-payments/list-a-purchase-payment-notes-files.md) | GET | `/purchase_payments/{purchase_payment_id}/notes/{pp_note_id}/files` | Returns the files attached to one purchase payment note. |
| [Retrieve a purchase payment note file](https://exsited.mintlify.site/api-reference/purchase-payments/retrieve-a-purchase-payment-note-file.md) | GET | `/purchase_payments/{purchase_payment_id}/notes/{pp_note_id}/files/{file_id}` | Returns the details of one file attached to a purchase payment note, under `file`. |
| [List a purchase payment's purchase credit notes](https://exsited.mintlify.site/api-reference/purchase-payments/list-a-purchase-payments-purchase-credit-notes.md) | GET | `/purchase_payments/{purchase_payment_id}/purchase_credit_notes` | Returns one page of the purchase credit notes a purchase payment raised. |
| [Update a purchase payment note](https://exsited.mintlify.site/api-reference/purchase-payments/update-a-purchase-payment-note.md) | PATCH | `/purchase_payments/{purchase_payment_id}/notes/{pp_note_id}` | Replaces the text of a purchase payment note and returns it under `note`. |
| [Delete a purchase payment note file](https://exsited.mintlify.site/api-reference/purchase-payments/delete-a-purchase-payment-note-file.md) | DELETE | `/purchase_payments/{purchase_payment_id}/notes/{pp_note_id}/files/{file_id}` | Removes one attachment from a purchase payment note. Nothing comes back. |

## Before you call

Register your API credentials once when your app starts, as shown in
[Authentication](https://exsited.mintlify.site/authentication.md). Every SDK sample on these pages then gets its client in one line.
With cURL, send the access token in an `Authorization` header: `Authorization: Bearer $ACCESS_TOKEN`.

## Things to know

* **Every JSON write body is wrapped in `purchase_payment`, and amounts are decimal strings such as `"1.00"`.** The note create and update are multipart forms.
* **A payment needs `payment_method_applications`.** Each entry names a payment processor by `id` and an amount.
* **Paying more than the invoices take raises a purchase credit note.** It appears in the purchase credit notes list with this payment under `purchase_payment`.
* **The invoice-scoped create pays the invoice in the path.** Send only `payment_method_applications` to it.
* **Listings page by cursor.** Records are under `data`; pass `pagination.next_cursor` as `cursor` while `pagination.has_more` is `true`.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.