This s a documentation page for our shiny new REST API - you weren't meant to find it. This API isn't ready for public use yet. We're chopping and changing it a LOT as we grow it. So if you build something that uses it then it's very likely to break in a future update. Don't say you weren't warned!
URL: | https://api.kashflow.com/v2/invoices/bulk/email |
Method(s): | post |
Response Formats: | JSON or XML |
Description: | This method allows you to email multiple invoices at one go. The request body should consist of List ( array ) of invoice numbers to be emailed. |
The response of this request is a list of status objects for each of the invoices mailed. Each status object has the fields mentioned in the following table:
| Name | Type | Description |
|---|---|---|
| Number | Number | Unique number of the invoice to be mailed |
| Sent | Boolean | True/False |
| Message | String | The descriptive message stating the reason for mail sending failure. |
Important features
1. Emails will be sent with the template setup for the customer invoiced.
2. If emails are successfully marked for sending, an invoice note is created and the email count for the invoice is automatically incremented.
3. Even if one or more invalid invoices are specified , email will be sent for the remaining valid invoices.
4. If one or more invoices have invalid customer email id, the processing of other invoices with valid email id’s will not be interrupted.
URL : /invoices/bulk/email
Example request
[ 101, 123, 2345, 65 ]
Example response
{
{
"Number": 101,
"Sent": true,
"Message": "Marked to send"
},
{
"Number": 123,
"Sent": false,
"Message": "Invalid invoice number"
},
{
"Number": 2345,
"Sent": false,
"Message": "Invalid customer email address"
},
{
"Number": 65,
"Sent": true,
"Message": "Marked to send"
}
}