POST

Send a receipt note by email

Scope: sales:invoices.write https://api.alladdin.com/api/v2/receipt-notes/{receiptNoteId}/send

Sends the receipt note by email to the contact using the template configured in your account settings.
You can optionally specify recipient email addresses, subject, and message body.

Parameters

Path parameters

receiptNoteId string required

Receipt Note ID (24-char hex ObjectId)

Request body

object emails[] string[] required

List of recipient email addresses

subject string | null optional

Custom email subject line

message string | null optional

Custom email body message

mail_template_id string | null optional

Identifier of the email template to use

cc[] string[] | null optional

List of CC email addresses

bcc[] string[] | null optional

List of BCC email addresses

Request

python

import requests

url = "https://api.alladdin.com/api/v2/receipt-notes/{receiptNoteId}/send"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Accept": "application/json",
}

payload = {
    "emails": [
        "string"
    ],
    "subject": "string",
    "message": "string",
    "mail_template_id": "string",
    "cc": [
        "string"
    ],
    "bcc": [
        "string"
    ]
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

Responses

Response

json

{
  "status": "sent"
}

Success responses

200 Receipt note sent application/json object status string required

Confirmation status

Error responses

400 Bad request application/json 401 Invalid or missing API key application/json 403 Insufficient permissions application/json 404 Receipt note not found application/json 429 Rate limit exceeded application/json 500 Internal server error application/json object type string title string status integer detail string

← PreviousCreate a payment for a receipt note →

Next →Update a receipt note →

Alladdin