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/supplierstatements/bulk/email?startdate={startdate}&enddate={enddate}&excludepaidpurchases={excludepaidpurchases}&filterby={filterby} |
Method(s): | post |
Response Formats: | JSON or XML |
Description: | This method allows you to email multiple supplier statements at one go. The request body should consist of List ( array ) of supplier codes for which statements need to be emailed. {startdate} and {enddate} are the dates between which supplier purchases are taken into consideration in the statement to be mailed. These dates need to be specified in yyyymmdd format. If {startdate} and {enddate} are not supplied, statement for last three months is mailed. If {filterby} parameter is set to ‘All’, then irrespective of the date specified, all purchases for the supplier will be enlisted in the statement. {excludepaidpurchases} is a numeric field which when set to 1, excludes paid purchases from the statement. 0 is the default value for this parameter. |
The response of this request is a list of status objects for each of the supplier statement mailed. Each status object has the fields mentioned in the following table:
| Name | Type | Description |
|---|---|---|
| SupplierCode | String | Unique code of the supplier whose statement is to be mailed |
| Sent | Boolean | True/False |
| Message | String | The descriptive message stating the reason for mail sending failure. |
Important features
1. If emails are successfully marked for sending, a supplier note is created.
2. Even if one or more invalid supplier(s) are specified, email will be sent for the remaining valid supplier(s).
3. If one or more supplier(s) have invalid email id, the processing of other supplier(s) with valid email id’s will not be interrupted.
URL : /supplierstatements/bulk/email?startdate=20130101&enddate=20131010&excludepaidpurchases=1&filterby=all
Example request
[ "101", "SUP123", "SUP2345", "SUP65" ]
Example response
{
{
"SupplierCode": "101",
"Sent": true,
"Message": "Marked to send"
},
{
"SupplierCode": "SUP123",
"Sent": false,
"Message": "Invalid customer code"
},
{
"SupplierCode": "SUP2345",
"Sent": false,
"Message": "Invalid customer email address"
},
{
"SupplierCode": "SUP65",
"Sent": true,
"Message": "Marked to send"
}
}