REST API Archive - Page 7 of 11

The REST API is a work in progress and as such is subject to change. You should not be using it in a production environment.

Read through the documents in the Introduction section below to familiarize yourself with the basics of our API before attempting to make use of it.

Below the Introduction section is a list of all resources that you can access via the API. We have attempted to categories these to make it easer to find what you are looking for.

Introduction

Before making use of the API you should familiarize yourself with the information in the documents below.

Account Summary - Retrieves the summary of all account related information of the user
Advance Payment List - Get list of advance payments for customers
Alert
Amazon Files - Initiates the migration process of Amazon files for the user
Archive customers - Archive multiple customers at one go
Archive suppliers - Archive multiple suppliers at one go
Assign project to bulk invoices - Assigns project to multiple invoices at one go
Authentication - Authentication mechanism to consume REST API
Bank Accounts - API for handling CRUD operations on bank account
Bank Icons
Bank Reconciliation - API to handle Bank Reconciliations.
Bank Transaction List - Deletes multiple bank transactions at one go
Bank Transactions - Bank transaction CRUD operations
Bulk Convert to Invoice - Converts quotes to invoices
Bulk Documents In PDF - Generates a url for a pdf
Bulk Payments - Records a single payment against multiple invoices/purchases
Business Sources - Get list of sources of business for user
Card Payments - Makes a card payment for an invoice
Cardless Payment
Countries Vatrates - API for handling GET operation on vatrates for countries
Credits - Credit api for making payments on an invoice
Currencies - Retrieves list of currencies set up for the user
Customer Custom Fields - Get list of custom fields
Customer List - Deletes multiple customers at one go
Customer Statement Bulk Email - Emails multiple cutomer statements at one go
Customers - Retrieves, creates, updates or deletes customer(s)
Data Import
Dropbox - Retrieves, uploads or deletes dropbox file(s)
Duplicate Entity - Creates duplicate KashFlow entities
Email - Sends a email
Email Templates - Templates for sending emails
Email Text Substitutions - Returns text substitution values.
Envelope - Prints customer address on specified envelope
Help Content - Retrieves help texts
Integrations - Retrieve list of applications integrated with KashFlow
Invoice Bulk Email - Emails multiple invoices at one go
Invoice Email Count - Updates the email sent count of a perticular invoice
Invoice List - Deletes multiple invoices at one go
Invoice Settings - Retrieves all invoice related settings
Invoices - Retrieves, creates, updates or deletes invoice(s)
Java Script Error - Sends javascript errors to server
KashFlow Permissions - Retrieves list of all KashFlow permissions
Language Resource - Retrieves the language data of the entire/section of KashFlow application
Mandates - Api to get, create and delete mandate for a customer
Menu Settings - Retrieves settings for rendering main menu
Metadata - Provides a user's account information such as total number of products etc
Next Available Invoice Number - Retrieves the next available (unused) invoice number
Next Available Project Number - Retrieves the next available (unused) project number
Next Available Purchase Number - Retrieves the next available (unused) purchase number
Next Available Quote Number - Retrieves the next available (unused) quote number
Notes - Retrieves, creates, updates or deletes note(s)
OAuth Signed URI - Used for signing URLs to be used with the OAuth protocol
Payment Methods - retrieves
Pdf Themes - Gets the list of pdf themes of the users
Permalinks - permanent links used to access different kashflow entities in pdf format
Permission Hierarchy - Retrieves the list of permission hierarchies which explains permission dependencies
Products - Retrieves list of products set up for the user
Project Settings - Retrieves all project related settings
Projects - Retrieves, creates, updates or deletes project(s)
Purchases - Retrieves, creates, updates or deletes purchase(s)
Quote Categories - Retrieves list of all quote categories set up for the user
Quote Category Icons - Retrieves list of all quote category icons
Quote List - Deletes multiple quotes at one go.
Quote Settings - Retrieves all quote related settings
Quotes - Retrieves, creates, updates or deletes quote(s)
Recurring Purchases - Retrieves and creates recurring purchase(s)
Referral - Creates referral code for user
Referral Settings - Retrieves user's referral settings
Reminder letters - Retrieve/Update the reminder letters
Response Codes - A list of the response codes that you are likely to receive from the API
Roles - Retrieves, creates, updates or deletes role(s)
Session Token - Authenticates the user and issues a session token for use with subsequent requests
Settings - Retrieves all the settings for the user
SMTP Configurations
Subscription
Supplier Statement Bulk Email - Emails multiple supplier statements at one go
Suppliers - Retrieves list of all suppliers for the user.
Tax List - Retrieves list of taxes setup for the user
User Advanced Settings - Retrieves user's advanced settings
User Permissions - Retrieves the list of user's permissions
Users - Retrieves, creates, updates or deletes user(s)
VAT Moss Report - Retrieves, creates, or deletes VAT Moss reports
VAT MOSS Returns
VAT Rates - Retrieves list of VAT rates set up for the user
ViaPost - Delivers the specified document to specified address by using user's viapost account
Withholding Tax Deduction - Applies Withholding Tax deduction

KashFlow Rest API Documentation

Introduction

Core Entities

Other Entities

Settings

Helper Methods

Other