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.
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.
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Unprocessable Entity
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.