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.

Deleting a purchase payment or a note cannot be undone.

At a glance

Endpoint	Method	Path	What it does
List purchase payments	GET	/purchase_payments	Returns one page of purchase payments.
Create a purchase payment	POST	/purchase_payments	Records a payment to a supplier and returns it under purchase_payment.
Delete a purchase payment	DELETE	/purchase_payments/{purchase_payment_id}	Deletes a purchase payment. Nothing comes back.
Retrieve a purchase payment	GET	/purchase_payments/{purchase_payment_id}	Returns one purchase payment under purchase_payment.
Update a purchase payment	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	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	GET	/purchase_payments/{purchase_payment_id}/notes	Returns one page of the notes on a purchase payment.
Create a purchase payment note	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	GET	/purchase_payments/{purchase_payment_id}/notes/{pp_note_id}	Returns one note of a purchase payment under note.
Delete a purchase payment note	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	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	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	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	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	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. 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.