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/internal/invoices?convertfrom={convertfrom}&retainafterconversion={retainafterconversion} |
Method(s): | post |
Response Formats: | JSON or XML |
Description: | This method allows you to create multiple invoices from other entities (quotes) at one go. The request body should consist of List ( array ) of entity numbers (quote numbers) to be converted. {convertfrom} is the source entity from which invoice is to be created, e.g, quote. This field is case-insensitive. {retainafterconversion} is a boolean field (true/false) which states whether source entities (quotes) need to be retained or not after conversion. If the above url is specifed without retainafterconversion parameter then quote will be retained based on user’s settings. |
POST Operation
Create multiple invoices from other entities (quotes) at one go from the of the quotes specified in the list of quote numbers.
Note: If any of the specified quote is invalid, API will respond with 400 status code accompanied by the list of invalid quotes number(s) in the message. In such a scenario, none of the valid quotes will be converted and you need to retry the operation after removing the invalid quotes from the list. On success an object containing the list of quote numbers sent and their corresponding newly created invoice numbers will be returned.
URL : /internal/invoices?convertfrom={convertfrom}&retainafterconversion={retainafterconversion}
Example request for POST
[ 101, 123, 2345, 65 ]
Response Status: 201 OK
Example response for POST
[{
“InvoiceNumber”: 2000,
“QuoteNumber”: 101
},
{
“InvoiceNumber”: 2001,
“QuoteNumber”: 123
},
{
“InvoiceNumber”: 2002,
“QuoteNumber”: 2345
},
{
“InvoiceNumber”: 2003,
“QuoteNumber”: 65
}]