Skip to main content
POST
/
sales
/
invoice
/
send
Send invoice email to contractor
curl --request POST \
  --url https://api.altera.co/sales/invoice/send \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "invoiceId": 123,
  "topic": "New invoice #123",
  "content": "<string>",
  "recipient": [
    "jsmith@example.com"
  ],
  "recipientFromSystem": true
}
'

Authorizations

​
Authorization
string
header
required

OpenApi Key created within Altera.app for a certain company

Body

application/json

Either recipient array or recipientFromSystem is required in order to send the e-mail. If not provided topic and/or content will be loaded dynamically from the company email configuration.

content accepts both raw text as well as HTML data that will be parsed and cleaned up before being added to the email content.

​
invoiceId
integer
required
​
topic
string
Maximum string length: 400
Example:

"New invoice #123"

​
content
string
Maximum string length: 8000
​
recipient
string<email>[]
​
recipientFromSystem
boolean

Response

200

OK