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/advanced |
Method(s): | get |
Response Formats: | JSON, XML |
Description: | This method allows you to retrieve list of user’s advanced settings. |
Response elements
| Name | Type | Description |
|---|---|---|
| AutomaticCreditControlEnabled | Boolean | Automatic credit control enabled for customers and invoices |
| ApplyManualDiscount | Boolean | Discount on invoices to be applied manually or automatically |
| DefaultNominalCode | Numeric | User’s default sales type |
| DefaultVATRate | Decimal | User’s default VAT rate |
| DropboxSettings | DropboxSettings | Contains Dropbox settings |
| JournalEnabled | Boolean | Whether journal is enabled or not |
| DateFormat | String | Date format either in US or UK format |
| PDFInNewWindow | Boolean | Pdf embedded in same window or to be opened in new window |
| ProjectsEnabled | Boolean | Whether project is enabled or not |
| QuoteText | String | User’s customized name of quote |
| ShowQuoteTotal | Boolean | Whether total to be displayed at bottom of quote list or not |
| TransactionLock | Boolean | Whether transaction lock enabled or not |
| TransactionLockDate | Date | Transaction lock date. User won’t be able to make changes to his quotes or invoices prior to this date. |
| UserId | Numeric | User’s unique id |
| VATText | String | User’s customized name of VAT |
| VATRegistered | Boolean | User’s VAT registration status |
| ViaPostEnabled | Boolean | Whether Via Post enabled or not. Via Post is a third party feature which lets you send physical post online. |
| AutoCalculateVAT | Boolean | AutoCalculateVAT value indicates way of tax due calculation.Folloing are the ways : 0 – Calculate the tax due on total value of the line amount (qty * rate) 1 – Calculate the tax due on a single item and then multiply it by the quantity. |
Dropbox settings response elements
| Name | Type | Description |
|---|---|---|
| UserId | Numeric | Account user identity |
| Token | String | Dropbox token |
| Secret | String | Dropbox secret key |
| IsEnabledForCustomers | Boolean | Determines whether files can be uploaded to Dropbox for customers |
| IsEnabledForSuppliers | Boolean | Determinies whether files can be uploaded to Dropbox for suppliers |
| IsEnabledForProjects | Boolean | Determines whether files can be uploaded to Dropbox for projects |
| IsEnabledForInvoices | Boolean | Determines whether files can be uploaded to Dropbox for invoices |
| IsEnabledForQuotes | Boolean | Determines whether files can be uploaded to Dropbox for quotes |
| IsEnabledForJournals | Boolean | Determines whether files can be uploaded to Dropbox for journals |
| IsEnabledForBankAccounts | Boolean | Determines whether files can be uploaded to Dropbox for bank accounts |
| IsGoogleViewEnabled | Boolean | Determines whether files uploaded to Dropbox can be viewed using Google view |
| IsEnabledForBankTransactions | Boolean | Determines whether files can be uploaded to Dropbox for bank transactions |
| IsEnabledForPurchases | Boolean | Determines whether files can be uploaded to Dropbox for purchases |
Payment Processor Details response elements
| Name | Type | Description |
|---|---|---|
| PaymentProcessorName | String | Name of the payment processor setup on the user account |
| PaymentProcessorLogo | String | Location of the payment processor logo |
| CardTypes | Array | List of card type containing display name and value (used to send when sending a cardPayment request) |
GET Operation
Returns list of different advance account settings for user.To get list of user advance account settings –
URL : /settings/advanced
Example response for GET of list of user advanced settings
{
"AutomaticCreditControlEnabled": true
"ApplyManualDiscount": true,
"AutoCalculateVAT": false,
"Currency": {
"Code": null,
"DisplaySymbolOnRight": false,
"ExchangeRate": 0,
"Name": null,
"Symbol": "£ "
},
"DateFormat": "DD\/MM\/YYYY",
"DefaultNominalCode": 4908,
"DropboxSettings": {
"Secret": "uzy9zfd8uplh78i",
"Token": "p118hjt4r9aeiui",
"UserId": "9020579",
"IsEnabledForBankAccounts": true,
"IsEnabledForBankTransactions": false,
"IsEnabledForCustomers": true,
"IsEnabledForInvoices": true,
"IsEnabledForJournals": false,
"IsEnabledForProjects": false,
"IsEnabledForQuotes": true,
"IsEnabledForReceipts": true,
"IsEnabledForSuppliers": false,
"IsGoogleViewEnabled": true
},
"JournalEnabled": true,
"ProjectsEnabled": true,
"PdfInNewWindow": true,
"QuoteText": "Quote",
"ShowQuoteTotal": false,
"TransactionLock": false,
"TransactionLockedDate": "2012-10-23 12:00:00",
"UserId": 13408,
"VATName": "VAT",
"VATRegistered": true,
"ViaPostEnabled": true
"PaymentProcessorDetails":{
"CardTypes":[
{
"Name":"Amex",
"Value":"AMEX-SSL"
},
{
"Name":"Visa",
"Value":"VISA"
},
{
"Name":"Visa Electron",
"Value":"UKE"
},
{
"Name":"Visa Delta",
"Value":"DELTA"
},
{
"Name":"MasterCard",
"Value":"MC"
},
{
"Name":"Solo",
"Value":"SOLO"
},
{
"Name":"Switch",
"Value":"SWITCH"
}
],
"PaymentProcessorLogo":"/images/cards_cardepdq.png",
"PaymentProcessorName":"BarclayCard ePDQ"
}
}