> ## 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 invoices

> Create, amend, cancel and read purchase invoices, their lines, notes, files, payments and credit note applications.

A purchase invoice is a bill from a supplier. These endpoints create, amend, cancel and reactivate purchase invoices, read their lines, payments and credit note applications, and manage their notes and attached files. This area has 22 endpoints, each available in all seven SDKs.

> [!WARNING]
>
> **Deleting a purchase invoice or one of its notes cannot be undone.** Cancel a purchase invoice instead if you may need it again.

## At a glance

| Endpoint | Method | Path | What it does |
| - | - | - | - |
| [List purchase invoices](https://exsited.mintlify.site/api-reference/purchase-invoices/list-purchase-invoices.md) | GET | `/purchase_invoices` | Returns one page of purchase invoices. |
| [Create a purchase invoice](https://exsited.mintlify.site/api-reference/purchase-invoices/create-a-purchase-invoice.md) | POST | `/purchase_invoices` | Creates a purchase invoice for a supplier and returns it under `purchase_invoice`. |
| [List notes across purchase invoices](https://exsited.mintlify.site/api-reference/purchase-invoices/list-notes-across-purchase-invoices.md) | GET | `/purchase_invoices/notes` | Returns one page of notes from every purchase invoice. |
| [Delete a purchase invoice](https://exsited.mintlify.site/api-reference/purchase-invoices/delete-a-purchase-invoice.md) | DELETE | `/purchase_invoices/{purchase_invoice_id}` | Deletes a purchase invoice. Nothing comes back. |
| [Retrieve a purchase invoice](https://exsited.mintlify.site/api-reference/purchase-invoices/retrieve-a-purchase-invoice.md) | GET | `/purchase_invoices/{purchase_invoice_id}` | Returns one purchase invoice with its lines under `purchase_invoice`. |
| [Amend a purchase invoice's lines](https://exsited.mintlify.site/api-reference/purchase-invoices/amend-a-purchase-invoices-lines.md) | POST | `/purchase_invoices/{purchase_invoice_id}/amend` | Adds or changes lines on a purchase invoice and returns it under `purchase_invoice`. |
| [Cancel a purchase invoice](https://exsited.mintlify.site/api-reference/purchase-invoices/cancel-a-purchase-invoice.md) | POST | `/purchase_invoices/{purchase_invoice_id}/cancel` | Cancels a purchase invoice and returns it under `purchase_invoice`. |
| [Retrieve a purchase invoice's information](https://exsited.mintlify.site/api-reference/purchase-invoices/retrieve-a-purchase-invoices-information.md) | GET | `/purchase_invoices/{purchase_invoice_id}/information` | Returns the header information of one purchase invoice under `purchase_invoice`. |
| [Update a purchase invoice's information](https://exsited.mintlify.site/api-reference/purchase-invoices/update-a-purchase-invoices-information.md) | PATCH | `/purchase_invoices/{purchase_invoice_id}/information` | Changes header fields of a purchase invoice and returns it under `purchase_invoice`. |
| [List a purchase invoice's lines](https://exsited.mintlify.site/api-reference/purchase-invoices/list-a-purchase-invoices-lines.md) | GET | `/purchase_invoices/{purchase_invoice_id}/lines` | Returns the lines of a purchase invoice under `purchase_invoice.lines`. |
| [List a purchase invoice's notes](https://exsited.mintlify.site/api-reference/purchase-invoices/list-a-purchase-invoices-notes.md) | GET | `/purchase_invoices/{purchase_invoice_id}/notes` | Returns one page of the notes on a purchase invoice. |
| [Create a purchase invoice note](https://exsited.mintlify.site/api-reference/purchase-invoices/create-a-purchase-invoice-note.md) | POST | `/purchase_invoices/{purchase_invoice_id}/notes` | Adds a note, with an optional file, to a purchase invoice and returns it under `note`. |
| [List a purchase invoice's credit note applications](https://exsited.mintlify.site/api-reference/purchase-invoices/list-a-purchase-invoices-credit-note-applications.md) | GET | `/purchase_invoices/{purchase_invoice_id}/purchase_credit_note_applications` | Returns one page of the purchase credit notes spent on a purchase invoice. |
| [List a purchase invoice's purchase payments](https://exsited.mintlify.site/api-reference/purchase-invoices/list-a-purchase-invoices-purchase-payments.md) | GET | `/purchase_invoices/{purchase_invoice_id}/purchase_payments` | Returns one page of the purchase payments made against a purchase invoice. |
| [Reactivate a purchase invoice](https://exsited.mintlify.site/api-reference/purchase-invoices/reactivate-a-purchase-invoice.md) | POST | `/purchase_invoices/{purchase_invoice_id}/reactivate` | Reactivates a cancelled purchase invoice and returns it under `purchase_invoice`. |
| [Retrieve a purchase invoice line](https://exsited.mintlify.site/api-reference/purchase-invoices/retrieve-a-purchase-invoice-line.md) | GET | `/purchase_invoices/{purchase_invoice_id}/lines/{purchase_invoice_line_uuid}` | Returns one line of a purchase invoice under `purchase_invoice.line`. |
| [Update a purchase invoice note](https://exsited.mintlify.site/api-reference/purchase-invoices/update-a-purchase-invoice-note.md) | PATCH | `/purchase_invoices/{purchase_invoice_id}/notes/{note_id}` | Replaces the text of a purchase invoice note and returns it under `note`. |
| [Retrieve a purchase invoice note](https://exsited.mintlify.site/api-reference/purchase-invoices/retrieve-a-purchase-invoice-note.md) | GET | `/purchase_invoices/{purchase_invoice_id}/notes/{note_id}` | Returns one note of a purchase invoice under `note`. |
| [Delete a purchase invoice note](https://exsited.mintlify.site/api-reference/purchase-invoices/delete-a-purchase-invoice-note.md) | DELETE | `/purchase_invoices/{purchase_invoice_id}/notes/{note_id}` | Deletes a note from a purchase invoice. Nothing comes back. |
| [List a purchase invoice note's files](https://exsited.mintlify.site/api-reference/purchase-invoices/list-a-purchase-invoice-notes-files.md) | GET | `/purchase_invoices/{purchase_invoice_id}/notes/{note_id}/files` | Returns the files attached to one purchase invoice note. |
| [Retrieve a purchase invoice note file](https://exsited.mintlify.site/api-reference/purchase-invoices/retrieve-a-purchase-invoice-note-file.md) | GET | `/purchase_invoices/{purchase_invoice_id}/notes/{note_id}/files/{file_id}` | Returns the details of one file attached to a purchase invoice note, under `file`. |
| [Retrieve a purchase invoice's credit note application](https://exsited.mintlify.site/api-reference/purchase-invoices/retrieve-a-purchase-invoices-credit-note-application.md) | GET | `/purchase_invoices/{purchase_invoice_id}/purchase_credit_note_applications/{application_id}` | Returns one purchase credit note application under `purchase_credit_note_application`. |

## 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_invoice`.** The cancel and reactivate calls take an empty object; the note create and update are multipart forms.
* **A new purchase invoice is `active`.** Cancelling sets it to `inactive` and reactivating sets it back to `active`.
* **The lines read is not a paged list.** It returns `purchase_invoice.lines`, and one line comes back as `purchase_invoice.line`.
* **A line can be addressed by its `id` or by that `id` written as a UUID.** For the UUID form, drop the prefix before `_` and add dashes in the 8-4-4-4-12 pattern. An unknown line returns `404`.
* **The credit note application read is not scoped to the invoice.** Any application can be read through any purchase invoice that exists.
* **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.