A request for sending a document or report by email. This API call is synchronous (returns when email is sent) and can take a few seconds to complete. Sending will be handled by the server. Email subject, sender's address, message content and attachment format (HTML/PDF) will be decided serverside and are configurable from Erply settings.
Parameter name | Description | Possible value | Required |
---|---|---|---|
id | ID of the document. For invoices, their numeric identifier. In the future, longer identifying strings may be used for printing reports. | string | yes |
type | Document category - SALESDOCUMENT or PURCHASEDOCUMENT. | string | yes |
E-mail address of the receiver. May include several addresses, separated by commas or spaces. | string | yes | |
senderName | string | ||
senderEmail | If unspecified, invoice creator's email address or company's general email address will be used. | string | |
message | If unspecified, default email message text for this particular document type will be used. | string |