Purchase Invoices
List Purchase Invoices
Get a paginated list of purchase invoices with filtering and sorting.
Create Purchase Invoice
Create a new purchase invoice linked to a purchase order.
Bulk Delete Purchase Invoices
Bulk delete purchase invoices by IDs or by applying filters.
Get Purchase Invoice
Get a single purchase invoice with full detail including lines, financial lines, payments, and accounting transaction.
Update Purchase Invoice
Update an existing purchase invoice. All fields are optional on update (uses sometimes validation).
Delete Purchase Invoice
Delete a single purchase invoice. Also unlinks any associated financial lines.
Get Line Items
Get the line items for a purchase invoice (used for expand row in the list view).
Get Shipment Prefill (From Invoice)
Build the prefill payload used by the Create Inbound Shipment from Invoice form.
List Inbound Shipments for Invoice
List all inbound shipments that were created from this purchase invoice. Used by the Inbound Shipments traceability panel on the invoice detail page.
Print Purchase Invoice PDF
Generate and stream a PDF of the purchase order invoice.
Reset Invoice Due Date to Term
Discards a manually-overridden due date on a supplier invoice and re-derives it from the effective payment term (the invoice's own term, else the linked purchase order's term, else the supplier default). The response's `due_date_source` returns to `derived` (or `none` when no term is resolvable).
Bulk Archive Purchase Invoices
Bulk archive purchase invoices.
Bulk Unarchive Purchase Invoices
Bulk unarchive purchase invoices.
Archive Purchase Invoice
Archive a single purchase invoice.
Unarchive Purchase Invoice
Unarchive a single purchase invoice.
Check Deletability
Check whether purchase invoices can be deleted. Invoices are always deletable.
Create Custom (Fees Received) Invoice
Create a custom purchase invoice for fees (e.g., freight, handling). Fires events to recalculate FIFO layers and product averages.
Approve Purchase Invoice
Approve a purchase invoice that requires approval.
Reject Purchase Invoice
Reject a purchase invoice that requires approval.
Resubmit Purchase Invoice for Approval
Re-submit a rejected invoice back to pending approval status.
Generate Accounting Transaction
Generate or regenerate the accounting transaction for a purchase invoice.
Sync PO Price From Invoice Line
Push the unit_price from a single invoice line up to the linked PO line's amount, then re-evaluate the invoice's approval status.
Sync PO Prices Bulk
Sync PO line prices from many invoice lines on a single invoice in one request, then re-evaluate the invoice's approval status once at the end.
Get Variance Report
Get paginated price variance data comparing invoice prices vs. PO prices.
Get Three-Way Match Data
Get three-way match data for an invoice: compares PO quantities/prices, received quantities, and invoice quantities/prices.
Variance Resolution Preview
Preview over-billed quantities per PO line so the UI can prefill a 'Resolve with vendor credit' dialog.
Resolve with Vendor Credit
Resolve an over-billed purchase invoice by issuing a vendor credit for the over-billed quantities and auto-allocating it against the bill.
List Activity Log Entries
Get paginated activity log entries for a purchase invoice.
Export Purchase Invoices
Export purchase invoices as XLSX or CSV.
Get Payables Aging Report
Supplier payables aging report over outstanding (unpaid and partially paid) purchase invoices and, optionally, bills.
Download Due-Date Calendar Event
Download a single-event iCalendar (.ics) file for the invoice's payment due date, suitable for importing into Outlook, Apple Calendar, or any calendar app.
List Notes
Get paginated notes for a purchase invoice, ordered by newest first.
Add Note
Add a note to a purchase invoice.
Toggle Note Pin
Toggle the pinned state of a note on a purchase invoice.
Delete Note
Delete a note from a purchase invoice.
List Payments
List all payments for a purchase invoice.
Create Payment
Record a payment against a purchase invoice.
Get Payment
Get a single payment for a purchase invoice.
Update Payment
Update a payment on a purchase invoice. All fields are optional on update.
Delete Payment
Delete a payment from a purchase invoice.
Download Import Template
Download an XLSX import template with headers, sample data, field guide, and reference data from the tenant's account.
Validate Import Data
Validate mapped import data and return a grouped preview. No side effects — safe to call repeatedly.
Execute Import
Execute the import — create purchase invoices from validated data.
List Purchase Invoice Attachments
List all file attachments on a purchase invoice, ordered oldest first.
Upload Purchase Invoice Attachment
Upload a file attachment to a purchase invoice. Send as `multipart/form-data` with a `file` field and an optional `category` field.
Delete Purchase Invoice Attachment
Delete an attachment from a purchase invoice. Removes both the stored file and its record, including any OCR extraction history for the attachment.
Download Purchase Invoice Attachment
Download the attachment file. The response is a file stream (not JSON) with `Content-Disposition: attachment` and the original file name, so clients save it as a download. The `Content-Type` matches the stored file type (e.g. `application/pdf`).
View Purchase Invoice Attachment
Stream the attachment file for inline display. Identical to the download endpoint except the response uses `Content-Disposition: inline`, so browsers render PDFs and images in the tab instead of saving them.
Preview Payment Approval Routing
Preview where a bill payment request of a given amount would be routed, before submitting it. Returns the routing mode and the resolved payer (if the amount routes directly to a single payer).
Submit Bill Payment for Approval
Submit a bill's outstanding balance for payment authorization. Routes the request to the appropriate approval chain, designated payer, or auto-approves it depending on configuration and amount.
Approve and Pay Bill
Approve a pending bill payment request and record the payment in a single step. The payment amount defaults to the bill's outstanding balance when omitted.
Approve Bill Payment
Approve a pending bill payment request without recording a payment. Use this when authorization and payment are handled separately.
Record Bill Payment
Record a payment against a bill whose payment has already been approved.
Send Invoice Payment Remittance
Email a remittance advice to the supplier for a bill that has already been paid. The message confirms the payment and can include selected invoice documents as attachments; supplier banking details are never included. A recorded payment is required first — sending before any payment is recorded returns 422. On success the bill's `remittance_sent_at` timestamp is stamped.
Scan Invoice Payment Proof
Scan a payment proof — a bank transfer confirmation image or PDF — and return the payment details read from it, used to pre-fill the record-payment form. Nothing is stored: the file is only persisted later (as a payment-proof attachment) when the payment is actually recorded.
Reject Bill Payment Request
Reject a pending bill payment request.
Withdraw Bill Payment Request
Withdraw an untouched pending payment request, returning the bill to the not-requested state. Only allowed while no approval step has been actioned.
List Bill Payment Approval Steps
List the payment approval steps for a bill, in level order. Each step represents one level of the multi-step approval chain.
Approve Bill Payment Approval Step
Approve the current pending step in a bill's payment approval chain. When the final step is approved the bill's payment becomes approved.
Reject Bill Payment Approval Step
Reject the current pending step in a bill's payment approval chain, rejecting the overall payment request.
List Purchase Invoice Approval Levels
List the configured bill payment approval levels, in level order. Levels define the multi-step approval chain and the amount threshold at which each level applies.
Create Purchase Invoice Approval Level
Create a bill payment approval level.
Update Purchase Invoice Approval Level
Update a bill payment approval level. All fields are optional; only supplied fields are changed.
Delete Purchase Invoice Approval Level
Delete a bill payment approval level.
List Supplier Payments
Paginated list of supplier payments, newest first.
Record Supplier Payment
Record one supplier-level payment allocated across multiple open invoices. All-or-nothing: the run is rejected (422) if any allocation exceeds its invoice's outstanding balance, targets another supplier's invoice, or repeats an invoice.
Get Allocation Suggestion
The supplier's open (unpaid or partially paid) invoices with a suggested allocation of the given total, distributed oldest due date first — the prefill for a payment run.