Purchase refunds

Record refunds from suppliers against purchase credit notes, and read, update and delete purchase refunds.

A purchase refund records money a supplier pays back against a purchase credit note. These endpoints record a refund from a credit note and read, update and delete refunds. This area has 5 endpoints, each available in all seven SDKs.

Deleting a purchase refund cannot be undone.

At a glance

Endpoint	Method	Path	What it does
List purchase refunds	GET	/purchase_refunds	Returns one page of purchase refunds.
Retrieve a purchase refund	GET	/purchase_refunds/{purchase_refund_id}	Returns one purchase refund under purchase_refund.
Create a purchase refund from a purchase credit note	POST	/purchase_credit_notes/{purchase_credit_note_id}/purchase_refunds	Records a refund from a supplier against a purchase credit note and returns it under purchase_refund.
Update a purchase refund	PATCH	/purchase_refunds/{purchase_refund_id}	Changes a refund’s reference, note, date or custom attributes and returns it under purchase_refund.
Delete a purchase refund	DELETE	/purchase_refunds/{purchase_refund_id}	Deletes a purchase refund. 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

• A purchase refund is created from a purchase credit note. Post it to /purchase_credit_notes/{purchase_credit_note_id}/purchase_refunds.
• Every write body is wrapped in purchase_refund.
• payment_method is the reference of one of the supplier’s payment methods. Take it from the reference of an entry in the supplier account’s payment methods, under account.payment_methods.
• The update takes only alternate_date, reference, note and custom_attributes. Any other key returns 400, and the amount cannot change.
• The update and delete address a refund by its id. Its uuid does not match.