ALaltera-co
Sales

Send invoice email to contractor

Changed on

Send an invoice to its contractor by email. Configure the company global reply-to address in Settings > Sales > E-mail messages before calling this endpoint. HTTP 200 with result OK confirms that the email was queued; it does not confirm mailbox delivery. In QA, external recipient addresses are filtered out by sandbox routing. To verify actual receipt in QA, coordinate a recipient address in the @altera.co domain with Altera support. See the endpoint guide for template requirements and testing.

post/sales/invoice/send

Request

  • Base URL
    https://api.altera.co
  • URL
    https://api.altera.co/sales/invoice/send
  • Auth
    API key in header Authorization

Request body

OR

Example request

{
  "topic": "New invoice #123"
}

Response

Email accepted into the sending queue. This confirms enqueueing, not delivery to the recipient mailbox.

result'OK' required
data'Ok' required

Changes

  • 45544bcb4e8aRevision changes
    • breaking

      request body became required

    • warning

      the request property's min was set to 1.00

    • info

      added subschema #1 subschema #2 to the request body anyOf list

    • info

      the request property default value false was added

    • info

      the request property's maxLength was increased from 8000 to 900000

    • info

      added the media type application/json for the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

  • 64c683372c45Revision changes
    • info

      endpoint added