KashFlow API - Manual - Methods

Manual Contents

Introduction

Methods and Arguments

  Overview

  Customers
    GetCustomer
    GetCustomerById
    GetCustomerByEmail
    GetCustomers
    GetCustomersModifiedSince
    InsertCustomer
    UpdateCustomer
    DeleteCustomer
    GetCustomerSources
    GetCustomerVATNumber
    SetCustomerVATNumber
    GetCustomerCurrency
    SetCustomerCurrency
    GetCustomersByPostcode
    GetCustomerBalance
    GetCustomerAdvancePayments

  Quotes
    DeleteQuote
    DeleteQuoteByID
    DeleteQuoteLine
    DeleteQuoteLineWithQuoteID
    GetQuoteByNumber
    GetQuoteByID
    GetQuotes
    GetQuotes_Recent
    GetQuotesForCustomer
    InsertQuote
    InsertQuoteLine
    isStillQuote
    UpdateQuote
    UpdateQuoteHeader
    ConvertQuoteToInvoice

  Invoices
    GetInvoice
    GetInvoiceByID
    GetInvoicesByDateRange
    GetInvoicesForCustomer
    GetInvoices_Overdue
    GetInvoices_Recent
    GetInvoices_Unpaid
    InsertInvoice
    InsertInvoiceLine
    InsertInvoiceLineWithInvoiceNumber
    UpdateInvoice
    UpdateInvoiceHeader
    DeleteInvoice
    DeleteInvoiceByID
    DeleteInvoiceLine
    DeleteInvoiceLineWithInvoiceID
    EmailInvoice
    PrintInvoice
    GetPaypalLink
    InsertInvoiceNotes
    GetInvoiceNotes

  Invoice Payments
    applyCreditNoteToInvoice
    GetInvoicePayment
    GetInvPayMethods
    InsertInvoicePayment
    DeleteInvoicePayment
    AllocateAdvancePaymentToInvoice

  Suppliers
    GetSupplier
    GetSuppliers
    GetSupplierById
    InsertSupplier
    UpdateSupplier
    GetSupplierVATNumber
    SetSupplierVATNumber
    GetSupplierCurrency
    SetSupplierCurrency

  Purchases
    GetReceipt
    GetReceipts
    GetReceipts_Recent
    GetReceiptsForSupplier
    InsertReceipt
    UpdateReceipt
    UpdateReceiptHeader
    DeleteReceipt
    DeleteReceiptByID
    InsertReceiptLine
    InsertReceiptLineFromNumber
    DeleteReceiptLine
    DeleteReceiptLineWithReceiptID
    AttachFileToReceipt
    GetReceiptAttachments
    DeleteReceiptAttachment
    InsertReceiptNotes
    GetReceiptNotes

  Purchase Payments
    GetReceiptPayment
    GetRecPayMethods
    InsertReceiptPayment
    DeleteReceiptPayment
    AllocateAdvancePaymentToReceipt

  Bank
    CreateBankAccount
    GetBankAccounts
    GetBankTXTypes
    GetBankBalance
    GetBankTransactions
    InsertBankTransaction
    UpdateBankTransaction
    DeleteBankTransaction

  Journals
    InsertJournal
    GetJournal
    GetJournals
    DeleteJournal
    DeleteJournalByID
    UpdateJournal
    UpdateJournalHeader

  Reports
    GetAgedDebtors
    GetAgedCreditors
    GetBalanceSheet
    GetDigitaCSVFile
    GetIncomeByCustomer
    GetKPIs
    GetMonthlyProfitAndLoss
    GetNominalLedger
    GetProfitAndLoss
    GetTrialBalance
    GetVATReport

  Projects
    GetProjects
    GetProjects_Full
    InsertOrUpdateProject
    GetProjectById
    GetProjectByName
    GetProjectByRef

  Supplementary Functions
    AddOrUpdateSubProduct
    AutoAuthIP
    createAccount
    GetAccountOverview
    GetBankOverview
    GetCurrencies
    GetRemoteLoginURL
    GetProducts
    GetProjects
    GetNominalCodes
    GetNominalCodesExtended
    GetSubProducts
    GetVATRates
    InsertNominalCode
    isUserVATRegistered
    SetCustomerCurrency
    SetSupplierCurrency
    SetCustomerVATNumber
    SetSupplierVATNumber
    VCFToCustomerObjects
    GetSubProductByID
    GetSubProductByCode
    GetCompanyDetails


Classes

  AccountOverview
  AgedDebtorsCreditors
  BalanceSheet
  BankAccount
  BankOverview
  BankTransaction
  BankTXType
  BasicDataset
  CompanyDetails
  Currencies
  Customer
  CustomerBalance
  Invoice
  InvoiceLine
  InvoiceNote
  JournalEntry
  JournalLine
  MonthlyPL
  NominalCode
  NominalCodeExtended
  Payment
  PaymentMethod
  Product
  ProfitAndLoss
  Project
  ReceiptAttachment
  ReceiptNote
  SubProduct
  Supplier
  TransactionInformation
  VATReport

Manual - Methods - createAccount

Unlike other API methods, this method doesn't require that you authenticate yourself by passing in a username and password.

However, this method is intended to be used mainly by our integration partners. So you do need to provide an AccountCreationKey. If you'd like a key to use to create accounts, please contact us.

If the account was successfully created then you'll receive an ID number. This is our reference for the user account.

If it was unsuccessful for any reason then you'll get a Status of NO and the StatusDetail will explain why (ie, username already in use)

IN	AccountCreationKey String	See above
IN	Username String	The desired username
IN	password String	The password for the new account. Must be at least 5 characters
IN	memorableword String	The memorable word for the new account. Must be at least 5 characters
IN	EmailAddress String	The users email address
IN	CompanyName String	The users company name
IN	Addr1 String	An address for the user
IN	Addr2 String
IN	Addr3 String
IN	Addr4 String
IN	Postcode String	The users postcode
IN	ContactName String	A contact name for the user. usually their full name.
IN	Telephone String	The users telephone number
IN	VATRegistered Integer	Set this to 1 is the user is VAT registered
IN	VATNumber String	The users VAT number
IN	USSettings Integer	Set this to 1 if you want the user to have the date in US format and default to $ for the currency
IN	promocode String	If you've joined our affiliate scheme, you can provide your promotional code here
RETURNS	Integer	If the account was successfully created you'll receive a user id number

View Client Soap Examples