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/settings/invoice |
Method(s): | get |
Response Formats: | JSON, XML |
Description: | This method allows you to retrieve all invoice related settings of user’s KashFlow account. |
Response Elements
| Name | Description |
|---|---|
| AccountName | User’s customized name for account |
| CreditNoteName | User’s customized name for credit note. When you create a invoice for a negative amount, this is the title it will have. |
| CustomerReferenceName | User’s customized name for customer reference. This is often used for purchase order numbers |
| DescriptionName | User’s customized name for invoice description field |
| DueDateName | User’s customized name for due date of an invoice |
| InvoiceDateName | User’s customized name for invoice date |
| InvoiceName | User’s customized name of invoice |
| InvoiceNumberName | User’s customized name for invoice number field |
| InvoiceTotalName | User’s customized name for invoice total field |
| IsEmailSentIconIncluded | Setting for whether an icon on sales page should be shown based on whether email has been sent for an invoice |
| IsInvoiceCustomerReferenceShownOnList | Setting for whether customer reference field needs to be displayed or not on invoice list page |
| IsQuantityFieldRemoved | Setting for whether to remove quantity fields from invoice |
| NetAmountName | User’s customized name for net amount field |
| QuantityName | User’s customized name for quantity field |
| RateName | User’s customized name for rate field |
| TotalName | User’s customized name for total field |
GET Operation
Returns invoice settings of user’s KashFlow account.URL : /settings/invoice
Example response for GET of invoicesettings
{
"AccountName": "Account",
"CreditNoteName": "Credit Note",
"CustomerReferenceName": "Purchase Order",
"DescriptionName": "Description",
"DueDateName": "Due Date",
"InvoiceDateName": "Invoice Date",
"InvoiceName": "Invoice",
"InvoiceNumberName": "Invoice Number",
"InvoiceTotalName": "Invoice Total",
"IsEmailSentIconIncluded": false,
"IsInvoiceCustomerReferenceShownOnList": false,
"IsQuantityFieldRemoved": false,
"NetAmountName": "Total Net Amount",
"QuantityName": "Qty",
"RateName": "Rate",
"TotalName": "Total"
}