fbpx

Invoice Settings

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

NameDescription
AccountNameUser’s customized name for account
CreditNoteNameUser’s customized name for credit note. When you create a invoice for a negative amount, this is the title it will have.
CustomerReferenceNameUser’s customized name for customer reference. This is often used for purchase order numbers
DescriptionNameUser’s customized name for invoice description field
DueDateNameUser’s customized name for due date of an invoice
InvoiceDateNameUser’s customized name for invoice date
InvoiceNameUser’s customized name of invoice
InvoiceNumberNameUser’s customized name for invoice number field
InvoiceTotalNameUser’s customized name for invoice total field
IsEmailSentIconIncludedSetting for whether an icon on sales page should be shown based on whether email has been sent for an invoice
IsInvoiceCustomerReferenceShownOnListSetting for whether customer reference field needs to be displayed or not on invoice list page
IsQuantityFieldRemovedSetting for whether to remove quantity fields from invoice
NetAmountNameUser’s customized name for net amount field
QuantityNameUser’s customized name for quantity field
RateNameUser’s customized name for rate field
TotalNameUser’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"
}

See how KashFlow works with your business and your books