KashFlow Accounting Software Accounting API
Home  |  Manual  |  Resources  |  Find a Developer  |  Support  |  Contact

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

  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
    

Classes

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


Manual - Classes - Customer


All of the fields below should be self explanatory when viewed in conjunction with the customer page in a KashFlow account.

Member Data Type Content
CustomerID Integer The system-wide, unique ID number for this customer
Code
String Customer Code
Name String The customers name
Contact String Contact Name
Telephone String  
Mobile String  
Fax String  
Email String  
Address1 String  
Address2 String  
Address3 String  
Address4 String  
Postcode String  
Website String  
EC Integer Is set to 1 if the customer is VAT registered and based in another EC country
OutsideEC Integer Is set to 1 if the customer is VAT registered and based outside an EC country
Notes String  
Source Integer  
Discount Decimal The discount percentage for this customer
ShowDiscount Boolean  
PaymentTerms String  
ExtraText1 String Custom field
ExtraText2 String Custom field
ExtraText3 String Custom field
ExtraText4 String Custom field
ExtraText5 String Custom field
ExtraText6 String Custom field
ExtraText7 String Custom field
ExtraText8 String Custom field
ExtraText9 String Custom field
ExtraText10 String Custom field
ExtraText11 String Custom field
ExtraText12 String Custom field
ExtraText13 String Custom field
ExtraText14 String Custom field
ExtraText15 String Custom field
ExtraText16 String Custom field
ExtraText17 String Custom field
ExtraText18 String Custom field
ExtraText19 String Custom field
ExtraText20 String Custom field
CheckBox1 Integer Custom field
CheckBox2 Integer Custom field
CheckBox3 Integer Custom field
CheckBox4 Integer Custom field
CheckBox5 Integer Custom field
CheckBox6 Integer Custom field
CheckBox7 Integer Custom field
CheckBox8 Integer Custom field
CheckBox9 Integer Custom field
CheckBox10 Integer Custom field
CheckBox11 Integer Custom field
CheckBox12 Integer Custom field
CheckBox13 Integer Custom field
CheckBox14 Integer Custom field
CheckBox15 Integer Custom field
CheckBox16 Integer Custom field
CheckBox17 Integer Custom field
CheckBox18 Integer Custom field
CheckBox19 Integer Custom field
CheckBox20 Integer Custom field
Created DateTime The date this customer was created
Updated DateTime The date the customer was updated.
CurrencyID Integer The default currency id
ContactTitle String Contact name title
ContactFirstName String Contact first name
ContactLastName String Contact last name
CustHasDeliveryAddress Integer A flag to indicate whether the customer has a delivery address. Set to 1 if delivery address is present.
DeliveryAddress1 String Delivery address line 1
DeliveryAddress2 String Delivery address line 2
DeliveryAddress3 String Delivery address line 3
DeliveryAddress4 String Delivery address line 4
DeliveryPostcode String Delivery address postcode





Home  |  Manual  |  Resources  |  Find a Developer  |  Support  |  Contact