Skip to main content

Send Invoice Payment Remittance

POST 
/api/purchase-invoices/:purchaseInvoice/payment-request/send-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.

Required scope: purchase-orders:write

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Authentication: Requires Bearer token.

Fields:

  • to (required, email): Recipient email address.
  • cc (optional, array of email, max 10): Additional recipients.
  • subject (required, string, max 255): Email subject.
  • note (optional, string, max 2000): Message added to the remittance advice body.
  • attachment_ids (optional, array of integer): IDs of invoice attachments to include with the email.

Delivery is synchronous: the request returns only after the mail transport has accepted the message, and remittance_sent_at is stamped only then (remittance_status = sent; any earlier failure is cleared). If the transport rejects it (or an attachment cannot be read), remittance_sent_at is not updated and the response is a 422 whose error explains why — the failure is also recorded on the document as remittance_status = failed with remittance_failed_at and the transport's reason in remittance_error, and stays there until a later send succeeds. remittance_sent_at always holds the last successful delivery, so read remittance_status to know how the newest send went. Correct the problem and send again.

Request​

Responses​

OK

Response Headers
    Content-Type