v1

latestOpenAPI 3.1.0Proprietary2026-08-06177398877.4 KB
Bill Payments

Send remittance advice email

Email the remittance advice to the carrier or vendor.

Uses the recipient's default email from their profile.

post/bill-payments/{id}/send-remittance

Path parameters

idstring required

Resource ID (UUID) or client key

Query parameters

by'id' | 'key'

Specify lookup type for faster retrieval. If omitted, defaults to looking up by ID first, then falls back to client key if not found. Use by=key when you know you're providing a client key for best performance.

Request body

toEmailstring email

Override recipient email

ccEmailsstring[]

CC recipients

messagestring

Additional message in email body

Response

Remittance advice sent successfully

successboolean
sentTostring email