Light APIv1.0.0

API / Reference / Invoice Receivables

Send invoice email

POST https://api.light.inc/v1/invoice-receivables/{invoiceReceivableId}/send-email

Sends an invoice receivable email with the given email information

Only for an opened invoice (OPEN, PARTIALLY_PAID, PAYMENT_PENDING, PAID); otherwise INVOICE_RECEIVABLE_EMAIL_INVALID_STATE. The email is queued, so a 2xx means accepted, not delivered, and a delivery failure is not reported back. recipients must be non-empty and valid, and subject and customMessage may not contain HTML (INVOICE_RECEIVABLE_HTML_NOT_ALLOWED). Returns an empty body.

Authorization

Send one of these on every request. See Authentication for how to get credentials.

  • API key

    Basic authentication header of the form Basic <api_key>, where <api_key> is your api key.

  • Bearer token

Path parameters

  • invoiceReceivableId string · uuidrequired

Request body

application/json;charset=UTF-8

  • subject string

    Email subject line

  • replyTo string

    Reply-to email address

  • recipients array of string

    List of email addresses to send the invoice to

  • cc array of string

    List of email addresses to CC on the invoice email

  • customMessage string

    Optional custom message added to the invoice email body

Response

This endpoint returns no content.