REST API Archive - IRIS KashFlow

SMTP Configurations

Dev Team — Tue, 15 Dec 2015 11:06:23 +0000

Parameters SMTP Configuration details Name Type Description ServerName String SMTP Configuration server name PortNumber SmallInt SMTP Configuration server using port number UserName String SMTP Configuration user name Password String SMTP Configuration email server password OverrideSMTPConfig Boolean Override SMTP config(if true, overrides KashFlow emails with SMTP configuration) Encryption Type String SMTP Configuration Encryption type (None, SSL […]

The post SMTP Configurations appeared first on IRIS KashFlow.

Referral

KashFlow — Mon, 15 Jun 2015 06:51:36 +0000

Example response of POST request, /referal/code "AFF2100060"

The post Referral appeared first on IRIS KashFlow.

Referral Settings

KashFlow — Fri, 12 Jun 2015 06:49:57 +0000

Response elements Name Type Description AddReferralCodeToAllOutCommunications Boolean Whether user wants to add his referral code to all his outbound communications RegistrationLink string Registration link containing user’s referral code. When this link is clicked user is navigated to KashFlow registration page and promocode is auto filled. Example response for GET of list of user referral settings […]

The post Referral Settings appeared first on IRIS KashFlow.

Integrations

KashFlow — Fri, 17 Apr 2015 07:25:33 +0000

Parameters Name Type Description Title String Name of the application. Description String Description of the application. Order Numeric Order in which the application is to be displayed. LogoFileName String Name of the Logo file name, used to dispaly logo. Page String The page in the application containing extra details about the application. Featured Boolean Indicates […]

The post Integrations appeared first on IRIS KashFlow.

VAT Moss Report

KashFlow — Tue, 13 Jan 2015 07:38:52 +0000

Parameters Name Type Description Id integer Id of VAT MOSS return report CreatedDate String Date when VAT Moss return report got created.for e.g.JSON Format :2012-06-28 12:00:00, XML Format : 2012-06-28 12:00:00 Period String Period for which VAT Moss return was submitted. e.g. Q1/2015 StartDate String Date when quarter starts EndDate String Date when quarter ends […]

The post VAT Moss Report appeared first on IRIS KashFlow.

VAT MOSS Returns

KashFlow — Mon, 12 Jan 2015 06:20:54 +0000

Parameters Name Type Description Id Numeric Unique vat moss return identifier Period String Period for which VAT Moss return was submitted. e.g. Q1 2015 Downloaded Boolean VAT Moss return downloaded or not. NetValueOfSales Decimal Net value of sales for a particular period NetVatDue Decimal Net value of vat due for a particular period Example response […]

The post VAT MOSS Returns appeared first on IRIS KashFlow.

Countries Vatrates

KashFlow — Wed, 24 Dec 2014 10:58:03 +0000

Parameters Name Type Description CountryCode String 2 digit ISO code for country CountryName String Name of Country Vat Rate details SuperReducedRate Numeric Array Reduced vatrate ReducedRate Numeric Array Reduced vatrate ParkingRate Numeric Array Parking vatrate StandardRate Numeric Array Standard vatrate

The post Countries Vatrates appeared first on IRIS KashFlow.

Bank Icons

KashFlow — Tue, 07 Oct 2014 14:37:58 +0000

Parameters Name Type Description Id Numeric Unique id assigned to a bank icon Name String Name of the Bank FileName Boolean File name of the logo image. These files will be located at “/images/bankIcons/<FileName>” Example response for GET of Bank Icons [{ "Id": 1, "FileName": "bank-of-scotland.png", "Name": "Bank of Scotland" }, { "Id": 2, "FileName": "", […]

The post Bank Icons appeared first on IRIS KashFlow.

Bank Transactions

KashFlow — Wed, 01 Oct 2014 17:26:54 +0000

Parameters Name Type Description AccountId Numeric Unique bank account identifier BFSTransactionId Numeric Bank Feeds transaction Id Comment String CustomerCode String Customer Code if it is an invoice payment CustomerId Numeric Customer Id if it is an invoice payment Id Numeric Id of the transaction PaidIn Numeric Money paid in MoneyOut Numeric Money paid out ProjectId […]

The post Bank Transactions appeared first on IRIS KashFlow.

Bank Transaction List

KashFlow — Tue, 23 Sep 2014 11:07:37 +0000

Parameters Name Type Description Account Id Numeric Unique bank identifier. TransactionId Numeric Unique transaction identifier. PaymentMethod Numeric Invoice/Purchase payment method identifier. Refer to Payment Methods API Number Numeric The number of invoice/purchase to which the transaction is to be assigned. URL : /bankaccounts/{accountId}/transactionlist {accountId} in the URL will be replaced by bank account id for […]

The post Bank Transaction List appeared first on IRIS KashFlow.

Bank Reconciliation

KashFlow — Mon, 04 Aug 2014 13:03:15 +0000

Reconciliation header parameters Name Type Description Id Numeric Unique reconciliation identifier. StartDate Date Reconciliation start date. EndDate Date Reconciliation end date. StartBalance Numeric Reconciliation start balance. EndBalance Numeric Reconciliation end balance. Status String Status of the reconciliation. Status message can be one of the values mentioned in the following table: Status InComplete Complete Overlaps_Previous ReconcileDate_Changed […]

The post Bank Reconciliation appeared first on IRIS KashFlow.

Customer Custom Fields

KashFlow — Thu, 17 Jul 2014 10:57:01 +0000

Parameters Name Type Description CustomTextBoxes Array list of names assigned to custom textboxes CustomCheckBoxes Array list of names assigned to custom checkboxes Example response for GET of credit list { "CustomCheckBoxes": ["check1", "check2"], "CustomTextBoxes": ["field1", "fields2"] }

The post Customer Custom Fields appeared first on IRIS KashFlow.

Pdf Themes

KashFlow — Mon, 14 Jul 2014 10:45:08 +0000

Parameters Name Type Description Id Numeric Unique id assigned to each pdf theme Name String Name of the pdf theme Example response for GET of pdf themes [{ "Id": 9, "Name": "Clean" }, { "Id": 228726, "Name": "Default" }, { "Id": 228727, "Name": "System" }]

The post Pdf Themes appeared first on IRIS KashFlow.

Business Sources

KashFlow — Fri, 11 Jul 2014 09:59:35 +0000

Parameters Name Type Description Id Numeric Unique id assigned to each source Name String Name of the source Example response for GET of source list [{ "Id": 9, "Name": "Other" }, { "Id": 228726, "Name": "Website" }, { "Id": 228727, "Name": "Newspaper" }, { "Id": 228728, "Name": "Google" }]

The post Business Sources appeared first on IRIS KashFlow.

Envelope

KashFlow — Thu, 03 Jul 2014 07:10:23 +0000

URL : /documents/customers/{guid}?envelopetype={envelopetype}

The post Envelope appeared first on IRIS KashFlow.

Advance Payment List

KashFlow — Fri, 27 Jun 2014 07:21:35 +0000

Parameters Name Type Description Id Numeric Unique identifier for each payment Amount Numeric Payment amount Date Date Date on which payment is done Comment String Note for this record Example response for GET of credit list [{ "Amount": 46.0000, "Comment": "Advance Payment on Invoice Test #1111111435", "Date": "2013-06-07 12:00:00", "Id": 23438824 }, { "Amount": 100.0000, […]

The post Advance Payment List appeared first on IRIS KashFlow.

Mandates

KashFlow — Thu, 26 Jun 2014 13:05:36 +0000

Parameters Name Type Description Amount Numeric Amount for the mandate which can be used for direct debit. This amount is the maximum amount that can be used within a duration specified in AmountValidity property. Title String Title of the mandate Description String Description of the mandate. AmountValidity String AmountValidity is the period in which specified […]

The post Mandates appeared first on IRIS KashFlow.

Alert

KashFlow — Fri, 20 Jun 2014 08:10:50 +0000

Example response for PUT of alert [{ "Id": 1, "Title": "Scheduled Maintenance", "Text": "KashFlow will be temporarily unavailable from 02:00 AM to 05:00 AM on 20/07/2014 due to maintentance." }, { "Id": 2, "Title": "Important Notice", "Text": "We further aplogise for not being able to print more than one document, this is top of our […]

The post Alert appeared first on IRIS KashFlow.

Data Import

KashFlow — Wed, 11 Jun 2014 13:19:21 +0000

URL : /dataimport Example request for POST { "SubscriberImportAccountId" : 6557 } Response 201

The post Data Import appeared first on IRIS KashFlow.

Subscription

KashFlow — Wed, 19 Feb 2014 10:56:54 +0000

To GET the count of invoices created for the current active subscription – URL : /invoicecountforsubscriptioncycle Example response for GET of invoice count 20

The post Subscription appeared first on IRIS KashFlow.

Supplier Statement Bulk Email

KashFlow — Tue, 07 Jan 2014 12:05:15 +0000

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 […]

The post Supplier Statement Bulk Email appeared first on IRIS KashFlow.

Archive suppliers

KashFlow — Tue, 07 Jan 2014 10:51:49 +0000

URL : /internal/suppliers/archive Example request for PUT [ "Code1", "Code2", "Code3", "Code4" ]

The post Archive suppliers appeared first on IRIS KashFlow.

Recurring Purchases

KashFlow — Tue, 17 Dec 2013 11:26:23 +0000

Parameters Name Type Description Number Numeric Unique number given to a recurring purchase Description String Description of the recurring purchase PurchaseDetails Object Information related to the purchase which will be created at scheduled interval PaymentDetails Object Information related to the payment details of the recurring purchase. The fields of this object are same as purchase […]

The post Recurring Purchases appeared first on IRIS KashFlow.

Archive customers

KashFlow — Tue, 10 Dec 2013 07:16:58 +0000

URL : /internal/customers/archive Example request for PUT [ "Code1", "Code2", "Code3", "Code4" ]

The post Archive customers appeared first on IRIS KashFlow.

Customer List

KashFlow — Tue, 10 Dec 2013 06:04:48 +0000

URL : /customerlist Example request for DELETE of customerlist [ "CA101", "CUST123", "2345", "CUST" ]

The post Customer List appeared first on IRIS KashFlow.

Amazon Files

KashFlow — Tue, 03 Dec 2013 05:40:51 +0000

Example response for PUT Response Status: 200 OK

The post Amazon Files appeared first on IRIS KashFlow.

Account Summary

KashFlow — Tue, 26 Nov 2013 10:10:35 +0000

Response elements Name Type Description Display Comprises of the display settings which govern the KashFlow ‘Overview’ UI Display object fields: ShowChangeLog Boolean Whether change log is to be displayed on UI. If this field is true, the recent changes made in the account are displayed on the ‘Overview’ UI ShowDoYouKnowSection Boolean Whether ‘Do You Know’ […]

The post Account Summary appeared first on IRIS KashFlow.

Next Available Purchase Number

KashFlow — Tue, 12 Nov 2013 05:05:47 +0000

URL : /nextavailablepurchasenumber Example response for GET of next available purchase number "11246"

The post Next Available Purchase Number appeared first on IRIS KashFlow.

Suppliers

KashFlow — Fri, 08 Nov 2013 12:49:02 +0000

Parameters Name Type Description Code String Unique code used to represent a supplier Name String Supplier name Contacts Object This object contains an array of customers contact information like name, title, firstname, lastname,Telephone, FAX, Mobile, Website Address Object This object contains the suppliers’ address details ApplyWithholdingTax Boolean WHT(Withholdong Tax commonly renamed to CIS. If this […]

The post Suppliers appeared first on IRIS KashFlow.

Bulk Payments

Duane Jackson - Founder — Thu, 24 Oct 2013 10:26:07 +0000

Parameters Name Type Description Number Numeric Unique number of bulk invoice payment Date Date Payment date. For e.g. JSON Format :2012-06-28 12:00:00, XML Format : 2012-06-28 12:00:00 Comment String Comment. AccountId Numeric Account to be used for making the payment. Method Numeric Payment mode. Reconciled Boolean If the bulk payment items are part of any […]

The post Bulk Payments appeared first on IRIS KashFlow.

Customer Statement Bulk Email

KashFlow — Thu, 17 Oct 2013 09:56:01 +0000

The response of this request is a list of status objects for each of the customer statement mailed. Each status object has the fields mentioned in the following table: Name Type Description CustomerCode String Unique code of the customer whose statement is to be mailed Sent Boolean True/False Message String The descriptive message stating the […]

The post Customer Statement Bulk Email appeared first on IRIS KashFlow.

Purchases

KashFlow — Wed, 04 Sep 2013 15:29:20 +0000

Parameters Name Type Description Number Numeric Unique purchase identifier. While creating purchase, if a value is passed for this field, then the purchase is created with this number (if it is unique w.r.t the user) IssuedDate Date Date the purchase was issued For e.g. JSON Format :[JSONDATE], XML Format : [XMLDATE] DueDate Date Date the […]

The post Purchases appeared first on IRIS KashFlow.

Bulk Convert to Invoice

KashFlow — Fri, 23 Aug 2013 07:19:31 +0000

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 }]

The post Bulk Convert to Invoice appeared first on IRIS KashFlow.

Assign project to bulk invoices

KashFlow — Fri, 23 Aug 2013 06:50:02 +0000

URL : /internal/invoices?assignproject={projectnumber} Example request for PUT [ 101, 123, 2345, 65 ]

The post Assign project to bulk invoices appeared first on IRIS KashFlow.

Invoice Bulk Email

KashFlow — Mon, 12 Aug 2013 08:34:27 +0000

The response of this request is a list of status objects for each of the invoices mailed. Each status object has the fields mentioned in the following table: Name Type Description Number Number Unique number of the invoice to be mailed Sent Boolean True/False Message String The descriptive message stating the reason for mail sending […]

The post Invoice Bulk Email appeared first on IRIS KashFlow.

Invoice List

KashFlow — Tue, 30 Jul 2013 10:20:37 +0000

URL : /invoicelist Example request for DELETE of invoicelist [ 101, 123, 2345, 65 ]

The post Invoice List appeared first on IRIS KashFlow.

Reminder letters

KashFlow — Mon, 29 Jul 2013 10:10:12 +0000

Parameters Name Type Description Number Numeric Unique identifier of the reminder letter Title String Title of the reminder letter Text String Contents of the letter body IncludeHeader Boolean Flag indicating whether header should be included in reminder letter pdf or not. SentVia String The name of the source using which reminder letter is being sent. […]

The post Reminder letters appeared first on IRIS KashFlow.

Invoice Email Count

KashFlow — Thu, 25 Jul 2013 13:31:35 +0000

Example response for PUT of email count Status Code: 200 OK Date: Mon, 24 Jun 2013 06:17:16 GMT Cache-Control: private Server: Microsoft-IIS/7.5 X-AspNet-Version: 4.0.30319 X-Powered-By: ASP.NET Content-Length: 0

The post Invoice Email Count appeared first on IRIS KashFlow.

Cardless Payment

KashFlow — Fri, 19 Jul 2013 06:02:18 +0000

Request Parameters Name Type Description InvoiceNumber Numeric Invoice number for which payment is being made. Amount Numeric Payment amount All parameters are mandatory for request.

The post Cardless Payment appeared first on IRIS KashFlow.

Bulk Documents In PDF

KashFlow — Tue, 16 Jul 2013 12:38:58 +0000

URL : /documents/invoice/bulk Example request for POST [2416,2417,2418,2388,2389,2390,2391,2392] Example response for POST "\/v2\/documents\/invoice\/bulk\/c19ee45b-b192-4695-86a3-c2cdb6958f00" URL : /documents/customerstatement/bulk Example request for POST of Customer statement ["ALEX01","ALEX02"] Example response for POST "\/v2\/documents\/customerstatement\/bulk\/bc696e79-57af-4626-86ef-dfbc3ef922c7" URL : /documents/customerstatement/bulk/{guid}?media={media}&theme={theme}&startdate={startdate}&enddate={enddate}&excludepaid={excludepaid}&filterby={filterby} URL : /documents/supplierstatement/bulk Example request for POST of Supplier statement ["ALEX01","ALEX02"] Example response for POST "\/v2\/documents\/supplierstatement\/bulk\/bc696e79-57af-4626-86ef-dfbc3ef922c7" URL : /documents/supplierstatement/bulk/{guid}?media={media}&theme={theme}&startdate={startdate}&enddate={enddate}&excludepaid={excludepaid}&filterby={filterby}

The post Bulk Documents In PDF appeared first on IRIS KashFlow.

Withholding Tax Deduction

KashFlow — Mon, 15 Jul 2013 13:12:57 +0000

Example response for POST of Withholding Tax deduction { "Address": { "Line1": "54 Main Street", "Line2": "HighField", "Line3": " ", "Line4": "", "PostCode": "CN7 8JH" }, "AutomaticCreditControlEnabled": false, "Currency": { "Code": "GBP", "DisplaySymbolOnRight": false, "ExchangeRate": 1.0000, "Name": "British Pounds", "Symbol": "£" }, "CustomerCode": "CUST102", "CustomerDiscount": 0.0000, "CustomerId": 0, "CustomerName": "CUST102", "CustomerReference": "", "DefaultNominalCode": 4905, "DeliveryAddress": […]

The post Withholding Tax Deduction appeared first on IRIS KashFlow.

Email

KashFlow — Tue, 09 Jul 2013 05:11:52 +0000

Parameters Name Type Description To String Comma or semicolon separated email “TO” addresses. Cc String Comma or semicolon separated email “CC” addresses. Bcc String Comma or semicolon separated email “BCC” addresses. Subject String Email subject Body String Email body Attachments Object Object containing information about two types of supported attachment types i.e. DocumentUrls, FileAttachments. Described […]

The post Email appeared first on IRIS KashFlow.

Email Text Substitutions

KashFlow — Thu, 04 Jul 2013 10:34:58 +0000

{objecttype} {objectnumber} Quotes Quote Number Invoices Invoice Number Customers Customer Code Purchases Purchase Number Parameters Name Type Description Key String The key that can be matched in a block of text Value String The above matched key can be replaced with this value. Example response for GET of EmailTextSubstitutions [{ "Key": "INVNUM", "Value": "33" }, […]

The post Email Text Substitutions appeared first on IRIS KashFlow.

Email Templates

KashFlow — Tue, 02 Jul 2013 09:50:00 +0000

Parameters Name Type Description Number Numeric User specific number assigned to template. Body String Email template body which will be sent as email body. The body may contain strings enclosed within # symbols. Please refer Email Text Substitutions Resource for further assistance on these special strings. Name String Email template name.Template name is unique for […]

The post Email Templates appeared first on IRIS KashFlow.

Card Payments

KashFlow — Tue, 02 Jul 2013 09:43:18 +0000

Name Type Description CardHolderName String Card holder name as it appears on the card CardType String The card types depend on the payment processor configured by the user (UserSettings -> PaymentProcessorDetails). CardNumber String The card number CVVNumber String The CVV number of the card ExpiryMonth String The month of expiry of the card in MM […]

The post Card Payments appeared first on IRIS KashFlow.

Permalinks

KashFlow — Fri, 28 Jun 2013 05:10:00 +0000

Document Type Permalink URL Description Invoice /invoice/{invoicekey} {invoicekey} in the URL will be replaced by unique guid assigned to invoice. Permalink can be obtained from INVOICE GET. Quote /quote/{quotekey} {quotekey} in the URL will be replaced by unique guid assigned to quote.Permalink can be obtained from QUOTE GET. Purchase /purchaseorder/{purchasekey} {purchasekey} in the URL will […]

The post Permalinks appeared first on IRIS KashFlow.

ViaPost

KashFlow — Tue, 25 Jun 2013 11:20:29 +0000

Parameters Name Type Description FileName String Name of the file to be uploaded. DocumentUrl String Url of the document that needs to be sent. Balance Decimal User viapost account’s balance. Address parameters Name String Name Line1 String First line of address Line2 String Seconf line of address Line3 String Third line of address Line4 String […]

The post ViaPost appeared first on IRIS KashFlow.

Dropbox

KashFlow — Thu, 20 Jun 2013 14:30:15 +0000

{objecttype} {objectnumber} Quotes Quote Number Invoices Invoice Number Purchases Purchase Number Customers Customer Code BankAccounts Bank Account Name So, the GET of URL /invoice/100/files would return the Dropbox files belonging to invoice number 100. Parameters Name Type Description Icon String The icon name for a file. This uniquely identifies the image file that needs to […]

The post Dropbox appeared first on IRIS KashFlow.

Metadata

KashFlow — Thu, 20 Jun 2013 05:13:13 +0000

Response elements Name Type Description TotalProductCount Numeric Count of the total number of products in the account. TotalNominalCount Numeric Count of the total number of nominals in the account. TotalCustomerCount Numeric Count of the total number of customers in the account. TotalInvoiceCount Numeric Count of the total number of invoices in the account. TotalBankBalance Numeric […]

The post Metadata appeared first on IRIS KashFlow.

Credits

KashFlow — Mon, 17 Jun 2013 09:43:45 +0000

Parameters Name Type Description Id Numeric If type is AdvancePayment then Id is the unique bank identifier. If type is CreditNote then Id is the unique invoice identifier. If type is OverPayment then Id is the unique invoice payment identifier. Amount Numeric The amount that can be credited. Date Date If type is AdvancePayment then […]

The post Credits appeared first on IRIS KashFlow.

Bank Accounts

KashFlow — Mon, 03 Jun 2013 07:31:43 +0000

Parameters FeedAccountNameStringName of bank feed account Name Type Description Id Numeric Unique id given to the bank account Code Numeric Code assigned to the bank account AccountName String Name of the bank account IsDefaultAccount Boolean Whether this account is the default bank account for the user IsArchived Boolean Whether this account is archived StartingDate Date […]

The post Bank Accounts appeared first on IRIS KashFlow.

Payment Methods

KashFlow — Fri, 31 May 2013 10:28:48 +0000

Parameters Name Type Description Id Numeric Unique id assigned to payment method Name String Payment method name IsDefault Boolean Flag indicating whether this method is default for user account. Example response for GET of payment method list [{ "Id": 409844, "IsDefault": true, "Name": "Bank Transfer" }, { "Id": 409845, "IsDefault": false, "Name": "Cash" }, { […]

The post Payment Methods appeared first on IRIS KashFlow.

Next Available Invoice Number

KashFlow — Fri, 31 May 2013 10:22:14 +0000

URL : /nextavailableinvoicenumber Example response for GET of next available invoice number "11256"

The post Next Available Invoice Number appeared first on IRIS KashFlow.

Authentication

KashFlow — Wed, 06 Mar 2013 10:48:54 +0000

For accessing REST API methods, it is mandatory to specify a valid session token in the Authorization Headers of HTTP Request. Example HTTP Request Headers Accept: application/json Content-Type: application/json Authorization: KfToken 496F5DBA-DBB2-42A3-9645-DA0253220C9E Connection: keep-alive Origin: chrome-extension: //rest-console-id User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.22 (KHTML, like Gecko) Chrome/25.0.1364.152 Safari/537.22 As mentioned in the example request […]

The post Authentication appeared first on IRIS KashFlow.

Quote List

KashFlow — Fri, 01 Mar 2013 17:12:02 +0000

URL : /quotelist Example request for DELETE of quotelist [ 101, 123, 2345, 65 ]

The post Quote List appeared first on IRIS KashFlow.

Duplicate Entity

KashFlow — Thu, 14 Feb 2013 10:43:49 +0000

Name Type Description SourceNumber Numeric Number of the entity to be copied SourceType String Type of the KF entity to be copied. The possible values can be “Quote” or “Invoice” TargetType String Type of the target KF entity. The possible values can be “Quote” or “Invoice” TargetId Numeric Database ID of the newly created entity […]

The post Duplicate Entity appeared first on IRIS KashFlow.

Settings

KashFlow — Mon, 28 Jan 2013 11:38:35 +0000

Response elements Name Type Description List of associated accounts. Each associated account has the following parameters CompanyName String Company name of the user Username String Name of the user Display settings parameters DisplayDensity String Display setting for the user’s account. The 3 acceptable options are 1. Comfortable, 2. Cozy and 3. Compact PrimaryColors Collection Array […]

The post Settings appeared first on IRIS KashFlow.

Response Codes

KashFlow — Thu, 10 Jan 2013 10:01:53 +0000

Every request to our REST API is responded to with an HTTP status code. Where appropriate, more information is provided in the response body. Listed below are the possible response codes you could be returned along with additional information as to their meaning. Code Status Description 200 OK Signifies that the operation (GET, POST, PUT) was dealt […]

The post Response Codes appeared first on IRIS KashFlow.

Menu Settings

KashFlow — Fri, 28 Dec 2012 07:26:52 +0000

Parameters Name Type Description JournalEnabled Boolean Flag to indicate whether journal is enabled or not for the user. True indicates journal is enabled for user account. ProjectsEnabled Boolean Flag to indicate whether project is enable or not for the user. True indicates project is enabled for user account. ProjectText String User’s customized name for project. […]

The post Menu Settings appeared first on IRIS KashFlow.

Users

KashFlow — Thu, 20 Dec 2012 06:18:37 +0000

Parameters Name Type Description Number Numeric Unique number associated with the user’s Kashflow account FullName String Full name of the user which includes first, middle and last name. RoleNumber Numeric Unique number of role to be assigned to the user. Username String Unique username of the user’s KashFlow account. Password String Password for the user’s […]

The post Users appeared first on IRIS KashFlow.

Roles

KashFlow — Thu, 20 Dec 2012 06:01:50 +0000

Parameters Name Type Description Number Numeric Company specific number assigned to role Name String Name of role Permissions Collection List of permissions that belong to the role Description String Description of the role UserNames Collection List of user names that belong to the role UserCount Numeric Number of user names that belong to this role […]

The post Roles appeared first on IRIS KashFlow.

Session Token

KashFlow — Thu, 20 Dec 2012 05:47:33 +0000

Example request for POST of login { "Password":"password", "UserName":"admin" } Example response for POST of login { "HasTemporaryPassword":false, "IsAdmin":true, "PackageName": "Business", "PartnerBrandingOptOut": true, "MemorableWordList": [{ "Position": 2, "Value": "" }, { "Position": 3, "Value": "" }, { "Position": 4, "Value": "" }], "PartnerId": 3, "SubscriptionExpired": false, "TemporaryToken": "c3ce04a3-65b3-48bb-a3b9-366769359c56" } Example request for PUT of login […]

The post Session Token appeared first on IRIS KashFlow.

Projects

KashFlow — Wed, 19 Dec 2012 12:35:05 +0000

Parameters Name Type Description Number* Numeric Unique number given to the project ActualJournalsAmount Numeric Balance of journals (Credit – Debit) associated with the project ActualPurchasesAmount Numeric Total value of purchases against the project ActualSalesAmount Numeric Sum of the amounts of all invoices associated with the project CustomerId Numeric Id of the customer against whom the […]

The post Projects appeared first on IRIS KashFlow.

Next Available Quote Number

KashFlow — Wed, 19 Dec 2012 11:03:35 +0000

URL : /nextavailablequotenumber Example response for GET of next available quote number "11256"

The post Next Available Quote Number appeared first on IRIS KashFlow.

Next Available Project Number

KashFlow — Wed, 19 Dec 2012 10:54:25 +0000

URL : /nextavailableprojectnumber Example response for GET of next available project number "873540"

The post Next Available Project Number appeared first on IRIS KashFlow.

Language Resource

KashFlow — Wed, 19 Dec 2012 10:41:11 +0000

The following are the sections in Kashflow application: Section Common Quote Overview Notes Customer Invoice Project Role User {section Name} is the section of the KashFlow application from which language related data needs to be fetched. Example response for GET of section of language resource [{"Common":{"ui_add_button_text":"Add Category","ui_cancel_button_text":"Cancel", "ui_common_addItem":"Add Item"}}]

The post Language Resource appeared first on IRIS KashFlow.

Permission Hierarchy

KashFlow — Wed, 19 Dec 2012 10:35:17 +0000

Parameters Name Type Description HierarchyId Integer Database Id of the heirarchy PermissionId Integer Database Id of the permission associated with a particular hierarchy ShouldHavePermissionId Integer Database Id of the permission that a hierarchy inherits(has) Example response for GET of permission hierarchy [ { "HierarchyId": "1", "PermissionId": "3", "ShouldHavePermissionId": "2" }, { "HierarchyId": "2", "PermissionId": "4", […]

The post Permission Hierarchy appeared first on IRIS KashFlow.

Java Script Error

KashFlow — Wed, 19 Dec 2012 10:25:36 +0000

Example request for POST of js error { "JsError": { "ErrorString": "this is the error message!!!!" } }

The post Java Script Error appeared first on IRIS KashFlow.

Project Settings

KashFlow — Wed, 19 Dec 2012 10:07:55 +0000

Response Elements Name Description CustomerDisplayFormat Setting that indicates how the customer’s first and last name should be arranged while displaying it. For 0 – Smith, John, Mr ; 1 – Smith, John; 3 – John Smith ProjectStartDateName User’s customized name for start date of project ProjectEndDateName User’s customized name for end date of project IsEnabled […]

The post Project Settings appeared first on IRIS KashFlow.

Invoice Settings

KashFlow — Wed, 19 Dec 2012 09:57:45 +0000

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 […]

The post Invoice Settings appeared first on IRIS KashFlow.

Quote Settings

KashFlow — Wed, 19 Dec 2012 09:53:38 +0000

Parameters Name Type Description PrevNextOptionEnabled Boolean Previous and next buttons to be displayed in view of quote or not PrevNextType Numeric Previous and next buttons to be looped through all quotes or all quotes for current selected customer QuoteAdditionalText Numeric Additonal text to appear at the bottom of quote pdf QuoteConvertedCategory Numeric After quote is […]

The post Quote Settings appeared first on IRIS KashFlow.

Help Content

KashFlow — Wed, 19 Dec 2012 09:37:50 +0000

Parameters Name Type Description Id Numeric Unique id of help content Title String Help text title Text String Help text content Example response of GET of help content { "Id": 78, "Text": "Sample text", "Title": "Text Substitutions" }

The post Help Content appeared first on IRIS KashFlow.

OAuth Signed URI

KashFlow — Wed, 19 Dec 2012 08:12:18 +0000

Parameters Name Description url The URI to sign endpoint Supported external applications 1) DROPBOX 2) TRADESHIFT 3) TRADESHIFT_SANDBOX method 1) GET 2) POST 3) PUT 4) DELETE Example response for GET of OAuth signed url https://api.dropbox.com/1/metadata/sandbox/Invoices/1?oauth_consumer_key=&oauth_nonce=13558257074A2EDF4FC3C64D14AABD60444562EA7A&oauth_signature_method=HMAC-SHA1&oauth_timestamp=1355825707&oauth_token=&oauth_signature=JfzWR26%2F6kjk4Hobx670q71CUnQ%3D&

The post OAuth Signed URI appeared first on IRIS KashFlow.

Tax List

KashFlow — Wed, 19 Dec 2012 07:26:34 +0000

Parameters Name Type Description Id Numeric Unique id given to the tax entry Code String Unique code assigned to the tax entry Description String Description of the tax entry Rate Numeric Vat rate for the tax entry Example response for GET of list of taxes { "Tax": [ { "Code": "TX7", "Description": "Purchases with GST […]

The post Tax List appeared first on IRIS KashFlow.

Currencies

KashFlow — Wed, 19 Dec 2012 07:12:29 +0000

Parameters Name Type Description Code String Unique code assigned to currency Symbol String Currency symbol Name String Currency name ExchangeRate Numeric Exchange rate DisplaySymbolOnRight Boolean Flag indicating whether currency symbol to be shown on right or left of the amount. True if want to show currency symbol on right side of amount. Example response for […]

The post Currencies appeared first on IRIS KashFlow.

Quote Category Icons

KashFlow — Wed, 19 Dec 2012 07:06:29 +0000

Parameters Name Type Description Id Numeric Unique id of the category icon Name String Name of the category icon Path String Path of the image file for the category icon Example Response for GET of quote category icons [ { "Id": 1, "Name": "Red Flag 1", "Path": "redflag1.gif" }, { "Id": 2, "Name": "Purple Flag […]

The post Quote Category Icons appeared first on IRIS KashFlow.

User Advanced Settings

KashFlow — Wed, 19 Dec 2012 07:04:47 +0000

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 […]

The post User Advanced Settings appeared first on IRIS KashFlow.

KashFlow Permissions

KashFlow — Wed, 19 Dec 2012 07:02:44 +0000

Permissions Permission Name Meaning FullAccess Admin permissions ViewCustomer Permission to view customer related information ViewQuote Permission to view quote related information ViewInvoice Permission to view invoice related information Example response for GET of KashFlow permissions { "FullAccess": "FullAccess", "ViewCustomer": "ViewCustomer", "ViewInvoice": "ViewInvoice", "ViewQuote": "ViewQuote" }

The post KashFlow Permissions appeared first on IRIS KashFlow.

User Permissions

KashFlow — Wed, 19 Dec 2012 06:57:01 +0000

Parameters Name Description FullAccess Full access to KashFlow account ViewInvoice Permission to view invoice CreateInvoice Permission to view and create invoice EditInvoice Permission to view, create and edit invoice DeleteInvoice Permission to view, create, edit and delete invoice (full access to invoices) ViewQuote Permission to view quote CreateQuote Permission to view and create quote EditQuote […]

The post User Permissions appeared first on IRIS KashFlow.

VAT Rates

KashFlow — Wed, 19 Dec 2012 06:37:26 +0000

Parameters Name Type Description VatId Numeric Unique number given to the VAT entry VATText String The way the VAT record needs to be displayed on UI VATRate Numeric VAT Rate associated with the VAT record Example response for GET of list of VAT entries [ { "VatId": 348, "VATText": "40%", "VATRate": 40 }, { "VatId": […]

The post VAT Rates appeared first on IRIS KashFlow.

Products

KashFlow — Wed, 19 Dec 2012 06:14:38 +0000

Parameters Name Type Description Id Numeric Unique product id Code String Unique product code NominalCode String Code of the parent nominal for this product NominalId Numeric Unique id of the nominal Name String Product name Description String Product description AutoFillLineItem Boolean If true, then when the user selects this code they expect other form fields […]

The post Products appeared first on IRIS KashFlow.

Quote Categories

KashFlow — Wed, 19 Dec 2012 05:37:50 +0000

Parameters Name Type Description Number Numeric Unique number of quote category IconId Numeric Unique id of quote category Name String Name of the quote category IconType String Type of the category. It can take the any of the following 4 values : [“flag”, “marker”, “tick”, “cross”] IconColor String Color of the the quote category flag/marker/cross/tick. […]

The post Quote Categories appeared first on IRIS KashFlow.

Notes

KashFlow — Thu, 06 Dec 2012 06:42:00 +0000

{objecttype} {objectnumber} Quotes Quote Number Invoices Invoice Number Customers Customer Code Purchases Purchase Number Suppliers Supplier Code So, the GET of URL /invoice/100/notes would return the notes belonging to invoice number 100. Each individual note resource is identified by a note number. Note number is unique with respect to the entity to which it belongs. […]

The post Notes appeared first on IRIS KashFlow.

Quotes

KashFlow — Thu, 06 Dec 2012 06:03:52 +0000

Parameters Name Type Description Number Numeric Number given to quote Date Date Date on which quote is issued. For e.g. [JSONDATE] CustomerCode String Unique customer code of quote’s customer CustomerName String Quote’s customer name CustomerReference String Quote’s reference GrossAmount Numeric Gross amount NetAmount Numeric Quote amount excluding VAT VATAmount Numeric Vat applied to quote Category […]

The post Quotes appeared first on IRIS KashFlow.

Invoices

KashFlow — Wed, 28 Nov 2012 06:29:09 +0000

Parameters Name Type Description Number Numeric Unique invoice identifier. While creating invoice, if a value is passed for this field, then the invoice is created with this number (if it is unique w.r.t the user) IssuedDate Date Date the invoice was issued. For e.g. JSON Format :[JSONDATE], XML Format : [XMLDATE] DueDate Date Date the […]

The post Invoices appeared first on IRIS KashFlow.

Customers

KashFlow — Tue, 23 Oct 2012 14:29:22 +0000

Parameters Name Type Description Code String Unique code used to represent a customer DisplayName String Customer name formatted according to user setting Name String Customer’s name Source Numeric Source CreatedDate Date Date of customer creation. For e.g. [JSONDATE] LastUpdatedDate Date Last date when customer was updated. For e.g. [JSONDATE] IsRegisteredInEC Boolean Flag indicating whether customer […]

The post Customers appeared first on IRIS KashFlow.